Package org.eclipse.ui.texteditor.rulers
Interface IColumnSupport
- All Known Implementing Classes:
AbstractTextEditor.ColumnSupport
public interface IColumnSupport
Provides support to modify and query the visibility of
ruler columns and test whether a ruler column is supported.
This interface must not be implemented by clients.
- Since:
- 3.3
- Restriction:
- This interface is not intended to be implemented by clients.
- Restriction:
- This interface is not intended to be extended by clients.
-
Method Summary
Modifier and TypeMethodDescriptionvoiddispose()Removes and disposes all currently visible ruler columns.booleanisColumnSupported(RulerColumnDescriptor descriptor) Returnstrueif the column described bydescriptoris supported by the receiver's editor,falseifidis 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.booleanisColumnVisible(RulerColumnDescriptor descriptor) Returnstrueif the column described bydescriptoris currently showing,falseif not.voidsetColumnVisible(RulerColumnDescriptor descriptor, boolean visible) Attempts to set the visibility of the column described bydescriptor.
-
Method Details
-
isColumnVisible
Returnstrueif the column described bydescriptoris currently showing,falseif not.- Parameters:
descriptor- the column descriptor- Returns:
trueif the specified column is currently visible
-
setColumnVisible
Attempts to set the visibility of the column described bydescriptor. Nothing happens if the visibility is already as requested, or if the column is not supported by the editor.- Parameters:
descriptor- the column descriptorvisible-trueto show the column,falseto hide it
-
isColumnSupported
Returnstrueif the column described bydescriptoris supported by the receiver's editor,falseifidis 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.- Parameters:
descriptor- the column descriptor- Returns:
trueif the specified column is supported
-
dispose
void dispose()Removes and disposes all currently visible ruler columns.
-