Class CKEDITOR.dialog.definition.vbox

Extends CKEDITOR.dialog.definition.uiElement.
Defined in: plugins/dialog/dialogDefinition.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	CKEDITOR.dialog.definition.vbox() Vertical layout box for dialog UI elements.

Field Summary
Field Attributes	Field Name and Description
	align (Optional) The alignment of the whole layout.
	children Array of CKEDITOR.ui.dialog.uiElement objects inside this container.
	expand (Optional) Whether the layout should expand vertically to fill its container.
	heights (Optional) The heights of individual cells.
	padding (Optional) The padding width inside child cells.
	styles The CSS styles to apply to this element.
	width (Optional) The width of the layout.

Fields borrowed from class CKEDITOR.dialog.definition.uiElement:: className, commit, id, onHide, onLoad, onShow, setup, style, title, type

Class Detail

CKEDITOR.dialog.definition.vbox()

Since: 3.0

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'
		}
	]
}

Field Detail

{String} align

Since: 3.0

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

{Array} children

Since: 3.0

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

{Boolean} expand

Since: 3.0

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

{Number} heights

Since: 3.0

(Optional) The heights of individual cells.

{Number} padding

Since: 3.0

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

{String} styles

Since: 3.0

The CSS styles to apply to this element.

{Array} width

Since: 3.0

(Optional) The width of the layout.

CKEditor 3 JavaScript API Documentation

Namespaces

Classes

Class CKEDITOR.dialog.definition.vbox