adapter.d.ts 2.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
  1. /**
  2. * @license
  3. * Copyright 2020 Google Inc.
  4. *
  5. * Permission is hereby granted, free of charge, to any person obtaining a copy
  6. * of this software and associated documentation files (the "Software"), to deal
  7. * in the Software without restriction, including without limitation the rights
  8. * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  9. * copies of the Software, and to permit persons to whom the Software is
  10. * furnished to do so, subject to the following conditions:
  11. *
  12. * The above copyright notice and this permission notice shall be included in
  13. * all copies or substantial portions of the Software.
  14. *
  15. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16. * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17. * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18. * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19. * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20. * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  21. * THE SOFTWARE.
  22. */
  23. export interface MDCSegmentedButtonSegmentAdapter {
  24. /**
  25. * @return Returns true if wrapping segmented button is single select
  26. */
  27. isSingleSelect(): boolean;
  28. /**
  29. * @param attrName Attribute of interest
  30. * @return Returns segment's attribute value if it is set, otherwise returns
  31. * null
  32. */
  33. getAttr(attrName: string): string | null;
  34. /**
  35. * Sets segment's attribute value to new value
  36. *
  37. * @param attrName Attribute of interest
  38. * @param value New value of attribute
  39. */
  40. setAttr(attrName: string, value: string): void;
  41. /**
  42. * Adds css class to segment
  43. *
  44. * @param className Class to add
  45. */
  46. addClass(className: string): void;
  47. /**
  48. * Removes css class from segment
  49. *
  50. * @param className Class to remove
  51. */
  52. removeClass(className: string): void;
  53. /**
  54. * @param className Class of interest
  55. * @return Returns true if segment has css class, otherwise returns false
  56. */
  57. hasClass(className: string): boolean;
  58. /**
  59. * Emits event about segment to wrapping segmented button
  60. *
  61. * @param selected Represents whether segment is currently selected
  62. * @event selected With detail - SegmentDetail
  63. */
  64. notifySelectedChange(selected: boolean): void;
  65. /**
  66. * @return Returns bounding rectangle for ripple effect
  67. */
  68. getRootBoundingClientRect(): DOMRect;
  69. }