Report an issue
Class

CKEDITOR.dialog.definition.vbox

class

Vertical layout box for dialog UI elements.

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

Once the dialog is opened, the created element becomes a CKEDITOR.ui.dialog.vbox 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: 'vbox',
    align: 'right',
    width: '200px',
    children: [
        {
            type: 'text',
            id: 'age',
            label: 'Age'
        },
        {
            type: 'text',
            id: 'sex',
            label: 'Sex'
        },
        {
            type: 'text',
            id: 'nationality',
            label: 'Nationality'
        }
    ]
}

Filtering

Properties

  • align : String

    inherited

    Horizontal alignment (in the container) of the UI element.

  • children : Array

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

  • className : String

    CSS class names to append to the UI element.

  • commit : Function

    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.

  • expand : Boolean

    (Optional) Whether the layout should expand vertically to fill its container.

  • heights : Number

    (Optional) The heights of individual cells.

  • id : String

    The ID of the UI element.

  • onHide : Function

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

  • onLoad : Function

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

  • onShow : Function

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

  • padding : Number

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

  • requiredContent : String | Object | style

    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.

  • setup : Function

    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.

  • style : String

    Inline CSS classes to append to the UI element.

  • styles : String

    The CSS styles to apply to this element.

  • title : String

    The popup label of the UI element.

  • type : String

    The type of the UI element. Required.

  • width : Array

    (Optional) The width of the layout.