Class OjTable

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

Hierarchy

  • OjTableBase
    • OjTable

Constructors

constructor

Methods

changeColumns changeCurrentRow changeEditRow changeScrollPosition changeSelected changeSelectedKeys changeSelection clear click doRowAction doSort findCell findElement findElements findFooter findHeader findRow getAccessibility getAddRowDisplay getAs getAttribute getColumnResizeBehavior getColumns getColumnsDefault getCssValue getCurrentRow getDisplay getDnd getDriver getEditMode getEditRow getFirstSelectedRow getHorizontalGridVisible getId getLayout getLocation getProperty getRect getRow getRowRenderer getScrollPolicy getScrollPolicyOptions getScrollPosition getScrollToKey getSelectAllControl getSelected getSelectedKeys getSelection getSelectionMode getSelectionRequired getShadowRoot getSize getTagName getText getTranslations getVerticalGridVisible 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 OjTable

Methods

changeColumns

  • Sets the value of columns property. An array of column definitions. See the Help documentation for more information.

    Parameters

    • columns: null | Columns[]

      The value to set for columns

    Returns Promise<void>

changeCurrentRow

  • Sets the value of currentRow property. Specifies the row that currently has keyboard focus. See the Help documentation for more information.

    Parameters

    • currentRow: object

      The value to set for currentRow

    Returns Promise<void>

changeEditRow

  • Sets the value of editRow property. Specifies the row that is currently being edited. See the Help documentation for more information.

    Parameters

    • editRow: object

      The value to set for editRow

    Returns Promise<void>

changeScrollPosition

  • Sets the value of scrollPosition property. Specifies the scroll position of the table. See the Help documentation for more information.

    Parameters

    • scrollPosition: ScrollPosition

      The value to set for scrollPosition

    Returns Promise<void>

changeSelected

  • Sets the value of "selected" property. Specifies the current selected rows and/or columns in the table. See the Help documentation for more information.

    Type Parameters

    • K

    Parameters

    • selected: {
          column: K[];
          row: K[];
      }

      The value to set for "selected"

      • column: K[]
      • row: K[]

    Returns Promise<void>

    Typeparam

    K Type of keys

    Deprecated

    Since 17.0.0 use changeSelectedKeys as the replacement.

changeSelectedKeys

  • Sets the value of "selected" property. If row/column are both unspecified selected for both will be empty. If no object is set on row/column, selected for that axis will be empty. If 'all' is unset for row/column object only 'keys' will be considered, if no 'keys' are specified selected for that axis will be empty. See the Help documentation for more information.

    Type Parameters

    • K

    Parameters

    • selected: {
          column?: {
              all: true;
              deletedKeys: K[];
              keys?: undefined;
          } | {
              all: false;
              deletedKeys?: undefined;
              keys: K[];
          };
          row?: {
              all: true;
              deletedKeys: K[];
              keys?: undefined;
          } | {
              all: false;
              deletedKeys?: undefined;
              keys: K[];
          };
      }

      The value to set for "selected"

      • Optional column?: {
            all: true;
            deletedKeys: K[];
            keys?: undefined;
        } | {
            all: false;
            deletedKeys?: undefined;
            keys: K[];
        }
      • Optional row?: {
            all: true;
            deletedKeys: K[];
            keys?: undefined;
        } | {
            all: false;
            deletedKeys?: undefined;
            keys: K[];
        }

    Returns Promise<void>

    Typeparam

    K Type of keys

changeSelection

  • Sets the value of selection property. Specifies the current selections in the table. See the Help documentation for more information.

    Parameters

    • selection: object[]

      The value to set for selection

    Returns Promise<void>

    Deprecated

    Since 7.0.0. Use selected attribute instead.

clear

  • Returns Promise<void>

    Inherit Doc

click

  • Returns Promise<void>

    Inherit Doc

doRowAction

  • Set a given row active. Triggers a ojRowAction Event.

    Type Parameters

    • K

    Parameters

    • itemLocator: {
          rowIndex: number;
          rowKey?: undefined;
      } | {
          rowIndex?: undefined;
          rowKey: K;
      }

    Returns Promise<void>

