4 package eu
.etaxonomy
.taxeditor
.ui
.element
;
6 import java
.util
.ConcurrentModificationException
;
7 import java
.util
.HashSet
;
11 import org
.eclipse
.core
.runtime
.Assert
;
12 import org
.eclipse
.jface
.util
.IPropertyChangeListener
;
13 import org
.eclipse
.jface
.util
.PropertyChangeEvent
;
14 import org
.eclipse
.swt
.graphics
.Color
;
15 import org
.eclipse
.swt
.widgets
.Composite
;
16 import org
.eclipse
.swt
.widgets
.Control
;
17 import org
.eclipse
.ui
.forms
.widgets
.Section
;
19 import eu
.etaxonomy
.taxeditor
.model
.AbstractUtility
;
20 import eu
.etaxonomy
.taxeditor
.ui
.campanula
.compatibility
.ICdmFormElement
;
23 * <p>Abstract AbstractCdmFormElement class.</p>
28 public abstract class AbstractCdmFormElement
implements ICdmFormElement
{
30 protected CdmFormFactory formFactory
;
32 private List
<IPropertyChangeListener
> propertyChangeListeners
;
34 private Composite layoutComposite
;
36 private final Set
<Control
> controls
= new HashSet
<Control
>();
38 private final Set
<ICdmFormElement
> elements
= new HashSet
<ICdmFormElement
>();
39 private ICdmFormElement parentElement
;
41 private Color persistentBackgroundColor
;
45 * <p>Constructor for AbstractCdmFormElement.</p>
47 * @param formFactory a {@link eu.etaxonomy.taxeditor.ui.element.CdmFormFactory} object.
48 * @param layoutComposite a {@link org.eclipse.swt.widgets.Composite} object.
50 protected AbstractCdmFormElement(CdmFormFactory formFactory
, Composite layoutComposite
){
51 this.layoutComposite
= layoutComposite
;
52 this.formFactory
= formFactory
;
56 * <p>Constructor for AbstractCdmFormElement.</p>
58 * @param formFactory a {@link eu.etaxonomy.taxeditor.ui.element.CdmFormFactory} object.
59 * @param formElement a {@link eu.etaxonomy.taxeditor.ui.element.ICdmFormElement} object.
61 public AbstractCdmFormElement(CdmFormFactory formFactory
, ICdmFormElement formElement
) {
62 this(formFactory
, formElement
.getLayoutComposite());
63 this.parentElement
= formElement
;
64 // addControl(layoutComposite);
68 public CdmFormFactory
getFormFactory() {
73 * Delegates the focus to <code>this</code> elements main input control
75 public void setFocus(){
76 // Override in subclasses where needed
80 * Returns all Controls that are managed by this element
82 * @return a {@link java.util.Set} object.
85 public Set
<Control
> getControls(){
90 * adds the control to the set of controls that are managed by this element
92 * @param child a {@link org.eclipse.swt.widgets.Control} object.
94 protected void addControl(Control child
){
99 * <p>removeControl</p>
101 * @param child a {@link org.eclipse.swt.widgets.Control} object.
103 protected void removeControl(Control child
){
104 controls
.remove(child
);
108 * <p>Getter for the field <code>elements</code>.</p>
110 * @return a {@link java.util.Set} object.
113 public Set
<ICdmFormElement
> getElements(){
118 * <p>Getter for the field <code>parentElement</code>.</p>
120 * @return a {@link eu.etaxonomy.taxeditor.ui.element.ICdmFormElement} object.
123 public ICdmFormElement
getParentElement(){
124 return parentElement
;
129 public void addElement(ICdmFormElement element
){
130 elements
.add(element
);
134 * <p>removeElement</p>
136 * @param element a {@link eu.etaxonomy.taxeditor.ui.element.ICdmFormElement} object.
138 protected void removeElement(ICdmFormElement element
){
139 elements
.remove(element
);
143 * <p>removeElements</p>
146 public void removeElements(){
147 for(ICdmFormElement childElement
: getElements()){
149 childElement
.removeElements();
151 // unregister selection arbitrator
152 if(childElement
instanceof ISelectableElement
){
153 SelectionArbitrator selectionArbitrator
= ((ISelectableElement
) childElement
).getSelectionArbitrator();
154 if(selectionArbitrator
!= null){
155 formFactory
.destroySelectionArbitrator(selectionArbitrator
);
159 // unregister from property changes
160 formFactory
.removePropertyChangeListener(childElement
);
162 // dispose of the controls
163 removeControls(childElement
);
165 removeControls(this);
169 private void removeControls(ICdmFormElement element
){
170 if(element
instanceof Section
){
171 ((Section
) element
).dispose();
174 for(Control control
: element
.getControls()){
175 // we added the layoutComposite of the parental element as the layout composite to this formElement
176 // but we do not want to destroy it.
177 if(control
.equals(element
.getLayoutComposite())){
188 * <p>Getter for the field <code>layoutComposite</code>.</p>
190 * @return a {@link org.eclipse.swt.widgets.Composite} object.
193 public Composite
getLayoutComposite() {
194 return layoutComposite
;
198 * <p>Setter for the field <code>layoutComposite</code>.</p>
200 * @param layoutComposite a {@link org.eclipse.swt.widgets.Composite} object.
202 public void setLayoutComposite(Composite layoutComposite
){
203 this.layoutComposite
= layoutComposite
;
207 * @see eu.etaxonomy.taxeditor.forms.ICdmFormComposite#getPropertyChangeListeners()
210 * <p>Getter for the field <code>propertyChangeListeners</code>.</p>
212 * @return a {@link java.util.Set} object.
215 public List
<IPropertyChangeListener
> getPropertyChangeListeners() {
216 return propertyChangeListeners
;
220 * @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)
236 public void firePropertyChangeEvent(CdmPropertyChangeEvent event
) {
237 //TODO: replace propertyChangeListeners with formFactory.getPropertyChangeListeners() and remove member propertyChangeListeners from AbstractCdmFormElement
238 Assert
.isNotNull(propertyChangeListeners
, "Property change listeners are not present");
241 for(Object listener
: propertyChangeListeners
){
242 ((IPropertyChangeListener
)listener
).propertyChange(event
);
244 }catch(ConcurrentModificationException e
){
245 // There are two cases that produce a CME.
246 // Described here: http://dev.e-taxonomy.eu/trac/ticket/2363#comment:2
247 // and here: http://dev.e-taxonomy.eu/trac/ticket/2438
248 // Ignoring the CME because nothing bad is happening
249 AbstractUtility
.warn(getClass(), "ConcurrentModificationException. Can be ignored.");
254 * Fires a {@link CdmPropertyChangeEvent} with the given object as source.
256 * @param object the object on which the property changed
258 public void firePropertyChangeEvent(Object object
){
259 firePropertyChangeEvent(object
, null);
263 * Fires a {@link CdmPropertyChangeEvent} with the given object as source also containing the
266 * @param object the object on which the property changed
267 * @param originatingEvent the originating event
269 public void firePropertyChangeEvent(Object object
, PropertyChangeEvent originatingEvent
){
270 firePropertyChangeEvent(new CdmPropertyChangeEvent(object
, originatingEvent
));
277 * This method gets called whenever the toolkit this composite was created with gets a property change notification.
279 * It is good advice to check whether the PropertyChangeEvent is destined for the implementing composite.
280 * Implementations should also check for null PropertyChangeEvents and return immediately in that case.
281 * @see eu.etaxonomy.taxeditor.ui.element.ICdmFormElement#propertyChange(org.eclipse.jface.util.PropertyChangeEvent)
284 public void propertyChange(PropertyChangeEvent event
) {
285 // implement in subclasses
290 public boolean containsFormElement(ICdmFormElement formElement
){
291 if(formElement
== this){
294 for(ICdmFormElement element
: getElements()){
295 boolean contains
= element
.containsFormElement(formElement
);
296 if(contains
== true){
306 * @see eu.etaxonomy.taxeditor.forms.ICdmFormElement#refresh()
312 public void refresh() {
313 // empty default implementation
319 public void setBackground(Color color
) {
320 for(ICdmFormElement element
: getElements()){
321 element
.setBackground(color
);
326 public void setPersistentBackground(Color color
) {
327 persistentBackgroundColor
= color
;
328 setBackground(color
);
332 public Color
getPersistentBackground() {
333 return persistentBackgroundColor
;
336 public Color
getColor(String colorId
){
337 return AbstractUtility
.getColor(colorId
);