Class OjSelectSingleBase

This is the base class for oj-select-single WebElement, and is generated from the component's metadata. Do not modify these contents since they'll be replaced during the next generation. Put overrides into the WebElements's subclass, OjSelectSingle.ts.

Hierarchy

Constructors

constructor

Methods

changeMessagesCustom changeValue changeValueItem clear click findElement findElements getAttribute getCssValue getData getDescribedBy getDisabled getDisplayOptions getHelp getHelpHints getItemText getLabelEdge getLabelHint getLabelledBy getLocation getMatchBy getMessagesCustom getPlaceholder getProperty getReadonly getReadonlyUserAssistanceShown getRect getRequired getSize getText getTranslations getUserAssistanceDensity getValid getValue getValueItem getVirtualKeyboard 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 OjSelectSingleBase

Methods

changeMessagesCustom

  • Sets the value of messagesCustom property. A list of messages added by an application to the component. See the Help documentation for more information.

    Parameters

    • messagesCustom: object[]

      The value to set for messagesCustom

    Returns Promise<void>

changeValue

  • Sets the value of value property. The value of the element.

    Parameters

    • value: any

      The value to set for value

    Returns Promise<void>

changeValueItem

  • Sets the value of valueItem property. The current value of the element and its associated data.

    Parameters

    • valueItem: null | object

      The value to set for valueItem

    Returns Promise<void>

clear

  • Returns Promise<void>

    Inherit Doc

click

  • Returns Promise<void>

    Inherit Doc

findElement

  • Parameters

    • locator: Locator

    Returns WebElementPromise

    Inherit Doc

findElements

  • Parameters

    • locator: Locator

    Returns Promise<WebElement[]>

    Inherit Doc

getAttribute

  • Parameters

    • attributeName: string

    Returns Promise<string>

    Inherit Doc

getCssValue

  • Parameters

    • cssStyleProperty: string

    Returns Promise<string>

    Inherit Doc

getData

  • Gets the value of data property. The data for the Select.

    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.

getDescribedBy

  • Gets the value of describedBy property. The form component's oj-label automatically sets described-by to make it accessible. It is not meant to be set by application developer.

    Returns Promise<string>

    The value of describedBy property.

getDisabled

  • Gets the value of disabled property. Specifies whether the component is disabled. The default is false.

    Returns Promise<boolean>

    The value of disabled property.

getDisplayOptions

  • Gets the value of displayOptions property. Display options for auxiliary content that determines whether it should be displayed.

    Returns Promise<DisplayOptions>

    The value of displayOptions property.

getHelp

  • Gets the value of help property. Form component help information.

    Returns Promise<Help>

    The value of help property.

getHelpHints

  • Gets the value of helpHints property. Represents hints for an oj-form-layout element to render help information on the label of the editable component.

    Returns Promise<HelpHints>

    The value of helpHints property.

getItemText

  • Gets the value of itemText property. Specifies the text string to render for a data item.

    Returns Promise<null | string>

    The value of itemText property.

getLabelEdge

  • Gets the value of labelEdge property. Defines how the label of a component is created. See the Help documentation for more information.

    Returns Promise<string>

    The value of labelEdge property.

getLabelHint

  • Gets the value of labelHint property. Represents a hint for oj-form-layout element to render a label on the editable component.

    Returns Promise<string>

    The value of labelHint property.

getLabelledBy

  • Gets the value of labelledBy property. The oj-label sets the labelledBy property programmatically on the form component.

    Returns Promise<null | string>

    The value of labelledBy property.

    Deprecated

    Since 20.0.0. This is an internal API and is not supported in the Redwood UX specification.

getLocation

getMatchBy

  • Gets the value of matchBy property. The ordered list of text filter matching behaviors to use when filtering data.

    Returns Promise<null | string[]>

    The value of matchBy property.

getMessagesCustom

  • Gets the value of messagesCustom property. A list of messages added by an application to the component. See the Help documentation for more information.

    Returns Promise<object[]>

    The value of messagesCustom property.

getPlaceholder

  • Gets the value of placeholder property. A short hint that can be displayed before user selects or enters a value.

    Returns Promise<string>

    The value of placeholder 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.

getReadonly

  • Gets the value of readonly property. Specifies whether a value is readonly

    Returns Promise<boolean>

    The value of readonly property.

getReadonlyUserAssistanceShown

  • Gets the value of readonlyUserAssistanceShown property. Specifies which user assistance types should be shown when the component is readonly.

    Returns Promise<string>

    The value of readonlyUserAssistanceShown property.

getRect

  • Returns Promise<IRectangle>

    Inherit Doc

getRequired

  • Gets the value of required property. Specifies whether the component is required or optional. See the Help documentation for more information.

    Returns Promise<boolean>

    The value of required 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.

getUserAssistanceDensity

  • Gets the value of userAssistanceDensity property. Specifies the density of the form component's user assistance presentation.

    Returns Promise<string>

    The value of userAssistanceDensity property.

getValid

  • Gets the value of valid property. The validity state of the component

    Returns Promise<string>

    The value of valid property.

getValue

  • Gets the value of value property. The value of the element.

    Returns Promise<any>

    The value of value property.

getValueItem

  • Gets the value of valueItem property. The current value of the element and its associated data.

    Returns Promise<null | object>

    The value of valueItem property.

getVirtualKeyboard

  • Gets the value of virtualKeyboard property. The type of virtual keyboard to display for entering a value on mobile browsers. See the Help documentation for more information.

    Returns Promise<string>

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