4 package eu
.etaxonomy
.taxeditor
.ui
.forms
;
6 import java
.util
.HashSet
;
10 import org
.eclipse
.core
.runtime
.Assert
;
11 import org
.eclipse
.jface
.util
.IPropertyChangeListener
;
12 import org
.eclipse
.jface
.util
.PropertyChangeEvent
;
13 import org
.eclipse
.swt
.graphics
.Color
;
14 import org
.eclipse
.swt
.widgets
.Composite
;
15 import org
.eclipse
.swt
.widgets
.Control
;
16 import org
.eclipse
.swt
.widgets
.Event
;
17 import org
.eclipse
.ui
.forms
.widgets
.Section
;
19 import eu
.etaxonomy
.taxeditor
.store
.StoreUtil
;
22 * <p>Abstract AbstractCdmFormElement class.</p>
27 public abstract class AbstractCdmFormElement
implements IPropertyChangeEmitter
, ICdmFormElement
, ISelectable
{
29 protected CdmFormFactory formFactory
;
31 private List
<IPropertyChangeListener
> propertyChangeListeners
;
33 private Composite layoutComposite
;
35 private Set
<Control
> controls
= new HashSet
<Control
>();
37 private Set
<ICdmFormElement
> elements
= new HashSet
<ICdmFormElement
>();
38 private ICdmFormElement parentElement
;
42 * <p>Constructor for AbstractCdmFormElement.</p>
44 * @param formFactory a {@link eu.etaxonomy.taxeditor.ui.forms.CdmFormFactory} object.
45 * @param layoutComposite a {@link org.eclipse.swt.widgets.Composite} object.
47 protected AbstractCdmFormElement(CdmFormFactory formFactory
, Composite layoutComposite
){
48 this.layoutComposite
= layoutComposite
;
49 this.formFactory
= formFactory
;
53 * <p>Constructor for AbstractCdmFormElement.</p>
55 * @param formFactory a {@link eu.etaxonomy.taxeditor.ui.forms.CdmFormFactory} object.
56 * @param formElement a {@link eu.etaxonomy.taxeditor.ui.forms.ICdmFormElement} object.
58 public AbstractCdmFormElement(CdmFormFactory formFactory
, ICdmFormElement formElement
) {
59 this(formFactory
, formElement
.getLayoutComposite());
60 this.parentElement
= formElement
;
61 // addControl(layoutComposite);
65 * <p>Getter for the field <code>formFactory</code>.</p>
67 * @return a {@link eu.etaxonomy.taxeditor.ui.forms.CdmFormFactory} object.
69 public CdmFormFactory
getFormFactory() {
74 public Color
getColor(boolean selected
) {
75 return selected ? SELECTED
: NOT_SELECTED
;
79 * Delegates the focus to <code>this</code> elements main input control
81 public void setFocus(){
82 // Override in subclasses where needed
86 * Returns all Controls that are managed by this element
88 * @return a {@link java.util.Set} object.
90 public Set
<Control
> getControls(){
95 * adds the control to the set of controls that are managed by this element
97 * @param child a {@link org.eclipse.swt.widgets.Control} object.
99 protected void addControl(Control child
){
104 * <p>removeControl</p>
106 * @param child a {@link org.eclipse.swt.widgets.Control} object.
108 protected void removeControl(Control child
){
109 controls
.remove(child
);
113 * <p>Getter for the field <code>elements</code>.</p>
115 * @return a {@link java.util.Set} object.
117 public Set
<ICdmFormElement
> getElements(){
122 * <p>Getter for the field <code>parentElement</code>.</p>
124 * @return a {@link eu.etaxonomy.taxeditor.ui.forms.ICdmFormElement} object.
126 public ICdmFormElement
getParentElement(){
127 return parentElement
;
131 public void addElement(ICdmFormElement element
){
132 elements
.add(element
);
136 * <p>removeElement</p>
138 * @param element a {@link eu.etaxonomy.taxeditor.ui.forms.ICdmFormElement} object.
140 protected void removeElement(ICdmFormElement element
){
141 elements
.remove(element
);
145 * <p>removeElements</p>
147 public void removeElements(){
148 for(ICdmFormElement childElement
: getElements()){
150 childElement
.removeElements();
152 // unregister selection arbitrator
153 if(childElement
instanceof ISelectableElement
){
154 SelectionArbitrator selectionArbitrator
= ((ISelectableElement
) childElement
).getSelectionArbitrator();
155 if(selectionArbitrator
!= null){
156 formFactory
.destroySelectionArbitrator(selectionArbitrator
);
160 // unregister from property changes
161 if(childElement
instanceof IPropertyChangeListener
){
162 formFactory
.removePropertyChangeListener((IPropertyChangeListener
) childElement
);
165 // dispose of the controls
166 removeControls(childElement
);
168 removeControls(this);
172 private void removeControls(ICdmFormElement element
){
173 if(element
instanceof Section
){
174 ((Section
) element
).dispose();
177 for(Control control
: element
.getControls()){
178 // we added the layoutComposite of the parental element as the layout composite to this formElement
179 // but we do not want to destroy it.
180 if(control
.equals(element
.getLayoutComposite())){
191 * <p>Getter for the field <code>layoutComposite</code>.</p>
193 * @return a {@link org.eclipse.swt.widgets.Composite} object.
195 public Composite
getLayoutComposite() {
196 return layoutComposite
;
200 * <p>Setter for the field <code>layoutComposite</code>.</p>
202 * @param layoutComposite a {@link org.eclipse.swt.widgets.Composite} object.
204 public void setLayoutComposite(Composite layoutComposite
){
205 this.layoutComposite
= layoutComposite
;
209 * @see eu.etaxonomy.taxeditor.forms.ICdmFormComposite#getPropertyChangeListeners()
212 * <p>Getter for the field <code>propertyChangeListeners</code>.</p>
214 * @return a {@link java.util.Set} object.
216 public List
<IPropertyChangeListener
> getPropertyChangeListeners() {
217 return propertyChangeListeners
;
221 * @see eu.etaxonomy.taxeditor.forms.ICdmFormComposite#setPropertyChangeListeners(org.eclipse.core.runtime.ListenerList)
224 public void setPropertyChangeListeners(List
<IPropertyChangeListener
> propertyChangeListeners
){
225 this.propertyChangeListeners
= propertyChangeListeners
;
229 * @see eu.etaxonomy.taxeditor.forms.IPropertyChangeEmitter#firePropertyChangeEvent()
232 * @see eu.etaxonomy.taxeditor.forms.ICdmFormComposite#firePropertyChangeEvent(org.eclipse.jface.util.PropertyChangeEvent)
235 public void firePropertyChangeEvent(CdmPropertyChangeEvent event
) {
236 Assert
.isNotNull(propertyChangeListeners
, "Property change listeners are not present");
238 for(Object listener
: propertyChangeListeners
){
239 ((IPropertyChangeListener
)listener
).propertyChange(event
);
243 public void firePropertyChangeEvent(Object object
){
244 firePropertyChangeEvent(object
, null);
247 public void firePropertyChangeEvent(Object object
, PropertyChangeEvent originatingEvent
){
248 firePropertyChangeEvent(new CdmPropertyChangeEvent(object
, originatingEvent
));
255 * This method gets called whenever the toolkit this composite was created with gets a property change notification.
257 * It is good advice to check whether the PropertyChangeEvent is destined for the implementing composite.
258 * Implementations should also check for null PropertyChangeEvents and return immediately in that case.
259 * @see eu.etaxonomy.taxeditor.ui.forms.ICdmFormElement#propertyChange(org.eclipse.jface.util.PropertyChangeEvent)
261 public void propertyChange(PropertyChangeEvent event
) {
262 // implement in subclasses
266 public boolean containsFormElement(ICdmFormElement formElement
){
267 if(formElement
== this){
270 for(ICdmFormElement element
: getElements()){
271 boolean contains
= element
.containsFormElement(formElement
);
272 if(contains
== true){
282 * @see eu.etaxonomy.taxeditor.forms.ICdmFormElement#refresh()
287 public void refresh() {
288 // empty default implementation
293 public void setBackground(Color color
) {
294 for(ICdmFormElement element
: getElements()){
295 element
.setBackground(color
);
299 public Color
getColor(String colorId
){
300 return StoreUtil
.getColor(colorId
);