doSort

  • Sort the given column.

    Parameters

    • header: string

      The key of the header which need to be sorted.

    • direction: "ascending" | "descending"

      The direction of the sort.

    Returns Promise<void>

findCell

  • Retrieve a SlotProxy which represents a single cell. Should be used only if cell contents are rendered using cell template/renderer/slot. Otherwise method will throw an exception.

    Type Parameters

    • K

    Parameters

    • itemLocator: {
          columnIndex?: number;
          columnKey?: string;
          rowIndex?: number;
          rowKey?: K;
      }

      Either column index or key and row index or key of the cell.

      • Optional columnIndex?: number
      • Optional columnKey?: string
      • Optional rowIndex?: number
      • Optional rowKey?: K

    Returns Promise<SlotProxy>

findElement

  • Parameters

    • locator: Locator

    Returns WebElementPromise

    Inherit Doc

findElements

  • Parameters

    • locator: Locator

    Returns Promise<WebElement[]>

    Inherit Doc

findFooter

  • Retrieve a SlotProxy which represents the given footer cell. Should be used only if footer is rendered using template/renderer/slot. Otherwise method will throw an exception.

    Parameters

    • itemLocator: {
          columnIndex: number;
          columnKey?: undefined;
      } | {
          columnIndex?: undefined;
          columnKey: string;
      }

      Either index or key of the footer cell.

    Returns Promise<SlotProxy>

findHeader

  • Retrieve a SlotProxy which represents the given header cell. Should be used only if header is rendered using template/renderer/slot. Otherwise method will throw an exception.

    Parameters

    • itemLocator: {
          columnIndex: number;
          columnKey?: undefined;
      } | {
          columnIndex?: undefined;
          columnKey: string;
      }

      Either index or key of the header cell.

    Returns Promise<SlotProxy>

findRow

  • Retrieve a SlotProxy which represents a single row. Should be used only if row is rendered using rowTemplate slot or renderer. Otherwise method will throw an exception.

    Type Parameters

    • K

    Parameters

    • itemLocator: {
          rowIndex: number;
          rowKey?: undefined;
      } | {
          rowIndex?: undefined;
          rowKey: K;
      }

      Either index or key of the row.

    Returns Promise<SlotProxy>

getAccessibility

  • Gets the value of accessibility property. Accessibility attributes.

    Returns Promise<null | Accessibility>

    The value of accessibility property.

getAddRowDisplay

  • Gets the value of addRowDisplay property. Specifies whether to show or hide add new row when addRowTemplate or addRowCellTemplate is present.

    Returns Promise<string>

    The value of addRowDisplay property.

getAs

  • Gets the value of as property. An alias for the '$current' context variable passed to the content of the cell 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

getColumnResizeBehavior

  • Gets the value of columnResizeBehavior property. Specifies the column resize behavior for this Table. See the Help documentation for more information.

    Returns Promise<string>

    The value of columnResizeBehavior property.

getColumns

  • Gets the value of columns property. An array of column definitions. See the Help documentation for more information.

    Returns Promise<null | Columns[]>

    The value of columns property.

getColumnsDefault

  • Gets the value of columnsDefault property. Default values to apply to all column objects.

    Returns Promise<null | ColumnsDefault>

    The value of columnsDefault property.

getCssValue

  • Parameters

    • cssStyleProperty: string

    Returns Promise<string>

    Inherit Doc

getCurrentRow

  • Gets the value of currentRow property. Specifies the row that currently has keyboard focus. See the Help documentation for more information.

    Returns Promise<object>

    The value of currentRow property.

getDisplay

  • Gets the value of display property. Specifies whether to display this table in list or grid mode. See the Help documentation for more information.

    Returns Promise<string>

    The value of display property.

getDnd

  • Gets the value of dnd property. Specifies drag and drop features. See the Help documentation for more information.

    Returns Promise<Dnd>

    The value of dnd property.

getDriver

  • Returns WebDriver

    The parent driver for this instance.

getEditMode

  • Gets the value of editMode property. Specifies if the table is read-only or editable. See the Help documentation for more information.

    Returns Promise<string>

    The value of editMode property.

