CKEditor 4 Documentation

CKEDITOR.dialog.definition.radio

Hierarchy

Files

The definition of a radio group.

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

Once the dialog is opened, the created element becomes a CKEDITOR.ui.dialog.radio 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.

// Example:
{
    type: 'radio',
    id: 'country',
    label: 'Which country is bigger',
    items: [ [ 'France', 'FR' ], [ 'Germany', 'DE' ] ],
    style: 'color: green',
    'default': 'DE',
    onClick: function() {
        // this = CKEDITOR.ui.dialog.radio
        alert( 'Current value: ' + this.getValue() );
    }
}
Defined By

Properties

Horizontal alignment (in container) of the UI element.

Horizontal alignment (in container) of the UI element.

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.radio
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

CKEDITOR.dialog.definition.radio
view source
: Array
An array of options. ...

An array of options. Each option is a 1- or 2-item array of format [ 'Description', 'Value' ]. If 'Value' is missing, then the value would be assumed to be the same as the description.

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

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.

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.radio
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]
}