public final class RulerColumnDescriptor extends Object
org.eclipse.ui.workbench.texteditor.rulerColumns
extension point. Instances are
immutable. Instances can be obtained from a RulerColumnRegistry
.Modifier and Type | Method and Description |
---|---|
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() |
public String getId()
public 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 checktrue
if this contribution targets the passed editorpublic 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 columnCoreException
- as thrown by IConfigurationElement.createExecutableExtension(String)
InvalidRegistryObjectException
- as thrown by IConfigurationElement.createExecutableExtension(String)
Copyright (c) 2000, 2015 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.