| <?xml version='1.0' encoding='UTF-8'?> |
| <!-- Schema file written by PDE --> |
| <schema targetNamespace="org.eclipse.ui"> |
| <annotation> |
| <appInfo> |
| <meta.schema plugin="org.eclipse.ui" id="decorators" name="Decorators"/> |
| </appInfo> |
| <documentation> |
| This extension point is used to add decorators to views that subscribe to a decorator manager. As of 2.1 there is the concept of a lightweight decorator that will handle the image management for the decorator. It is also possible to declare a lightweight decorator that simply overlays an icon when enabled that requires no implementation from the plug-in. |
| </documentation> |
| </annotation> |
| |
| <include schemaLocation="commonExpression.exsd"/> |
| |
| <element name="extension"> |
| <complexType> |
| <sequence> |
| <element ref="decorator" minOccurs="0" maxOccurs="unbounded"/> |
| </sequence> |
| <attribute name="point" type="string" use="required"> |
| <annotation> |
| <documentation> |
| a fully qualified identifier of the target extension point |
| </documentation> |
| </annotation> |
| </attribute> |
| <attribute name="id" type="string"> |
| <annotation> |
| <documentation> |
| an optional identifier of the extension instance |
| </documentation> |
| </annotation> |
| </attribute> |
| <attribute name="name" type="string"> |
| <annotation> |
| <documentation> |
| an optional name of the extension instance |
| </documentation> |
| </annotation> |
| </attribute> |
| </complexType> |
| </element> |
| |
| <element name="decorator"> |
| <annotation> |
| <appInfo> |
| <meta.element labelAttribute="label"/> |
| </appInfo> |
| </annotation> |
| <complexType> |
| <sequence> |
| <element ref="description" minOccurs="0" maxOccurs="1"/> |
| <element ref="enablement" minOccurs="0" maxOccurs="1"/> |
| </sequence> |
| <attribute name="id" type="string" use="required"> |
| <annotation> |
| <documentation> |
| a unique name that will be used to identify this decorator. |
| </documentation> |
| </annotation> |
| </attribute> |
| <attribute name="label" type="string" use="required"> |
| <annotation> |
| <documentation> |
| a translatable name that will be used in the workbench window menu to represent this decorator. |
| </documentation> |
| </annotation> |
| </attribute> |
| <attribute name="class" type="string"> |
| <annotation> |
| <documentation> |
| a fully qualified name of a class which implements <samp>org.eclipse.jface.viewers.ILabelDecorator</samp> |
| if <b><i> lightweight</i></b> is false or <samp>org.eclipse.jface.viewers.ILightweightLabelDecorator</samp> if lightweight is true. The default value is false. If there is no <b><i>class</i></b> element it is assumed to be true. |
| </documentation> |
| <appInfo> |
| <meta.attribute kind="java" basedOn="org.eclipse.jface.viewers.ILabelDecorator"/> |
| </appInfo> |
| </annotation> |
| </attribute> |
| <attribute name="objectClass" type="string"> |
| <annotation> |
| <documentation> |
| a fully qualified name of a class which this decorator will be applied to. Deprecated in 2.1. Make this value part of the enablement. |
| </documentation> |
| </annotation> |
| </attribute> |
| <attribute name="adaptable" type="boolean"> |
| <annotation> |
| <documentation> |
| a flag that indicates if types that adapt to IResource should use this object contribution. |
| This flag is used only if objectClass adapts to IResource. Default value is false. |
| </documentation> |
| </annotation> |
| </attribute> |
| <attribute name="state" type="boolean"> |
| <annotation> |
| <documentation> |
| a flag that indicates if the decorator is on by default. Default value is false. |
| </documentation> |
| </annotation> |
| </attribute> |
| <attribute name="lightweight"> |
| <annotation> |
| <documentation> |
| The lightweight flag indicates that the decorator is either |
| declarative or implements |
| <samp>org.eclipse.jface.viewers.ILightweightLabelDecorator</samp>. |
| </documentation> |
| </annotation> |
| <simpleType> |
| <restriction base="string"> |
| <enumeration value="true"> |
| </enumeration> |
| <enumeration value="false"> |
| </enumeration> |
| </restriction> |
| </simpleType> |
| </attribute> |
| <attribute name="icon" type="string"> |
| <annotation> |
| <documentation> |
| if the decorator is <b><i>lightweight</i></b> and the <b><i>class</i></b> is not specified this is the path to the overlay image to apply |
| </documentation> |
| <appInfo> |
| <meta.attribute kind="resource"/> |
| </appInfo> |
| </annotation> |
| </attribute> |
| <attribute name="location"> |
| <annotation> |
| <documentation> |
| if the decorator is <b><i>lightweight</i></b> this is the location to apply the decorator to. Defaults to BOTTOM_RIGHT. |
| </documentation> |
| </annotation> |
| <simpleType> |
| <restriction base="string"> |
| <enumeration value="TOP_LEFT"> |
| </enumeration> |
| <enumeration value="TOP_RIGHT"> |
| </enumeration> |
| <enumeration value="BOTTOM_LEFT"> |
| </enumeration> |
| <enumeration value="BOTTOM_RIGHT"> |
| </enumeration> |
| <enumeration value="UNDERLAY"> |
| </enumeration> |
| </restriction> |
| </simpleType> |
| </attribute> |
| </complexType> |
| </element> |
| |
| <element name="description" type="string"> |
| <annotation> |
| <documentation> |
| an optional subelement whose body should contain text providing a short description of the decorator. This will be shown in the Decorators preference page so it is recommended that this is included. Default value is an empty String. |
| </documentation> |
| </annotation> |
| </element> |
| |
| <annotation> |
| <appInfo> |
| <meta.section type="since"/> |
| </appInfo> |
| <documentation> |
| Release 2.0 |
| </documentation> |
| </annotation> |
| |
| <annotation> |
| <appInfo> |
| <meta.section type="examples"/> |
| </appInfo> |
| <documentation> |
| The following are example of decorators: |
| <p> |
| A full decorator. The plug-in developer must handle their own image support. |
| </p> |
| <p> |
| <pre> |
| <extension point="org.eclipse.ui.decorators"> |
| <decorator |
| id="com.xyz.decorator" |
| label="XYZ Decorator" |
| state="true" |
| class="com.xyz.DecoratorContributor"> |
| <enablement> |
| <objectClass name="org.eclipse.core.resources.IResource"/> |
| </enablement> |
| </decorator> |
| </extension> |
| </pre> |
| </p> |
| |
| <p> |
| A lightweight decorator. There is a concrete class but as it is an |
| ILightweightLabelDecorator it only needs to supply text and an ImageDescriptor and therefore needs no resource handling. |
| </p> |
| |
| <p> |
| <pre> |
| <extension point="org.eclipse.ui.decorators"> |
| <decorator |
| id="com.xyz.lightweight.decorator" |
| label="XYZ Lightweight Decorator" |
| state="false" |
| class="com.xyz.LightweightDecoratorContributor" |
| lightweight="true" > |
| <enablement> |
| <objectClass name="org.eclipse.core.resources.IResource"/> |
| </enablement> |
| </decorator> |
| </extension> |
| </pre> |
| </p> |
| <p>A declarative lightweight decorator. There is no concrete class so it |
| supplies an icon and a quadrant to apply that icon. |
| </p> |
| |
| <p> |
| <pre> |
| <extension point="org.eclipse.ui.decorators"> |
| <decorator |
| id="com.xyz.lightweight.declarative.decorator" |
| label="XYZ Lightweight Declarative Decorator" |
| state="false" |
| lightweight="true" |
| icon="icons/full/declarative.gif" |
| location="TOP_LEFT"> |
| <enablement> |
| <objectClass name="org.eclipse.core.resources.IResource"/> |
| </enablement> |
| </decorator> |
| </extension> |
| </pre> |
| </p> |
| </documentation> |
| </annotation> |
| |
| <annotation> |
| <appInfo> |
| <meta.section type="apiInfo"/> |
| </appInfo> |
| <documentation> |
| The value of the <samp>class</samp> attribute must be the fully qualified name of a class that implements <samp>org.eclipse.jface.viewers.ILabelDecorator</samp> (if lightweight is false) or <samp>org.eclipse.jface.viewers.ILightweightLabelDecorator</samp>. This class is loaded as late as possible to avoid loading the entire plug-in before it is really needed. Declarative decorators do not entail any plug-in activation and should be used whenever possible. Non-lightweight decorators will eventually be deprecated. |
| </documentation> |
| </annotation> |
| |
| <annotation> |
| <appInfo> |
| <meta.section type="implementation"/> |
| </appInfo> |
| <documentation> |
| Plug-ins may use this extension point to add new decorators to be applied to views that use the decorator manager as their label decorator. |
| To use the decorator manager, use the result of IViewPart.getDecoratorManager() as the decorator for an instance of DecoratingLabelProvider. |
| This is currently in use by the Resource Navigator. |
| </documentation> |
| </annotation> |
| |
| <annotation> |
| <appInfo> |
| <meta.section type="copyright"/> |
| </appInfo> |
| <documentation> |
| Copyright (c) 2002, 2004 IBM Corporation and others.<br> |
| All rights reserved. This program and the accompanying materials are made |
| available under the terms of the Common Public License v1.0 which accompanies |
| this distribution, and is available at |
| <a href="http://www.eclipse.org/legal/cpl-v10.html">http://www.eclipse.org/legal/cpl-v10.html</a> |
| </documentation> |
| </annotation> |
| |
| </schema> |