Package org.eclipse.ui.texteditor

Class AbstractTextEditor.ColumnSupport

java.lang.Object

org.eclipse.ui.texteditor.AbstractTextEditor.ColumnSupport

All Implemented Interfaces:

IColumnSupport

Enclosing class:

AbstractTextEditor

protected static class AbstractTextEditor.ColumnSupport
extends Object
implements IColumnSupport

Implements the ruler column support of for the given editor.

This is currently only used to support vertical ruler columns.

Since:

3.3

Constructor Summary

Constructors

Constructor	Description
ColumnSupport(AbstractTextEditor editor, RulerColumnRegistry registry)	Creates a new column support for the given editor.

Method Summary

Modifier and Type	Method	Description
void	dispose()	Removes and disposes all currently visible ruler columns.
protected void	initializeColumn(IContributedRulerColumn column)	Hook to let subclasses initialize a newly created column.
boolean	isColumnSupported(RulerColumnDescriptor descriptor)	Returns true if the column described by descriptor is supported by the receiver's editor, false if id is not the identifier of a known column contribution, if the column does not target the editor, or if the editor does not support contributed columns.
boolean	isColumnVisible(RulerColumnDescriptor descriptor)	Returns true if the column described by descriptor is currently showing, false if not.
void	setColumnVisible(RulerColumnDescriptor descriptor, boolean visible)	Attempts to set the visibility of the column described by descriptor.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ColumnSupport

public ColumnSupport(AbstractTextEditor editor,
                     RulerColumnRegistry registry)

Creates a new column support for the given editor. Only the editor itself should normally create such an instance.

Parameters:

editor - the editor

registry - the contribution registry to refer to

Method Detail

setColumnVisible

public final void setColumnVisible(RulerColumnDescriptor descriptor,
                                   boolean visible)

Description copied from interface: IColumnSupport

Attempts to set the visibility of the column described by descriptor. Nothing happens if the visibility is already as requested, or if the column is not supported by the editor.

Specified by:

setColumnVisible in interface IColumnSupport

Parameters:

descriptor - the column descriptor

visible - true to show the column, false to hide it

initializeColumn

protected void initializeColumn(IContributedRulerColumn column)

Hook to let subclasses initialize a newly created column.

Subclasses may extend this method.

Parameters:

column - the created column

isColumnVisible

public final boolean isColumnVisible(RulerColumnDescriptor descriptor)

Description copied from interface: IColumnSupport

Returns true if the column described by descriptor is currently showing, false if not.

Specified by:

isColumnVisible in interface IColumnSupport

Parameters:

descriptor - the column descriptor

Returns:

true if the specified column is currently visible

isColumnSupported

public final boolean isColumnSupported(RulerColumnDescriptor descriptor)

Description copied from interface: IColumnSupport

Returns true if the column described by descriptor is supported by the receiver's editor, false if id is not the identifier of a known column contribution, if the column does not target the editor, or if the editor does not support contributed columns.

Specified by:

isColumnSupported in interface IColumnSupport

Parameters:

descriptor - the column descriptor

Returns:

true if the specified column is supported

dispose

public void dispose()

Removes and disposes all currently visible ruler columns.

Subclasses may extend this method.

Specified by:

dispose in interface IColumnSupport