Package org.eclipse.jface.action
Class SubCoolBarManager
java.lang.Object
org.eclipse.jface.action.SubContributionManager
org.eclipse.jface.action.SubCoolBarManager
- All Implemented Interfaces:
IContributionManager,ICoolBarManager
A
SubCoolBarManager monitors the additional and removal of
items from a parent manager so that visibility of the entire set can be changed as a
unit.- Since:
- 3.0
-
Field Summary
Fields inherited from interface org.eclipse.jface.action.ICoolBarManager
SIZE -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidadd(IToolBarManager toolBarManager) A convenience method to add a tool bar as a contribution item to this cool bar manager.Returns the context menu manager used by this cool bar manager.booleanReturns whether the layout of the underlying cool bar widget is locked.protected final ICoolBarManagerReturns the parent cool bar manager that this sub-manager contributes to.intgetStyle()Returns the style of the underlying cool bar widget.voidsetContextMenuManager(IMenuManager menuManager) Sets the context menu of this cool bar manager to the given menu manager.voidsetLockLayout(boolean value) Locks or unlocks the layout of the underlying cool bar widget.voidupdate(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.SubContributionManager
add, add, appendToGroup, appendToGroup, disposeManager, find, getItems, getOverrides, getParent, insertAfter, insertAfter, insertBefore, insertBefore, isDirty, isEmpty, isVisible, itemAdded, itemRemoved, items, markDirty, prependToGroup, prependToGroup, remove, remove, removeAll, setVisible, unwrap, wrapMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods 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
-
SubCoolBarManager
Constructs a new manager.- Parameters:
mgr- the parent manager. All contributions made to theSubCoolBarManagerare forwarded and appear in the parent manager.
-
-
Method Details
-
add
Description copied from interface:ICoolBarManagerA convenience method to add a tool bar as a contribution item to this cool bar manager. Equivalent toadd(new ToolBarContributionManager(toolBarManager)).- Specified by:
addin interfaceICoolBarManager- Parameters:
toolBarManager- the tool bar manager to be added- See Also:
-
getStyle
public int getStyle()Description copied from interface:ICoolBarManagerReturns the style of the underlying cool bar widget.- Specified by:
getStylein interfaceICoolBarManager- Returns:
- the style of the cool bar
-
getParentCoolBarManager
Returns the parent cool bar manager that this sub-manager contributes to.- Returns:
- the parent cool bar manager
-
getLockLayout
public boolean getLockLayout()Description copied from interface:ICoolBarManagerReturns whether the layout of the underlying cool bar widget is locked.- Specified by:
getLockLayoutin interfaceICoolBarManager- Returns:
trueif cool bar layout is locked,falseotherwise
-
setLockLayout
public void setLockLayout(boolean value) Description copied from interface:ICoolBarManagerLocks or unlocks the layout of the underlying cool bar widget. Once the cool bar is locked, cool items cannot be repositioned by the user.Note that items can be added or removed programmatically even while the cool bar is locked.
- Specified by:
setLockLayoutin interfaceICoolBarManager- Parameters:
value-trueto lock the cool bar,falseto unlock
-
getContextMenuManager
Description copied from interface:ICoolBarManagerReturns the context menu manager used by this cool bar manager. This context menu manager is used by the cool bar manager except for cool items that provide their own.- Specified by:
getContextMenuManagerin interfaceICoolBarManager- Returns:
- the context menu manager, or
nullif none - See Also:
-
setContextMenuManager
Description copied from interface:ICoolBarManagerSets the context menu of this cool bar manager to the given menu manager.- Specified by:
setContextMenuManagerin interfaceICoolBarManager- Parameters:
menuManager- the context menu manager, ornullif none- See Also:
-
update
public void update(boolean force) Description copied from interface:IContributionManagerUpdates 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:
updatein interfaceIContributionManager- Parameters:
force-truemeans update even if not dirty, andfalsefor normal incremental updating
-