eu.etaxonomy.taxeditor.editor.name.e4.container

Class AbstractGroupedContainerE4<T extends eu.etaxonomy.cdm.model.taxon.TaxonBase>

java.lang.Object

eu.etaxonomy.taxeditor.editor.name.e4.container.AbstractGroupedContainerE4<T>

Type Parameters:

T -

All Implemented Interfaces:

IContainerConstants, IElementHasDetails, org.eclipse.ui.forms.IFormPart

Direct Known Subclasses:

AcceptedNameContainerE4, ConceptContainerE4, SynonymContainerE4

public abstract class AbstractGroupedContainerE4<T extends eu.etaxonomy.cdm.model.taxon.TaxonBase>
extends java.lang.Object
implements org.eclipse.ui.forms.IFormPart, IContainerConstants, IElementHasDetails

Formats GroupedComposite with cosmetic and layout properties specific to the Editor. This should be used to maintain a consistent look and feel for all Editor freetext area components, such as DescriptionElementComposite.

Requires an IManagedForm, whose input is set to the contents of getData() when the GroupedComposite gets focus, i.e. to populate the property sheet with the data.

The IManagedForm is also required to have a Taxon in its own getData().

The IManagedForm can also used for drawing borders by calling the method createBorderSupport().

Author:

pplitzner

Field Summary

Fields

Modifier and Type	Field and Description
protected org.eclipse.swt.widgets.Composite	control
protected NameViewerE4	nameViewer
protected ParseHandler	parseHandler

Fields inherited from interface eu.etaxonomy.taxeditor.editor.name.container.IContainerConstants

ACCEPTED_ICON, ACCEPTED_INDENT, ACCEPTED_TAXON, ADD_GROUP_BASIONYM, AUTONYM_ICON, CONCEPT_ICON, CONCEPT_INDENT, CONCEPTRELATION, EMPTY_NAME_PROMPT, HETEROTYPIC_SYNONYM, HETEROTYPIC_SYNONYM_ICON, HETEROTYPIC_SYNONYM_ORIGINAL_COMBINATION_ICON, HOMOTYPIC_SYNONYM, HOMOTYPIC_SYNONYM_ICON, HOMOTYPIC_SYNONYM_IN_HETEROTYPIC_GROUP_ICON, HOMOTYPIC_SYNONYM_IN_HETEROTYPIC_GROUP_INDENT, HOMOTYPIC_SYNONYM_ORIGINAL_COMBINATION_ICON, INVALID_OR_NUDUM_NAME_ICON, MISAPPLIED_NAME, MISAPPLIEDNAME_ICON, MISAPPLIEDNAME_INDENT, MOVE, NOT_SELECTED, PARTIAL_SYNONYM_ICON, PRO_PARTE_SYNONYM_ICON, REMOVE_GROUP_BASIONYM, SELECTED_FOCUS, SELECTED_NO_FOCUS, SYNONYM_INDENT

Constructor Summary

Constructors

Constructor and Description
AbstractGroupedContainerE4(AbstractGroupE4 group, T taxonBase)

Method Summary

Modifier and Type	Method and Description
protected void	addListener()
protected void	calculateAnnotations()
void	colorSelected(int mode)
void	commit(boolean onSave)
void	createContent()
protected void	createControl()
void	createEmptyViewerPrompt(java.lang.String prompt)
protected void	createLineBreakListener() If the user hitting carriage return should cause something to happen - i.e.
protected void	createLineWrapSupport()
protected void	createListener()
protected void	createTextViewer()
void	dispose()
protected void	enableFreeText()
org.eclipse.swt.widgets.Composite	getControl()
T	getData() The data for which the details view should show details.
protected TaxonNameEditorE4	getEditor()
protected java.lang.String	getEmptyTextPrompt()
AbstractGroupE4	getGroup()
eu.etaxonomy.cdm.model.name.TaxonName	getName()
NameViewerE4	getNameViewer()
T	getTaxonBase()
protected abstract org.eclipse.swt.graphics.Font	getViewerFont()
protected void	handleSplitText(java.lang.String text)
protected void	initEmptyText()
void	initialize(org.eclipse.ui.forms.IManagedForm form)
protected abstract void	initializeComposite() Initialize the composite specific code
protected void	initTextViewer()
boolean	isDirty()
boolean	isSelected()
boolean	isStale()
void	parseAndCalculateAnnotations() Parse the text and calculate errors
void	persistName()
void	placeCursor() Puts the cursor to the position it was last seen on or to the end of line if no former position is known.
void	refresh() Refreshes the display with latest data from the model.
void	remove()
protected void	removeListener()
void	restoreColor()
void	setBackground(org.eclipse.swt.graphics.Color color)
void	setData(T data)
protected void	setDelayedSelection()
void	setDirty(boolean isDirty)
void	setDisabled(boolean disabled)
protected void	setDraggableControl(org.eclipse.swt.widgets.Control[] controls)
void	setEnabled(boolean enabled)
void	setFocus()
protected void	setFocusListener(org.eclipse.swt.events.FocusListener focusListener)
void	setFont(org.eclipse.swt.graphics.Font font)
boolean	setFormInput(java.lang.Object input)
void	setIcon(org.eclipse.swt.graphics.Image icon)
void	setIndent(int indent)
void	setIsDraggable(boolean draggable)
void	setMenu()
void	setNonEditableInfo(java.lang.String info, boolean append) nonEditableInfo is a label displayed underneath a GroupedComposite's input field.
void	setSelected()
void	showAnnotations()
void	storeCursor()
protected abstract void	updateIcon()
protected abstract void	updateIndent()
protected abstract void	updateNonEditableInfo()

