Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 


Eclipse Platform
Release 3.5

org.eclipse.ui.texteditor.rulers
Interface IContributedRulerColumn

All Superinterfaces:
IVerticalRulerColumn
All Known Implementing Classes:
AbstractContributedRulerColumn

public interface IContributedRulerColumn
extends IVerticalRulerColumn

Interface that has to be implemented by contributions to the org.eclipse.ui.texteditor.rulerColumns extension point.

Implementors must have a zero-argument constructor so that they can be created by IConfigurationElement.createExecutableExtension(String).

Since:
3.3

Method Summary
 void columnCreated ()
          Hook method called after a column has been instantiated, but before it is added to a CompositeRuler and before createControl is called.
 void columnRemoved ()
          Hook method called after a column has been removed from the CompositeRuler.
  RulerColumnDescriptor getDescriptor ()
          Returns the extension point descriptor of this ruler.
  ITextEditor getEditor ()
          Returns the editor targeted by this ruler instance.
 void setDescriptor ( RulerColumnDescriptor descriptor)
          Sets the extension point descriptor of this ruler.
 void setEditor ( ITextEditor editor)
          Sets the editor (called right after the extension was instantiated).
 
Methods inherited from interface org.eclipse.jface.text.source. IVerticalRulerColumn
createControl, getControl, getWidth, redraw, setFont, setModel
 

Method Detail

getDescriptor

RulerColumnDescriptor getDescriptor()
Returns the extension point descriptor of this ruler.

Returns:
descriptor the extension point descriptor of this ruler or null if called before columnCreated()

setDescriptor

void setDescriptor(
RulerColumnDescriptor descriptor)
Sets the extension point descriptor of this ruler.

This method will be called by the framework and must not be called by clients.

Parameters:
descriptor - the extension point descriptor

setEditor

void setEditor(
ITextEditor editor)
Sets the editor (called right after the extension was instantiated).

This method will be called by the framework and must not be called by clients.

Parameters:
editor - the editor targeted by this ruler instance

getEditor

ITextEditor getEditor()
Returns the editor targeted by this ruler instance.

Returns:
the editor targeted by this ruler instance or null if called before columnCreated()

columnCreated

void columnCreated()
Hook method called after a column has been instantiated, but before it is added to a CompositeRuler and 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.


columnRemoved

void columnRemoved()
Hook method called after a column has been removed from the CompositeRuler.

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.


Eclipse Platform
Release 3.5

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.


 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire