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

CKEDITOR.dom.window

class
See source

Represents a DOM window.

var document = new CKEDITOR.dom.window( window );

Filtering

Properties

  • readonly inherited

    $ : Object

    See source

    The native DOM object represented by this class instance.

    var element = new CKEDITOR.dom.element( 'span' );
alert( element.$.nodeType ); // '1'

Static properties

Methods

  • inherited

    constructor( nativeDomObject ) → domObject

    See source

    Creates a domObject class instance.

    Parameters

    nativeDomObject : Object

    A native DOM object.

    Returns

    domObject

  • inherited

    capture()

    See source

    Register event handler under the capturing stage on supported target.

  • inherited

    clearCustomData()

    See source

    Removes any data stored in this object. To avoid memory leaks we must assure that there are no references left after the object is no longer needed.

  • inherited

    define( name, meta )

    See source

    Predefine some intrinsic properties on a specific event name.

    Parameters

    name : String

    The event name

    meta : Object

  • inherited

    equals( object ) → Boolean

    See source

    Determines whether the specified object is equal to the current object.

    var doc = new CKEDITOR.dom.document( document );
alert( doc.equals( CKEDITOR.document ) );   // true
alert( doc == CKEDITOR.document );          // false

    Parameters

    object : Object

    The object to compare with the current object.

    Returns

    Boolean

    true if the object is equal.

  • inherited

    fire( eventName, [ data ], [ editor ] ) → Boolean | Object

    See source

    Fires an specific event in the object. All registered listeners are called at this point.

    someObject.on( 'someEvent', function() { ... } );
someObject.on( 'someEvent', function() { ... } );
someObject.fire( 'someEvent' );             // Both listeners are called.

someObject.on( 'someEvent', function( event ) {
    alert( event.data );                    // 'Example'
} );
someObject.fire( 'someEvent', 'Example' );

    Parameters

    eventName : String

    The event name to fire.

    [ data ] : Object

    Data to be sent as the CKEDITOR.eventInfo.data when calling the listeners.

    [ editor ] : editor

    The editor instance to send as the CKEDITOR.eventInfo.editor when calling the listener.

    Returns

    Boolean | Object

    A boolean indicating that the event is to be canceled, or data returned by one of the listeners.

  • inherited

    fireOnce( eventName, [ data ], [ editor ] ) → Boolean | Object

    See source

    Fires an specific event in the object, releasing all listeners registered to that event. The same listeners are not called again on successive calls of it or of fire.

    someObject.on( 'someEvent', function() { ... } );
someObject.fire( 'someEvent' );         // Above listener called.
someObject.fireOnce( 'someEvent' );     // Above listener called.
someObject.fire( 'someEvent' );         // No listeners called.

    Parameters

    eventName : String

    The event name to fire.

    [ data ] : Object

    Data to be sent as the CKEDITOR.eventInfo.data when calling the listeners.

    [ editor ] : editor

    The editor instance to send as the CKEDITOR.eventInfo.editor when calling the listener.

    Returns

    Boolean | Object

    A booloan indicating that the event is to be canceled, or data returned by one of the listeners.

  • focus()

    See source

    Moves the selection focus to this window.

    var win = new CKEDITOR.dom.window( window );
win.focus();

  • inherited

    getCustomData( key ) → Object

    See source

    Gets the value set to a data slot in this object.

    var element = new CKEDITOR.dom.element( 'span' );
alert( element.getCustomData( 'hasCustomData' ) );      // e.g. 'true'
alert( element.getCustomData( 'nonExistingKey' ) );     // null

    Parameters

    key : String

    The key used to identify the data slot.

    Returns

    Object

    This value set to the data slot.

  • getFrame() → element

    See source

    Gets the frame element containing this window context.

    Returns

    element

    The frame element or null if not in a frame context.

  • inherited

    getPrivate() → Object

    See source

    Gets the private _ object which is bound to the native DOM object using getCustomData.

    var elementA = new CKEDITOR.dom.element( nativeElement );
elementA.getPrivate().value = 1;
...
var elementB = new CKEDITOR.dom.element( nativeElement );
elementB.getPrivate().value; // 1

    Returns

    Object

    The private object.

  • getScrollPosition() → Object

    See source

    Gets the current position of the window's scroll.

    var win = new CKEDITOR.dom.window( window );
var pos = win.getScrollPosition();
alert( pos.x );
alert( pos.y );

    Returns

    Object

    An object with the x and y properties containing the scroll position.

  • inherited

    getUniqueId() → Number

    See source

    Gets an ID that can be used to identify this DOM object in the running session.

    Note: This method does not work on text nodes prior to Internet Explorer 9.

    Returns

    Number

    A unique ID.

  • getViewPaneSize() → Object

    See source

    Gets the width and height of this window's viewable area.

    var win = new CKEDITOR.dom.window( window );
