eu.etaxonomy.taxeditor.ui.section

Class AbstractEntityCollectionSection<ENTITY,ELEMENT>

java.lang.Object

org.eclipse.swt.widgets.Widget

org.eclipse.swt.widgets.Control

org.eclipse.swt.widgets.Scrollable

org.eclipse.swt.widgets.Composite

org.eclipse.swt.widgets.Canvas

org.eclipse.ui.forms.widgets.ExpandableComposite

org.eclipse.ui.forms.widgets.Section

eu.etaxonomy.taxeditor.ui.element.AbstractFormSection<ENTITY>

eu.etaxonomy.taxeditor.ui.section.AbstractEntityCollectionSection<ENTITY,ELEMENT>

Type Parameters:

ENTITY - A CDM entity which should be visualized by this section.

ELEMENT - An element that can be added (multiple times) to this entity.

All Implemented Interfaces:

eu.etaxonomy.cdm.api.conversation.IConversationEnabled, eu.etaxonomy.cdm.persistence.hibernate.ICdmPostDataChangeObserver, ICdmFormElement, IEntityElement<ENTITY>, IPropertyChangeEmitter, ISelectable, java.util.EventListener, java.util.Observer, org.eclipse.jface.util.IPropertyChangeListener, org.eclipse.jface.viewers.ISelectionChangedListener, org.eclipse.swt.graphics.Drawable, org.eclipse.ui.forms.events.IExpansionListener

Direct Known Subclasses:

AbstractDeterminationEventDetailSection, AbstractIdentifierSection, AbstractSampleDesignationDetailSection, AbstractUnboundEntityCollectionSection, AmplificationGelPhotoCollectionDetailSection, AnnotationSection, CollectingAreasDetailSection, CreditSection, DerivedUnitTypeDesignationSection, DescribedSpecimenSection, DescriptionElementMediaSection, DescriptionElementSourceSection, DescriptionSourceSection, ExtensionSection, GeoScopeDetailSection, GeoScopePolyKeyDetailSection, GeoScopeSection, GrantedAuthorityDetailSection, GroupsByUserDetailSection, MediaRepresentationPartSection, MediaRepresentationSection, MediaSection, MemberDetailSection, NameRelationshipDetailSection, NomenclaturalStatusSection, PreservedSpecimenAbstractDeterminationEventDetailSection, PreservedSpecimenSourceCollectionDetailSection, ProtologueSection, RightsSection, SequenceContigFileCollectionDetailSection, SingleReadPherogramCollectionDetailSection, SourceCollectionDetailSection, SourceSection, SpecimenCollectionDetailSection, StateDataSection, StatisticalMeasurementValueSection, TaxonNodeAgentRelationCollectionSection, TaxonomicScopeSection, TypeDesignationSection

public abstract class AbstractEntityCollectionSection<ENTITY,ELEMENT>
extends AbstractFormSection<ENTITY>
implements org.eclipse.ui.forms.events.IExpansionListener, java.util.Observer

This class visualizes an CDM entity of type ENTITY and additionally provides the functionality to add other elements of type ELEMENT to them.

Version:

$Id: $

Author:

n.hoffmann

Nested Class Summary

Nested classes/interfaces inherited from class eu.etaxonomy.taxeditor.ui.element.AbstractFormSection

AbstractFormSection.ExpandListener

Field Summary

Fields

Modifier and Type	Field and Description
protected org.eclipse.swt.widgets.Composite	container

Fields inherited from class eu.etaxonomy.taxeditor.ui.element.AbstractFormSection

DEFAULT_NUM_COLUMNS, formFactory

Fields inherited from class org.eclipse.ui.forms.widgets.Section

DESCRIPTION

Fields inherited from class org.eclipse.ui.forms.widgets.ExpandableComposite

CLIENT_INDENT, clientVerticalSpacing, COMPACT, descriptionVerticalSpacing, EXPANDED, FOCUS_TITLE, GAP, LEFT_TEXT_CLIENT_ALIGNMENT, marginHeight, marginWidth, NO_TITLE, NO_TITLE_FOCUS_BOX, SHORT_TITLE_BAR, textLabel, TITLE_BAR, titleBarTextMarginWidth, toggle, TREE_NODE, TWISTIE, VGAP

Fields inherited from class org.eclipse.swt.widgets.Control

handle

Fields inherited from interface eu.etaxonomy.taxeditor.ui.element.ISelectable

NOT_SELECTED, SELECTED

Constructor Summary

Constructors

Constructor and Description
AbstractEntityCollectionSection(CdmFormFactory formFactory, eu.etaxonomy.cdm.api.conversation.ConversationHolder conversation, ICdmFormElement parentElement, java.lang.String title, int style)

Method Summary

