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

CKEDITOR.plugins.balloontoolbar.context

class
See source

A class representing a single balloon toolbar context in the editor.

It can be configured with various conditions for showing up the toolbar using the options parameter.

Multiple contexts are handled by the context manager.

Filtering

Properties

  • editor : editor

    See source

    An editor instance.

  • options : contextDefinition

    See source

    Options passed to the constructor.

  • toolbar : balloonToolbar

    See source

    Toolbar instance pointed by context.

Methods

  • since 4.8.0

    constructor( editor, options ) → context

    See source

    Creates a balloon toolbar context instance.

    Parameters

    editor : editor

    The editor instance for which the toolbar is created.

    options : contextDefinition

    A set of options defining the context behavior.

    Returns

    context

  • destroy()

    See source

    Destroys the toolbar maintained by this context.

  • hide()

    See source

    Hides the toolbar controlled by this context.

  • refresh()

    See source

    Refreshes the toolbar state attached to this context.

  • show( [ pointedElement ] )

    See source

    Shows the toolbar controlled by this context.

    Parameters

    [ pointedElement ] : element

    An element that should be pointed by the balloon toolbar.

  • private

    _loadButtons()

    See source

    Loads a button from options.buttons.

  • private

    _matchElement( elem ) → element | null

    See source

    Checks if a given element matches the options.cssSelector selector.

    Parameters

    elem : element

    An element to be tested.

    Returns

    element | null

    CKEDITOR.dom.element instance if an element was matched, null otherwise.

  • private

    _matchRefresh( path, selection ) → element | null

    See source

    Performs matching against options.refresh.

    Parameters

    path : elementPath

    The element path to be checked.

    selection : selection

    The selection object to be passed to the refresh function.

    Returns

    element | null

    Returns a CKEDITOR.dom.element if matched by options.refresh, null otherwise.

  • private

    _matchWidget() → element | null

    See source

    Checks if any of the options.widgets widgets is currently focused.

    Returns

    element | null

    Returns a CKEDITOR.dom.element instance that the toolbar should point to if any matched widget is focused. Returns false otherwise, which means that no tracked widget was matched.