Methods inherited from class java.lang.Object

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

Field Detail

parseHandler

protected ParseHandler parseHandler

nameViewer

protected NameViewerE4 nameViewer

control

protected org.eclipse.swt.widgets.Composite control

Constructor Detail

AbstractGroupedContainerE4

public AbstractGroupedContainerE4(AbstractGroupE4 group,
                                  T taxonBase)

Method Detail

createContent

public void createContent()

createListener

protected void createListener()

addListener

protected void addListener()

removeListener

protected void removeListener()

initializeComposite

protected abstract void initializeComposite()

Initialize the composite specific code

getEmptyTextPrompt

protected java.lang.String getEmptyTextPrompt()

initTextViewer

protected void initTextViewer()

calculateAnnotations

protected void calculateAnnotations()

showAnnotations

public void showAnnotations()

handleSplitText

protected void handleSplitText(java.lang.String text)

refresh

public void refresh()

Refreshes the display with latest data from the model. Note: Will not parse the text and not calculate errors!

Specified by:

refresh in interface org.eclipse.ui.forms.IFormPart

updateIcon

protected abstract void updateIcon()

updateIndent

protected abstract void updateIndent()

updateNonEditableInfo

protected abstract void updateNonEditableInfo()

enableFreeText

protected void enableFreeText()

parseAndCalculateAnnotations

public void parseAndCalculateAnnotations()

Parse the text and calculate errors

getTaxonBase

public T getTaxonBase()

getName

public eu.etaxonomy.cdm.model.name.TaxonName getName()

persistName

public void persistName()

getGroup

public AbstractGroupE4 getGroup()

remove

public void remove()

createControl

protected void createControl()

getEditor

protected TaxonNameEditorE4 getEditor()

getControl

public org.eclipse.swt.widgets.Composite getControl()

createLineWrapSupport

protected void createLineWrapSupport()

createTextViewer

protected void createTextViewer()

setIcon

public void setIcon(org.eclipse.swt.graphics.Image icon)

setIndent

public void setIndent(int indent)

setSelected

public void setSelected()

isSelected

public boolean isSelected()

colorSelected

public void colorSelected(int mode)

setDelayedSelection

protected void setDelayedSelection()

setBackground

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

setFont

public void setFont(org.eclipse.swt.graphics.Font font)

getNameViewer

public NameViewerE4 getNameViewer()

createEmptyViewerPrompt

public void createEmptyViewerPrompt(java.lang.String prompt)

getViewerFont

protected abstract org.eclipse.swt.graphics.Font getViewerFont()

initEmptyText

protected void initEmptyText()

setFocusListener

protected void setFocusListener(org.eclipse.swt.events.FocusListener focusListener)

setDirty

public void setDirty(boolean isDirty)

isDirty

public boolean isDirty()

Specified by:

isDirty in interface org.eclipse.ui.forms.IFormPart

setMenu

public void setMenu()

setDraggableControl

protected void setDraggableControl(org.eclipse.swt.widgets.Control[] controls)

setIsDraggable

public void setIsDraggable(boolean draggable)

setNonEditableInfo

public void setNonEditableInfo(java.lang.String info,
                               boolean append)

nonEditableInfo is a label displayed underneath a GroupedComposite's input field. For instance, NameComposites display things like name relations, sec. references, etc. here.

Parameters:

info - the text to display in the label

append - whether the string should be appended to text that is already shown in the label

getData

public T getData()

Description copied from interface: IElementHasDetails

The data for which the details view should show details.

Specified by:

getData in interface IElementHasDetails

Returns:

setData

public void setData(T data)

createLineBreakListener

protected void createLineBreakListener()

If the user hitting carriage return should cause something to happen - i.e. the creation of a new composite - call this method and override the method handleSplitText().

storeCursor

public void storeCursor()

placeCursor

public void placeCursor()

Puts the cursor to the position it was last seen on or to the end of line if no former position is known.

restoreColor

public void restoreColor()

initialize

public void initialize(org.eclipse.ui.forms.IManagedForm form)

Specified by:

initialize in interface org.eclipse.ui.forms.IFormPart

dispose

public void dispose()

Specified by:

dispose in interface org.eclipse.ui.forms.IFormPart

commit

public void commit(boolean onSave)

Specified by:

commit in interface org.eclipse.ui.forms.IFormPart

setFormInput

public boolean setFormInput(java.lang.Object input)

Specified by:

setFormInput in interface org.eclipse.ui.forms.IFormPart

setFocus

public void setFocus()

Specified by:

setFocus in interface org.eclipse.ui.forms.IFormPart

isStale

public boolean isStale()

Specified by:

isStale in interface org.eclipse.ui.forms.IFormPart

setDisabled

public void setDisabled(boolean disabled)

setEnabled

public void setEnabled(boolean enabled)