Modifier and Type	Method and Description
abstract void	addElement(ELEMENT element) Add an element to the entities collection
abstract ELEMENT	addExisting() Add an existing element to the entities collection.
abstract boolean	allowAddExisting() If true the section will also display a browse icon to choose from existing elements.
protected void	createDynamicContents(java.util.Collection<ELEMENT> elements) Creates the widgets for the collection
protected void	createElementComposite(ELEMENT element, org.eclipse.swt.events.SelectionListener removeListener, org.eclipse.swt.graphics.Color backgroundColor) Create the specific widget for the element
protected void	createEmptyContent()
abstract ELEMENT	createNewElement() Create a new Element for this collection
protected org.eclipse.swt.widgets.Control	createToolbar()
void	expansionStateChanged(org.eclipse.ui.forms.events.ExpansionEvent e)
void	expansionStateChanging(org.eclipse.ui.forms.events.ExpansionEvent e)
abstract java.util.Collection<ELEMENT>	getCollection(ENTITY entity) Get the specific collection of this entity
abstract java.util.Comparator<ELEMENT>	getComparator() Returns the Comparator specific for the ELEMENTs which is used to sort the elements
abstract java.lang.String	getEmptyString() String to display when the collection is empty
AbstractEntityCollectionElement<ENTITY>	getEntityCollectionElement()
java.lang.String	getTitleString() getTitleString
protected abstract java.lang.String	getTooltipString() getTooltipString
protected void	internalUpdateSection(boolean changed) Call this method after dynamically changing the client area.
abstract void	removeElement(ELEMENT element) Remove an element from the entities collection
void	removeElementAndUpdate(ELEMENT element) Remove an element from the entities collection and update the section
void	removeToolbar() using this method is discouraged, use updateToolBar() instead
void	setBackground(org.eclipse.swt.graphics.Color color) setBackground
void	setEntity(ENTITY entity) Setter for the field entity.
protected void	setSectionTitle() Sets the title for the section.
void	setTitleString(java.lang.String title) setTitleString
void	showToolbar() using this method is discouraged, use updateToolBar() instead
void	update(java.util.Observable o, java.lang.Object arg)

Methods inherited from class eu.etaxonomy.taxeditor.ui.element.AbstractFormSection

addElement, addExpandListener, addSelectionListener, containsFormElement, dispose, firePropertyChangeEvent, firePropertyChangeEvent, firePropertyChangeEvent, getControls, getConversationHolder, getElements, getEntity, getFormFactory, getLayoutComposite, getParentElement, getPersistentBackground, getPropertyChangeListeners, getSection, getToggle, propertyChange, refresh, removeElement, removeElements, removeSelectionListener, selectionChanged, setFocus, setPersistentBackground, setPropertyChangeListeners, setSelected, update, widgetSelected

Methods inherited from class org.eclipse.ui.forms.widgets.Section

getDescription, getDescriptionControl, getSeparatorControl, getTitleBarBackground, getTitleBarBorderColor, getTitleBarGradientBackground, internalSetExpanded, onPaint, reflow, setBackgroundImage, setDescription, setDescriptionControl, setForeground, setSeparatorControl, setTitleBarBackground, setTitleBarBorderColor, setTitleBarGradientBackground

Methods inherited from class org.eclipse.ui.forms.widgets.ExpandableComposite

addExpansionListener, computeSize, forceFocus, getClient, getExpansionStyle, getText, getTextClient, getTextClientHeightDifference, getTitleBarForeground, hasTitleBar, isExpanded, isFixedStyle, removeExpansionListener, setActiveToggleColor, setClient, setEnabled, setExpanded, setFont, setLayout, setMenu, setText, setTextClient, setTitleBarForeground, setToggleColor, setToolTipText

Methods inherited from class org.eclipse.swt.widgets.Canvas

drawBackground, getCaret, getIME, scroll, setCaret, setIME

Methods inherited from class org.eclipse.swt.widgets.Composite

changed, checkSubclass, drawBackground, getBackgroundMode, getChildren, getLayout, getLayoutDeferred, getTabList, isLayoutDeferred, layout, layout, layout, layout, layout, setBackgroundMode, setLayoutDeferred, setTabList

Methods inherited from class org.eclipse.swt.widgets.Scrollable

computeTrim, getClientArea, getHorizontalBar, getScrollbarsMode, getVerticalBar

Methods inherited from class org.eclipse.swt.widgets.Control

addControlListener, addDragDetectListener, addFocusListener, addGestureListener, addHelpListener, addKeyListener, addMenuDetectListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addMouseWheelListener, addPaintListener, addTouchListener, addTraverseListener, computeSize, dragDetect, dragDetect, getAccessible, getBackground, getBackgroundImage, getBorderWidth, getBounds, getCursor, getDragDetect, getEnabled, getFont, getForeground, getLayoutData, getLocation, getMenu, getMonitor, getOrientation, getParent, getRegion, getShell, getSize, getTextDirection, getToolTipText, getTouchEnabled, getVisible, internal_dispose_GC, internal_new_GC, isAutoScalable, isEnabled, isFocusControl, isReparentable, isVisible, moveAbove, moveBelow, pack, pack, print, redraw, redraw, removeControlListener, removeDragDetectListener, removeFocusListener, removeGestureListener, removeHelpListener, removeKeyListener, removeMenuDetectListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removeMouseWheelListener, removePaintListener, removeTouchListener, removeTraverseListener, requestLayout, setBounds, setBounds, setCapture, setCursor, setDragDetect, setLayoutData, setLocation, setLocation, setOrientation, setParent, setRedraw, setRegion, setSize, setSize, setTextDirection, setTouchEnabled, setVisible, toControl, toControl, toDisplay, toDisplay, traverse, traverse, traverse, update

