The component WebElement for oj-date-picker. Do not instantiate this class directly, instead, use ojDatePicker.

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 OjDatePicker

Methods

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

    Deprecated

    Since 17.0.0. The oj-date-picker is used internally by the input date component and is not meant to display messages, be labelled, or be in a form layout by itself. Per the Redwood UX specification, the oj-date-picker is not intended to be a form component.

  • Sets the value of value property. The value of the date picker element, which must be an ISOString. See the Help documentation for more information.

    Parameters

    • value: string

      The value to set for value

    Returns Promise<void>

  • Schedules a command to clear the value of this element. This command has no effect if the underlying DOM element is neither a text INPUT element nor a TEXTAREA element.

    Returns Promise<void>

    A promise that will be resolved when the element has been cleared.

  • Schedules a command to click on this element.

    Returns Promise<void>

    A promise that will be resolved when the click command has completed.

  • Schedule a command to find a descendant of this element. If the element cannot be found, a bot.ErrorCode.NO_SUCH_ELEMENT result will be returned by the driver. Unlike other commands, this error cannot be suppressed. In other words, scheduling a command to find an element doubles as an assert that the element is present on the page. To test whether an element is present on the page, use #findElements.

    The search criteria for an element may be defined using one of the factories in the By namespace, or as a short-hand By.Hash object. For example, the following two statements are equivalent:

    var e1 = element.findElement(By.id('foo'));
    var e2 = element.findElement({id:'foo'});

    You may also provide a custom locator function, which takes as input this WebDriver instance and returns a WebElement, or a promise that will resolve to a WebElement. For example, to find the first visible link on a page, you could write:

    var link = element.findElement(firstVisibleLink);

    function firstVisibleLink(element) {
    var links = element.findElements(By.tagName('a'));
    return promise.filter(links, function(link) {
    return links.isDisplayed();
    }).then(function(visibleLinks) {
    return visibleLinks[0];
    });
    }

    Parameters

    • locator: Locator

      The locator strategy to use when searching for the element.

    Returns WebElementPromise

    A WebElement that can be used to issue commands against the located element. If the element is not found, the element will be invalidated and all scheduled commands aborted.

  • Schedules a command to find all of the descendants of this element that match the given search criteria.

    Parameters

    • locator: Locator

      The locator strategy to use when searching for the element.

    Returns Promise<WebElement[]>

    A promise that will resolve to an array of WebElements.

  • Gets the value of asyncValidators property. Specifies a list of asynchronous validators used by the component when performing validation. Use async-validators when you need to perform some validation work on the server. See the Help documentation for more information.

    Returns Promise<object[]>

    The value of asyncValidators property.

    Deprecated

    Since 8.0.0. Use the validators property instead for either regular Validators or AsyncValidators.

  • Schedules a command to query for the value of the given attribute of the element. Will return the current value, even if it has been modified after the page has been loaded. More exactly, this method will return the value of the given attribute, unless that attribute is not present, in which case the value of the property with the same name is returned. If neither value is set, null is returned (for example, the 'value' property of a textarea element). The 'style' attribute is converted as best can be to a text representation with a trailing semi-colon. The following are deemed to be 'boolean' attributes and will return either 'true' or null:

    async, autofocus, autoplay, checked, compact, complete, controls, declare, defaultchecked, defaultselected, defer, disabled, draggable, ended, formnovalidate, hidden, indeterminate, iscontenteditable, ismap, itemscope, loop, multiple, muted, nohref, noresize, noshade, novalidate, nowrap, open, paused, pubdate, readonly, required, reversed, scoped, seamless, seeking, selected, spellcheck, truespeed, willvalidate

    Finally, the following commonly mis-capitalized attribute/property names are evaluated as expected:

    • 'class'
    • 'readonly'

    Parameters

    • attributeName: string

      The name of the attribute to query.

    Returns Promise<string>

    A promise that will be resolved with the attribute's value. The returned value will always be either a string or null.

  • Gets the value of autofocus property. Specifies whether the component will get input focus when the page is loaded. See the Help documentation for more information.

    Returns Promise<boolean>

    The value of autofocus property.

    Deprecated

    Since 17.0.0. This is not recommended for accessibility reasons.

  • Gets the value of converter property. An object that converts the value. See the Help documentation for more information.

    Returns Promise<object>

    The value of converter property.

  • Schedules a command to query for the computed style of the element represented by this instance. If the element inherits the named style from its parent, the parent will be queried for its value. Where possible, color values will be converted to their hex representation (e.g. #00ff00 instead of rgb(0, 255, 0)).

    Warning: the value returned will be as the browser interprets it, so it may be tricky to form a proper assertion.

    Parameters

    • cssStyleProperty: string

      The name of the CSS style property to look up.

    Returns Promise<string>

    A promise that will be resolved with the requested CSS value.

  • Gets the value of datePicker property. An object whose properties describe the appearance and behavior of the date picker. See the Help documentation for more information.

    Returns Promise<DatePicker>

    The value of datePicker property.

  • Gets the value of dayFormatter property. Specifies a callback function used when rendering the day. See the Help documentation for more information.

    Returns Promise<null>

    The value of dayFormatter property.

  • Gets the value of dayMetaData property. Specifies additional information to be used when rendering the day. See the Help documentation for more information.

    Returns Promise<object>

    The value of dayMetaData property.

    Deprecated

    Since 17.0.0. Use dayFormatter instead, as it is more flexible.

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

    Deprecated

    Since 17.0.0. The oj-date-picker is used internally by the input date component and is not meant to display messages, be labelled, or be in a form layout by itself. Per the Redwood UX specification, the oj-date-picker is not intended to be a form component.

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

    Returns Promise<boolean>

    The value of disabled property.

    Deprecated

    Since 17.0.0. Disabled is not supported by the Date Picker UX specification, use readonly property instead.

  • Gets the value of displayOptions property. Form component display options.

    Returns Promise<DisplayOptions>

    The value of displayOptions property.

    Deprecated

    Since 17.0.0. The oj-date-picker is used internally by the input date component and is not meant to display messages, be labelled, or be in a form layout by itself. Per the Redwood UX specification, the oj-date-picker is not intended to be a form component.

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

    Returns Promise<Help>

    The value of help property.

    Deprecated

    Since 17.0.0. The oj-date-picker is used internally by the input date component and is not meant to display messages, be labelled, or be in a form layout by itself. Per the Redwood UX specification, the oj-date-picker is not intended to be a form component.

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

    Deprecated

    Since 17.0.0. The oj-date-picker is used internally by the input date component and is not meant to display messages, be labelled, or be in a form layout by itself. Per the Redwood UX specification, the oj-date-picker is not intended to be a form component.

  • Returns Promise<string>

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

  • Gets the value of keyboardEdit property. Determines if keyboard entry of the text is allowed. When the datepicker is inline, the only supported value is "disabled".

    Returns Promise<string>

    The value of keyboardEdit property.

    Deprecated

    Since 17.0.0. This was never intended for oj-date-picker.

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

    Deprecated

    Since 17.0.0. The oj-date-picker is used internally by the input date component and is not meant to display messages, be labelled, or be in a form layout by itself. Per the Redwood UX specification, the oj-date-picker is not intended to be a form component.

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

    Deprecated

    Since 17.0.0. The oj-date-picker is used internally by the input date component and is not meant to display messages, be labelled, or be in a form layout by itself. Per the Redwood UX specification, the oj-date-picker is not intended to be a form component.

  • Gets the value of labelledBy property. The oj-label sets the labelledBy property programmatically on the form component. See the Help documentation for more information.

    Returns Promise<null | string>

    The value of labelledBy property.

    Deprecated

    Since 17.0.0. The oj-date-picker is used internally by the input date component and is not meant to display messages, be labelled, or be in a form layout by itself. Per the Redwood UX specification, the oj-date-picker is not intended to be a form component.

  • DEPRECATED 3.0 Schedules a command to compute the location of this element in page space.

    Returns Promise<ILocation>

    A promise that will be resolved to the element's location as a {@code {x:number, y:number}} object.

  • Gets the value of max property. The maximum selectable date, in ISO string format.

    Returns Promise<null | string>

    The value of max property.

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

    Deprecated

    Since 17.0.0. The oj-date-picker is used internally by the input date component and is not meant to display messages, be labelled, or be in a form layout by itself. Per the Redwood UX specification, the oj-date-picker is not intended to be a form component.

  • Gets the value of min property. The minimum selectable date, in ISO string format.

    Returns Promise<null | string>

    The value of min property.

  • Gets the value of name property. Specifies the name of the component.

    Returns Promise<string>

    The value of name property.

    Deprecated

    Since 6.0.0. JET does not use form submit, so this is not needed.

  • Gets the value of pickerAttributes property. Specifies attributes to be set on the picker DOM element when it is launched. See the Help documentation for more information.

    Returns Promise<PickerAttributes>

    The value of pickerAttributes property.

    Deprecated

    Since 17.0.0. Changing the Class or Style property is not recommended, as it leads to an inconsistent UI.

  • Gets the value of placeholder property. The placeholder text to set on the element.

    Returns Promise<string>

    The value of placeholder property.

    Deprecated

    Since 17.0.0. oj-date-picker doesn't have a text input, so this was never needed.

  • 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 rawValue property. Read-only property used for retrieving the current value from the input field in string form. See the Help documentation for more information.

    Returns Promise<string>

    The value of rawValue property.

    Deprecated

    Since 11.0.0. This property is deprecated because it was incorrectly exposed on oj-date-picker and not fully implemented.

  • Gets the value of readonly property. Specifies whether the component is read-only. A read-only element cannot be modified, but user interaction is allowed. See the Help documentation for more information.

    Returns Promise<boolean>

    The value of readonly property.

  • Returns an object describing an element's location, in pixels relative to the document element, and the element's size in pixels.

    Returns Promise<IRectangle>

  • Gets the value of renderMode property. Specifies whether to render the date picker in JET, or as a native picker control. See the Help documentation for more information.

    Returns Promise<string>

    The value of renderMode property.

    Deprecated

    Since 8.0.0. Support for "native" mode rendering is deprecated because JET promotes a consistent Oracle UX based upon the Redwood design system. As a result, the theme variable "$inputDateTimeRenderModeOptionDefault" is also deprecated.

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

    Deprecated

    Since 17.0.0. The oj-date-picker is used internally by the input date component and is not meant to display messages, be labelled, or be in a form layout by itself. Per the Redwood UX specification, the oj-date-picker is not intended to be a form component.

  • DEPRECATED 3.0 Schedules a command to compute the size of this element's bounding box, in pixels.

    Returns Promise<ISize>

    A promise that will be resolved with the element's size as a {@code {width:number, height:number}} object.

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

  • Get the visible (i.e. not hidden by CSS) innerText of this element, including sub-elements, without any leading or trailing whitespace.

    Returns Promise<string>

    A promise that will be resolved with the element's visible text.

  • Gets the value of todayTimeZone property. The today-time-zone attribute is used to compute today's date. It defaults to the user's system timezone.

    Returns Promise<string>

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

    The value of translations property.

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

    Deprecated

    Since 17.0.0. The oj-date-picker is used internally by the input date component and is not meant to display messages, be labelled, or be in a form layout by itself. Per the Redwood UX specification, the oj-date-picker is not intended to be a form component.

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

    Returns Promise<string>

    The value of valid property.

    Deprecated

    Since 17.0.0. The oj-date-picker is used internally by the input date component and is not meant to be validated, display messages, be labelled, or be in a form layout by itself. Per the Redwood UX specification, the oj-date-picker is not intended to be a form component.

  • Gets the value of validators property. Specifies a list of synchronous validators for performing validation by the element. See the Help documentation for more information.

    Returns Promise<object[]>

    The value of validators property.

  • Gets the value of value property. The value of the date picker element, which must be an ISOString. See the Help documentation for more information.

    Returns Promise<string>

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

  • Schedules a command to test whether this element is currently displayed.

    Returns Promise<boolean>

    A promise that will be resolved with whether this element is currently visible on the page.

  • Schedules a command to query whether the DOM element represented by this instance is enabled, as dicted by the {@code disabled} attribute.

    Returns Promise<boolean>

    A promise that will be resolved with whether this element is currently enabled.

  • Schedules a command to query whether this element is selected.

    Returns Promise<boolean>

    A promise that will be resolved with whether this element is currently selected.

  • Schedules a command to type a sequence on the DOM element represented by this promsieinstance.

    Modifier keys (SHIFT, CONTROL, ALT, META) are stateful; once a modifier is processed in the keysequence, that key state is toggled until one of the following occurs:

    • The modifier key is encountered again in the sequence. At this point the state of the key is toggled (along with the appropriate keyup/down events).

    • The Key.NULL key is encountered in the sequence. When this key is encountered, all modifier keys current in the down state are released (with accompanying keyup events). The NULL key can be used to simulate common keyboard shortcuts:

        element.sendKeys('text was',
      Key.CONTROL, 'a', Key.NULL,
      'now text is');
      // Alternatively:
      element.sendKeys('text was',
      Key.chord(Key.CONTROL, 'a'),
      'now text is');
    • The end of the keysequence is encountered. When there are no more keys to type, all depressed modifier keys are released (with accompanying keyup events).

    If this element is a file input ({@code }), the specified key sequence should specify the path to the file to attach to the element. This is analgous to the user clicking 'Browse...' and entering the path into the file select dialog.

    var form = driver.findElement(By.css('form'));
    var element = form.findElement(By.css('input[type=file]'));
    element.sendKeys('/path/to/file.txt');
    form.submit();

    For uploads to function correctly, the entered path must reference a file on the browser's machine, not the local machine running this script. When running against a remote Selenium server, a FileDetector may be used to transparently copy files to the remote machine before attempting to upload them in the browser.

    Note: On browsers where native keyboard events are not supported (e.g. Firefox on OS X), key events will be synthesized. Special punctionation keys will be synthesized according to a standard QWERTY en-us keyboard layout.

    Parameters

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

      The sequence of keys to type. All arguments will be joined into a single sequence.

    Returns Promise<void>

    A promise that will be resolved when all keys have been typed.

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

  • Schedules a command to submit the form containing this element (or this element if it is a FORM element). This command is a no-op if the element is not contained in a form.

    Returns Promise<void>

    A promise that will be resolved when the form has been submitted.

  • Take a screenshot of the visible region encompassed by this element's bounding rectangle.

    Parameters

    • Optional optScroll: boolean

      Optional argument that indicates whether the element should be scrolled into view before taking a screenshot. Defaults to false.

    Returns Promise<string>

    A promise that will be resolved to the screenshot as a base-64 encoded PNG.

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

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

  • Compares two WebElements for equality.

    Parameters

    Returns Promise<boolean>

    A promise that will be resolved to whether the two WebElements are equal.

  • Extracts the encoded WebElement ID from the object.

    Parameters

    Returns string

    the extracted ID.

    Throws

    if the object is not a valid encoded ID.

  • Parameters

    Returns boolean

    whether the object is a valid encoded WebElement ID.

Generated using TypeDoc