com.ephox.editlive.ephoxaction.toolbar
Interface InlineToolbar

public interface InlineToolbar

Toolbar that renders inside the editor, attaching itself to elements. Created using ToolbarFactory.createInlineToolbar(EphoxAction,boolean).

Since:

7.5

Method Summary

void	hideToolbar() Hides the toolbar.
boolean	isVisible()
void	repositionAtCurrentPoint() Updates the toolbar position using the element bounds cache.
void	showToolbar() Shows the toolbar and calls repositionAtCurrentPoint().
void	updateBounds(Element elem) Updates the element bounds cache stored by the toolbar.

Method Detail

updateBounds

void updateBounds(Element elem)

Updates the element bounds cache stored by the toolbar.

Parameters:

elem - element the toolbar will be displayed next to

repositionAtCurrentPoint

void repositionAtCurrentPoint()

Updates the toolbar position using the element bounds cache.

Horizontally, the toolbar position is left aligned to the element bounds. If left aligning would cause the toolbar to render partially off the right side of the editor, it becomes right aligned 5px from the right side of the editor.

Vertically, the position behaviour depends on the value of the stickToTop parameter passed to ToolbarFactory.createInlineToolbar(EphoxAction,boolean):

• stickToTop false (eg Inline Image Toolbar):
  • When there is enough room, 5px above view and scrolls editor to make the toolbar visible
  • When there is not enough room above, 5px below view
• stickToTop true (eg Inline Table Toolbar):
  • When there is enough room, 5px above the view (does not scroll the editor)
  • When there is not enough room above, 5px below the top of the editor (overlapping the view)

Automatically called when a button on the toolbar is clicked.

hideToolbar

void hideToolbar()

Hides the toolbar.

showToolbar

void showToolbar()

Shows the toolbar and calls repositionAtCurrentPoint().

isVisible

boolean isVisible()

Returns:

true if the toolbar is currently visible