Methods inherited from class org.eclipse.swt.widgets.Widget

addDisposeListener, addListener, checkWidget, getData, getData, getDisplay, getListeners, getStyle, isAutoDirection, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, reskin, setData, setData, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

container

protected org.eclipse.swt.widgets.Composite container

Constructor Detail

AbstractEntityCollectionSection

public AbstractEntityCollectionSection(CdmFormFactory formFactory,
                                       eu.etaxonomy.cdm.api.conversation.ConversationHolder conversation,
                                       ICdmFormElement parentElement,
                                       java.lang.String title,
                                       int style)

Method Detail

createToolbar

protected org.eclipse.swt.widgets.Control createToolbar()

showToolbar

public void showToolbar()

using this method is discouraged, use updateToolBar() instead

removeToolbar

public void removeToolbar()

using this method is discouraged, use updateToolBar() instead

setEntity

public void setEntity(ENTITY entity)

Description copied from class: AbstractFormSection

Setter for the field entity.

Overrides:

setEntity in class AbstractFormSection<ENTITY>

Parameters:

entity - a ENTITY object.

setSectionTitle

protected void setSectionTitle()

Sets the title for the section. Adds a "+" sign if the collection is not empty for this section. Override in subclasses if you want to have a different behaviour.

internalUpdateSection

protected void internalUpdateSection(boolean changed)

Call this method after dynamically changing the client area. If the options changed is set to true, will also fire a state changed event to inform the user of unsaved changes.

Parameters:

changed - a boolean.

createEmptyContent

protected void createEmptyContent()

createDynamicContents

protected void createDynamicContents(java.util.Collection<ELEMENT> elements)

Creates the widgets for the collection

Parameters:

elements - a Collection object.

createElementComposite

protected void createElementComposite(ELEMENT element,
                                      org.eclipse.swt.events.SelectionListener removeListener,
                                      org.eclipse.swt.graphics.Color backgroundColor)

Create the specific widget for the element

Parameters:

element - a ELEMENT object.

removeListener - a SelectionListener object.

backgroundColor - a Color object.

setBackground

public void setBackground(org.eclipse.swt.graphics.Color color)

setBackground

Specified by:

setBackground in interface ICdmFormElement

Overrides:

setBackground in class AbstractFormSection<ENTITY>

Parameters:

color - a Color object.

getTitleString

public java.lang.String getTitleString()

getTitleString

Returns:

a String object.

setTitleString

public void setTitleString(java.lang.String title)

setTitleString

Parameters:

title - a String object.

expansionStateChanging

public void expansionStateChanging(org.eclipse.ui.forms.events.ExpansionEvent e)

Specified by:

expansionStateChanging in interface org.eclipse.ui.forms.events.IExpansionListener

expansionStateChanged

public void expansionStateChanged(org.eclipse.ui.forms.events.ExpansionEvent e)

Specified by:

expansionStateChanged in interface org.eclipse.ui.forms.events.IExpansionListener

removeElementAndUpdate

public void removeElementAndUpdate(ELEMENT element)

Remove an element from the entities collection and update the section

Parameters:

element - a ELEMENT object.

update

public void update(java.util.Observable o,
                   java.lang.Object arg)

Specified by:

update in interface java.util.Observer

getEntityCollectionElement

public AbstractEntityCollectionElement<ENTITY> getEntityCollectionElement()

getComparator

public abstract java.util.Comparator<ELEMENT> getComparator()

Returns the Comparator specific for the ELEMENTs which is used to sort the elements

Returns:

the comparator for ELEMENT

getCollection

public abstract java.util.Collection<ELEMENT> getCollection(ENTITY entity)

Get the specific collection of this entity

Parameters:

entity - a ENTITY object.

Returns:

a Collection object.

createNewElement

public abstract ELEMENT createNewElement()

Create a new Element for this collection

Returns:

a ELEMENT object.

addElement

public abstract void addElement(ELEMENT element)

Add an element to the entities collection

Parameters:

element - a ELEMENT object.

addExisting

public abstract ELEMENT addExisting()

Add an existing element to the entities collection.

Returns:

the existing element

allowAddExisting

public abstract boolean allowAddExisting()

If true the section will also display a browse icon to choose from existing elements.
Note: when returning true you have to make sure to implement the addExisting() method

Returns:

true if existing entities can be added; false otherwise

removeElement

public abstract void removeElement(ELEMENT element)

Remove an element from the entities collection

Parameters:

element - a ELEMENT object.

getEmptyString

public abstract java.lang.String getEmptyString()

String to display when the collection is empty

Returns:

a String object.

getTooltipString

protected abstract java.lang.String getTooltipString()

getTooltipString

Returns:

String to display when hovering the add button