import { OjWebElement } from '../';
/**
* This is the base class for oj-input-text 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, OjInputText.ts.
*/
export declare class OjInputTextBase extends OjWebElement {
/**
* 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.
* @return The value of asyncValidators property.
* @deprecated Since 8.0.0. Use the validators property instead for either regular Validators or AsyncValidators.
*/
getAsyncValidators(): Promise>;
/**
* Gets the value of autocomplete property.
* Specifies a component's autocomplete state. See the Help documentation for more information.
* @return The value of autocomplete property.
*
*/
getAutocomplete(): Promise;
/**
* 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.
* @return The value of autofocus property.
*
*/
getAutofocus(): Promise;
/**
* Gets the value of clearIcon property.
* Specifies if an icon to clear the input field should be visible.
* @return The value of clearIcon property.
*
*/
getClearIcon(): Promise;
/**
* Gets the value of converter property.
* An object that converts the value. See the Help documentation for more information.
* @return The value of converter property.
*
*/
getConverter(): Promise;
/**
* 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.
* @return The value of describedBy property.
*
*/
getDescribedBy(): Promise;
/**
* Gets the value of disabled property.
* Specifies whether the component is disabled. The default is false.
* @return The value of disabled property.
*
*/
getDisabled(): Promise;
/**
* Gets the value of displayOptions property.
* Display options for auxiliary content that determines whether or not it should be displayed.
* @return The value of displayOptions property.
*
*/
getDisplayOptions(): Promise;
/**
* Gets the value of help property.
* Form component help information.
* @return The value of help property.
*
*/
getHelp(): Promise;
/**
* 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.
* @return The value of helpHints property.
*
*/
getHelpHints(): Promise;
/**
* Gets the value of labelEdge property.
* Defines how the label of a component is created. See the Help documentation for more information.
* @return The value of labelEdge property.
*
*/
getLabelEdge(): Promise;
/**
* Gets the value of labelHint property.
* Represents a hint for oj-form-layout element to render a label on the editable component.
* @return The value of labelHint property.
*
*/
getLabelHint(): Promise;
/**
* 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.
* @return The value of labelledBy property.
*
*/
getLabelledBy(): Promise;
/**
* Gets the value of length property.
* An object whose properties describe the maximum length attributes. // * @ojtsignore tsdefonly
* @return The value of length property.
*
*/
getLength(): Promise;
/**
* Gets the value of list property.
* Specifies a list of pre-defined options to present to the user. See the Help documentation for more information.
* @return The value of list property.
*
*/
getList(): Promise;
/**
* Sets the value of messagesCustom 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
*
*/
changeMessagesCustom(messagesCustom: Array): Promise;
/**
* Gets the value of messagesCustom 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.
*
*/
getMessagesCustom(): Promise>;
/**
* Gets the value of name property.
* Specifies the name of the component.
* @return The value of name property.
* @deprecated Since 6.0.0. JET does not use form submit, so this is not needed.
*/
getName(): Promise;
/**
* Gets the value of placeholder property.
* The placeholder text to set on the element.
* @return The value of placeholder property.
*
*/
getPlaceholder(): Promise;
/**
* 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.
* @return The value of rawValue property.
*
*/
getRawValue(): Promise;
/**
* 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.
* @return The value of readonly property.
*
*/
getReadonly(): Promise;
/**
* Gets the value of readonlyUserAssistanceShown property.
* Specifies which user assistance types should be shown when the component is readonly.
* @return The value of readonlyUserAssistanceShown property.
*
*/
getReadonlyUserAssistanceShown(): Promise;
/**
* Gets the value of required property.
* Specifies whether the component is required or optional. See the Help documentation for more information.
* @return The value of required property.
*
*/
getRequired(): Promise;
/**
* Gets the value of translations property.
* A collection of translated resources from the translation bundle, or null if this component has no resources.
* @return The value of translations property.
*
*/
getTranslations(): Promise;
/**
* Gets the value of userAssistanceDensity property.
* Specifies the density of the form component's user assistance presentation.
* @return The value of userAssistanceDensity property.
*
*/
getUserAssistanceDensity(): Promise;
/**
* Gets the value of valid property.
* The validity state of the component
* @return The value of valid property.
*
*/
getValid(): Promise;
/**
* 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.
* @return The value of validators property.
*
*/
getValidators(): Promise>;
/**
* Sets the value of value property.
* The value of the component.
* @param value The value to set for value
*
*/
changeValue(value: any): Promise;
/**
* Gets the value of value property.
* The value of the component.
* @return The value of value property.
*
*/
getValue(): Promise;
/**
* 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.
* @return The value of virtualKeyboard property.
*
*/
getVirtualKeyboard(): Promise;
}
export interface DisplayOptions {
/**
* Display options for auxiliary converter hint text that determines whether it should be displayed.
*/
converterHint: Array | string;
/**
* Display options for auxiliary help instruction text that determines whether it should be displayed.
* @deprecated Since 9.0.0. If you want none, remove help-instruction attribute.
*/
helpInstruction: Array | string;
/**
* Display options for auxiliary message text that determines whether it should be displayed.
*/
messages: Array | string;
/**
* Display options for auxiliary validator hint text that determines whether it should be displayed.
*/
validatorHint: Array | 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 Length {
/**
* Specifies the manner in which the input text characters has to be counted.
*/
countBy: string;
/**
* Specifies the maximum number of characters to be entered in the input text.
*/
max: number | null;
}
export interface Translations {
/**
* Tooltip for the clear icon.
* @deprecated Since 18.0.0. This tooltip text should be consistent across the application, and not configured per component instance.
*/
accessibleClearIcon: string;
/**
* Message to announce to AT via aria-live when the length.max is exceeded.
* @deprecated Since 18.0.0. This message text should be consistent across the application, and not configured per component instance.
*/
accessibleMaxLengthExceeded: string;
/**
* Message to announce to AT via aria-live for the remaining character count.
* @deprecated Since 18.0.0. This message text should be consistent across the application, and not configured per component instance.
*/
accessibleMaxLengthRemaining: string;
/**
* Provides properties to customize the message text used by the implicit regexp validator associated to the InputText and TextArea components.
* @deprecated Since 18.0.0. The implicit regexp validator is not supported by the component.
*/
regexp: TranslationsRegexp;
/**
* 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;
}
export interface TranslationsRegexp {
/**
* Provides properties to customize the error message detail used by the implicit regexp validator associated to the InputText and TextArea components.
* @deprecated Since 18.0.0. The implicit regexp validator is not supported by the component.
*/
messageDetail: string;
/**
* Provides properties to customize the error message summary used by the implicit regexp validator associated to the InputText and TextArea components.
* @deprecated Since 18.0.0. The implicit regexp validator is not supported by the component.
*/
messageSummary: string;
}
export interface TranslationsRequired {
/**
* Hint text used by required validation error.
* @deprecated Since 18.0.0. Setting a required validator hint is not recommended in the Redwood design system.
*/
hint: string;
/**
* Message text that describes the details of the required validation error.
*/
messageDetail: string;
/**
* Message text for summarizing a required validation error.
* @deprecated Since 14.0.0. In the Redwood design system form components do not show validator summaries, so this is no longer needed.
*/
messageSummary: string;
}