taxeditor-editor/src/main/java/eu/etaxonomy/taxeditor/forms/ICdmFormElement.java

   1 package eu.etaxonomy.taxeditor.forms;
   2
   3
   4 import java.util.Set;
   5
   6 import org.eclipse.jface.util.IPropertyChangeListener;
   7 import org.eclipse.swt.graphics.Color;
   8 import org.eclipse.swt.widgets.Composite;
   9 import org.eclipse.swt.widgets.Control;
  10
  11 /**
  12  * <p>ICdmFormElement interface.</p>
  13  *
  14  * @author n.hoffmann
  15  * @version $Id: $
  16  */
  17 public interface ICdmFormElement extends IPropertyChangeEmitter, IPropertyChangeListener {
  18
  19         /**
  20          * <p>getPropertyChangeListeners</p>
  21          *
  22          * @return a {@link java.util.Set} object.
  23          */
  24         public abstract Set<IPropertyChangeListener> getPropertyChangeListeners();
  25
  26         /**
  27          * <p>setPropertyChangeListeners</p>
  28          *
  29          * @param propertyChangeListeners a {@link java.util.Set} object.
  30          */
  31         public abstract void setPropertyChangeListeners(
  32                         Set<IPropertyChangeListener> propertyChangeListeners);
  33
  34         /**
  35          * <p>getControls</p>
  36          *
  37          * @return a {@link java.util.Set} object.
  38          */
  39         public abstract Set<Control> getControls();
  40
  41         /**
  42          * <p>getElements</p>
  43          *
  44          * @return a {@link java.util.Set} object.
  45          */
  46         public abstract Set<ICdmFormElement> getElements();
  47
  48         /**
  49          * <p>addElement</p>
  50          *
  51          * @param element a {@link eu.etaxonomy.taxeditor.forms.ICdmFormElement} object.
  52          */
  53         public abstract void addElement(ICdmFormElement element);
  54
  55         /**
  56          * <p>getParentElement</p>
  57          *
  58          * @return a {@link eu.etaxonomy.taxeditor.forms.ICdmFormElement} object.
  59          */
  60         public abstract ICdmFormElement getParentElement();
  61
  62         /**
  63          * <p>removeElements</p>
  64          */
  65         public abstract void removeElements();
  66
  67         /**
  68          * <p>getLayoutComposite</p>
  69          *
  70          * @return a {@link org.eclipse.swt.widgets.Composite} object.
  71          */
  72         public abstract Composite getLayoutComposite();
  73
  74         /**
  75          * <p>containsFormElement</p>
  76          *
  77          * @param formElement a {@link eu.etaxonomy.taxeditor.forms.ICdmFormElement} object.
  78          * @return a boolean.
  79          */
  80         public boolean containsFormElement(ICdmFormElement formElement);
  81
  82         /**
  83          * <p>setBackground</p>
  84          *
  85          * @param color a {@link org.eclipse.swt.graphics.Color} object.
  86          */
  87         public void setBackground(Color color);
  88
  89         /**
  90          * Refreshes the layout of this form element.
  91          *
  92          * This method should be called when the content of the form element
  93          * changes and the current element needs to display that changes
  94          */
  95         public void refresh();
  96 }