CKEditor 4 Documentation

CKEDITOR.dialog.definition.textInput

Hierarchy

Files

The definition of a text field (single line).

This class is not really part of the API. It just illustrates the properties that developers can use to define and create text fields.

Once the dialog is opened, the created element becomes a CKEDITOR.ui.dialog.textInput object and can be accessed with CKEDITOR.dialog.getContentElement.

For a complete example of dialog definition, please check CKEDITOR.dialog.add.

// There is no constructor for this class, the user just has to define an
// object with the appropriate properties.

{
    type: 'text',
    id: 'name',
    label: 'Your name',
    'default': '',
    validate: function() {
        if ( !this.getValue() ) {
            api.openMsgDialog( '', 'Name cannot be empty.' );
            return false;
        }
    }
}
Defined By

Properties

Horizontal alignment (in container) of the UI element.

Horizontal alignment (in container) of the UI element.

CKEDITOR.dialog.definition.textInput
view source
: Boolean
Whether the text direction of this input should be togglable using the following keystrokes: Shift+Alt+End – ...

Whether the text direction of this input should be togglable using the following keystrokes:

  • Shift+Alt+End – switch to Right-To-Left,
  • Shift+Alt+Home – switch to Left-To-Right.

By default the input will be loaded without any text direction set, which means that the direction will be inherited from the editor's text direction.

If the direction was set, a marker will be prepended to every non-empty value of this input:

  • \u202A – for Right-To-Left,
  • \u202B – for Left-To-Right.

This marker allows for restoring the same text direction upon the next dialog opening.

CSS class names to append to the UI element.

CSS class names to append to the UI element.

Function to execute whenever the UI element's parent dialog's CKEDITOR.dialog.commitContent method is executed. ...

Function to execute whenever the UI element's parent dialog's CKEDITOR.dialog.commitContent method is executed. It usually takes care of the respective UI element as a standalone element.

Specify the inline style of the input element container. ...

Specify the inline style of the input element container.

{
    type: 'text',
    label: 'My Label',
    controlStyle: 'width: 3em'
}

Available since: 3.6.1

CKEDITOR.dialog.definition.textInput
view source
: String

The default value.

The default value.

The id of the UI element.

The id of the UI element.

Specify the inline style of the input element. ...

Specify the inline style of the input element.

{
    type: 'text',
    label: 'My Label',
    inputStyle: 'text-align: center'
}

Available since: 3.6.1

The label of the UI element. ...

The label of the UI element.

{
    type: 'text',
    label: 'My Label'
}
(Optional) Specify the layout of the label. ...

(Optional) Specify the layout of the label. Set to 'horizontal' for horizontal layout. The default layout is vertical.

{
    type: 'text',
    label: 'My Label',
    labelLayout: 'horizontal'
}
Specify the inline style of the uiElement label. ...

Specify the inline style of the uiElement label.

{
    type: 'text',
    label: 'My Label',
    labelStyle: 'color: red'
}
CKEDITOR.dialog.definition.textInput
view source
: Number

(Optional) The maximum length.

(Optional) The maximum length.

Function to execute whenever the UI element's parent dialog is closed.

Function to execute whenever the UI element's parent dialog is closed.

Function to execute the first time the UI element is displayed.

Function to execute the first time the UI element is displayed.

Function to execute whenever the UI element's parent dialog is displayed.

Function to execute whenever the UI element's parent dialog is displayed.

The content that needs to be allowed to enable this UI element. ...

The content that needs to be allowed to enable this UI element. All formats accepted by CKEDITOR.filter.check may be used.

When all UI elements in a tab are disabled, this tab will be disabled automatically.

Function to execute whenever the UI element's parent dialog's CKEDITOR.dialog.setupContent method is executed. ...

Function to execute whenever the UI element's parent dialog's CKEDITOR.dialog.setupContent method is executed. It usually takes care of the respective UI element as a standalone element.

CKEDITOR.dialog.definition.textInput
view source
: Number

(Optional) The size of the input field.

(Optional) The size of the input field.

Inline CSS classes to append to the UI element.

Inline CSS classes to append to the UI element.

The popup label of the UI element.

The popup label of the UI element.

The type of the UI element. ...

The type of the UI element. Required.

CKEDITOR.dialog.definition.textInput
view source
: Function

(Optional) The validation function.

(Optional) The validation function.

(Optional) Applies only to horizontal layouts: a two elements array of lengths to specify the widths of the label and...

(Optional) Applies only to horizontal layouts: a two elements array of lengths to specify the widths of the label and the content element. See also labelLayout.

{
    type: 'text',
    label: 'My Label',
    labelLayout: 'horizontal',
    widths: [100, 200]
}