EDIT

import eu.etaxonomy.taxeditor.model.AbstractUtility;

 * Abstract super class for a {@link Section} GUI element that visualizes a CDM

 * entity, manages a conversation and listens to selections

 * @param <ENTITY> A CDM entity which should be visualized by this section.

 *

//TODO shouldn't ENTITY be bound with super class ICdmBase for example (AbstractFormSection<ENTITY extends ICdmBase>)?

		ISelectionChangedListener, IEntityElement<ENTITY>,

			AbstractUtility.warn(getClass(),

				if (selectableElement.getSelectionArbitrator() != null) {

			IEditorPart activeEditor = AbstractUtility.getActiveEditor();

				ConversationHolder conversation = ((IConversationEnabled) AbstractUtility.getActiveEditor()).getConversationHolder();

		AbstractUtility.errorDialog("Could not get conversation for AbstractFormSection",

import org.eclipse.ui.forms.widgets.ExpandableComposite;

import eu.etaxonomy.taxeditor.model.AbstractUtility;

import eu.etaxonomy.taxeditor.ui.section.AbstractEntityCollectionSection;

    private BoldFontHolder2 boldFontHolder2;

    private MouseListener selectionMouseHandler;

    private FocusListener selectionFocusHandler;

    private final Set selectionListenerList = new HashSet();

    private final List<IPropertyChangeListener> propertyChangeListeners = new ArrayList<IPropertyChangeListener>();

    private final int orientation = Window.getDefaultOrientation();

    private ISelectionProvider selectionProvider;

    /** Constant <code>EMPTY_SELECTION</code> */

    public static ISelection EMPTY_SELECTION = new ISelection() {

        @Override

        public boolean isEmpty() {

            return true;

        }

    };

    /**

     *

     * @author n.hoffmann

     * @date Jan 25, 2010

     *

     */

    private class SelectionMouseHandler extends MouseAdapter {

        @Override

        public void mouseDown(MouseEvent e) {

            notifySelectionListeners(e);

        }

    }

    /**

     *

     * @author n.hoffmann

     * @date Jan 25, 2010

     *

     */

    private class SelectionFocusHandler extends FocusAdapter {

        @Override

        public void focusGained(FocusEvent e) {

            notifySelectionListeners(e);

        }

    }

    private void notifySelectionListeners(TypedEvent e) {

        Event event = new Event();

        event.widget = e.widget;

        SelectionEvent selectionEvent = new SelectionEvent(event);

        for (Object listener : selectionListenerList) {

            ((SelectionListener) listener).widgetSelected(selectionEvent);

        }

    }

    /**

     * <p>

     * Constructor for CdmFormFactory.

     * </p>

     *

     * @param display

     *            a {@link org.eclipse.swt.widgets.Display} object.

     * @param selectionProvider

     *            a {@link org.eclipse.jface.viewers.ISelectionProvider} object.

     */

    public CdmFormFactory(Display display, ISelectionProvider selectionProvider) {

        super(display);

        this.selectionProvider = selectionProvider;

        init();

    }

    /**

     * <p>

     * Constructor for CdmFormFactory.

     * </p>

     *

     * @param display

     *            a {@link org.eclipse.swt.widgets.Display} object.

     */

    public CdmFormFactory(Display display) {

        super(display);

        init();

    }

    /**

    private void init() {

        boldFontHolder2 = new BoldFontHolder2();

        selectionMouseHandler = new SelectionMouseHandler();

        selectionFocusHandler = new SelectionFocusHandler();

    }

    /**

     * Creates an instance initialized with the correct selectionProvider

     *

     * Make sure to remove the instance when the entityComposite disposes via

     * destroySelectionArbitrator(..)

     *

     * @param entityElement

     *            a {@link eu.etaxonomy.taxeditor.ui.element.IEntityElement}

     *            object.

     * @return a {@link eu.etaxonomy.taxeditor.ui.element.SelectionArbitrator}

     *         object.

     */

    public SelectionArbitrator createSelectionArbitrator(IEntityElement entityElement) {

        SelectionArbitrator selectionArbitrator = new SelectionArbitrator(entityElement);

        selectionArbitrator.addSelectionProvider(selectionProvider);

        selectionProvider.addSelectionChangedListener(selectionArbitrator);

        addSelectionListener(selectionArbitrator);

        return selectionArbitrator;

    }

    /**

     * <p>

     * destroySelectionArbitrator

     * </p>

     *

     * @param selectionArbitrator

     *            a

     *            {@link eu.etaxonomy.taxeditor.ui.element.SelectionArbitrator}

     *            object.

     */

    public void destroySelectionArbitrator(SelectionArbitrator selectionArbitrator) {

        removeSelectionListener(selectionArbitrator);

        if (selectionProvider != null) {

            selectionProvider.removeSelectionChangedListener(selectionArbitrator);

        } else {

            AbstractUtility.error(this.getClass(),

                    "Tried to destroy a selection listener from this factories listeners but was null", null);

        }

    }

    /** {@inheritDoc} */

    @Override

    public void adapt(Composite composite) {

        composite.addMouseListener(selectionMouseHandler);

        super.adapt(composite);

    }

    /**

     * <p>

     * Adapts the {@link AbstractCdmFormElement}:<br>

     * - sets the {@link IPropertyChangeListener}s handled by this class

     * </p>

     *

     * @param formElement

     *            a

     *            {@link eu.etaxonomy.taxeditor.ui.element.AbstractCdmFormElement}

     *            object.

     */

    public void adapt(AbstractCdmFormElement formElement) {

        formElement.setPropertyChangeListeners(propertyChangeListeners);

    }

    /** {@inheritDoc} */

    @Override

    public void adapt(Control control, boolean trackFocus, boolean trackKeyboard) {

        if (trackFocus) {

            control.addFocusListener(selectionFocusHandler);

        }

        super.adapt(control, trackFocus, trackKeyboard);

    }

    /**

     * <p>

     * destroyElement

     * </p>

     *

     * @param formElement

     *            a {@link eu.etaxonomy.taxeditor.ui.element.ICdmFormElement}

     *            object.

     */

    public void destroyElement(ICdmFormElement formElement) {

        // return if element was not initialized

        if (formElement == null) {

            return;

        }

        // destroy selection arbitrator, if any

        if (formElement instanceof ISelectableElement) {

            destroySelectionArbitrator(((ISelectableElement) formElement).getSelectionArbitrator());

        }

        // remove this element form its parents list of elements

        // ICdmFormElement parentElement = formElement.getParentElement();

        // if(parentElement != null){

        // parentElement.removeElement(formElement);

        // }

        // call destroy on child elements recursively

        for (ICdmFormElement childElement : formElement.getElements()) {

            destroyElement(childElement);

        }

        // dispose of the controls

        for (Control control : formElement.getControls()) {

            // we added the layoutComposite of the parental element as the

            // layout composite to this formElement

            // but we do not want to destroy it.

            if (control.equals(formElement.getLayoutComposite())) {

                continue;

            } else {

                control.dispose();

                control = null;

            }

        }

    }

    /**

     * <p>

     * createEmptyCell

     * </p>

     *

     * @param parent

     *            a {@link org.eclipse.swt.widgets.Composite} object.

     * @return a {@link org.eclipse.swt.widgets.Label} object.

     */

    public Label createEmptyCell(Composite parent) {

        return this.createLabel(parent, null);

    }

    /**

     * <p>

     * createMultilineTextWithLabel

     * </p>

     *

     * @param labelString

     *            a {@link java.lang.String} object.

     * @param textHeight

     *            a int.

     * @param style

     *            a int.

     * @param parentElement

     *            a {@link eu.etaxonomy.taxeditor.ui.element.ICdmFormElement}

     *            object.

     * @return a {@link eu.etaxonomy.taxeditor.ui.element.TextWithLabelElement}

     *         object.

     */

    public TextWithLabelElement createMultilineTextWithLabel(ICdmFormElement parentElement, String labelString,

            int textHeight, int style) {

        TextWithLabelElement element = new TextWithLabelElement(this, parentElement, labelString, "", textHeight, style);

        adapt(element);

        parentElement.addElement(element);

        return element;

    }

    /**

     * <p>

     * createMultiLanguageTextElement

     * </p>

     *

     * @param parentElement

     *            a {@link eu.etaxonomy.taxeditor.ui.element.ICdmFormElement}

     *            object.

     * @param labelString

     *            a {@link java.lang.String} object.

     * @param multilanguageText

     *            a {@link java.util.Map} object.

     * @param textHeight

     *            a int.

     * @param style

     *            a int.

     * @return a

     *         {@link eu.etaxonomy.taxeditor.ui.element.MultilanguageTextElement}

     *         object.

     */

    public MultilanguageTextElement createMultiLanguageTextElement(ICdmFormElement parentElement, String labelString,

            Map<Language, LanguageString> multilanguageText, int textHeight, int style) {

        MultilanguageTextElement element = new MultilanguageTextElement(this, parentElement, labelString,

                multilanguageText, textHeight, style);

        adapt(element);

        parentElement.addElement(element);

        return element;

    }

    public KeyStatementElement createKeyStatementElement(ICdmFormElement parentElement, String labelString,

            KeyStatement keyStatement, int textHeight, int style) {

        KeyStatementElement element = new KeyStatementElement(this, parentElement, labelString, keyStatement,

                textHeight, style);

        adapt(element);

        parentElement.addElement(element);

        return element;

    }

    /**

     * <p>

     * createTextWithLabelElement

     * </p>

     *

     * @param labelString

     *            a {@link java.lang.String} object.

     * @param initialText

     *            a {@link java.lang.String} object.

     * @param style

     *            a int.

     * @param parentElement

     *            a {@link eu.etaxonomy.taxeditor.ui.element.ICdmFormElement}

     *            object.

     * @return a {@link eu.etaxonomy.taxeditor.ui.element.TextWithLabelElement}

     *         object.

     */

    public TextWithLabelElement createTextWithLabelElement(ICdmFormElement parentElement, String labelString,

            String initialText, int style) {

        TextWithLabelElement element = new TextWithLabelElement(this, parentElement, labelString, initialText, null,

                style);

        adapt(element);

        parentElement.addElement(element);

        return element;

    }

    public UriWithLabelElement createUriWithLabelElement(ICdmFormElement parentElement, String labelString,

            URI initialUri, int style) {

        UriWithLabelElement element = new UriWithLabelElement(this, parentElement, labelString, initialUri, null, style);

        adapt(element);

        parentElement.addElement(element);

        return element;

    }

    /**

     * @param element

     * @param string

     * @param uri

     * @param style

     * @return

     */

    public OpenUrlSelectorElement createOpenUrlSelectorElement(ICdmFormElement parentElement, String labelString,

            IOpenUrlEnabled openUrlEnabled, int style) {

        OpenUrlSelectorElement element = new OpenUrlSelectorElement(this, parentElement, labelString, openUrlEnabled,

                style);

        adapt(element);

        parentElement.addElement(element);

        return element;

    }

    /**

     *

     * @param parentElement

     * @param labelString

     * @param conversationEnabled

     * @param user

     * @param style

     * @return

     */

    public EditPasswordElement createEditPasswordElement(ICdmFormElement parentElement, String labelString,

            ConversationHolder conversation, User user, int style) {

        EditPasswordElement element = new EditPasswordElement(this, parentElement, labelString, user, conversation);

        adapt(element);

        parentElement.addElement(element);

        return element;

    }

    /**

     * <p>

     * createIntegerTextWithLabelElement

     * </p>

     *

     * @param parentElement

     *            a {@link eu.etaxonomy.taxeditor.ui.element.ICdmFormElement}

     *            object.

     * @param labelString

     *            a {@link java.lang.String} object.

     * @param initialInteger

     *            a {@link java.lang.Integer} object.

     * @param style

     *            a int.

     * @return a

     *         {@link eu.etaxonomy.taxeditor.ui.element.NumberWithLabelElement}

     *         object.

     */

    public NumberWithLabelElement createIntegerTextWithLabelElement(ICdmFormElement parentElement, String labelString,

            Integer initialInteger, int style) {

        NumberWithLabelElement element = new NumberWithLabelElement(this, parentElement, labelString, initialInteger,

                style);

        adapt(element);

        parentElement.addElement(element);

        return element;

    }

    /**

     * <p>

     * createFloatTextWithLabelElement

     * </p>

     *

     * @param parentElement

     *            a {@link eu.etaxonomy.taxeditor.ui.element.ICdmFormElement}

     *            object.

     * @param labelString

     *            a {@link java.lang.String} object.

     * @param initialFloat

     *            a float.

     * @param style

     *            a int.

     * @return a

     *         {@link eu.etaxonomy.taxeditor.ui.element.NumberWithLabelElement}

     *         object.

     */

    public NumberWithLabelElement createFloatTextWithLabelElement(ICdmFormElement parentElement, String labelString,

            float initialFloat, int style) {

        NumberWithLabelElement element = new NumberWithLabelElement(this, parentElement, labelString, initialFloat,

                style);

        adapt(element);

        parentElement.addElement(element);

        return element;

    }

    /**

     * <p>

     * createLanguageStringWithLabelElement

     * </p>

     *

     * @param parentElement

     *            a {@link eu.etaxonomy.taxeditor.ui.element.ICdmFormElement}

     *            object.

     * @param labelString

     *            a {@link java.lang.String} object.

     * @param languageString

     *            a {@link eu.etaxonomy.cdm.model.common.LanguageString} object.

     * @param style

     *            a int.

     * @return a

     *         {@link eu.etaxonomy.taxeditor.ui.element.LanguageStringWithLabelElement}

     *         object.

     */

    public LanguageStringWithLabelElement createLanguageStringWithLabelElement(ICdmFormElement parentElement,

            String labelString, LanguageString languageString, int style) {

        LanguageStringWithLabelElement element = new LanguageStringWithLabelElement(this, parentElement, labelString,

                languageString, style);

        adapt(element);

        parentElement.addElement(element);

        return element;

    }

    /**

     * <p>

     * createLanguageStringWithLabelElement

     * </p>

     *

     * @param parentElement

     *            a {@link eu.etaxonomy.taxeditor.ui.element.ICdmFormElement}

     *            object.

     * @param labelString

     *            a {@link java.lang.String} object.

     * @param languageString

     *            a {@link eu.etaxonomy.cdm.model.common.LanguageString} object.

     * @param height

     *            a int.

     * @param style

     *            a int.

     * @return a

     *         {@link eu.etaxonomy.taxeditor.ui.element.LanguageStringWithLabelElement}

     *         object.

     */

    public LanguageStringWithLabelElement createLanguageStringWithLabelElement(ICdmFormElement parentElement,

            String labelString, LanguageString languageString, int height, int style) {

        LanguageStringWithLabelElement element = new LanguageStringWithLabelElement(this, parentElement, labelString,

                languageString, height, style);

        adapt(element);

        parentElement.addElement(element);

        return element;

    }

    /**

     * <p>

     * createTextElement

     * </p>

     *

     * @param parentElement

     *            a {@link eu.etaxonomy.taxeditor.ui.element.ICdmFormElement}

     *            object.

     * @param initialText

     *            a {@link java.lang.String} object.

     * @param style

     *            a int.

     * @return a {@link eu.etaxonomy.taxeditor.ui.element.TextWithLabelElement}

     *         object.

     */

    public TextWithLabelElement createTextElement(ICdmFormElement parentElement, String initialText, int style) {

        TextWithLabelElement element = new TextWithLabelElement(this, parentElement, null, initialText, null, style);

        adapt(element);

        parentElement.addElement(element);

        return element;

    }

    /**

     * <p>

     * createKeyValueViewerElement

     * </p>

     *

     * @param parentElement

     *            a {@link eu.etaxonomy.taxeditor.ui.element.ICdmFormElement}

     *            object.

     * @param keyHeading

     *            a {@link java.lang.String} object.

     * @param valueHeading

     *            a {@link java.lang.String} object.

     * @param map

     *            a {@link java.util.Map} object.

     * @return a {@link eu.etaxonomy.taxeditor.ui.element.KeyValueViewerElement}

     *         object.

     */

    public KeyValueViewerElement createKeyValueViewerElement(ICdmFormElement parentElement, String keyHeading,

            String valueHeading, Map<Object, Object> map) {

        KeyValueViewerElement element = new KeyValueViewerElement(this, parentElement, keyHeading, valueHeading, map);

        adapt(element);

        parentElement.addElement(element);

        return element;

    }

    /**

     * <p>

     * createTermComboElement

     * </p>

     *

     * @param termComboType

     *            a

     *            {@link eu.eu.etaxonomy.taxeditor.ui.element.CdmFormFactory.TermComboType}

     *            object.

     * @param parentElement

     *            a {@link eu.etaxonomy.taxeditor.ui.element.ICdmFormElement}

     *            object.

     * @param labelString

     *            a {@link java.lang.String} object.

     * @param selection

     *            a {@link eu.etaxonomy.cdm.model.common.DefinedTermBase}

     *            object.

     * @param style

     *            a int.

     * @return a {@link eu.etaxonomy.taxeditor.ui.combo.TermComboElement}

     *         object.

     */

    public <T extends DefinedTermBase> TermComboElement<T> createTermComboElement(Class<T> termComboType,

            ICdmFormElement parentElement, String labelString, T selection, int style) {

        TermComboElement<T> element = new TermComboElement<T>(this, parentElement, termComboType, labelString,

                selection, style);

        adapt(element);

        parentElement.addElement(element);

        return element;

    }

    /**

     * <p>

     * createEnumComboElement

     * </p>

     *

     * @param enumComboType

     *            a

     *            {@link eu.eu.etaxonomy.taxeditor.ui.element.CdmFormFactory.EnumComboType}

     *            object.

     * @param parentElement

     *            a {@link eu.etaxonomy.taxeditor.ui.element.ICdmFormElement}

     *            object.

     * @param style

     *            a int.

     * @return a {@link eu.etaxonomy.taxeditor.ui.term.AbstractEnumComboElement}

     *         object.

     */

    public <T extends IDefinedTerm> EnumComboElement<T> createEnumComboElement(Class<T> enumComboType,

            ICdmFormElement parentElement, int style) {

        EnumComboElement<T> element = new EnumComboElement<T>(this, parentElement, enumComboType, style);

        adapt(element);

        parentElement.addElement(element);

        return element;

    }

    /**

     * <p>

     * createBrowserElement

     * </p>

     *

     * @param imageUri

     *            a {@link java.net.URI} object.

     * @param style

     *            a int.

     * @param parentElement

     *            a {@link eu.etaxonomy.taxeditor.ui.element.ICdmFormElement}

     *            object.

     * @return a {@link eu.etaxonomy.taxeditor.ui.element.BrowserElement}

     *         object.

     */

    public BrowserElement createBrowserElement(ICdmFormElement parentElement, URI imageUri, int style) {

        BrowserElement element = new BrowserElement(this, parentElement, imageUri, style);

        adapt(element);

        parentElement.addElement(element);

        return element;

    }

    /**

     * <p>

     * createImageElement

     * </p>

     *

     * @param parentElement

     *            a {@link eu.etaxonomy.taxeditor.ui.element.ICdmFormElement}

     *            object.

     * @param imageUri

     *            a {@link java.net.URI} object.

     * @param style

     *            a int.

     * @return a {@link eu.etaxonomy.taxeditor.ui.element.ImageElement} object.

     */

    public ImageElement createImageElement(ICdmFormElement parentElement, URI imageUri, int style) {

        ImageElement element = new ImageElement(this, parentElement, imageUri, style);

        adapt(element);

        parentElement.addElement(element);

        return element;

    }

    /**

     * <p>

     * createTextActionElement

     * </p>

     *

     * @param labelString

     *            a {@link java.lang.String} object.

     * @param initialText

     *            a {@link java.lang.String} object.

     * @param style

     *            a int.

     * @param parentElement

     *            a {@link eu.etaxonomy.taxeditor.ui.element.ICdmFormElement}

     *            object.

     * @param buttonLabel

     *            a {@link java.lang.String} object.

     * @return a {@link eu.etaxonomy.taxeditor.ui.element.TextActionElement}

     *         object.

     */

    public TextActionElement createTextActionElement(ICdmFormElement parentElement, String labelString,

            String buttonLabel, String initialText, int style) {

        TextActionElement element = new TextActionElement(this, parentElement, labelString, buttonLabel, initialText,

                style);

        adapt(element);

        parentElement.addElement(element);

        return element;

    }

    /**

     * <p>

     * createCheckbox

     * </p>

     *

     * @param parentElement

     *            a {@link eu.etaxonomy.taxeditor.ui.element.ICdmFormElement}

     *            object.

     * @param label

     *            a {@link java.lang.String} object.

     * @param initialState

     *            a boolean.

     * @param style

     *            a int.

     * @return a {@link eu.etaxonomy.taxeditor.ui.element.CheckboxElement}

     *         object.

     */

    public CheckboxElement createCheckbox(ICdmFormElement parentElement, String label, boolean initialState, int style) {

        CheckboxElement element = new CheckboxElement(this, parentElement, label, initialState, style | orientation);

        adapt(element);

        parentElement.addElement(element);

        return element;

    }

    /**

     * Creates a section as a part of the form.

     *

     * @return the section widget

     * @param section

     *            a

     *            {@link eu.etaxonomy.taxeditor.ui.element.AbstractFormSection}

     *            object.

     */

    public Section adapt(AbstractFormSection section) {

        section.setMenu(section.getLayoutComposite().getMenu());

        adapt(section, true, true);

        // handle focus and property change events for cdm use

        section.addFocusListener(selectionFocusHandler);

        section.setPropertyChangeListeners(propertyChangeListeners);

        if (section.getToggle() != null) {

            section.getToggle().setHoverDecorationColor(getColors().getColor(IFormColors.TB_TOGGLE_HOVER));

            section.getToggle().setDecorationColor(getColors().getColor(IFormColors.TB_TOGGLE));

        }