CKEditor Ecosystem Documentation
Search
Report an issue
Home/CKEditor 4/API
Class

CKEDITOR.ui.dialog.file

class
See source

A file upload input.

Filtering

Properties

  • eventProcessors : Object

    Defines the onChange event for UI element definitions.

    See source

Methods

  • constructor( dialog, elementDefinition, htmlList ) → file

    Creates a file class instance.

    See source

    Parameters

    dialog : dialog

    Parent dialog window object.

    elementDefinition : uiElement

    The element definition. Accepted fields:

    • validate (Optional) The validation function.
    htmlList : Array

    List of HTML code to output to.

    Returns

    file

  • accessKeyDown( dialog, key )

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

    See source

    Can be overridded in child classes for more sophisticaed behavior.

    Parameters

    dialog : 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.

  • accessKeyUp( dialog, key )

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

    See source

    Can be overridded in child classes for more sophisticated behavior.

    Parameters

    dialog : 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.

  • disable()

    Disables a UI element.

    See source

  • enable()

    Enables a UI element.

    See source

  • focus() → uiElement

    chainable

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

    See source
    uiElement.focus();

    Returns

    uiElement

    this

  • getAction() → String

    Gets the action assigned to the form.

    See source

    Returns

    String

    The value of the action.

  • getDialog() → dialog

    Gets the parent dialog object containing this UI element.

    See source
    var dialog = uiElement.getDialog();

    Returns

    dialog

    Parent dialog object.

  • getElement() → element

    Gets the root DOM element of this dialog UI object.

    See source
    uiElement.getElement().hide();

    Returns

    element

    Root DOM element of UI object.

  • getInputElement() → element

    Gets the <input> element of this file input.

    See source

    Returns

    element

    The file input element.

  • getLabel() → String

    Retrieves the current label text of the elment.

    See source

    Returns

    String

    The current label text.

  • getValue() → Object

    Gets the current value of this dialog UI object.

    See source
    var myValue = uiElement.getValue();

    Returns

    Object

    The current value.

  • isChanged() → Boolean

    Tells whether the UI object's value has changed.

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

    Returns

    Boolean

    true if changed, false if not changed.

  • isEnabled() → Boolean

    Determines whether an UI element is enabled or not.

    See source

    Returns

    Boolean

    Whether the UI element is enabled.

  • isFocusable() → Boolean

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

    See source

    Returns

    Boolean

    Whether the UI element can be focused.

  • isVisible() → Boolean

    Determines whether an UI element is visible or not.

    See source

    Returns

    Boolean

    Whether the UI element is visible.

  • registerEvents( definition ) → file

    chainable

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

    See source

    Parameters

    definition : Object

    Returns

    file

    this

  • reset()

    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.

    See source

  • selectParentTab() → uiElement

    chainable

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

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

    Returns

    uiElement

    this

  • setInitValue()

    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).

    See source

  • setLabel( label ) → labeledElement

    chainable

    Sets the label text of the element.

    See source

    Parameters

    label : String

    The new label text.

    Returns

    labeledElement

    The current labeled element.

  • setValue( value, noChangeEvent ) → uiElement

    chainable

    Sets the value of this dialog UI object.

    See source
    uiElement.setValue( 'Dingo' );

    Parameters

    value : Object

    The new value.

    noChangeEvent : Boolean

    Internal commit, to supress change event on this element.

    Returns

    uiElement

    this

  • submit() → file

    chainable

    Uploads the file in the file input.

    See source

    Returns

    file

    This object.

Events

  • change( evt )

    Fired when the value of the uiElement is changed.

    See source

    Parameters

    evt : eventInfo