|
Eclipse Platform Release 3.6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.ui.texteditor.rulers.RulerColumnDescriptor
public final class RulerColumnDescriptor
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.
| Method Summary | |
|---|---|
IContributedRulerColumn |
createColumn(ITextEditor editor)
Creates a IContributedRulerColumn instance as described by the receiver. |
boolean |
equals(java.lang.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. |
java.lang.String |
getId()
Returns the identifier of the described extension. |
java.lang.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. |
java.lang.String |
toString()
|
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
| Method Detail |
|---|
public java.lang.String getId()
public java.lang.String getName()
public ImageDescriptor getIcon()
null if it does not
have an image.
null for no imagepublic boolean getDefaultEnablement()
public boolean isGlobal()
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.
public boolean isIncludedInMenu()
true.
public boolean matchesEditor(ITextEditor editor)
true if this contribution matches the passed editor, false if not.
editor - the editor to check
true if this contribution targets the passed editor
public IContributedRulerColumn createColumn(ITextEditor editor)
throws CoreException,
InvalidRegistryObjectException
IContributedRulerColumn instance as described by the receiver. This may load the contributing plug-in.
editor - the editor that loads the contributed column
CoreException - as thrown by IConfigurationElement.createExecutableExtension(String)
InvalidRegistryObjectException - as thrown by IConfigurationElement.createExecutableExtension(String)public java.lang.String toString()
toString in class java.lang.Objectpublic int hashCode()
hashCode in class java.lang.Objectpublic boolean equals(java.lang.Object obj)
equals in class java.lang.Object
|
Eclipse Platform Release 3.6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2010. All rights reserved.