Package org.eclipse.handly.ui.outline
Class OutlineActionContribution
java.lang.Object
org.eclipse.handly.ui.outline.OutlineContribution
org.eclipse.handly.ui.outline.OutlineActionContribution
- All Implemented Interfaces:
IOutlineContribution
- Direct Known Subclasses:
CollapseAllActionContribution,ExpandAllActionContribution,ToggleActionContribution
An abstract base class for outline action contributions.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected voidcontribute(org.eclipse.jface.action.ActionContributionItem item, org.eclipse.jface.action.IContributionManager manager) Contributes the given action contribution item to the given manager.protected abstract org.eclipse.jface.action.IActionReturns a new action that is to be contributed to the outline page.voiddispose()Disposes of this contribution.protected voiddisposeAction(org.eclipse.jface.action.IAction action) Disposes of the contributed action.protected org.eclipse.jface.action.IContributionManagerReturns the manager that is to be used for contributing the action to the outline page.voidinit(ICommonOutlinePage outlinePage) Initializes this contribution.Methods inherited from class org.eclipse.handly.ui.outline.OutlineContribution
getOutlinePage
-
Constructor Details
-
OutlineActionContribution
public OutlineActionContribution()
-
-
Method Details
-
init
Description copied from class:OutlineContributionInitializes this contribution. This method is called after the outline page's tree viewer has been created.This method may be extended by subclasses. Subclasses must call the superclass implementation.
- Specified by:
initin interfaceIOutlineContribution- Overrides:
initin classOutlineContribution- Parameters:
outlinePage- the contribution's outline page (nevernull)
-
dispose
public void dispose()Description copied from class:OutlineContributionDisposes of this contribution. Implementors should clean up any resources associated with this contribution. Note that there is no guarantee thatinit()has been called. This method has no effect if this contribution has already been disposed.This method may be extended by subclasses. Subclasses must call the superclass implementation.
- Specified by:
disposein interfaceIOutlineContribution- Overrides:
disposein classOutlineContribution
-
createAction
protected abstract org.eclipse.jface.action.IAction createAction()Returns a new action that is to be contributed to the outline page.- Returns:
- the created action, or
null
-
disposeAction
protected void disposeAction(org.eclipse.jface.action.IAction action) Disposes of the contributed action.Default implementation does nothing. Subclasses may override.
- Parameters:
action- the action to dispose (nevernull)
-
getContributionManager
protected org.eclipse.jface.action.IContributionManager getContributionManager()Returns the manager that is to be used for contributing the action to the outline page.Default implementation returns the outline page's toolbar manager. Subclasses may override.
- Returns:
- the contribution manager (not
null)
-
contribute
protected void contribute(org.eclipse.jface.action.ActionContributionItem item, org.eclipse.jface.action.IContributionManager manager) Contributes the given action contribution item to the given manager.Default implementation calls
manager.add(item). Subclasses may override.- Parameters:
item- nevernullmanager- nevernull
-