CKEditor Ecosystem Documentation
Search
Report an issue
Home/CKEditor 4/API
Class

CKEDITOR.ui.dialog.textInput

class
See source

A text input with a label. This UI element class represents both the single-line text inputs and password inputs in dialog boxes.

Since 4.11.0 it also represents the phone number input.

Filtering

Properties

  • eventProcessors : Object

    Defines the onChange event for UI element definitions.

    See source

Methods

  • constructor( dialog, elementDefinition, htmlList ) → textInput

    Creates a textInput class instance.

    See source

    Parameters

    dialog : dialog

    Parent dialog window object.

    elementDefinition : uiElement

    The element definition. Accepted fields:

    • default (Optional) The default value.
    • validate (Optional) The validation function.
    • maxLength (Optional) The maximum length of text box contents.
    • size (Optional) The size of the text box. This is usually overridden by the size defined by the skin, though.
    htmlList : Array

    List of HTML code to output to.

    Returns

    textInput

  • accessKeyDown( dialog, key )

    The default handler for a UI element's access key down event, which tries to put focus to the UI element.

    See source

    Can be overridded in child classes for more sophisticaed behavior.

    Parameters

    dialog : dialog

    The parent dialog object.

    key : String

    The key combination pressed. Since access keys are defined to always include the CTRL key, its value should always include a 'CTRL+' prefix.

  • accessKeyUp()

    Handler for the text input's access key up event. Makes a select() call to the text input.

    See source

  • disable()

    Disables a UI element.

    See source

  • enable()

    Enables a UI element.

    See source

  • focus()

    Puts focus into the text input.

    See source

  • getDialog() → dialog

    Gets the parent dialog object containing this UI element.

    See source
    var dialog = uiElement.getDialog();

    Returns

    dialog

    Parent dialog object.

  • getDirectionMarker() → String

    since 4.5.0

    Gets the value of the text direction marker.

    See source

    Returns

    String

    'ltr', 'rtl' or null if the marker is not set.

  • getElement() → element

    Gets the root DOM element of this dialog UI object.

    See source
    uiElement.getElement().hide();

    Returns

    element

    Root DOM element of UI object.

  • getInputElement() → element

    Gets the text input DOM element under this UI object.

    See source

    Returns

    element

    The DOM element of the text input.

  • getLabel() → String

    Retrieves the current label text of the elment.

    See source

    Returns

    String

    The current label text.

  • getValue() → String

    Gets the value of this text input object.

    See source

    Returns

    String

    The value.

  • isChanged() → Boolean

    Tells whether the UI object's value has changed.

    See source
    if ( uiElement.isChanged() )
    confirm( 'Value changed! Continue?' );

    Returns

    Boolean

    true if changed, false if not changed.

  • isEnabled() → Boolean

    Determines whether an UI element is enabled or not.

    See source

    Returns

    Boolean

    Whether the UI element is enabled.

  • isFocusable() → Boolean

    Determines whether an UI element is focus-able or not. Focus-able is defined as being both visible and enabled.

    See source

    Returns

    Boolean

    Whether the UI element can be focused.

  • isVisible() → Boolean

    Determines whether an UI element is visible or not.

    See source

    Returns

    Boolean

    Whether the UI element is visible.

  • registerEvents( definition ) → uiElement

    chainable

    Registers the on* event handlers defined in the element definition.

    See source

    The default behavior of this function is:

    1. If the on* event is defined in the class's eventProcesors list, then the registration is delegated to the corresponding function in the eventProcessors list.
    2. If the on* event is not defined in the eventProcessors list, then register the event handler under the corresponding DOM event of the UI element's input DOM element (as defined by the return value of getInputElement).

    This function is only called at UI element instantiation, but can be overridded in child classes if they require more flexibility.

    Parameters

    definition : uiElement

    The UI element definition.

    Returns

    uiElement

    this

  • select()

    Selects all the text in the text input.

    See source

  • selectParentTab() → uiElement

    chainable

    Selects the parent tab of this element. Usually called by focus() or overridden focus() methods.

    See source
    focus : function() {
    this.selectParentTab();
    // do something else.
}

    Returns

    uiElement

    this

  • setDirectionMarker( dir )

    since 4.5.0

    Sets the text direction marker and the dir attribute of the input element.

    See source

    Parameters

    dir : String

    The text direction. Pass null to reset.

  • setLabel( label ) → labeledElement

    chainable

    Sets the label text of the element.

    See source

    Parameters

    label : String

    The new label text.

    Returns

    labeledElement

    The current labeled element.

  • setValue( value ) → textInput

    Sets the value of this text input object.

    See source
    uiElement.setValue( 'Blamo' );

    Parameters

    value : Object

    The new value.

    Returns

    textInput

    The current UI element.

Events

  • change( evt )

    Fired when the value of the uiElement is changed.

    See source

    Parameters

    evt : eventInfo