Class RadiosetWebElement

The component WebElement for oj-c-radioset. Do not instantiate this class directly, instead, use findRadioset.

Hierarchy

  • RadiosetWebElementBase
    • RadiosetWebElement

Constructors

constructor

Methods

changeMessagesCustom changeValue clear click findElement findElements getAttribute getColumnSpan getContainerReadonly getCssValue getDirection getDisabled getDisplayOptions getDriver getHelp getHelpHints getId getLabelEdge getLabelHint getLabelStartWidth getLabelWrapping getLocation getMessagesCustom getOptions getProperty getReadonly getRect getRequired getRequiredMessageDetail getShadowRoot getSize getTagName getText getUserAssistanceDensity getValid getValue 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 RadiosetWebElement

Methods

changeMessagesCustom

  • Sets the value of messagesCustom property. List of custom component messages

    Parameters

    • messagesCustom: MessagesCustom[]

      The value to set for messagesCustom

    Returns Promise<void>

changeValue

  • Sets the value of "value" property for the Radioset component

    Parameters

    • value: any

      The value to set for "value"

    Returns Promise<void>

    Throws

    if the API is called when the control is readonly or disabled

    Throws

    if the value is non-existent

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

getColumnSpan

  • Gets the value of columnSpan property. Specifies how many columns this component should span.

    Returns Promise<number>

    The value of columnSpan property.

getContainerReadonly

  • Gets the value of containerReadonly property. Specifies whether an ancestor container, like oj-c-form-layout, is readonly.

    Returns Promise<boolean>

    The value of containerReadonly property.

getCssValue

  • Parameters

    • cssStyleProperty: string

    Returns Promise<string>

    Inherit Doc

getDirection

  • Gets the value of direction property. Layout direction of the radioset radio elements.

    Returns Promise<string>

    The value of direction property.

getDisabled

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

    Returns Promise<boolean>

    The value of disabled property.

getDisplayOptions

  • Gets the value of displayOptions property. Display options for auxiliary content that describes whether or not the auxiliary content should be displayed.

    Returns Promise<DisplayOptions>

    The value of displayOptions property.

getDriver

  • Returns WebDriver

    The parent driver for this instance.

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. The helpHints object contains a definition property, sourceText property, and a source property.

    Returns Promise<HelpHints>

    The value of helpHints property.

getId

  • Returns Promise<string>

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

getLabelEdge

  • Gets the value of labelEdge property. Specifies how the label is positioned for the component relative to the field.

    Returns Promise<string>

    The value of labelEdge property.

getLabelHint

  • Gets the value of labelHint property. Represents a hint for rendering a label on the component.

    Returns Promise<string>

    The value of labelHint property.

getLabelStartWidth

  • Gets the value of labelStartWidth property. The width of the label when labelEdge is 'start'.

    Returns Promise<string | number>

    The value of labelStartWidth property.

getLabelWrapping

  • Gets the value of labelWrapping property. Should the labels wrap or truncate when there is not enough available space.

    Returns Promise<string>

    The value of labelWrapping property.

    Deprecated

    Since 18.0.0. Label truncation for 'start' and 'top' aligned labels is no longer recommended by the Redwood Design System. The default for labelWrapping was 'wrap' and that is now the only suggested pattern by UX design for 'start' and 'top' aligned labels. 'inside' aligned labels are always truncated per UX design and are not affected by this property's value.

getLocation

  • Returns Promise<ILocation>

    Inherit Doc

getMessagesCustom

  • Gets the value of messagesCustom property. List of custom component messages

    Returns Promise<MessagesCustom[]>

    The value of messagesCustom property.

getOptions

  • Gets the value of options property. The data provided to the radioset that represents one or more radio items.

    Returns Promise<object[]>

    The value of options 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. Whether the component is readonly or not.

    Returns Promise<boolean>

    The value of readonly property.

getRect

  • Returns Promise<IRectangle>

    Inherit Doc

getRequired

  • Gets the value of required property. Specifies whether or not the component is required.

    Returns Promise<boolean>

    The value of required property.

getRequiredMessageDetail

  • Gets the value of requiredMessageDetail property. Overrides the default Required error message.

    Returns Promise<string>

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

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. Specifies how the valid state of the component

    Returns Promise<string>

    The value of valid property.

getValue

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

    Returns Promise<null | string | number>

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