Open topic with navigation

com.hp.lft.sdk.sap.ui5

## Interface FacetFilter

- All Superinterfaces:
    Clickable, LocationInfoProvider, SupportDragAndDrop, SupportsNativeObject, TestObject, TestObjectDescriber, VisibleProvider, WaitUntilVisibleProvider, WebElement, WebTestObject, WebTestObjectDescriber, WaitUntilEnabledProvider, EnabledProvider

      public interface FacetFilter
      extends WebElement

  An SAPUI5 facet filter object.

- - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `ControlType` | `getControlType()` Returns the type of facet filter object.
    `DesktopFacetFilterBehavior` | `getDesktop()` Returns the functionality provided by `DesktopFacetFilterBehavior`.
    `java.util.List<java.lang.String>` | `getFilters()` Returns the collection of all filter lists.
    `MobileFacetFilterBehavior` | `getMobile()` Returns the functionality provided by `MobileFacetFilterBehavior`.
    `FacetFilterMode` | `getMode()` Returns the visual design of the facet filter.
    `int` | `getSelectedKeysCountFor(java.lang.String filterListTitle)` Returns the number of selected keys in the specified filter list.
    `java.util.List<java.lang.String>` | `getSelectedKeysFor(java.lang.String filterListTitle)` Returns the selected filter keys in the specified filter list.
    `boolean` | `isEnabled()` Returns whether the control is enabled.

    - ### Methods inherited from interface com.hp.lft.sdk.web.WebElement

      `doubleClick, doubleClick, fireEvent, getAccessibilityName, getCSSSelector, getRole, getXPath, hoverTap, hoverTap, longPress, longPress, pan, pan, pinch, pinch, swipe, swipe`

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

      `exists, exists, findChildren, getDescription, getDisplayName, getParent, getSnapshot, getTextLocations, getTextLocations, getVisibleText, getVisibleText, highlight, highlightMatches, setDescription, setDisplayName, verifyImageExists, verifyImageExists, verifyImageMatch, verifyImageMatch, verifyImageMatch, verifyImageMatch, verifyImageMatch, verifyImageMatch, waitUntilExists, waitUntilExists`

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

      `click, click, click`

    - ### Methods inherited from interface com.hp.lft.sdk.web.WebTestObject

      `getAttribute, getAttributes, getClassName, getComputedStyle, getComputedStyles, getId, getInnerHTML, getInnerText, getName, getOuterHTML, getOuterText, getTagName, getTitle, isVisible`

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

      `getAbsoluteLocation, getLocation, getSize`

    - ### Methods inherited from interface com.hp.lft.sdk.web.WebTestObjectDescriber

      `describe, describe`

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

      `describe`

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

      `getNativeObject`

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

      `dragAndDropOn, dragAndDropOn`

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

      `waitUntilEnabled, waitUntilEnabled`

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

      `isEnabled`

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

      `waitUntilVisible, waitUntilVisible`

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

      `isVisible`

- - ### Method Detail

    - #### getControlType

                                                      ControlType getControlType()

      Returns the type of facet filter object. Possible values: `ControlType`
      Returns:
        The type of facet filter object, or `Unknown` if the control type cannot be determined.

    - #### getMobile

                                                      MobileFacetFilterBehavior getMobile()

      Returns the functionality provided by `MobileFacetFilterBehavior`.
      Returns:
        The functionality provided by `MobileFacetFilterBehavior`.

    - #### getDesktop

                                                      DesktopFacetFilterBehavior getDesktop()

      Returns the functionality provided by `DesktopFacetFilterBehavior`.
      Returns:
        the functionality provided by `DesktopFacetFilterBehavior`.

    - #### getFilters

          java.util.List<java.lang.String> getFilters()
                                               throws GeneralLeanFtException

      Returns the collection of all filter lists.
      Returns:
        The collection of all filter lists.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### isEnabled

          boolean isEnabled()
                     throws GeneralLeanFtException

      Returns whether the control is enabled.
      Returns:
        True if enabled.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getMode

                                                      FacetFilterMode getMode()
                           throws GeneralLeanFtException

      Returns the visual design of the facet filter.
      Returns:
        The visual design of the facet filter. Possible values: `FacetFilterMode`
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getSelectedKeysFor

          java.util.List<java.lang.String> getSelectedKeysFor(java.lang.String filterListTitle)
                                                       throws GeneralLeanFtException

      Returns the selected filter keys in the specified filter list.
      Parameters:
        `filterListTitle` - the title of the filter list.
      Returns:
        The selected keys in the specified filter list.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getSelectedKeysCountFor

          int getSelectedKeysCountFor(java.lang.String filterListTitle)
                               throws GeneralLeanFtException

      Returns the number of selected keys in the specified filter list.
      Parameters:
        `filterListTitle` - the title of the filter list.
      Returns:
        The number of the selected keys in the specified filter list.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.