|
| |
|
| java.lang.Object
 org.eclipse.ui.texteditor.rulers.RulerColumnDescriptor
| RulerColumnDescriptor | | final public class RulerColumnDescriptor (Code) | | 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 |
| RulerColumnDescriptor | | RulerColumnDescriptor(IConfigurationElement element, RulerColumnRegistry registry) throws InvalidRegistryObjectException(Code) | | Creates a new descriptor.
Parameters:
element - the configuration element to read
Parameters:
registry - the computer registry creating this descriptor
throws:
InvalidRegistryObjectException - if the configuration element does not conform to theextension point spec |
| createColumn | | public IContributedRulerColumn createColumn(ITextEditor editor) throws CoreException, InvalidRegistryObjectException(Code) | | 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 the instantiated column
throws:
CoreException - as thrown by IConfigurationElement.createExecutableExtension(String)
throws:
InvalidRegistryObjectException - as thrown by IConfigurationElement.createExecutableExtension(String) |
| getConfigurationElement | | IConfigurationElement getConfigurationElement()(Code) | | |
| getDefaultEnablement | | public boolean getDefaultEnablement()(Code) | | Returns the default enablement of the described extension. Editors that support this
contribution should typically enable the column by default.
the default enablement of the described extension |
| getIcon | | public ImageDescriptor getIcon()(Code) | | Returns the image descriptor of the described extension, null if it does not
have an image.
the image descriptor of the described extension or null for no image |
| getId | | public String getId()(Code) | | Returns the identifier of the described extension.
the identifier of the described extension |
| getName | | public String getName()(Code) | | Returns the name of the described extension.
the name of the described extension |
| hashCode | | public int hashCode()(Code) | | |
| isGlobal | | public boolean isGlobal()(Code) | | 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.
the global property of the described extension |
| isIncludedInMenu | | public boolean isIncludedInMenu()(Code) | | 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.
the menu inclusion property of the described extension |
| matchesEditor | | public boolean matchesEditor(ITextEditor editor)(Code) | | Returns true if this contribution matches the passed editor, false if not.
Parameters:
editor - the editor to check true if this contribution targets the passed editor |
|
|
|