Class OjNavigationList

The component WebElement for oj-navigation-list. Do not instantiate this class directly, instead, use ojNavigationList.

Hierarchy

Constructors

constructor

Methods

changeCurrentItem changeExpanded changeExpandedByIndex changeSelection changeSelectionByIndex clear click doSelection findElement findElements findItem getAs getAttribute getCssValue getCurrentItem getDisplay getDrillMode getEdge getExpanded getHierarchyMenuThreshold getItem getItemByIndex getLocation getOverflow getProperty getRect getRootLabel getSelection getSize getText getTranslations hasSize hasVisibility isDisplayed isEnabled isSelected sendKeys setProperty submit takeScreenshot whenBusyContextReady whenReady

Constructors

constructor

  • Constructor. Pass an instance of WebDriver's WebElement that represents the DOM node on which we"ll perform operations.

    Parameters

    • el: WebElement

      The basic WebElement with which this WebElement will work.

    • locators: ElementLocators

    Returns OjNavigationList

Methods

changeCurrentItem

  • Sets the value of currentItem property. Specifies the key of the item that should have keyboard focus. See the Help documentation for more information.

    Parameters

    • currentItem: any

      The value to set for currentItem

    Returns Promise<void>

changeExpanded

  • Sets the value of "expanded" property. Specifies the key set containing the keys of the items that should be expanded. Use the ExpandedKeySet class to specify items to expand. Use the ExpandAllKeySet class to expand all items.

    Parameters

    • expanded: any[]

      The value to set for "expanded"

    Returns Promise<void>

changeExpandedByIndex

  • Parameters

    • indexes: number[][]

    Returns Promise<void>

changeSelection

  • Sets the value of selection property. Specifies the key of the selected item. See the Help documentation for more information.

    Parameters

    • selection: any

      The value to set for selection

    Returns Promise<void>

    Deprecated

    Since 16.1.0. Instead use doSelection to change selection.

changeSelectionByIndex

  • Selets item specified by index path. Note: This expands all intermediate items too.

    Parameters

    • index: number | number[]

      array of index path to the element to be selected

    Returns Promise<void>

clear

click

doSelection

  • Selects item specified by key. Triggers ojSelectionAction if the key passed is same as the current selection value.

    Type Parameters

    • K

    Parameters

    • key: K

      key of the item to be selected

    Returns Promise<void>

findElement

findElements

findItem

  • Retrieve a SlotProxy which represents a single navlist item.

    Type Parameters

    • T

    Parameters

    • itemLocator: {
          key: T;
      }
      • key: T

    Returns Promise<SlotProxy>

getAs

  • Gets the value of as property. Specifies the alias for the current item when referenced inside the item template.

    Returns Promise<string>

    The value of as property.

    Deprecated

    Since 6.2.0. Set the alias directly on the template element using the data-oj-as attribute instead.

getAttribute

getCssValue

  • Parameters

    • cssStyleProperty: string

    Returns Promise<string>

    Inherit Doc

getCurrentItem

  • Gets the value of currentItem property. Specifies the key of the item that should have keyboard focus. See the Help documentation for more information.

    Returns Promise<any>

    The value of currentItem property.

getDisplay

  • Gets the value of display property. Specifies what needs to be displayed. See the Help documentation for more information.

    Returns Promise<string>

    The value of display property.

getDrillMode

  • Gets the value of drillMode property. Specifies whether expand/collapse or sliding operations are allowed.

    Returns Promise<string>

    The value of drillMode property.

getEdge

  • Gets the value of edge property. Specifies the edge position of the Navigation List.

    Returns Promise<string>

    The value of edge property.

    Deprecated

    Since 17.0.0. Support for horizontal layout in oj-navigation-list is deprecated - use oj-tab-bar instead.

