Code Index | File Index

Namespaces

Classes


Class CKEDITOR.ui.dialog.textInput


Extends CKEDITOR.ui.dialog.labeledElement.
Defined in: plugins/dialogui/plugin.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
CKEDITOR.ui.dialog.textInput(dialog, elementDefinition, htmlList)
A text input with a label.
Fields borrowed from class CKEDITOR.ui.dialog.labeledElement:
eventProcessors
Method Summary
Method Attributes Method Name and Description
 
Handler for the text input's access key up event.
 
Puts focus into the text input.
 
Gets the text input DOM element under this UI object.
 
Selects all the text in the text input.
 
setValue(value)
Sets the value of this text input object.
Methods borrowed from class CKEDITOR.ui.dialog.labeledElement:
getLabel, setLabel
Methods borrowed from class CKEDITOR.ui.dialog.uiElement:
accessKeyDown, disable, enable, getDialog, getElement, getValue, isChanged, isEnabled, isFocusable, isVisible, registerEvents, selectParentTab
Events borrowed from class CKEDITOR.ui.dialog.uiElement:
change
Class Detail
CKEDITOR.ui.dialog.textInput(dialog, elementDefinition, htmlList)
Since: 3.0
A text input with a label. This UI element class represents both the single-line text inputs and password inputs in dialog boxes.
Parameters:
{CKEDITOR.dialog} dialog
Parent dialog object.
{CKEDITOR.dialog.definition.uiElement} 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: 3.0
Handler for the text input's access key up event. Makes a select() call to the text input.

{Undefined} focus()
Since: 3.0
Puts focus into the text input.

{CKEDITOR.dom.element} getInputElement()
Since: 3.0
Gets the text input DOM element under this UI object.
Returns:
{CKEDITOR.dom.element} The DOM element of the text input.

{Undefined} select()
Since: 3.0
Selects all the text in the text input.

{CKEDITOR.ui.dialog.textInput} setValue(value)
Since: 3.0
Sets the value of this text input object.
uiElement.setValue( 'Blamo' );
Parameters:
{Object} value
The new value.
Returns:
{CKEDITOR.ui.dialog.textInput} The current UI element.

Copyright © 2003-2010, CKSource - Frederico Knabben. All rights reserved.