Eclipse Plug-in Developer Guide (Galileo) - RulerColumnDescriptor (Eclipse Platform API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.ui.texteditor.rulers
Class RulerColumnDescriptor


java.lang.Object
  
org.eclipse.ui.texteditor.rulers.RulerColumnDescriptor

public final class RulerColumnDescriptor
extends Object
extends Object

The description of an extension to the org.eclipse.ui.workbench.texteditor.rulerColumns extension point. Instances are immutable. Instances can be obtained from a RulerColumnRegistry.

Since:: 3.3
Restriction:: This class is not intended to be instantiated by clients.

Method Summary

IContributedRulerColumn createColumn ( ITextEditor editor)
          Creates a IContributedRulerColumn instance as described by the receiver.

boolean equals ( Object obj)


boolean getDefaultEnablement ()
          Returns the default enablement of the described extension.

ImageDescriptor getIcon ()
          Returns the image descriptor of the described extension, null if it does not have an image.

String getId ()
          Returns the identifier of the described extension.

String getName ()
          Returns the name of the described extension.

int hashCode ()


boolean isGlobal ()
          Returns the global property of the described extension.

boolean isIncludedInMenu ()
          Returns the menu inclusion property of the described extension.

boolean matchesEditor ( ITextEditor editor)
          Returns true if this contribution matches the passed editor, false if not.

String toString ()


Methods inherited from class java.lang. Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getId

public 
String getId()

Returns the identifier of the described extension.

Returns:: the identifier of the described extension

getName

public 
String getName()

Returns the name of the described extension.

Returns:: the name of the described extension

getIcon

public 
ImageDescriptor getIcon()

Returns the image descriptor of the described extension, null if it does not have an image.

Returns:: the image descriptor of the described extension or null for no image

getDefaultEnablement

public boolean getDefaultEnablement()

Returns the default enablement of the described extension. Editors that support this contribution should typically enable the column by default.

Returns:: the default enablement of the described extension

isGlobal

public boolean isGlobal()

Returns the global property of the described extension. Changing the visibility of a column with the global property set to true should typically affect all matching editors. Changing the visibility of a column with the global property set to false should only affect the current editor.

Returns:: the global property of the described extension

isIncludedInMenu

public boolean isIncludedInMenu()

Returns the menu inclusion property of the described extension. A toggle menu entry should be inluded in the ruler context menu for columns with this property set to true.

Returns:: the menu inclusion property of the described extension

matchesEditor

public boolean matchesEditor(
ITextEditor editor)

Returns true if this contribution matches the passed editor, false if not.

Parameters:: editor - the editor to check
Returns:: true if this contribution targets the passed editor

createColumn

public 
IContributedRulerColumn createColumn(
ITextEditor editor)
                                     throws 
CoreException,
                                            
InvalidRegistryObjectException

Creates a IContributedRulerColumn instance as described by the receiver. This may load the contributing plug-in.

Parameters:: editor - the editor that loads the contributed column
Returns:: the instantiated column
Throws:: CoreException - as thrown by IConfigurationElement.createExecutableExtension(String); InvalidRegistryObjectException - as thrown by IConfigurationElement.createExecutableExtension(String)

toString

public 
String toString()

Overrides:: toString in class Object

hashCode

public int hashCode()

Overrides:: hashCode in class Object

equals

public boolean equals(
Object obj)

Overrides:: equals in class Object