Package org.eclipse.handly.ui.outline
Class ToggleActionContribution
java.lang.Object
org.eclipse.handly.ui.outline.OutlineContribution
org.eclipse.handly.ui.outline.OutlineActionContribution
org.eclipse.handly.ui.outline.ToggleActionContribution
- All Implemented Interfaces:
IOutlineContribution
- Direct Known Subclasses:
LexicalSortActionContribution,LinkWithEditorActionContribution
An abstract base class for outline action contributions
that toggle a boolean-valued preference.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected abstract voidconfigureAction(org.eclipse.jface.action.IAction action) Hook to configure the contributed action (set its id, text, image, etc.) This method is called once, when this contribution is initializing.protected final org.eclipse.jface.action.IActionReturns a new action that is to be contributed to the outline page.protected final voiddisposeAction(org.eclipse.jface.action.IAction action) Disposes of the contributed action.protected abstract IBooleanPreferenceReturns a boolean-valued preference that is to be toggled by the contributed action.Methods inherited from class org.eclipse.handly.ui.outline.OutlineActionContribution
contribute, dispose, getContributionManager, initMethods inherited from class org.eclipse.handly.ui.outline.OutlineContribution
getOutlinePage
-
Constructor Details
-
ToggleActionContribution
public ToggleActionContribution()
-
-
Method Details
-
createAction
protected final org.eclipse.jface.action.IAction createAction()Description copied from class:OutlineActionContributionReturns a new action that is to be contributed to the outline page.- Specified by:
createActionin classOutlineActionContribution- Returns:
- the created action, or
null
-
disposeAction
protected final void disposeAction(org.eclipse.jface.action.IAction action) Description copied from class:OutlineActionContributionDisposes of the contributed action.Default implementation does nothing. Subclasses may override.
- Overrides:
disposeActionin classOutlineActionContribution- Parameters:
action- the action to dispose (nevernull)
-
getPreference
Returns a boolean-valued preference that is to be toggled by the contributed action. May returnnull, in which case this contribution will be effectively disabled. This method is called once, when this contribution is initializing.- Returns:
- the linked preference, or
null
-
configureAction
protected abstract void configureAction(org.eclipse.jface.action.IAction action) Hook to configure the contributed action (set its id, text, image, etc.) This method is called once, when this contribution is initializing.- Parameters:
action- the action to configure (nevernull)
-