Class CKFinder.ui.dialog.labeledElement
Extends
CKFinder.ui.dialog.uiElement.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
CKFinder.ui.dialog.labeledElement(dialog, elementDefinition, htmlList, contentHtml)
Base class for all dialog elements with a textual label on the left.
|
| Method Attributes | Method Name and Description |
|---|---|
|
getLabel()
Retrieves the current label text of the elment.
|
|
|
setLabel(label)
Sets the label text of the element.
|
- Methods borrowed from class CKFinder.ui.dialog.uiElement:
- disable, enable, focus, getDialog, getElement, getInputElement, getValue, isChanged, isEnabled, isVisible, selectParentTab, setValue
Class Detail
CKFinder.ui.dialog.labeledElement(dialog, elementDefinition, htmlList, contentHtml)
Since:
2.0
Base class for all dialog elements with a textual label on the left.
Note: the whole CKFinder.ui.dialog namespace is not directly accessible (CKFinder.ui.dialog is undefined).
Instances of this class are created by CKFinder when dialog is created.
To add a element to a dialog, check CKFinder.dialog.definition.uiElement.
Instances of this class are created by CKFinder when dialog is created.
- Parameters:
- {CKFinder.dialog} dialog
- Parent dialog object.
- {CKFinder.dialog.uiElementDefinition} elementDefinition
- The element definition. Accepted fields:
- label (Required) The label string.
- labelLayout (Optional) Put 'horizontal' here if the label element is to be layed out horizontally. Otherwise a vertical layout will be used.
- widths (Optional) This applies only for horizontal layouts - an 2-element array of lengths to specify the widths of the label and the content element.
- {Array} htmlList
- List of HTML code to output to.
- {Function} contentHtml
- A function returning the HTML code string to be added inside the content cell.
Method Detail
{String}
getLabel()
Since:
2.0
Retrieves the current label text of the elment.
- Returns:
- {String} The current label text.
{CKFinder.ui.dialog.labeledElement}
setLabel(label)
Since:
2.0
Sets the label text of the element.
- Parameters:
- {String} label
- The new label text.
- Returns:
- {CKFinder.ui.dialog.labeledElement} The current labeled element.