Class OjTabBar

The component WebElement for oj-tab-bar. Do not instantiate this class directly, instead, use ojTabBar.

Hierarchy

Constructors

constructor

Methods

changeCurrentItem changeSelection clear click doRemove doReorder findElement findElements getAs getAttribute getCssValue getCurrentItem getData getDisplay getEdge getItem getLayout getLocation getOverflow getProperty getRect getReorderable getSelection getSize getText getTranslations getTruncation 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 OjTabBar

Methods

changeCurrentItem

  • Sets the value of currentItem property. Specifies the key of the item that should have keyboard focus. See the Help documentation for more information.

    Parameters

    • currentItem: any

      The value to set for currentItem

    Returns Promise<void>

changeSelection

  • Sets the value of selection property. Specifies the key of the selected item. See the Help documentation for more information.

    Parameters

    • selection: any

      The value to set for selection

    Returns Promise<void>

clear

  • Returns Promise<void>

    Inherit Doc

click

  • Returns Promise<void>

    Inherit Doc

doRemove

  • Remove a tab specific by the key

    Type Parameters

    • K

    Parameters

    • key: K

      key of the tab to be removed If the key is not found, an error will be thrown

    Returns Promise<void>

    Typeparam

    K Type of keys

doReorder

  • Moves tab specified by key then put the tab to the specified place

    Type Parameters

    • K

    Parameters

    • key: K

      key of the tab to be reordered If the key is not found, an error will be thrown

    • position: {
          index: number;
      } | {
          key: null | K;
      }

      the index or the key of the tab that user want to move in front of, if the key is null, the tab will move to the end of the tab bar If the key or the index of the position is not found, an error will be thrown

    Returns Promise<void>

    Typeparam

    K Type of keys

    Typeparam

    number Type of index

findElement

  • Parameters

    • locator: Locator

    Returns WebElementPromise

    Inherit Doc

findElements

  • Parameters

    • locator: Locator

    Returns Promise<WebElement[]>

    Inherit Doc

getAs

  • Gets the value of as property. Specifies the alias for the current item when referenced inside the item template.

    Returns Promise<string>

    The value of as property.

    Deprecated

    Since 6.2.0. Set the alias directly on the template element using the data-oj-as attribute instead.

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. Specifies the key of the item that should have keyboard focus. See the Help documentation for more information.

    Returns Promise<any>

    The value of currentItem property.

getData

  • Gets the value of data property. Specifies the data provider for the Tab Bar. See the Help documentation for more information.

    Returns Promise<null | object>

    The value of data property.

    Deprecated

    Since 14.0.0. Data sets from a DataProvider cannot be sent to WebDriverJS; use ViewModels or page variables instead.

getDisplay

  • Gets the value of display property. Specifies what needs to be displayed. See the Help documentation for more information.

    Returns Promise<string>

    The value of display property.

getEdge

  • Gets the value of edge property. Specifies the edge position of the Tab Bar.

    Returns Promise<string>

    The value of edge property.

getItem

  • Gets the value of item property. Customize the functionality of each tab on Tab Bar.

    Returns Promise<Item>

    The value of item property.

getLayout

  • Gets the value of layout property. Specifies whether to stretch the tab bar items to occupy available space or to condense items.

    Returns Promise<string>

    The value of layout property.

getLocation

getOverflow

  • Gets the value of overflow property. Specifies overflow behaviour for the Tab Bar.

    Returns Promise<string>

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

    Inherit Doc

getReorderable

  • Gets the value of reorderable property. Specifies whether tabs can be reordered.

    Returns Promise<string>

    The value of reorderable property.

getSelection

  • Gets the value of selection property. Specifies the key of the selected item. See the Help documentation for more information.

    Returns Promise<any>

    The value of selection property.

getSize

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.

getTruncation

  • Gets the value of truncation property. Specifies whether truncation needs to be applied.

    Returns Promise<string>

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

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