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

CKEDITOR.ui.floatPanel

class
See source

Represents a floating panel UI element.

It is reused by rich combos, color combos, menus, etc. and it renders its content using CKEDITOR.ui.panel.

Filtering

Methods

  • constructor( editor, parentElement, definition, level ) → floatPanel

    Creates a floatPanel class instance.

    See source

    Parameters

    editor : editor
    parentElement : element
    definition : Object

    Definition of the panel that will be floating.

    level : Number

    Returns

    floatPanel

  • addBlock( name, block )

    See source

    Parameters

    name : Object
    block : Object

  • addListBlock( name, multiSelect )

    See source

    Parameters

    name : Object
    multiSelect : Object

  • allowBlur( allow )

    See source

    Parameters

    allow : Object

  • blur()

    See source

  • focus()

    Restores the last focused element or simply focuses the panel window.

    See source

  • getBlock( name )

    See source

    Parameters

    name : Object

  • hide( returnFocus )

    Hides the panel.

    See source

    Parameters

    returnFocus : Object

  • hideChild( restoreFocus )

    See source

    Parameters

    restoreFocus : Object

  • reposition()

    since 4.5.4

    Repositions the panel with the same parameters that were used in the last showBlock call.

    See source

  • showAsChild( panel, blockName, offsetParent, corner, [ offsetX ], [ offsetY ] )

    Shows the specified panel as a child of one block of this one.

    See source

    Parameters

    panel : floatPanel
    blockName : String
    offsetParent : element

    Positioned parent.

    corner : Number
    • For LTR (left to right) oriented editor:
      • 1 = top-left
      • 2 = top-right
      • 3 = bottom-right
      • 4 = bottom-left
    • For RTL (right to left):
      • 1 = top-right
      • 2 = top-left
      • 3 = bottom-left
      • 4 = bottom-right
    [ offsetX ] : Number

    Defaults to 0

    [ offsetY ] : Number

    Defaults to 0

  • showBlock( name, offsetParent, corner, [ offsetX ], [ offsetY ], [ callback ] )

    Shows the panel block.

    See source

    Parameters

    name : String
    offsetParent : element

    Positioned parent.

    corner : Number
    • For LTR (left to right) oriented editor:
      • 1 = top-left
      • 2 = top-right
      • 3 = bottom-right
      • 4 = bottom-left
    • For RTL (right to left):
      • 1 = top-right
      • 2 = top-left
      • 3 = bottom-left
      • 4 = bottom-right
    [ offsetX ] : Number

    Defaults to 0

    [ offsetY ] : Number

    Defaults to 0

    [ callback ] : Function

    A callback function executed when block positioning is done. what do exactly these params mean (especially corner)?