Package org.eclipse.jface.action
Class ToolBarManager
java.lang.Object
org.eclipse.jface.action.ContributionManager
org.eclipse.jface.action.ToolBarManager
- All Implemented Interfaces:
IContributionManager
,IToolBarManager
A tool bar manager is a contribution manager which realizes itself and its
items in a tool bar control.
This class may be instantiated; it may also be subclassed if a more sophisticated layout is required.
-
Constructor Summary
ConstructorDescriptionCreates a new tool bar manager with the default SWT button style.ToolBarManager
(int style) Creates a tool bar manager with the given SWT button style.ToolBarManager
(ToolBar toolbar) Creates a tool bar manager for an existing tool bar control. -
Method Summary
Modifier and TypeMethodDescriptioncreateControl
(Composite parent) Creates and returns this manager's tool bar control.void
dispose()
Disposes of this tool bar manager and frees all allocated SWT resources.Returns the context menu manager for this tool bar manager.Returns the tool bar control for this manager.protected void
Re-lays out the tool bar.void
setContextMenuManager
(MenuManager contextMenuManager) Sets the context menu manager for this tool bar manager to the given menu manager.void
setStyle
(int style) Sets SWT button style for new tool bar controls created in thecreateControl(Composite)
method.void
update
(boolean force) Updates this manager's underlying widget(s) with any changes which have been made to it or its items.Methods inherited from class org.eclipse.jface.action.ContributionManager
add, add, allowItem, appendToGroup, appendToGroup, dumpStatistics, find, getItems, getOverrides, getSize, hasDynamicItems, indexOf, indexOf, insert, insertAfter, insertAfter, insertBefore, insertBefore, internalSetItems, isDirty, isEmpty, itemAdded, itemRemoved, markDirty, prependToGroup, prependToGroup, remove, remove, removeAll, replaceItem, setDirty, setOverrides
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.eclipse.jface.action.IContributionManager
add, add, appendToGroup, appendToGroup, find, getItems, getOverrides, insertAfter, insertAfter, insertBefore, insertBefore, isDirty, isEmpty, markDirty, prependToGroup, prependToGroup, remove, remove, removeAll
-
Constructor Details
-
ToolBarManager
public ToolBarManager()Creates a new tool bar manager with the default SWT button style. Use thecreateControl(Composite)
method to create the tool bar control. -
ToolBarManager
public ToolBarManager(int style) Creates a tool bar manager with the given SWT button style. Use thecreateControl
method to create the tool bar control.- Parameters:
style
- the tool bar item style- See Also:
-
ToolBarManager
Creates a tool bar manager for an existing tool bar control. This manager becomes responsible for the control, and will dispose of it when the manager is disposed. NOTE When creating a ToolBarManager from an existingToolBar
you will not get the accessible listener provided by JFace.- Parameters:
toolbar
- the tool bar control- See Also:
-
-
Method Details
-
setStyle
public void setStyle(int style) Sets SWT button style for new tool bar controls created in thecreateControl(Composite)
method. It does not affect already existing tool bar control.- Parameters:
style
- the tool bar item style- Since:
- 3.10
-
createControl
Creates and returns this manager's tool bar control. Does not create a new control if one already exists and is not disposed. Also create anAccessibleListener
for theToolBar
.- Parameters:
parent
- the parent control- Returns:
- the tool bar control
-
dispose
public void dispose()Disposes of this tool bar manager and frees all allocated SWT resources. Notifies all contribution items of the dispose. Note that this method does not clean up references between this tool bar manager and its associated contribution items. UseremoveAll
for that purpose. -
getControl
Returns the tool bar control for this manager.- Returns:
- the tool bar control, or
null
if none (before creating or after disposal)
-
relayout
Re-lays out the tool bar.The default implementation of this framework method re-lays out the parent when the number of items are different and the new count != 0
- Parameters:
layoutBar
- the tool bar controloldCount
- the old number of itemsnewCount
- the new number of items
-
update
public void update(boolean force) Description copied from interface:IContributionManager
Updates this manager's underlying widget(s) with any changes which have been made to it or its items. Normally changes to a contribution manager merely mark it as dirty, without updating the underlying widgets. This brings the underlying widgets up to date with any changes.- Specified by:
update
in interfaceIContributionManager
- Parameters:
force
-true
means update even if not dirty, andfalse
for normal incremental updating
-
getContextMenuManager
Returns the context menu manager for this tool bar manager.- Returns:
- the context menu manager, or
null
if none - Since:
- 3.0
-
setContextMenuManager
Sets the context menu manager for this tool bar manager to the given menu manager. If the tool bar control exists, it also adds the menu control to the tool bar.- Parameters:
contextMenuManager
- the context menu manager, ornull
if none- Since:
- 3.0
-