Open topic with navigation

com.hp.lft.sdk.sap.ui5

## Class FacetFilterDescription

- java.lang.Object
- - com.hp.lft.sdk.internal.PropertiesDescriptionBase
  - - com.hp.lft.sdk.PropertiesDescription
    - - com.hp.lft.sdk.DescriptionBase
      - - com.hp.lft.sdk.web.WebBaseDescription
        - - com.hp.lft.sdk.web.WebElementDescription
          - - com.hp.lft.sdk.sap.ui5.FacetFilterDescription

- All Implemented Interfaces:
    CloneableObject, Description, com.hp.lft.sdk.internal.DescriptionWithVri, java.lang.Cloneable

      public class FacetFilterDescription
      extends WebElementDescription

  The description of an SAPUI5 FacetFilter test object.

- - ### Nested Class Summary

    Modifier and Type | Class and Description
    --- | ---
    `static class` | `FacetFilterDescription.Builder` This class can be used to construct an instance of the FacetFilterDescription class using the builder pattern.
    `protected static class` | `FacetFilterDescription.Init<T extends FacetFilterDescription.Init<T>>`

  - ### Field Summary

    - ### Fields inherited from class com.hp.lft.sdk.internal.PropertiesDescriptionBase

      `properties`

  - ### Constructor Summary

    Modifier | Constructor and Description
    --- | ---
    `` | `FacetFilterDescription()` Construct a new FacetFilterDescription.
    `protected` | `FacetFilterDescription(FacetFilterDescription.Init<?> init)`

  - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `java.lang.String[]` | `getFilters()` Returns a list of filters in the facet filter.
    `java.lang.Integer` | `getFiltersCount()` Gets the number of filter lists of the facet filter.
    `FacetFilterMode` | `getMode()` Returns the visual mode of the facet filter.
    `java.lang.Boolean` | `isEnabled()` Returns whether the facet filter is enabled.
    `void` | `setEnabled(java.lang.Boolean enabled)` Sets whether the facet filter is enabled.
    `void` | `setFilters(java.lang.String[] filters)` Sets a list of filters in the facet filter.
    `void` | `setFiltersCount(java.lang.Integer filtersCount)` Sets the number of filter lists of the facet filter.
    `void` | `setMode(FacetFilterMode mode)` Sets the visual mode of the facet filter.

    - ### Methods inherited from class com.hp.lft.sdk.web.WebElementDescription

      `getAccessibilityName, getCSSSelector, getRole, getXPath, setAccessibilityName, setAccessibilityName, setCSSSelector, setCSSSelector, setRole, setRole, setXPath, setXPath`

    - ### Methods inherited from class com.hp.lft.sdk.web.WebBaseDescription

      `cloneTo, getAbsoluteLocation, getAttributes, getClassName, getId, getInnerHTML, getInnerText, getLocation, getName, getOuterHTML, getOuterText, getSize, getStyles, getTagName, getTitle, isVisible, setAbsoluteLocation, setAbsoluteLocation, setAbsoluteLocation, setAttributes, setClassName, setClassName, setId, setId, setInnerHTML, setInnerHTML, setInnerText, setInnerText, setLocation, setLocation, setLocation, setName, setName, setOuterHTML, setOuterHTML, setOuterText, setOuterText, setSize, setSize, setSize, setStyles, setTagName, setTagName, setTitle, setTitle, setVisible`

    - ### Methods inherited from class com.hp.lft.sdk.DescriptionBase

      `getIndex, getIndexType, getVRI, setIndex, setIndexType, setVRI, setVRI`

    - ### Methods inherited from class com.hp.lft.sdk.PropertiesDescription

      `clone`

    - ### Methods inherited from class com.hp.lft.sdk.internal.PropertiesDescriptionBase

      `getValueAs, getValueAsStringProperty, insertValue`

    - ### Methods inherited from class java.lang.Object

      `equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

    - ### Methods inherited from interface com.hp.lft.sdk.CloneableObject

      `clone`

- - ### Constructor Detail

    - #### FacetFilterDescription

          public FacetFilterDescription()

      Construct a new FacetFilterDescription.

    - #### FacetFilterDescription

          protected FacetFilterDescription(FacetFilterDescription.Init<?> init)

  - ### Method Detail

    - #### setFilters

          public void setFilters(java.lang.String[] filters)

      Sets a list of filters in the facet filter.
      Parameters:
        `filters` - a list of filter buttons that can be used to filter the rows.

    - #### getFilters

          public java.lang.String[] getFilters()

      Returns a list of filters in the facet filter.
      Returns:
        a list of filters in the facet filter.

    - #### setFiltersCount

          public void setFiltersCount(java.lang.Integer filtersCount)

      Sets the number of filter lists of the facet filter.
      Parameters:
        `filtersCount` - the number of filter lists of the facet filter.

    - #### getFiltersCount

          public java.lang.Integer getFiltersCount()

      Gets the number of filter lists of the facet filter.
      Returns:
        the number of filter lists of the facet filter.

    - #### setMode

          public void setMode(FacetFilterMode mode)

      Sets the visual mode of the facet filter.
      Parameters:
        `mode` - the visual mode of the facet filter.

    - #### getMode

          public FacetFilterMode getMode()

      Returns the visual mode of the facet filter.
      Returns:
        the visual mode.

    - #### setEnabled

          public void setEnabled(java.lang.Boolean enabled)

      Sets whether the facet filter is enabled.
      Parameters:
        `enabled` - true to enable the object.

    - #### isEnabled

          public java.lang.Boolean isEnabled()

      Returns whether the facet filter is enabled.
      Returns:
        True if enabled.