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 Type
    Method
    Description
    void
    dispose()
    Removes and disposes all currently visible ruler columns.
    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.

  • Method Details

    • isColumnVisible

      boolean isColumnVisible(RulerColumnDescriptor descriptor)
      Returns true if the column described by descriptor is currently showing, false if not.
      Parameters:
      descriptor - the column descriptor
      Returns:
      true if the specified column is currently visible

    • setColumnVisible

      void setColumnVisible(RulerColumnDescriptor descriptor, boolean visible)
      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.
      Parameters:
      descriptor - the column descriptor
      visible - true to show the column, false to hide it

    • isColumnSupported

      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.
      Parameters:
      descriptor - the column descriptor
      Returns:
      true if the specified column is supported

    • dispose

      void dispose()
      Removes and disposes all currently visible ruler columns.