getEditRow

  • Gets the value of editRow property. Specifies the row that is currently being edited. See the Help documentation for more information.

    Returns Promise<object>

    The value of editRow property.

getFirstSelectedRow

  • Gets the value of firstSelectedRow property. Read-only property used for retrieving the key and data of the first selected row. See the Help documentation for more information.

    Returns Promise<FirstSelectedRow>

    The value of firstSelectedRow property.

getHorizontalGridVisible

  • Gets the value of horizontalGridVisible property. Specifies the visibility of the horizontal gridlines. See the Help documentation for more information.

    Returns Promise<string>

    The value of horizontalGridVisible property.

getId

  • Returns Promise<string>

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

getLayout

  • Gets the value of layout property. The column sizing method used for the Table and its columns.

    Returns Promise<string>

    The value of layout property.

getLocation

  • Returns Promise<ILocation>

    Inherit Doc

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

getRow

  • Gets the value of row property. Customizes the functionality of each row in the table.

    Returns Promise<Row>

    The value of row property.

getRowRenderer

  • Gets the value of rowRenderer property. A function that returns row content. The function takes a context argument, provided by the table. See the Help documentation for more information.

    Returns Promise<null>

    The value of rowRenderer property.

getScrollPolicy

  • Gets the value of scrollPolicy property. Specifies how data are fetched as user scrolls down the table.

    Returns Promise<string>

    The value of scrollPolicy property.

getScrollPolicyOptions

  • Gets the value of scrollPolicyOptions property. Specifies fetch options for scrolling behaviors that trigger data fetches.

    Returns Promise<null | ScrollPolicyOptions>

    The value of scrollPolicyOptions property.

getScrollPosition

  • Gets the value of scrollPosition property. Specifies the scroll position of the table. See the Help documentation for more information.

    Returns Promise<ScrollPosition>

    The value of scrollPosition property.

getScrollToKey

  • Gets the value of scrollToKey property. Specifies the behavior when Table needs to scroll to a position based on an item key.

    Returns Promise<null | string>

    The value of scrollToKey property.

getSelectAllControl

  • Gets the value of selectAllControl property. Specifies the visibility of the select all control. See the Help documentation for more information.

    Returns Promise<string>

    The value of selectAllControl property.

getSelected

  • Gets the value of "selected" property. Specifies the current selected rows and/or columns in the table. See the Help documentation for more information.

    Type Parameters

    • K

    Returns Promise<{
        column: K[];
        row: K[];
    }>

    The value of "selected" property.

    Typeparam

    K Type of keys

    Deprecated

    Since 17.0.0 use getSelectedKeys as the replacement.

getSelectedKeys

  • Gets the value of "selected" property.

    Type Parameters

    • K

    Returns Promise<{
        column: {
            all: true;
            deletedKeys: K[];
            keys?: undefined;
        } | {
            all: false;
            deletedKeys?: undefined;
            keys: K[];
        };
        row: {
            all: true;
            deletedKeys: K[];
            keys?: undefined;
        } | {
            all: false;
            deletedKeys?: undefined;
            keys: K[];
        };
    }>

    The value of "selected" property.

    Typeparam

    K Type of keys

getSelection

  • Gets the value of selection property. Specifies the current selections in the table. See the Help documentation for more information.

    Returns Promise<object[]>

    The value of selection property.

    Deprecated

    Since 7.0.0. Use selected attribute instead.

getSelectionMode

  • Gets the value of selectionMode property. Specifies the row and column selection modes.

    Returns Promise<null | SelectionMode>

    The value of selectionMode property.

getSelectionRequired

  • Gets the value of selectionRequired property. Specifies whether selection is required on the Table.

    Returns Promise<boolean>

    The value of selectionRequired property.

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>

    Inherit Doc

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>

    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.

getVerticalGridVisible

  • Gets the value of verticalGridVisible property. Specifies the visibility of the vertical gridlines. See the Help documentation for more information.

    Returns Promise<string>

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

  • Returns Promise<boolean>

    Inherit Doc

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