var size = win.getViewPaneSize();
alert( size.width );
alert( size.height );

    Returns

    Object

    An object with the width and height properties containing the size.

  • inherited

    hasListeners( eventName ) → Boolean

    See source

    Checks if there is any listener registered to a given event.

    var myListener = function() { ... };
someObject.on( 'someEvent', myListener );
alert( someObject.hasListeners( 'someEvent' ) );    // true
alert( someObject.hasListeners( 'noEvent' ) );      // false

    Parameters

    eventName : String

    The event name.

    Returns

    Boolean

  • inherited

    on( eventName, listenerFunction, [ scopeObj ], [ listenerData ], [ priority ] ) → Object

    See source

    Registers a listener to a specific event in the current object.

    someObject.on( 'someEvent', function() {
    alert( this == someObject );        // true
} );

someObject.on( 'someEvent', function() {
    alert( this == anotherObject );     // true
}, anotherObject );

someObject.on( 'someEvent', function( event ) {
    alert( event.listenerData );        // 'Example'
}, null, 'Example' );

someObject.on( 'someEvent', function() { ... } );                       // 2nd called
someObject.on( 'someEvent', function() { ... }, null, null, 100 );      // 3rd called
someObject.on( 'someEvent', function() { ... }, null, null, 1 );        // 1st called

    Note: CKEditor's event system has a limitation that one function cannot be used as a listener for the same event more than once. Hence, to reuse it with multiple listeners, it should be wrapped into additional wrapper function:

    function listener( evt ) { ... };

someObject.on( 'someEvent', function() {
    listener();
} );

someObject.on( 'someEvent', function( evt ) {
    listener( evt );
} );

    Parameters

    eventName : String

    The event name to which listen.

    listenerFunction : Function

    The function listening to the event. A single CKEDITOR.eventInfo object instanced is passed to this function containing all the event data.

    [ scopeObj ] : Object

    The object used to scope the listener call (the this object). If omitted, the current object is used.

    [ listenerData ] : Object

    Data to be sent as the CKEDITOR.eventInfo.listenerData when calling the listener.

    [ priority ] : Number

    The listener priority. Lower priority listeners are called first. Listeners with the same priority value are called in registration order.

    Defaults to 10

    Returns

    Object

    An object containing the removeListener function, which can be used to remove the listener at any time.

  • inherited

    once()

    See source

    Similiar with on but the listener will be called only once upon the next event firing.

    CKEDITOR.event.on

  • inherited

    removeAllListeners()

    See source

    Removes any listener set on this object.

    To avoid memory leaks we must assure that there are no references left after the object is no longer needed.

  • inherited

    removeCustomData( key ) → Object

    See source

    Removes the value in the data slot under the given key.

    Parameters

    key : String

    Returns

    Object

    Removed value or null if not found.

  • inherited

    removeListener( eventName, listenerFunction )

    See source

    Unregisters a listener function from being called at the specified event. No errors are thrown if the listener has not been registered previously.

    var myListener = function() { ... };
someObject.on( 'someEvent', myListener );
someObject.fire( 'someEvent' );                 // myListener called.
someObject.removeListener( 'someEvent', myListener );
someObject.fire( 'someEvent' );                 // myListener not called.

    Parameters

    eventName : String

    The event name.

    listenerFunction : Function

    The listener function to unregister.

  • chainable inherited

    setCustomData( key, value ) → domObject

    See source

    Sets a data slot value for this object. These values are shared by all instances pointing to that same DOM object.

    Note: The created data slot is only guaranteed to be available on this unique DOM node, thus any wish to continue access to it from other element clones (either created by clone node or from innerHtml) will fail. For such usage please use CKEDITOR.dom.element.setAttribute instead.

    Note: This method does not work on text nodes prior to Internet Explorer 9.

    var element = new CKEDITOR.dom.element( 'span' );
element.setCustomData( 'hasCustomData', true );

    Parameters

    key : String

    A key used to identify the data slot.

    value : Object

    The value to set to the data slot.

    Returns

    domObject

    This DOM object instance.

Static methods

  • mixed static

    implementOn( targetObject )

    See source

    Implements the CKEDITOR.event features in an object.

    var myObject = { message: 'Example' };
CKEDITOR.event.implementOn( myObject );

myObject.on( 'testEvent', function() {
    alert( this.message );
} );
myObject.fire( 'testEvent' ); // 'Example'

    Parameters

    targetObject : Object

    The object into which implement the features.