Package org.eclipse.handly.ui.outline
Class OutlineSorterContribution
java.lang.Object
org.eclipse.handly.ui.outline.OutlineContribution
org.eclipse.handly.ui.outline.OutlineSorterContribution
- All Implemented Interfaces:
IOutlineContribution
- Direct Known Subclasses:
LexicalSortContribution
An abstract base class for outline sorter contributions.
The activation of the sorter is governed by a user preference.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoiddispose()Disposes of this contribution.protected abstract org.eclipse.jface.viewers.ViewerComparatorReturns a comparator that will be used when the sorter is active.protected org.eclipse.jface.viewers.ViewerComparatorReturns a comparator that will be used when the sorter is inactive, ornullif no sorting needs to take place then.protected abstract IBooleanPreferenceReturns a boolean-valued preference that will control the activation of the sorter.voidinit(ICommonOutlinePage outlinePage) Initializes this contribution.Methods inherited from class org.eclipse.handly.ui.outline.OutlineContribution
getOutlinePage
-
Constructor Details
-
OutlineSorterContribution
public OutlineSorterContribution()
-
-
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
-
getPreference
Returns a boolean-valued preference that will control the activation of the sorter. May returnnull, in which case this contribution will be effectively disabled. This method is called once, when this contribution is initializing.- Returns:
- the sorter preference, or
null
-
getComparator
protected abstract org.eclipse.jface.viewers.ViewerComparator getComparator()Returns a comparator that will be used when the sorter is active. This method is called once, when this contribution is initializing.- Returns:
- the comparator to use when the sorter is active
(not
null)
-
getDefaultComparator
protected org.eclipse.jface.viewers.ViewerComparator getDefaultComparator()Returns a comparator that will be used when the sorter is inactive, ornullif no sorting needs to take place then. This method is called once, when this contribution is initializing.Default implementation returns
null. Subclasses may override.- Returns:
- the comparator to use when the sorter is inactive,
or
nullif none
-