Class DrawerPopupWebElement

The component WebElement for oj-c-drawer-popup. Do not instantiate this class directly, instead, use findDrawerPopup.

Hierarchy

  • DrawerPopupWebElementBase
    • DrawerPopupWebElement

Constructors

constructor

Methods

changeOpened clear click doClose findElement findElements getAttribute getAutoDismiss getBackgroundColor getCloseGesture getCssValue getDriver getEdge getId getLocation getModality getOpened getProperty getRect getShadowRoot getSize getTagName getText 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 DrawerPopupWebElement

Methods

changeOpened

  • Sets the value of opened property. Specifies whether the Drawer is open.

    Parameters

    • opened: boolean

      The value to set for opened

    Returns Promise<void>

    Deprecated

    Since 18.0.0. Use a launcher action to open the drawer and doClose to dismiss it.

clear

  • Returns Promise<void>

    Inherit Doc

click

  • Returns Promise<void>

    Inherit Doc

doClose

  • Dismisses the drawer.

    Returns Promise<void>

findElement

  • Parameters

    • locator: Locator

    Returns WebElementPromise

findElements

  • Parameters

    • locator: Locator

    Returns Promise<WebElement[]>

getAttribute

  • Parameters

    • attributeName: string

    Returns Promise<string>

    Inherit Doc

getAutoDismiss

  • Gets the value of autoDismiss property. Specifies the close auto-dismiss behaviour to close the drawer.

    Returns Promise<string>

    The value of autoDismiss property.

getBackgroundColor

  • Gets the value of backgroundColor property. Specifies background color of the Drawer.

    Returns Promise<string>

    The value of backgroundColor property.

getCloseGesture

  • Gets the value of closeGesture property. Specifies whether a gesture closes the drawer.

    Returns Promise<string>

    The value of closeGesture property.

getCssValue

  • Parameters

    • cssStyleProperty: string

    Returns Promise<string>

    Inherit Doc

getDriver

  • Returns WebDriver

    The parent driver for this instance.

getEdge

  • Gets the value of edge property. Specifies at what edge the drawer opens.

    Returns Promise<string>

    The value of edge property.

getId

  • Returns Promise<string>

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

getLocation

  • Returns Promise<ILocation>

    Inherit Doc

getModality

  • Gets the value of modality property. Controls the modality of the drawer.

    Returns Promise<string>

    The value of modality property.

getOpened

  • Gets the value of opened property. Specifies whether the Drawer is open.

    Returns Promise<boolean>

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

  • Returns Promise<IRectangle>

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>

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>

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>

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