getExpanded

  • Gets the value of "expanded" property. Specifies the key set containing the keys of the items that should be expanded.

    Use the ExpandedKeySet class to specify items to expand. Use the ExpandAllKeySet class to expand all items.

    Returns Promise<any[]>

    The value of "expanded" property.

getHierarchyMenuThreshold

  • Gets the value of hierarchyMenuThreshold property. Specifies the level at which the user can see hierarchical menu button. See the Help documentation for more information.

    Returns Promise<number>

    The value of hierarchyMenuThreshold property.

    Deprecated

    Since 13.0.0. This is not supported in the Redwood theme.

getItem

  • Gets the value of item property. Customize the functionality of each item in Navigation List.

    Returns Promise<Item>

    The value of item property.

getItemByIndex

  • Returns item node specified by index path.

    Parameters

    • indexPath: number[]

    Returns Promise<undefined | WebElement>

getLocation

getOverflow

  • Gets the value of overflow property. Specifies overflow behaviour for the Navigation List.

    Returns Promise<string>

    The value of overflow property.

    Deprecated

    Since 17.0.0. Support for horizontal layout in oj-navigation-list is deprecated - use oj-tab-bar instead.

getProperty

  • Get a named property value from this component. This function will wait for the application's busy context to complete before attempting to get the property value.

    Type Parameters

    • T = string

    Parameters

    • propertyName: string

      The name of the property

    Returns Promise<T>

    A Promise that yields a value for the named property.

getRect

getRootLabel

  • Gets the value of rootLabel property. Specifies the label for top level list items.

    Returns Promise<string>

    The value of rootLabel property.

getSelection

  • Gets the value of selection property. Specifies the key of the selected item. See the Help documentation for more information.

    Returns Promise<any>

    The value of selection property.

getSize

getText

getTranslations

  • Gets the value of translations property. A collection of translated resources from the translation bundle, or null if this component has no resources.

    Returns Promise<null | Translations>

    The value of translations property.

Protected hasSize

  • Create a wait condition that is satisfied when the element's DOM has a non-zero size.

    Returns Condition<Promise<boolean>>

    The Condition to be used with driver.wait() that's satisfied when the element's DOM has a non-zero size.

    Deprecated

    Since 11.0.0. Call the appropriate WebElement method to test the size of the element.

Protected hasVisibility

  • Create a wait condition that is satisfid when the element is visible. The condition is satisfied when the element is displayed, as reported by #isDisplayed, and is scrolled into view. This is method is deprecated. Use WebElement.isDisplayed instead to test the display of the element, and scroll it into view if necessary.

    Returns Condition<Promise<boolean>>

    Deprecated

isDisplayed

isEnabled

isSelected

sendKeys

  • Parameters

    • Rest ...varArgs: (string | number | Promise<string | number>)[]

    Returns Promise<void>

    Inherit Doc

Protected setProperty

  • Set a property value on the remote element. This function first waits for the BusyContext to clear before setting the property, then after setting, waits again to ensure that no additional busy states were created due to the property setting.

    Type Parameters

    • T = string

    Parameters

    • propertyName: string

      The property name to set

    • value: T

      The value to set for the property

    Returns Promise<void>

    A Promise which resolves when the remote property has been set to the value. Any value returned from the call to set the remote property is returned in the Promise.

submit

takeScreenshot

whenBusyContextReady

  • Returns a Promise that is resolved when the application's busy state reports ready. This method checks only that the application's busy context is ready, and not that the DOM element is actually displayed or has a physical size, such as is the case with #whenReady. Operations which are read-only in nature should call this method prior to execution.

    Returns Promise<void>

    A Promise which is resolved when the page's busy state is ready.

whenReady

  • Returns a Promise that is resolved when the element is ready for interaction--it is visible, has a size, and the app's busy context is ready. Operations on the DOM which rely on its physical location and size to be in a "ready" state should use this command, such as clicking, sending keys, locating child elements, and so on.

    Returns Promise<void>

    A Promise that's resolved when all conditions are met.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc