Package org.eclipse.ui.texteditor.rulers
Class AbstractContributedRulerColumn
java.lang.Object
org.eclipse.ui.texteditor.rulers.AbstractContributedRulerColumn
- All Implemented Interfaces:
IVerticalRulerColumn,IContributedRulerColumn
public abstract class AbstractContributedRulerColumn
extends Object
implements IContributedRulerColumn
Helper class for contributions to the
org.eclipse.ui.texteditor.rulerColumns extension point.
Subclasses must have a zero-argument constructor so that they can be created by
IConfigurationElement.createExecutableExtension(String).
- Since:
- 3.3
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidHook method called after a column has been instantiated, but before it is added to aCompositeRulerand before createControl is called.voidHook method called after a column has been removed from theCompositeRuler.final RulerColumnDescriptorReturns the extension point descriptor of this ruler.final ITextEditorReturns the editor targeted by this ruler instance.final voidsetDescriptor(RulerColumnDescriptor descriptor) Sets the extension point descriptor of this ruler.final voidsetEditor(ITextEditor editor) Sets the editor (called right after the extension was instantiated).Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.eclipse.jface.text.source.IVerticalRulerColumn
createControl, getControl, getWidth, redraw, setFont, setModel
-
Constructor Details
-
AbstractContributedRulerColumn
public AbstractContributedRulerColumn()
-
-
Method Details
-
getDescriptor
Description copied from interface:IContributedRulerColumnReturns the extension point descriptor of this ruler.- Specified by:
getDescriptorin interfaceIContributedRulerColumn- Returns:
- descriptor the extension point descriptor of this ruler or
nullif called beforeIContributedRulerColumn.columnCreated()
-
setDescriptor
Description copied from interface:IContributedRulerColumnSets the extension point descriptor of this ruler.This method will be called by the framework and must not be called by clients.
- Specified by:
setDescriptorin interfaceIContributedRulerColumn- Parameters:
descriptor- the extension point descriptor
-
setEditor
Description copied from interface:IContributedRulerColumnSets the editor (called right after the extension was instantiated).This method will be called by the framework and must not be called by clients.
- Specified by:
setEditorin interfaceIContributedRulerColumn- Parameters:
editor- the editor targeted by this ruler instance
-
getEditor
Description copied from interface:IContributedRulerColumnReturns the editor targeted by this ruler instance.- Specified by:
getEditorin interfaceIContributedRulerColumn- Returns:
- the editor targeted by this ruler instance or
nullif called beforeIContributedRulerColumn.columnCreated()
-
columnCreated
public void columnCreated()Description copied from interface:IContributedRulerColumnHook method called after a column has been instantiated, but before it is added to aCompositeRulerand before createControl is called.This happens when
- the column is set visible by the user or programmatically
- the editor is created, if this ruler targets the editor and is enabled by default
- the editor input changes and the column now targets the new editor contents.
- Specified by:
columnCreatedin interfaceIContributedRulerColumn
-
columnRemoved
public void columnRemoved()Description copied from interface:IContributedRulerColumnHook method called after a column has been removed from theCompositeRuler.This happens when
- the column is hidden by the user or programmatically
- the editor is closed
- the editor input changes and the column no longer targets the editor contents.
The column will not be used after this method has been called. A new column will be instantiated if the same column type should be shown for the same editor.
- Specified by:
columnRemovedin interfaceIContributedRulerColumn
-