Class OjTreeView

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

Hierarchy

  • OjTreeViewBase
    • OjTreeView

Constructors

constructor

Methods

changeExpanded changeSelected changeSelection clear click doCollapse doExpand findElement findElements findItem getAttribute getCssValue getCurrentItem getDnd getDriver getId getItem getLocation getProperty getRect getScrollPolicyOptions getSelected getSelection getSelectionMode getShadowRoot getSize getTagName getText getTranslations hasSize hasVisibility isDisplayed isEnabled isSelected sendKeys serialize setProperty submit takeScreenshot whenBusyContextReady whenReady buildId equals extractId isId

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 OjTreeView

Methods

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>

changeSelected

  • Sets the value of "selected" property. Specifies the current selected items in the treeview. 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 tree. An empty array indicates nothing is selected.

    Parameters

    • selection: any[]

      The value to set for selection

    Returns Promise<void>

    Deprecated

    Since 8.0.0. Use selected attribute instead.

clear

  • Returns Promise<void>

    Inherit Doc

click

  • Returns Promise<void>

    Inherit Doc

doCollapse

  • Collapses an expanded treeview item. If already collapsed it will remain collapsed.

    Type Parameters

    • T

    Parameters

    • itemLocator: {
          id?: string;
          key?: T;
      }
      • Optional id?: string
      • Optional key?: T

    Returns Promise<void>

doExpand

  • Expands a collapsed treeview item. If already expanded it will remain expanded.

    Type Parameters

    • T

    Parameters

    • itemLocator: {
          id?: string;
          key?: T;
      }
      • Optional id?: string
      • Optional key?: T

    Returns Promise<void>

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 treeview item.

    Type Parameters

    • T

    Parameters

    • itemLocator: {
          id?: string;
          key?: T;
      }
      • Optional id?: string
      • Optional key?: T

    Returns Promise<SlotProxy>

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. Read-only property used for retrieving the key of the item that currently has focus.

    Returns Promise<any>

    The value of currentItem 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.

getDriver

  • Returns WebDriver

    The parent driver for this instance.

getId

  • Returns Promise<string>

    A promise that resolves to the server-assigned opaque ID assigned to this element.

getItem

  • Gets the value of item property. Customizes the functionality of each item in the tree.

    Returns Promise<Item>

    The value of item property.

getLocation

  • Returns Promise<ILocation>

    Inherit Doc

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

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.

getSelected

  • Gets the value of "selected" property. Retrieves the current selected items in the treeview. 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 tree. An empty array indicates nothing is selected.

    Returns Promise<any[]>

    The value of selection property.

    Deprecated

    Since 8.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.

getShadowRoot

  • Get the shadow root of the current web element.

    Returns ShadowRootPromise

    A promise that will be resolved with the elements shadow root or rejected with NoSuchShadowRootError

getSize

  • Returns Promise<ISize>

    Inherit Doc

getTagName

  • Schedules a command to query for the tag/node name of this element.

    Returns Promise<string>

    A promise that will be resolved with the element's tag name.

getText

  • Returns Promise<string>

    Inherit Doc

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

  • Returns Promise<boolean>

    Inherit Doc

isEnabled

  • Returns Promise<boolean>

    Inherit Doc

isSelected

  • Returns Promise<boolean>

    Inherit Doc

sendKeys

  • Parameters

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

    Returns Promise<void>

    Inherit Doc

serialize

  • Returns Promise<IWebElementId>

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

  • Returns Promise<void>

    Inherit Doc

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.

Static buildId

  • Parameters

    • id: string

      The raw ID.

    • Optional opt_noLegacy: boolean

      Whether to exclude the legacy element key.

    Returns IWebElementId

    The element ID for use with WebDriver's wire protocol.

Static equals

  • Compares two WebElements for equality.

    Parameters

    • a: WebElement

      A WebElement.

    • b: WebElement

      A WebElement.

    Returns Promise<boolean>

    A promise that will be resolved to whether the two WebElements are equal.

Static extractId

  • Extracts the encoded WebElement ID from the object.

    Parameters

    • obj: IWebElementId

      The object to extract the ID from.

    Returns string

    the extracted ID.

    Throws

    if the object is not a valid encoded ID.

Static isId

  • Parameters

    • obj: IWebElementId

      the object to test.

    Returns boolean

    whether the object is a valid encoded WebElement ID.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc