Class CKEDITOR.ui.dialog.radio
Extends
CKEDITOR.ui.dialog.labeledElement.
Defined in: plugins/dialogui/plugin.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
CKEDITOR.ui.dialog.radio(dialog, elementDefinition, htmlList)
A group of radio buttons.
|
| Field Attributes | Field Name and Description |
|---|---|
|
Defines the onChange event for UI element definitions.
|
| Method Attributes | Method Name and Description |
|---|---|
|
Handler for the access key up event.
|
|
|
getValue()
Gets the value of the currently checked radio button.
|
|
|
setValue(value, noChangeEvent)
Checks one of the radio buttons in this button group.
|
- Methods borrowed from class CKEDITOR.ui.dialog.labeledElement:
- getLabel, setLabel
- Methods borrowed from class CKEDITOR.ui.dialog.uiElement:
- accessKeyDown, disable, enable, focus, getDialog, getElement, getInputElement, isChanged, isEnabled, isFocusable, isVisible, registerEvents, selectParentTab
- Events borrowed from class CKEDITOR.ui.dialog.uiElement:
- change
Class Detail
CKEDITOR.ui.dialog.radio(dialog, elementDefinition, htmlList)
Since:
3.0
A group of radio buttons.
- Parameters:
- {CKEDITOR.dialog} dialog
- Parent dialog object.
- {CKEDITOR.dialog.definition.uiElement} elementDefinition
- The element definition. Accepted fields:
- default (Required) The default value.
- validate (Optional) The validation function.
- items (Required) 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.
- {Array} htmlList
- List of HTML code to output to.
Field Detail
{Object}
eventProcessors
Since:
3.0
Defines the onChange event for UI element definitions.
Method Detail
{Undefined}
accessKeyUp()
Since:
3.0
Handler for the access key up event. Focuses the currently
selected radio button, or the first radio button if none is
selected.
{String}
getValue()
Since:
3.0
Gets the value of the currently checked radio button.
- Returns:
- {String} The currently checked button's value.
{Undefined}
setValue(value, noChangeEvent)
Since:
3.0
Checks one of the radio buttons in this button group.
- Parameters:
- {String} value
- The value of the button to be chcked.
- {Boolean} noChangeEvent
- Internal commit, to supress 'change' event on this element.