| <?xml version='1.0' encoding='UTF-8'?> |
| <!-- Schema file written by PDE --> |
| <schema targetNamespace="org.eclipse.eef.ide.ui" xmlns="http://www.w3.org/2001/XMLSchema"> |
| <annotation> |
| <appinfo> |
| <meta.schema plugin="org.eclipse.eef.ide.ui" id="eefLifecycleManagerProvider" name="EEF Lifecycle Manager Provider"/> |
| </appinfo> |
| <documentation> |
| This extension point allows the contribution of an <code>org.eclipse.eef.ide.ui.api.widgets.IEEFLifecycleManagerProvider</code> which can be used to create an instance of <code>org.eclipse.eef.ide.ui.api.widgets.IEEFLifecycleManager</code> for the description of some controls. With this mechanism, you can not only provide the compulsory lifecycle manager of a custom widget but you can also replace the default lifecycle manager of any widget or container which gives you the ability to change the behavior and appearance of each part of the user interface (excluding groups and pages). |
| </documentation> |
| </annotation> |
| |
| <element name="extension"> |
| <annotation> |
| <appinfo> |
| <meta.element /> |
| </appinfo> |
| </annotation> |
| <complexType> |
| <sequence> |
| <element ref="descriptor" minOccurs="1" maxOccurs="unbounded"/> |
| </sequence> |
| <attribute name="point" type="string" use="required"> |
| <annotation> |
| <documentation> |
| |
| </documentation> |
| </annotation> |
| </attribute> |
| <attribute name="id" type="string"> |
| <annotation> |
| <documentation> |
| |
| </documentation> |
| </annotation> |
| </attribute> |
| <attribute name="name" type="string"> |
| <annotation> |
| <documentation> |
| |
| </documentation> |
| <appinfo> |
| <meta.attribute translatable="true"/> |
| </appinfo> |
| </annotation> |
| </attribute> |
| </complexType> |
| </element> |
| |
| <element name="descriptor"> |
| <complexType> |
| <attribute name="id" type="string" use="required"> |
| <annotation> |
| <documentation> |
| The identifier of the contribution. |
| </documentation> |
| </annotation> |
| </attribute> |
| <attribute name="label" type="string" use="required"> |
| <annotation> |
| <documentation> |
| The label of the provider, this information may be used in the user interface and as such it may be visible by the end user. It should be internationalized if possible. |
| </documentation> |
| <appinfo> |
| <meta.attribute translatable="true"/> |
| </appinfo> |
| </annotation> |
| </attribute> |
| <attribute name="description" type="string" use="required"> |
| <annotation> |
| <documentation> |
| The description of the provider, this information may be used in the user interface and as such it may be visible by the end user. It should be internationalized if possible. |
| </documentation> |
| <appinfo> |
| <meta.attribute translatable="true"/> |
| </appinfo> |
| </annotation> |
| </attribute> |
| <attribute name="class" type="string" use="required"> |
| <annotation> |
| <documentation> |
| The implementation of the IEEFLifecycleManagerProvider. |
| </documentation> |
| <appinfo> |
| <meta.attribute kind="java" basedOn=":org.eclipse.eef.ide.ui.api.widgets.IEEFLifecycleManagerProvider"/> |
| </appinfo> |
| </annotation> |
| </attribute> |
| </complexType> |
| </element> |
| |
| <annotation> |
| <appinfo> |
| <meta.section type="since"/> |
| </appinfo> |
| <documentation> |
| This extension point has been available since Eclipse EEF 1.6.0 (Eclipse Neon release in June 2016). |
| </documentation> |
| </annotation> |
| |
| <annotation> |
| <appinfo> |
| <meta.section type="examples"/> |
| </appinfo> |
| <documentation> |
| <pre> |
| <extension |
| point="org.eclipse.eef.ide.ui.eefLifecycleManagerProvider"> |
| <descriptor |
| class="org.eclipse.eef.sample.internal.extensions.SampleLifecycleManagerProvider" |
| description="Provides EEF Lifecycle Managers" |
| id="org.eclipse.eef.sample.eefLifecycleManagerProvider" |
| label="EEF Sample Lifecycle Manager Provider"> |
| </descriptor> |
| </extension> |
| </pre> |
| Example of IEEFLifecycleManagerProvider contribution. In this example, we are providing a contribution to provide an IEEFLifecycleManager for a custom widget description. Once EEF has retrieved the description of the user interface to create, it will navigate in this description in order to build the necessary widgets and containers. For each description of containers or widgets found, it will ask the IEEFLifecycleManagerProviders registered if they can handle the description. The first lifecycle manager provider which can handle the given description will thus be used to create the lifecycle manager for this description using the whole available context. The lifecycle manager returned will have the following responsibilities: |
| <ul> |
| <li>Creation of the SWT widgets for the description - IEEFLifecycleManager#createControls(...)</li> |
| <li>Registration of the listeners between the widgets - IEEFLifecycleManager#aboutToBeShown(...)</li> |
| <li>Refresh of the widgets - IEEFLifecycleManager#refresh(...)</li> |
| <li>Unregistration of the listeners - IEEFLifecycleManager#aboutToBeDisposed(...)</li> |
| <li>Removal of all additional resources - IEEFLifecycleManager#dispose(...)</li> |
| </ul> |
| In order to perform those duties, the architecture of EEF encourages the creator of an IEEFLifecycleManager to separate the user interface-related behavior from the business behavior by using a controller to handle the business part. The controller should implement <code>org.eclipse.eef.core.api.controllers.IEEFController</code> in order to perform basic task in a similar fashion as other controllers. There are several abstract classes available in order to build a new controller quite easily: |
| <ul> |
| <li><code>org.eclipse.eef.core.api.controllers.AbstractEEFController</code></li> |
| <li><code>org.eclipse.eef.core.api.controllers.AbstractEEFWidgetController</code></li> |
| <li><code>org.eclipse.eef.core.api.controllers.AbstractEEFCustomWidgetController</code></li> |
| </ul> |
| The AbstractEEFController provides support for the validation and the refresh. The AbstractEEFWidgetController, which extends the AbstractEEFController, adds support for the refresh of the label and the help of the widgets and finally the AbstractEEFCustomWidgetController, which extends the AbstractEEFWidgetController, adds on top of that utility methods for the execution of command expressions. |
| <pre> |
| package org.eclipse.eef.sample.internal.extensions; |
| |
| import org.eclipse.eef.EEFControlDescription; |
| import org.eclipse.eef.core.api.EditingContextAdapter; |
| import org.eclipse.eef.ide.ui.api.widgets.IEEFLifecycleManager; |
| import org.eclipse.eef.ide.ui.api.widgets.IEEFLifecycleManagerProvider; |
| import org.eclipse.sirius.common.interpreter.api.IInterpreter; |
| import org.eclipse.sirius.common.interpreter.api.IVariableManager; |
| |
| public class SampleLifecycleManagerProvider implements IEEFLifecycleManagerProvider { |
| |
| private static final String DESCRIPTION_IDENTIFIER = "org.eclipse.eef.sample.customwidget"; |
| |
| @Override |
| public boolean canHandle(EEFControlDescription controlDescription) { |
| // Only handle the control with our description |
| return DESCRIPTION_IDENTIFIER.equals(controlDescription.getIdentifier()); |
| } |
| |
| @Override |
| public IEEFLifecycleManager getLifecycleManager(EEFControlDescription controlDescription, IVariableManager variableManager, IInterpreter interpreter, EditingContextAdapter contextAdapter) { |
| // Returns a lifecycle manager for the control supported |
| return new SampleLifecycleManager(controlDescription, variableManager, interpreter, contextAdapter); |
| } |
| |
| } |
| </pre> |
| This example requires at least the following dependencies: |
| <ul> |
| <li>org.eclipse.sirius.common.interpreter</li> |
| <li>org.eclipse.eef</li> |
| <li>org.eclipse.eef.core</li> |
| <li>org.eclipse.eef.ide.ui</li> |
| </ul> |
| </documentation> |
| </annotation> |
| |
| <annotation> |
| <appinfo> |
| <meta.section type="apiinfo"/> |
| </appinfo> |
| <documentation> |
| The IEEFLifecycleManagerProvider allows the contribution of an IEEFLifecycleManager for a custom widget or the replacement of a default IEEFLifecycleManager for any widget or container. |
| </documentation> |
| </annotation> |
| |
| <annotation> |
| <appinfo> |
| <meta.section type="implementation"/> |
| </appinfo> |
| <documentation> |
| EEF does not supply directly any implementation of the <code>org.eclipse.eef.ide.ui.api.widgets.IEEFLifecycleManagerProvider</code> but you can find an example in the sample project with the implementation of a custom widget, the color picker. |
| |
| While we do not have any implementation for the lifecycle manager provider, there are several abstract implementations of <code>org.eclipse.eef.ide.ui.api.widgets.IEEFLifecycleManager</code> provided by this plugin: |
| <ul> |
| <li><code>org.eclipse.eef.ide.ui.api.widgets.AbstractEEFLifecycleManager</code></li> |
| <li><code>org.eclipse.eef.ide.ui.api.widgets.AbstractEEFWidgetLifecycleManager</code></li> |
| </ul> |
| |
| The class AbstractEEFLifecycleManager provides the support for validation and refresh of the controller automatically. In order to subclass it, you will have to provide a subclass of org.eclipse.swt.widgets.Control which will be used in order to "attach" the validation icons in the user interface. The class AbstractEEFWidgetLifecycleManager extends the class AbstractEEFLifecycleManager and as a result it also provides support for the validation but on top of that it brings support for the label and help widgets. By subclassing AbstractEEFWidgetLifecycleManager, your main responsibility will be the creation of the "main control" of your widget. It does not have to be "one" SWT control only. If you have access to the EEF source code, you can also look for the subclasses of those lifecycle managers to see the default implementations of all the widgets and the container. |
| </documentation> |
| </annotation> |
| |
| <annotation> |
| <appinfo> |
| <meta.section type="copyright"/> |
| </appinfo> |
| <documentation> |
| Copyright (c) 2016 Obeo<br/> |
| All rights reserved. This program and the accompanying materials |
| are made available under the terms of the Eclipse Public License v1.0 |
| which accompanies this distribution, and is available at |
| <a href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a> |
| </documentation> |
| </annotation> |
| |
| </schema> |
