Class OjConveyorBelt

The component WebElement for oj-conveyor-belt. Do not instantiate this class directly, instead, use ojConveyorBelt.

Migration

When you migrate a page from using oj-conveyor-belt to oj-c-conveyor-belt you will also need to migrate your WebDriver tests from OjConveyorBelt to ConveyorBeltWebElement. To do that you will need to revise type and locator instances as follows
Type: from OjConveyorBelt to ConveyorBeltWebElement
Locator: from ojConveyorBelt to findConveyorBelt
For more details on migrating from legacy to core pack please see component's migration section

Hierarchy

Constructors

constructor

Methods

changeArrowVisibility changeContentParent changeOrientation changeScrollPosition clear click findElement findElements getArrowVisibility getAttribute getContentParent getCssValue getLocation getOrientation getProperty getRect getScrollPosition getSize getText getTranslations hasSize hasVisibility isDisplayed isEnabled isSelected scrollElementIntoView 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 OjConveyorBelt

Methods

changeArrowVisibility

  • Sets the value of arrowVisibility property. Specifies visibility of overflow arrow buttons.

    Parameters

    • arrowVisibility: string

      The value to set for arrowVisibility

    Returns Promise<void>

changeContentParent

  • Sets the value of contentParent property. Specify the selector of the descendant DOM element in the conveyorBelt that directly contains the items to scroll among.

    Parameters

    • contentParent: string

      The value to set for contentParent

    Returns Promise<void>

changeOrientation

  • Sets the value of orientation property. Specifies the orientation of the conveyorBelt.

    Parameters

    • orientation: string

      The value to set for orientation

    Returns Promise<void>

changeScrollPosition

  • Sets the value of scrollPosition property. Gets or sets the number of pixels that an element's content is scrolled from its initial position.

    Parameters

    • scrollPosition: number

      The value to set for scrollPosition

    Returns Promise<void>

clear

click

findElement

  • Parameters

    • locator: Locator

    Returns WebElementPromise

    Inherit Doc

findElements

  • Parameters

    • locator: Locator

    Returns Promise<WebElement[]>

    Inherit Doc

getArrowVisibility

  • Gets the value of arrowVisibility property. Specifies visibility of overflow arrow buttons.

    Returns Promise<string>

    The value of arrowVisibility property.

getAttribute

  • Parameters

    • attributeName: string

    Returns Promise<string>

    Inherit Doc

getContentParent

  • Gets the value of contentParent property. Specify the selector of the descendant DOM element in the conveyorBelt that directly contains the items to scroll among.

    Returns Promise<string>

    The value of contentParent property.

getCssValue

  • Parameters

    • cssStyleProperty: string

    Returns Promise<string>

    Inherit Doc

getLocation

getOrientation

  • Gets the value of orientation property. Specifies the orientation of the conveyorBelt.

    Returns Promise<string>

    The value of orientation property.

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

getScrollPosition

  • Gets the value of scrollPosition property. Gets or sets the number of pixels that an element's content is scrolled from its initial position.

    Returns Promise<number>

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

scrollElementIntoView

  • Scroll the conveyor belt, so that the conveyor belt's element (button, tab bar) of interest is in the view

    Parameters

    • locator: Locator

      The lookup to pass into findElement

    Returns Promise<void>

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