CKEDITOR.dialog.definition.hbox
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'
}
]
}
Filtering
Properties
-
Horizontal alignment (in the container) of the UI element.
-
children : Array
CKEDITOR.dialog.definition.hbox#children
Array of CKEDITOR.ui.dialog.uiElement objects inside this container.
-
className : String
CKEDITOR.dialog.definition.hbox#className
CSS class names to append to the UI element.
-
commit : Function
CKEDITOR.dialog.definition.hbox#commit
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.
-
height : Number
CKEDITOR.dialog.definition.hbox#height
(Optional) The height of the layout.
-
id : String
CKEDITOR.dialog.definition.hbox#id
The ID of the UI element.
-
onHide : Function
CKEDITOR.dialog.definition.hbox#onHide
Function to execute whenever the UI element's parent dialog is closed.
-
onLoad : Function
CKEDITOR.dialog.definition.hbox#onLoad
Function to execute the first time the UI element is displayed.
-
onShow : Function
CKEDITOR.dialog.definition.hbox#onShow
Function to execute whenever the UI element's parent dialog is displayed.
-
padding : Number
CKEDITOR.dialog.definition.hbox#padding
(Optional) The padding width inside child cells. Example: 0, 1.
-
requiredContent : String | Object | style
CKEDITOR.dialog.definition.hbox#requiredContent
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
CKEDITOR.dialog.definition.hbox#setup
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
CKEDITOR.dialog.definition.hbox#style
Inline CSS classes to append to the UI element.
-
styles : String
CKEDITOR.dialog.definition.hbox#styles
The CSS styles to apply to this element.
-
title : String
CKEDITOR.dialog.definition.hbox#title
The popup label of the UI element.
-
type : String
CKEDITOR.dialog.definition.hbox#type
The type of the UI element. Required.
-
widths : Array
CKEDITOR.dialog.definition.hbox#widths
(Optional) The widths of child cells.