Class CKEDITOR.ui.dialog.file
Extends
CKEDITOR.ui.dialog.labeledElement.
Defined in: plugins/dialogui/plugin.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
CKEDITOR.ui.dialog.file(dialog, elementDefinition, htmlList)
A file upload input.
|
| Field Attributes | Field Name and Description |
|---|---|
|
Defines the onChange event for UI element definitions.
|
| Method Attributes | Method Name and Description |
|---|---|
|
Get the action assigned to the form.
|
|
|
Gets the <input> element of this file input.
|
|
|
getValue()
|
|
|
registerEvents(definition)
The events must be applied on the inner input element, and
that must be done when the iframe & form has been loaded
|
|
|
reset()
Redraws the file input and resets the file path in the file input.
|
|
|
The default value of input type="file" is an empty string, but during initialization
of this UI element, the iframe still isn't ready so it can't be read from that object
Setting it manually prevents later issues about the current value ("") being different
of the initial value (undefined as it asked for .value of a div)
|
|
|
submit()
Uploads the file in the file input.
|
- Methods borrowed from class CKEDITOR.ui.dialog.labeledElement:
- getLabel, setLabel
- Methods borrowed from class CKEDITOR.ui.dialog.uiElement:
- accessKeyDown, accessKeyUp, disable, enable, focus, getDialog, getElement, isChanged, isEnabled, isFocusable, isVisible, selectParentTab, setValue
- Events borrowed from class CKEDITOR.ui.dialog.uiElement:
- change
Class Detail
CKEDITOR.ui.dialog.file(dialog, elementDefinition, htmlList)
Since:
3.0
A file upload input.
- Parameters:
- {CKEDITOR.dialog} dialog
- Parent dialog object.
- {CKEDITOR.dialog.definition.uiElement} elementDefinition
- The element definition. Accepted fields:
- validate (Optional) The validation function.
- {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
{String}
getAction()
Since:
3.0
Get the action assigned to the form.
- Returns:
- {String} The value of the action.
{CKEDITOR.dom.element}
getInputElement()
Since:
3.0
Gets the <input> element of this file input.
- Returns:
- {CKEDITOR.dom.element} The file input element.
{Undefined}
getValue()
Since:
3.0
NO EXAMPLE AVAILABLE
{Undefined}
registerEvents(definition)
Since:
3.0
The events must be applied on the inner input element, and
that must be done when the iframe & form has been loaded
NO EXAMPLE AVAILABLE
- Parameters:
- {Undefined} definition
{Undefined}
reset()
Since:
3.0
Redraws the file input and resets the file path in the file input.
The redraw logic is necessary because non-IE browsers tend to clear
the <iframe> containing the file input after closing the dialog.
{Undefined}
setInitValue()
Since:
3.0
The default value of input type="file" is an empty string, but during initialization
of this UI element, the iframe still isn't ready so it can't be read from that object
Setting it manually prevents later issues about the current value ("") being different
of the initial value (undefined as it asked for .value of a div)
NO EXAMPLE AVAILABLE
{CKEDITOR.ui.dialog.file}
submit()
Since:
3.0
Uploads the file in the file input.
- Returns:
- {CKEDITOR.ui.dialog.file} This object.