@oracle/oraclejet-webdriver 11.0.9 → 12.0.0

package/elements/oj-input-number/OjInputNumberBase.ts

@@ -1,4 +1,4 @@
-import {OjWebElement} from "../";
+import { OjWebElement } from '../';
 
 /**
  * This is the base class for OjInputNumber, and is generated from
@@ -9,428 +9,425 @@ import {OjWebElement} from "../";
  */
 export class OjInputNumberBase extends OjWebElement {
   /**
-   * Gets the value of asyncValidators property.
+   * Gets the value of <code>asyncValidators</code> 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.
-   * @return The value of asyncValidators property.
+   * @return The value of <code>asyncValidators</code> property.
    * @deprecated Since 8.0.0. Use the validators property instead for either regular Validators or AsyncValidators.
    */
   public getAsyncValidators(): Promise<Array<object>> {
-    return this.getProperty<Array<object>>("asyncValidators");
+    return this.getProperty<Array<object>>('asyncValidators');
   }
 
   /**
-   * Gets the value of autocomplete property.
+   * Gets the value of <code>autocomplete</code> property.
    * Specifies a component's autocomplete state. See the Help documentation for more information.
-   * @return The value of autocomplete property.
+   * @return The value of <code>autocomplete</code> property.
    * 
    */
   public getAutocomplete(): Promise<string> {
-    return this.getProperty<string>("autocomplete");
+    return this.getProperty<string>('autocomplete');
   }
 
   /**
-   * Gets the value of autofocus property.
+   * Gets the value of <code>autofocus</code> property.
    * Specifies whether the component will get input focus when the page is loaded. See the Help documentation for more information.
-   * @return The value of autofocus property.
+   * @return The value of <code>autofocus</code> property.
    * 
    */
   public getAutofocus(): Promise<boolean> {
-    return this.getProperty<boolean>("autofocus");
+    return this.getProperty<boolean>('autofocus');
   }
 
   /**
-   * Gets the value of converter property.
+   * Gets the value of <code>converter</code> property.
    * An object that converts the value. See the Help documentation for more information.
-   * @return The value of converter property.
+   * @return The value of <code>converter</code> property.
    * 
    */
   public getConverter(): Promise<object> {
-    return this.getProperty<object>("converter");
+    return this.getProperty<object>('converter');
   }
 
   /**
-   * Gets the value of describedBy property.
+   * Gets the value of <code>describedBy</code> 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.
-   * @return The value of describedBy property.
+   * @return The value of <code>describedBy</code> property.
    * 
    */
   public getDescribedBy(): Promise<string> {
-    return this.getProperty<string>("describedBy");
+    return this.getProperty<string>('describedBy');
   }
 
   /**
-   * Gets the value of disabled property.
+   * Gets the value of <code>disabled</code> property.
    * Specifies whether the component is disabled. The default is false.
-   * @return The value of disabled property.
+   * @return The value of <code>disabled</code> property.
    * 
    */
   public getDisabled(): Promise<boolean> {
-    return this.getProperty<boolean>("disabled");
+    return this.getProperty<boolean>('disabled');
   }
 
   /**
-   * Gets the value of displayOptions property.
+   * Gets the value of <code>displayOptions</code> property.
    * Display options for auxiliary content that determines whether or not it should be displayed.
-   * @return The value of displayOptions property.
+   * @return The value of <code>displayOptions</code> property.
    * 
    */
-  public getDisplayOptions(): Promise<OjInputNumberBase.DisplayOptions> {
-    return this.getProperty<OjInputNumberBase.DisplayOptions>("displayOptions");
+  public getDisplayOptions(): Promise<DisplayOptions> {
+    return this.getProperty<DisplayOptions>('displayOptions');
   }
 
   /**
-   * Gets the value of help property.
+   * Gets the value of <code>help</code> property.
    * Form component help information.
-   * @return The value of help property.
+   * @return The value of <code>help</code> property.
    * 
    */
-  public getHelp(): Promise<OjInputNumberBase.Help> {
-    return this.getProperty<OjInputNumberBase.Help>("help");
+  public getHelp(): Promise<Help> {
+    return this.getProperty<Help>('help');
   }
 
   /**
-   * Gets the value of helpHints property.
+   * Gets the value of <code>helpHints</code> property.
    * Represents hints for an oj-form-layout element to render help information on the label of the editable component.
-   * @return The value of helpHints property.
+   * @return The value of <code>helpHints</code> property.
    * 
    */
-  public getHelpHints(): Promise<OjInputNumberBase.HelpHints> {
-    return this.getProperty<OjInputNumberBase.HelpHints>("helpHints");
+  public getHelpHints(): Promise<HelpHints> {
+    return this.getProperty<HelpHints>('helpHints');
   }
 
   /**
-   * Gets the value of labelEdge property.
+   * Gets the value of <code>labelEdge</code> property.
    * Defines how the label of a component is created. See the Help documentation for more information.
-   * @return The value of labelEdge property.
+   * @return The value of <code>labelEdge</code> property.
    * 
    */
   public getLabelEdge(): Promise<string> {
-    return this.getProperty<string>("labelEdge");
+    return this.getProperty<string>('labelEdge');
   }
 
   /**
-   * Gets the value of labelHint property.
+   * Gets the value of <code>labelHint</code> property.
    * Represents a hint for oj-form-layout element to render a label on the editable component.
-   * @return The value of labelHint property.
+   * @return The value of <code>labelHint</code> property.
    * 
    */
   public getLabelHint(): Promise<string> {
-    return this.getProperty<string>("labelHint");
+    return this.getProperty<string>('labelHint');
   }
 
   /**
-   * Gets the value of labelledBy property.
+   * Gets the value of <code>labelledBy</code> property.
    * The oj-label sets the labelledBy property programmatically on the form component.
-   * @return The value of labelledBy property.
+   * @return The value of <code>labelledBy</code> property.
    * 
    */
   public getLabelledBy(): Promise<string|null> {
-    return this.getProperty<string|null>("labelledBy");
+    return this.getProperty<string|null>('labelledBy');
   }
 
   /**
-   * Gets the value of max property.
+   * Gets the value of <code>max</code> property.
    * The maximum allowed value. A value of null indicates that there is no maximum. See the Help documentation for more information.
-   * @return The value of max property.
+   * @return The value of <code>max</code> property.
    * 
    */
   public getMax(): Promise<number> {
-    return this.getProperty<number>("max");
+    return this.getProperty<number>('max');
   }
 
   /**
-   * Sets the value of "messagesCustom" property.
+   * Sets the value of <code>messagesCustom</code> property.
    * A list of messages added by an application to the component. See the Help documentation for more information.
-   * @param messagesCustom The value to set for "messagesCustom"
+   * @param messagesCustom The value to set for <code>messagesCustom</code>
    * 
    */
   public changeMessagesCustom(messagesCustom: Array<object>): Promise<void> {
-    return this.setProperty<Array<object>>("messagesCustom", messagesCustom);
+    return this.setProperty<Array<object>>('messagesCustom', messagesCustom);
   }
 
   /**
-   * Gets the value of messagesCustom property.
+   * Gets the value of <code>messagesCustom</code> property.
    * A list of messages added by an application to the component. See the Help documentation for more information.
-   * @return The value of messagesCustom property.
+   * @return The value of <code>messagesCustom</code> property.
    * 
    */
   public getMessagesCustom(): Promise<Array<object>> {
-    return this.getProperty<Array<object>>("messagesCustom");
+    return this.getProperty<Array<object>>('messagesCustom');
   }
 
   /**
-   * Gets the value of min property.
+   * Gets the value of <code>min</code> property.
    * The minimum allowed value. A value of null indicates that there is no minimum. See the Help documentation for more information.
-   * @return The value of min property.
+   * @return The value of <code>min</code> property.
    * 
    */
   public getMin(): Promise<number> {
-    return this.getProperty<number>("min");
+    return this.getProperty<number>('min');
   }
 
   /**
-   * Gets the value of name property.
+   * Gets the value of <code>name</code> property.
    * Specifies the name of the component.
-   * @return The value of name property.
+   * @return The value of <code>name</code> property.
    * @deprecated Since 6.0.0. JET does not use form submit, so this is not needed.
    */
   public getName(): Promise<string> {
-    return this.getProperty<string>("name");
+    return this.getProperty<string>('name');
   }
 
   /**
-   * Gets the value of placeholder property.
+   * Gets the value of <code>placeholder</code> property.
    * The placeholder text to set on the element.
-   * @return The value of placeholder property.
+   * @return The value of <code>placeholder</code> property.
    * 
    */
   public getPlaceholder(): Promise<string|null> {
-    return this.getProperty<string|null>("placeholder");
+    return this.getProperty<string|null>('placeholder');
   }
 
   /**
-   * Gets the value of rawValue property.
+   * Gets the value of <code>rawValue</code> property.
    * Read-only property used for retrieving the current value from the input field in string form. See the Help documentation for more information.
-   * @return The value of rawValue property.
+   * @return The value of <code>rawValue</code> property.
    * 
    */
   public getRawValue(): Promise<string> {
-    return this.getProperty<string>("rawValue");
+    return this.getProperty<string>('rawValue');
   }
 
   /**
-   * Gets the value of readonly property.
+   * Gets the value of <code>readonly</code> 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.
-   * @return The value of readonly property.
+   * @return The value of <code>readonly</code> property.
    * 
    */
   public getReadonly(): Promise<boolean> {
-    return this.getProperty<boolean>("readonly");
+    return this.getProperty<boolean>('readonly');
   }
 
   /**
-   * Gets the value of required property.
+   * Gets the value of <code>required</code> property.
    * Specifies whether the component is required or optional. See the Help documentation for more information.
-   * @return The value of required property.
+   * @return The value of <code>required</code> property.
    * 
    */
   public getRequired(): Promise<boolean> {
-    return this.getProperty<boolean>("required");
+    return this.getProperty<boolean>('required');
   }
 
   /**
-   * Gets the value of step property.
+   * Gets the value of <code>step</code> property.
    * Specifies the amount to increase or decrease the value when moving in step increments. If 0, no step functionality. See the Help documentation for more information.
-   * @return The value of step property.
+   * @return The value of <code>step</code> property.
    * 
    */
   public getStep(): Promise<number> {
-    return this.getProperty<number>("step");
+    return this.getProperty<number>('step');
   }
 
   /**
-   * Gets the value of transientValue property.
+   * Gets the value of <code>transientValue</code> property.
    * Read-only property used for retrieving the transient value from the component. See the Help documentation for more information.
-   * @return The value of transientValue property.
+   * @return The value of <code>transientValue</code> property.
    * 
    */
   public getTransientValue(): Promise<number> {
-    return this.getProperty<number>("transientValue");
+    return this.getProperty<number>('transientValue');
   }
 
   /**
-   * Gets the value of translations property.
+   * Gets the value of <code>translations</code> property.
    * A collection of translated resources from the translation bundle, or null if this component has no resources.
-   * @return The value of translations property.
+   * @return The value of <code>translations</code> property.
    * 
    */
-  public getTranslations(): Promise<OjInputNumberBase.Translations|null> {
-    return this.getProperty<OjInputNumberBase.Translations|null>("translations");
+  public getTranslations(): Promise<Translations|null> {
+    return this.getProperty<Translations|null>('translations');
   }
 
   /**
-   * Gets the value of userAssistanceDensity property.
+   * Gets the value of <code>userAssistanceDensity</code> property.
    * Specifies the density of the form component's user assistance presentation.
-   * @return The value of userAssistanceDensity property.
+   * @return The value of <code>userAssistanceDensity</code> property.
    * 
    */
   public getUserAssistanceDensity(): Promise<string> {
-    return this.getProperty<string>("userAssistanceDensity");
+    return this.getProperty<string>('userAssistanceDensity');
   }
 
   /**
-   * Gets the value of valid property.
+   * Gets the value of <code>valid</code> property.
    * The validity state of the component
-   * @return The value of valid property.
+   * @return The value of <code>valid</code> property.
    * 
    */
   public getValid(): Promise<string> {
-    return this.getProperty<string>("valid");
+    return this.getProperty<string>('valid');
   }
 
   /**
-   * Gets the value of validators property.
+   * Gets the value of <code>validators</code> property.
    * Specifies a list of validators for performing validation by the element. See the Help documentation for more information.
-   * @return The value of validators property.
+   * @return The value of <code>validators</code> property.
    * 
    */
   public getValidators(): Promise<Array<object>> {
-    return this.getProperty<Array<object>>("validators");
+    return this.getProperty<Array<object>>('validators');
   }
 
   /**
-   * Sets the value of "value" property.
+   * Sets the value of <code>value</code> property.
    * The value of the component, which must be either a number or null. See the Help documentation for more information.
-   * @param value The value to set for "value"
+   * @param value The value to set for <code>value</code>
    * 
    */
   public changeValue(value: number): Promise<void> {
-    return this.setProperty<number>("value", value);
+    return this.setProperty<number>('value', value);
   }
 
   /**
-   * Gets the value of value property.
+   * Gets the value of <code>value</code> property.
    * The value of the component, which must be either a number or null. See the Help documentation for more information.
-   * @return The value of value property.
+   * @return The value of <code>value</code> property.
    * 
    */
   public getValue(): Promise<number> {
-    return this.getProperty<number>("value");
+    return this.getProperty<number>('value');
   }
 
   /**
-   * Gets the value of virtualKeyboard property.
+   * Gets the value of <code>virtualKeyboard</code> property.
    * The type of virtual keyboard to display for entering a value on mobile browsers. See the Help documentation for more information.
-   * @return The value of virtualKeyboard property.
+   * @return The value of <code>virtualKeyboard</code> property.
    * 
    */
   public getVirtualKeyboard(): Promise<string> {
-    return this.getProperty<string>("virtualKeyboard");
+    return this.getProperty<string>('virtualKeyboard');
   }
 
 }
-
-namespace OjInputNumberBase {
-  export interface DisplayOptions {
-    /**
-     * Display options for auxiliary converter hint text that determines whether it should be displayed.
-     */
-    "converterHint": Array<string>|string;
-    /**
-     * Display options for auxiliary help instruction text that determines whether it should be displayed.
-     */
-    "helpInstruction": Array<string>|string;
-    /**
-     * Display options for auxiliary message text that determines whether it should be displayed.
-     */
-    "messages": Array<string>|string;
-    /**
-     * Display options for auxiliary validator hint text that determines whether it should be displayed.
-     */
-    "validatorHint": Array<string>|string;
-  }
-  export interface Help {
-    /**
-     * Represents advisory information for the component, such as would be appropriate for a tooltip.
-     */
-    "instruction": string;
-  }
-  export interface HelpHints {
-    /**
-     * Hint for help definition text associated with the label.
-     */
-    "definition": string;
-    /**
-     * Help source URL associated with the component.
-     */
-    "source": string;
-  }
-  export interface Translations {
-    /**
-     * Provides properties to customize the hint and message text used by the implicit number range validator associated to the inputNumber component.
-     */
-    "numberRange": OjInputNumberBase.TranslationsNumberRange;
-    /**
-     * Provides properties to customize the summary, detail and hint text used by the implicit required validator associated to any editable component that supports the required option.
-     */
-    "required": OjInputNumberBase.TranslationsRequired;
-    /**
-     * Tooltip text for the inputNumber's Down arrow.
-     */
-    "tooltipDecrement": string;
-    /**
-     * Tooltip text for the inputNumber's Up arrow.
-     */
-    "tooltipIncrement": string;
-  }
-  export interface TranslationsNumberRange {
-    /**
-     * Provides properties to customize the hint text used by the implicit number range validator associated to the inputNumber component.
-     */
-    "hint": OjInputNumberBase.TranslationsNumberRangeHint;
-    /**
-     * Provides properties to customize the error message text used by the implicit number range validator associated to the inputNumber component.
-     */
-    "messageDetail": OjInputNumberBase.TranslationsNumberRangeMessageDetail;
-    /**
-     * Provides properties to customize the error message summary text used by the implicit number range validator associated to the inputNumber component.
-     */
-    "messageSummary": OjInputNumberBase.TranslationsNumberRangeMessageSummary;
-  }
-  export interface TranslationsNumberRangeHint {
-    /**
-     * Hint text used by the number range validator associated to the inputNumber component. hint.exact is shown when both min and max are set and are equal to each other. This hint is used to tell the user to enter that particular number.
-     */
-    "exact": string;
-    /**
-     * Hint text used by the number range validator associated to the inputNumber component. hint.inRange is shown when both min and max are set, and is used to tell the user the allowed number range.
-     */
-    "inRange": string;
-    /**
-     * Hint text used by the number range validator associated to the inputNumber component. hint.max is shown when max is set and min is not set, and is used to tell the user the allowed maximum.
-     */
-    "max": string;
-    /**
-     * Hint text used by the number range validator associated to the inputNumber component. hint.min is shown when min is set and max is not set, and is used to tell the user the allowed minimum.
-     */
-    "min": string;
-  }
-  export interface TranslationsNumberRangeMessageDetail {
-    /**
-     * Error message text used by the number range validator associated to the inputNumber component. messageDetail.exact is shown when min and max are both set and are equal to each other, and the value is not equal to the min/max.
-     */
-    "exact": string;
-    /**
-     * Error message text used by the number range validator associated to the inputNumber component. messageDetail.rangeOverflow is shown when max is set, and the value is greater than the maximum.
-     */
-    "rangeOverflow": string;
-    /**
-     * Error message text used by the number range validator associated to the inputNumber component. messageDetail.rangeUnderflow is shown when min is set, and the value is less than the minimum.
-     */
-    "rangeUnderflow": string;
-  }
-  export interface TranslationsNumberRangeMessageSummary {
-    /**
-     * Error message summary text used by the number range validator associated to the inputNumber component. messageSummary.rangeOverflow is shown when max is set, and the value is greater than the maximum.
-     */
-    "rangeOverflow": string;
-    /**
-     * Error message summary text used by the number range validator associated to the inputNumber component. messageSummary.rangeUnderflow is shown when min is set, and the value is less than the minimum.
-     */
-    "rangeUnderflow": string;
-  }
-  export interface TranslationsRequired {
-    /**
-     * Hint text used by required validation error.
-     */
-    "hint": string;
-    /**
-     * Message text that describes the details of the required validation error.
-     */
-    "messageDetail": string;
-    /**
-     * Message text for summarizing a required validation error.
-     */
-    "messageSummary": string;
-  }
+export interface DisplayOptions {
+  /**
+   * Display options for auxiliary converter hint text that determines whether it should be displayed.
+   */
+  "converterHint": Array<string>|string;
+  /**
+   * Display options for auxiliary help instruction text that determines whether it should be displayed.
+   */
+  "helpInstruction": Array<string>|string;
+  /**
+   * Display options for auxiliary message text that determines whether it should be displayed.
+   */
+  "messages": Array<string>|string;
+  /**
+   * Display options for auxiliary validator hint text that determines whether it should be displayed.
+   */
+  "validatorHint": Array<string>|string;
+}
+export interface Help {
+  /**
+   * Represents advisory information for the component, such as would be appropriate for a tooltip.
+   */
+  "instruction": string;
+}
+export interface HelpHints {
+  /**
+   * Hint for help definition text associated with the label.
+   */
+  "definition": string;
+  /**
+   * Help source URL associated with the component.
+   */
+  "source": string;
+}
+export interface Translations {
+  /**
+   * Provides properties to customize the hint and message text used by the implicit number range validator associated to the inputNumber component.
+   */
+  "numberRange": TranslationsNumberRange;
+  /**
+   * Provides properties to customize the summary, detail and hint text used by the implicit required validator associated to any editable component that supports the required option.
+   */
+  "required": TranslationsRequired;
+  /**
+   * Tooltip text for the inputNumber's Down arrow.
+   */
+  "tooltipDecrement": string;
+  /**
+   * Tooltip text for the inputNumber's Up arrow.
+   */
+  "tooltipIncrement": string;
+}
+export interface TranslationsNumberRange {
+  /**
+   * Provides properties to customize the hint text used by the implicit number range validator associated to the inputNumber component.
+   */
+  "hint": TranslationsNumberRangeHint;
+  /**
+   * Provides properties to customize the error message text used by the implicit number range validator associated to the inputNumber component.
+   */
+  "messageDetail": TranslationsNumberRangeMessageDetail;
+  /**
+   * Provides properties to customize the error message summary text used by the implicit number range validator associated to the inputNumber component.
+   */
+  "messageSummary": TranslationsNumberRangeMessageSummary;
+}
+export interface TranslationsNumberRangeHint {
+  /**
+   * Hint text used by the number range validator associated to the inputNumber component. hint.exact is shown when both min and max are set and are equal to each other. This hint is used to tell the user to enter that particular number.
+   */
+  "exact": string;
+  /**
+   * Hint text used by the number range validator associated to the inputNumber component. hint.inRange is shown when both min and max are set, and is used to tell the user the allowed number range.
+   */
+  "inRange": string;
+  /**
+   * Hint text used by the number range validator associated to the inputNumber component. hint.max is shown when max is set and min is not set, and is used to tell the user the allowed maximum.
+   */
+  "max": string;
+  /**
+   * Hint text used by the number range validator associated to the inputNumber component. hint.min is shown when min is set and max is not set, and is used to tell the user the allowed minimum.
+   */
+  "min": string;
+}
+export interface TranslationsNumberRangeMessageDetail {
+  /**
+   * Error message text used by the number range validator associated to the inputNumber component. messageDetail.exact is shown when min and max are both set and are equal to each other, and the value is not equal to the min/max.
+   */
+  "exact": string;
+  /**
+   * Error message text used by the number range validator associated to the inputNumber component. messageDetail.rangeOverflow is shown when max is set, and the value is greater than the maximum.
+   */
+  "rangeOverflow": string;
+  /**
+   * Error message text used by the number range validator associated to the inputNumber component. messageDetail.rangeUnderflow is shown when min is set, and the value is less than the minimum.
+   */
+  "rangeUnderflow": string;
+}
+export interface TranslationsNumberRangeMessageSummary {
+  /**
+   * Error message summary text used by the number range validator associated to the inputNumber component. messageSummary.rangeOverflow is shown when max is set, and the value is greater than the maximum.
+   */
+  "rangeOverflow": string;
+  /**
+   * Error message summary text used by the number range validator associated to the inputNumber component. messageSummary.rangeUnderflow is shown when min is set, and the value is less than the minimum.
+   */
+  "rangeUnderflow": string;
+}
+export interface TranslationsRequired {
+  /**
+   * Hint text used by required validation error.
+   */
+  "hint": string;
+  /**
+   * Message text that describes the details of the required validation error.
+   */
+  "messageDetail": string;
+  /**
+   * Message text for summarizing a required validation error.
+   */
+  "messageSummary": string;
 }