CKEditor 4 Documentation

CKEDITOR.dialog.definition.hbox

Hierarchy

CKEDITOR.dialog.definition.uiElement
CKEDITOR.dialog.definition.hbox

Files

Horizontal layout box for dialog UI elements, auto-expends to available width of container.

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

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

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

// Example:
{
    type: 'hbox',
    widths: [ '25%', '25%', '50%' ],
    children: [
        {
            type: 'text',
            id: 'id1',
            width: '40px',
        },
        {
            type: 'text',
            id: 'id2',
            width: '40px',
        },
        {
            type: 'text',
            id: 'id3'
        }
    ]
}
Defined By

Properties

CKEDITOR.dialog.definition.hbox
view source
: String
(Optional) The alignment of the whole layout. ...

(Optional) The alignment of the whole layout. Example: center, top.

Overrides: CKEDITOR.dialog.definition.uiElement.align

CKEDITOR.dialog.definition.hbox
view source
: Array

Array of CKEDITOR.ui.dialog.uiElement objects inside this container.

Array of CKEDITOR.ui.dialog.uiElement objects inside this container.

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.

CKEDITOR.dialog.definition.hbox
view source
: Number

(Optional) The height of the layout.

(Optional) The height of the layout.

The id of the UI element.

The id of the UI element.

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.

CKEDITOR.dialog.definition.hbox
view source
: Number
(Optional) The padding width inside child cells. ...

(Optional) The padding width inside child cells. Example: 0, 1.

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.

Inline CSS classes to append to the UI element.

Inline CSS classes to append to the UI element.

CKEDITOR.dialog.definition.hbox
view source
: String

The CSS styles to apply to this element.

The CSS styles to apply to this 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.hbox
view source
: Array

(Optional) The widths of child cells.

(Optional) The widths of child cells.