Class OjListView

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

Hierarchy

Constructors

constructor

Methods

changeCurrentItem changeScrollPosition changeSelected changeSelection clear click doReorder findElement findElements findItem getAs getAttribute getCssValue getCurrentItem getDisplay getDnd getDrillMode getFirstSelectedItem getGridlines getGroupHeaderPosition getItem getLocation getProperty getRect getScrollPolicy getScrollPolicyOptions getScrollPosition getScrollToKey getSelected getSelection getSelectionMode getSelectionRequired 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 OjListView

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>

changeScrollPosition

  • Sets the value of scrollPosition property. Specifies the current scroll position of the list. See the Help documentation for more information.

    Parameters

    Returns Promise<void>

changeSelected

  • Sets the value of "selected" property. Specifies the current selected items in the listview. See the Help documentation for more information.

    Type Parameters

    • K

    Parameters

    • selected: K[]

      The value to set for "selected"

    Returns Promise<void>

    Typeparam

    K Type of keys

changeSelection

  • Sets the value of selection property. Specifies the current selections in the list. See the Help documentation for more information.

    Parameters

    • selection: any[]

      The value to set for selection

    Returns Promise<void>

    Deprecated

    Since 7.0.0. Use selected attribute instead.

clear

click

doReorder

  • Move an item specified by key to the specified position.

    Type Parameters

    • K

    Parameters

    • key: K

      key of the item to be reordered

    • position: {
          index: number;
      } | {
          groupIndex: number[];
          itemIndex?: number;
      } | {
          key: null | K;
      } | {
          groupKey: K;
          itemIndex?: number;
      }

      the position where the item should be move to, the value can be one of:

      • key - the key of the item to move in front of. If the key is null, the item will be move to the end of the list
      • index - the index of the item relative to the root node to move in front of
      • groupKey with itemIndex - the key of the group to move the item inside. The itemIndex indicates the index of the item relative to the group in which to move in front of. If not specified, then it will be moved to the end of the group
      • groupIndex with itemIndex - an array of indexes to locate the group to move the item inside. The itemIndex indicates the index of the item relative to the group in which to move in front of. If not specified, then it will be moved to the end of the group

    Returns Promise<void>

    Typeparam

    K Type of keys

    Typeparam

    number Type of index

findElement

  • Parameters

    • locator: Locator

    Returns WebElementPromise

    Inherit Doc

findElements

  • Parameters

    • locator: Locator

    Returns Promise<WebElement[]>

    Inherit Doc

findItem

  • Retrieve a SlotProxy which represents a single listview 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

  • Parameters

    • attributeName: string

    Returns Promise<string>

    Inherit Doc

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 how the items should be displayed.

    Returns Promise<string>

    The value of display property.

getDnd

  • Gets the value of dnd property. Customizes the drag and drop functionality. See the Help documentation for more information.

    Returns Promise<Dnd>

    The value of dnd property.

getDrillMode

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

    Returns Promise<string>

    The value of drillMode property.

getFirstSelectedItem

  • Gets the value of firstSelectedItem property. Specifies the key and data of the first selected item. See the Help documentation for more information.

    Returns Promise<object>

    The value of firstSelectedItem property.

getGridlines

  • Gets the value of gridlines property. Customizes the functionality of how gridlines are shown in various parts of the list.

    Returns Promise<Gridlines>

    The value of gridlines property.

getGroupHeaderPosition

  • Gets the value of groupHeaderPosition property. Specifies whether group header should stick to the top as user scrolls.

    Returns Promise<string>

    The value of groupHeaderPosition property.

getItem

  • Gets the value of item property. Customizes the functionality of each item on the list.

    Returns Promise<Item>

    The value of item property.

getLocation

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

  • Returns Promise<IRectangle>

    Inherit Doc

getScrollPolicy

  • Gets the value of scrollPolicy property. Specifies how data are fetched as user scrolls down the list.

    Returns Promise<null | string>

    The value of scrollPolicy property.

getScrollPolicyOptions

  • Gets the value of scrollPolicyOptions property. Specifies fetch options for scrolling behaviors that trigger data fetches. See the Help documentation for more information.

    Returns Promise<null | ScrollPolicyOptions>

    The value of scrollPolicyOptions property.

getScrollPosition

  • Gets the value of scrollPosition property. Specifies the current scroll position of the list. See the Help documentation for more information.

    Returns Promise<ScrollPosition>

    The value of scrollPosition property.

getScrollToKey

  • Gets the value of scrollToKey property. Specifies the behavior when ListView needs to scroll to a position based on an item key.

    Returns Promise<null | string>

    The value of scrollToKey property.

getSelected

  • Gets the value of "selected" property. Retrieves the current selected items in the listview. See the Help documentation for more information.

    Type Parameters

    • K

    Returns Promise<K[]>

    The value of "selected" property.

    Typeparam

    K Type of keys

getSelection

  • Gets the value of selection property. Specifies the current selections in the list. See the Help documentation for more information.

    Returns Promise<any[]>

    The value of selection property.

    Deprecated

    Since 7.0.0. Use selected attribute instead.

getSelectionMode

  • Gets the value of selectionMode property. Specifies the selection mode.

    Returns Promise<string>

    The value of selectionMode property.

getSelectionRequired

  • Gets the value of selectionRequired property. Specifies whether selection is required on the ListView.

    Returns Promise<boolean>

    The value of selectionRequired 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

  • Parameters

    • Optional optScroll: boolean

    Returns Promise<string>

    Inherit Doc

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