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

Migration

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

Hierarchy

Constructors

  • 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 OjCollapsible

Methods

  • Sets the value of expanded property. Specifies if the content is expanded.

    Parameters

    • expanded: boolean

      The value to set for expanded

    Returns Promise<void>

    Deprecated

    Since 13.0.0. Use doCollapse/doExpand instead

  • Collapse the oj-collapsible. If the component is expanded, this method will collapse it. If it's already collapsed, this method will do nothing.

    Returns Promise<void>

  • Expand the oj-collapsible. If the component is collapsed, this method will expand it. If it's already expanded, this method will do nothing.

    Returns Promise<void>

  • Parameters

    • locator: Locator

    Returns WebElementPromise

    Inherit Doc

  • Parameters

    • locator: Locator

    Returns Promise<WebElement[]>

    Inherit Doc

  • Parameters

    • attributeName: string

    Returns Promise<string>

    Inherit Doc

  • Parameters

    • cssStyleProperty: string

    Returns Promise<string>

    Inherit Doc

  • Gets the value of disabled property. Disables the collapsible if set to true.

    Returns Promise<boolean>

    The value of disabled property.

  • Gets the value of expandArea property. Where in the header to click to toggle disclosure.

    Returns Promise<string>

    The value of expandArea property.

    Deprecated

    Since 14.0.0. The expand-area attribute should no longer be used and will be removed in the future. A click anywhere in the header area will toggle the disclosure (current default setting).

  • Gets the value of expanded property. Specifies if the content is expanded.

    Returns Promise<boolean>

    The value of expanded property.

  • 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.

  • 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 | object>

    The value of translations property.

  • 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.

  • 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

  • Parameters

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

    Returns Promise<void>

    Inherit Doc

  • 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.

  • Parameters

    • Optional optScroll: boolean

    Returns Promise<string>

    Inherit Doc

  • 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.

  • 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.

Generated using TypeDoc