Class CKFinder.ui.dialog.textInput
Extends
CKFinder.ui.dialog.labeledElement.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
CKFinder.ui.dialog.textInput(dialog, elementDefinition, htmlList)
A text input with a label.
|
| Method Attributes | Method Name and Description |
|---|---|
|
Handler for the text input's access key up event.
|
|
|
focus()
Puts focus into the text input.
|
|
|
Gets the text input DOM element under this UI object.
|
|
|
select()
Selects all the text in the text input.
|
|
|
setValue(value)
Sets the value of this text input object.
|
- Methods borrowed from class CKFinder.ui.dialog.labeledElement:
- getLabel, setLabel
- Methods borrowed from class CKFinder.ui.dialog.uiElement:
- disable, enable, getDialog, getElement, getValue, isChanged, isEnabled, isVisible, selectParentTab
Class Detail
CKFinder.ui.dialog.textInput(dialog, elementDefinition, htmlList)
Since:
2.0
A text input with a label. This UI element class represents both the
single-line text inputs and password inputs in dialog boxes.
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 text input to a dialog, check CKFinder.dialog.definition.textInput.
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:
- default (Optional) The default value.
- validate (Optional) The validation function.
- maxLength (Optional) The maximum length of text box contents.
- size (Optional) The size of the text box. This is usually overridden by the size defined by the skin, however.
- {Array} htmlList
- List of HTML code to output to.
Method Detail
{Undefined}
accessKeyUp()
Since:
2.0
Handler for the text input's access key up event. Makes a select()
call to the text input.
{Undefined}
focus()
Since:
2.0
Puts focus into the text input.
{CKFinder.dom.element}
getInputElement()
Since:
2.0
Gets the text input DOM element under this UI object.
- Returns:
- {CKFinder.dom.element} The DOM element of the text input.
{Undefined}
select()
Since:
2.0
Selects all the text in the text input.
{CKFinder.ui.dialog.textInput}
setValue(value)
Since:
2.0
Sets the value of this text input object.
uiElement.setValue( 'Blamo' );
- Parameters:
- {Object} value
- The new value.
- Returns:
- {CKFinder.ui.dialog.textInput} The current UI element.