Class OjSelector

The component WebElement for oj-selector. Do not instantiate this class directly, instead, use ojSelector.

Hierarchy

Constructors

constructor

Methods

changeIndeterminate changeSelectedKeys clear click findElement findElements getAttribute getCssValue getIndeterminate getLocation getProperty getRect getRowKey getSelectedKeys getSelectionMode getSize getText 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 OjSelector

Methods

changeIndeterminate

  • Sets the value of indeterminate property. Visual only state to indicate partial selection

    Parameters

    • indeterminate: boolean

      The value to set for indeterminate

    Returns Promise<void>

changeSelectedKeys

  • Sets the value of selectedKeys property. Specifies the selectedKeys, should be hooked into the collection component.

    Parameters

    • selectedKeys: object

      The value to set for selectedKeys

    Returns Promise<void>

clear

click

findElement

  • Parameters

    • locator: Locator

    Returns WebElementPromise

    Inherit Doc

findElements

  • Parameters

    • locator: Locator

    Returns Promise<WebElement[]>

    Inherit Doc

getAttribute

  • Parameters

    • attributeName: string

    Returns Promise<string>

    Inherit Doc

getCssValue

  • Parameters

    • cssStyleProperty: string

    Returns Promise<string>

    Inherit Doc

getIndeterminate

  • Gets the value of indeterminate property. Visual only state to indicate partial selection

    Returns Promise<boolean>

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

getRowKey

  • Gets the value of rowKey property. Specifies the row key of each selector. If the selectionMode property is 'all', rowKey is ignored.

    Returns Promise<any>

    The value of rowKey property.

getSelectedKeys

  • Gets the value of selectedKeys property. Specifies the selectedKeys, should be hooked into the collection component.

    Returns Promise<object>

    The value of selectedKeys property.

getSelectionMode

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

    Returns Promise<string>

    The value of selectionMode property.

getSize

getText

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

  • Gets the selected value of the selector.

    Returns Promise<boolean>

    boolean selection checked state.

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