CKEditor 4 Documentation

CKEDITOR.ui.dialog.file

Hierarchy

Files

A file upload input.

Defined By

Properties

CKEDITOR.ui.dialog.file
view source
: Object

Defines the onChange event for UI element definitions.

Defines the onChange event for UI element definitions.

Overrides: CKEDITOR.ui.dialog.labeledElement.eventProcessors

Defined By

Methods

CKEDITOR.ui.dialog.file
view source
new( dialog, elementDefinition, htmlList ) : CKEDITOR.ui.dialog.file
Creates a file class instance. ...

Creates a file class instance.

Parameters

Returns

Overrides: CKEDITOR.ui.dialog.labeledElement.constructor

The default handler for a UI element's access key down event, which tries to put focus to the UI element. ...

The default handler for a UI element's access key down event, which tries to put focus to the UI element.

Can be overridded in child classes for more sophisticaed behavior.

Parameters

  • dialog : CKEDITOR.dialog

    The parent dialog object.

  • key : String

    The key combination pressed. Since access keys are defined to always include the CTRL key, its value should always include a 'CTRL+' prefix.

The default handler for a UI element's access key up event, which does nothing. ...

The default handler for a UI element's access key up event, which does nothing.

Can be overridded in child classes for more sophisticated behavior.

Parameters

  • dialog : CKEDITOR.dialog

    The parent dialog object.

  • key : String

    The key combination pressed. Since access keys are defined to always include the CTRL key, its value should always include a 'CTRL+' prefix.

Disables a UI element. ...

Disables a UI element.

Enables a UI element. ...

Enables a UI element.

Puts the focus to the UI object. ...

Puts the focus to the UI object. Switches tabs if the UI object isn't in the active tab page.

uiElement.focus();

Returns

CKEDITOR.ui.dialog.file
view source
( ) : String
Gets the action assigned to the form. ...

Gets the action assigned to the form.

Returns

  • String

    The value of the action.

Gets the parent dialog object containing this UI element. ...

Gets the parent dialog object containing this UI element.

var dialog = uiElement.getDialog();

Returns

Gets the root DOM element of this dialog UI object. ...

Gets the root DOM element of this dialog UI object.

uiElement.getElement().hide();

Returns

Gets the <input> element of this file input. ...

Gets the <input> element of this file input.

Returns

Overrides: CKEDITOR.ui.dialog.uiElement.getInputElement

Retrieves the current label text of the elment. ...

Retrieves the current label text of the elment.

Returns

  • String

    The current label text.

Gets the current value of this dialog UI object. ...

Gets the current value of this dialog UI object.

var myValue = uiElement.getValue();

Returns

  • Object

    The current value.

Tells whether the UI object's value has changed. ...

Tells whether the UI object's value has changed.

if ( uiElement.isChanged() )
    confirm( 'Value changed! Continue?' );

Returns

  • Boolean

    true if changed, false if not changed.

Determines whether an UI element is enabled or not. ...

Determines whether an UI element is enabled or not.

Returns

  • Boolean

    Whether the UI element is enabled.

Determines whether an UI element is focus-able or not. ...

Determines whether an UI element is focus-able or not. Focus-able is defined as being both visible and enabled.

Returns

  • Boolean

    Whether the UI element can be focused.

Determines whether an UI element is visible or not. ...

Determines whether an UI element is visible or not.

Returns

  • Boolean

    Whether the UI element is visible.

CKEDITOR.ui.dialog.file
view source
( definition ) : CKEDITOR.ui.dialog.filechainable
The events must be applied to the inner input element, and this must be done when the iframe and form have been loaded. ...

The events must be applied to the inner input element, and this must be done when the iframe and form have been loaded.

Parameters

  • definition : Object

Returns

Overrides: CKEDITOR.ui.dialog.uiElement.registerEvents

CKEDITOR.ui.dialog.file
view source
( )
Redraws the file input and resets the file path in the file input. ...

Redraws the file input and resets the file path in the file input. The redrawing logic is necessary because non-IE browsers tend to clear the <iframe> containing the file input after closing the dialog window.

Selects the parent tab of this element. ...

Selects the parent tab of this element. Usually called by focus() or overridden focus() methods.

focus : function() {
    this.selectParentTab();
    // do something else.
}

Returns

CKEDITOR.ui.dialog.file
view source
( )
The default value of input type="file" is an empty string, but during the initialization of this UI element, the ifra...

The default value of input type="file" is an empty string, but during the initialization of this UI element, the iframe still is not ready so it cannot be read from that object. Setting it manually prevents later issues with the current value ('') being different than the initial value (undefined as it asked for .value of a div).

Sets the label text of the element. ...

Sets the label text of the element.

Parameters

  • label : String

    The new label text.

Returns

Sets the value of this dialog UI object. ...

Sets the value of this dialog UI object.

uiElement.setValue( 'Dingo' );

Parameters

  • value : Object

    The new value.

  • noChangeEvent : Boolean

    Internal commit, to supress change event on this element.

Returns

CKEDITOR.ui.dialog.file
view source
( ) : CKEDITOR.ui.dialog.filechainable
Uploads the file in the file input. ...

Uploads the file in the file input.

Returns

Defined By

Events

Fired when the value of the uiElement is changed. ...

Fired when the value of the uiElement is changed.

Parameters