import eu.etaxonomy.taxeditor.section.taxon.TaxonBaseDetailSection;
/**
- *
+ * <p>CdmFormFactory class.</p>
+ *
* @author n.hoffmann
* @created Feb 24, 2010
* @version 1.0
private ISelectionProvider selectionProvider;
/**
- *
- * @return
+ * <p>LAYOUT</p>
+ *
+ * @return a {@link org.eclipse.ui.forms.widgets.TableWrapLayout} object.
*/
public static final TableWrapLayout LAYOUT(){
return LAYOUT(1, false);
}
/**
- *
- * @param columns
- * @param equalWidth
- * @return
+ * <p>LAYOUT</p>
+ *
+ * @param columns a int.
+ * @param equalWidth a boolean.
+ * @return a {@link org.eclipse.ui.forms.widgets.TableWrapLayout} object.
*/
public static final TableWrapLayout LAYOUT(int columns, boolean equalWidth){
TableWrapLayout layout = new TableWrapLayout();
return layout;
}
+ /**
+ * <p>FILL</p>
+ *
+ * @return a {@link org.eclipse.ui.forms.widgets.TableWrapData} object.
+ */
public static final TableWrapData FILL(){
return FILL(1, 1);
}
/**
- *
- * @return
+ * <p>FILL</p>
+ *
+ * @param horizontalSpan a int.
+ * @param verticalSpan a int.
+ * @return a {@link org.eclipse.ui.forms.widgets.TableWrapData} object.
*/
public static final TableWrapData FILL(int horizontalSpan, int verticalSpan){
TableWrapData layoutData = new TableWrapData(TableWrapData.FILL_GRAB, TableWrapData.FILL_GRAB);
return layoutData;
}
+ /**
+ * <p>LEFT</p>
+ *
+ * @return a {@link org.eclipse.ui.forms.widgets.TableWrapData} object.
+ */
public static final TableWrapData LEFT(){
return new TableWrapData(TableWrapData.LEFT, TableWrapData.TOP);
}
+ /**
+ * <p>RIGHT</p>
+ *
+ * @return a {@link org.eclipse.ui.forms.widgets.TableWrapData} object.
+ */
public static final TableWrapData RIGHT(){
return new TableWrapData(TableWrapData.RIGHT, TableWrapData.TOP);
}
/**
- *
- * @return
+ * <p>FILL_HORIZONTALLY</p>
+ *
+ * @return a {@link org.eclipse.ui.forms.widgets.TableWrapData} object.
*/
public static final TableWrapData FILL_HORIZONTALLY(){
return FILL_HORIZONTALLY(1, 1);
}
/**
- *
- * @param horizontalSpan
- * @param verticalSpan
- * @return
+ * <p>FILL_HORIZONTALLY</p>
+ *
+ * @param horizontalSpan a int.
+ * @param verticalSpan a int.
+ * @return a {@link org.eclipse.ui.forms.widgets.TableWrapData} object.
*/
public static final TableWrapData FILL_HORIZONTALLY(int horizontalSpan, int verticalSpan){
TableWrapData layoutData = new TableWrapData(TableWrapData.FILL_GRAB, TableWrapData.TOP);
return layoutData;
}
+ /** Constant <code>EMPTY_SELECTION</code> */
public static ISelection EMPTY_SELECTION = new ISelection() {
public boolean isEmpty() {
return true;
}
/**
- *
- * @param display
- * @param selectionProvider
+ * <p>Constructor for CdmFormFactory.</p>
+ *
+ * @param display a {@link org.eclipse.swt.widgets.Display} object.
+ * @param selectionProvider a {@link org.eclipse.jface.viewers.ISelectionProvider} object.
*/
public CdmFormFactory(Display display, ISelectionProvider selectionProvider) {
super(display);
}
/**
- *
- * @param display
+ * <p>Constructor for CdmFormFactory.</p>
+ *
+ * @param display a {@link org.eclipse.swt.widgets.Display} object.
*/
public CdmFormFactory(Display display){
super(display);
/**
* Creates an instance initialized with the correct selectionProvider
- *
+ *
* Make sure to remove the instance when the entityComposite disposes via
* destroySelectionArbitrator(..)
- * @return
+ *
+ * @param entityElement a {@link eu.etaxonomy.taxeditor.forms.IEntityElement} object.
+ * @return a {@link eu.etaxonomy.taxeditor.forms.SelectionArbitrator} object.
*/
public SelectionArbitrator createSelectionArbitrator(IEntityElement entityElement){
SelectionArbitrator selectionArbitrator = new SelectionArbitrator(entityElement);
return selectionArbitrator;
}
+ /**
+ * <p>destroySelectionArbitrator</p>
+ *
+ * @param selectionArbitrator a {@link eu.etaxonomy.taxeditor.forms.SelectionArbitrator} object.
+ */
public void destroySelectionArbitrator(SelectionArbitrator selectionArbitrator){
removeSelectionListener(selectionArbitrator);
if(selectionProvider != null){
}
}
+ /** {@inheritDoc} */
@Override
public void adapt(Composite composite) {
composite.addMouseListener(selectionMouseHandler);
super.adapt(composite);
}
+ /**
+ * <p>adapt</p>
+ *
+ * @param formElement a {@link eu.etaxonomy.taxeditor.forms.AbstractCdmFormElement} object.
+ */
public void adapt(AbstractCdmFormElement formElement){
formElement.setPropertyChangeListeners(propertyChangeListeners);
}
+ /** {@inheritDoc} */
@Override
public void adapt(Control control, boolean trackFocus, boolean trackKeyboard) {
if(trackFocus){
super.adapt(control, trackFocus, trackKeyboard);
}
+ /**
+ * <p>destroyElement</p>
+ *
+ * @param formElement a {@link eu.etaxonomy.taxeditor.forms.ICdmFormElement} object.
+ */
public void destroyElement(ICdmFormElement formElement){
// return if element was not initialized
if(formElement == null){
}
+ /**
+ * <p>createEmptyCell</p>
+ *
+ * @param parent a {@link org.eclipse.swt.widgets.Composite} object.
+ * @return a {@link org.eclipse.swt.widgets.Label} object.
+ */
public Label createEmptyCell(Composite parent){
return this.createLabel(parent, null);
}
/**
- *
- * @param parent
- * @param labelString
- * @param textHeight
- * @param style
- * @return
+ * <p>createMultilineTextWithLabel</p>
+ *
+ * @param labelString a {@link java.lang.String} object.
+ * @param textHeight a int.
+ * @param style a int.
+ * @param parentElement a {@link eu.etaxonomy.taxeditor.forms.ICdmFormElement} object.
+ * @return a {@link eu.etaxonomy.taxeditor.forms.TextWithLabelElement} object.
*/
public TextWithLabelElement createMultilineTextWithLabel(ICdmFormElement parentElement, String labelString, int textHeight, int style){
TextWithLabelElement element = new TextWithLabelElement(this, parentElement, labelString, "", textHeight, style);
/**
- * @param textDataDetailElement
- * @param object
- * @param i
- * @param wrap
- * @return
+ * <p>createMultiLanguageTextElement</p>
+ *
+ * @param parentElement a {@link eu.etaxonomy.taxeditor.forms.ICdmFormElement} object.
+ * @param labelString a {@link java.lang.String} object.
+ * @param multilanguageText a {@link java.util.Map} object.
+ * @param textHeight a int.
+ * @param style a int.
+ * @return a {@link eu.etaxonomy.taxeditor.forms.MultilanguageTextElement} object.
*/
public MultilanguageTextElement createMultiLanguageTextElement(
ICdmFormElement parentElement, String labelString, Map<Language, LanguageString> multilanguageText, int textHeight,
/**
- *
- * @param parent
- * @param labelString
- * @param initialText
- * @param style
- * @return
+ * <p>createTextWithLabelElement</p>
+ *
+ * @param labelString a {@link java.lang.String} object.
+ * @param initialText a {@link java.lang.String} object.
+ * @param style a int.
+ * @param parentElement a {@link eu.etaxonomy.taxeditor.forms.ICdmFormElement} object.
+ * @return a {@link eu.etaxonomy.taxeditor.forms.TextWithLabelElement} object.
*/
public TextWithLabelElement createTextWithLabelElement(ICdmFormElement parentElement, String labelString, String initialText, int style){
TextWithLabelElement element = new TextWithLabelElement(this, parentElement, labelString, initialText, null, style);
return element;
}
+ /**
+ * <p>createIntegerTextWithLabelElement</p>
+ *
+ * @param parentElement a {@link eu.etaxonomy.taxeditor.forms.ICdmFormElement} object.
+ * @param labelString a {@link java.lang.String} object.
+ * @param initialInteger a {@link java.lang.Integer} object.
+ * @param style a int.
+ * @return a {@link eu.etaxonomy.taxeditor.forms.NumberWithLabelElement} object.
+ */
public NumberWithLabelElement createIntegerTextWithLabelElement(ICdmFormElement parentElement, String labelString, Integer initialInteger, int style){
NumberWithLabelElement element = new NumberWithLabelElement(this, parentElement, labelString, initialInteger, style);
adapt(element);
}
+ /**
+ * <p>createFloatTextWithLabelElement</p>
+ *
+ * @param parentElement a {@link eu.etaxonomy.taxeditor.forms.ICdmFormElement} object.
+ * @param labelString a {@link java.lang.String} object.
+ * @param initialFloat a float.
+ * @param style a int.
+ * @return a {@link eu.etaxonomy.taxeditor.forms.NumberWithLabelElement} object.
+ */
public NumberWithLabelElement createFloatTextWithLabelElement(
ICdmFormElement parentElement, String labelString, float initialFloat,
int style) {
return element;
}
+ /**
+ * <p>createLanguageStringWithLabelElement</p>
+ *
+ * @param parentElement a {@link eu.etaxonomy.taxeditor.forms.ICdmFormElement} object.
+ * @param labelString a {@link java.lang.String} object.
+ * @param languageString a {@link eu.etaxonomy.cdm.model.common.LanguageString} object.
+ * @param style a int.
+ * @return a {@link eu.etaxonomy.taxeditor.forms.LanguageStringWithLabelElement} object.
+ */
public LanguageStringWithLabelElement createLanguageStringWithLabelElement(ICdmFormElement parentElement, String labelString, LanguageString languageString, int style){
LanguageStringWithLabelElement element = new LanguageStringWithLabelElement(this, parentElement, labelString, languageString, style);
adapt(element);
return element;
}
+ /**
+ * <p>createLanguageStringWithLabelElement</p>
+ *
+ * @param parentElement a {@link eu.etaxonomy.taxeditor.forms.ICdmFormElement} object.
+ * @param labelString a {@link java.lang.String} object.
+ * @param languageString a {@link eu.etaxonomy.cdm.model.common.LanguageString} object.
+ * @param height a int.
+ * @param style a int.
+ * @return a {@link eu.etaxonomy.taxeditor.forms.LanguageStringWithLabelElement} object.
+ */
public LanguageStringWithLabelElement createLanguageStringWithLabelElement(ICdmFormElement parentElement, String labelString, LanguageString languageString, int height, int style){
LanguageStringWithLabelElement element = new LanguageStringWithLabelElement(this, parentElement, labelString, languageString, height, style);
adapt(element);
}
/**
- *
- * @param parentElement
- * @param labelString
- * @param initialText
- * @param style
- * @return
+ * <p>createTextElement</p>
+ *
+ * @param parentElement a {@link eu.etaxonomy.taxeditor.forms.ICdmFormElement} object.
+ * @param initialText a {@link java.lang.String} object.
+ * @param style a int.
+ * @return a {@link eu.etaxonomy.taxeditor.forms.TextWithLabelElement} object.
*/
public TextWithLabelElement createTextElement(ICdmFormElement parentElement, String initialText, int style){
TextWithLabelElement element = new TextWithLabelElement(this, parentElement, null, initialText, null, style);
return element;
}
+ /**
+ * <p>createKeyValueViewerElement</p>
+ *
+ * @param parentElement a {@link eu.etaxonomy.taxeditor.forms.ICdmFormElement} object.
+ * @param keyHeading a {@link java.lang.String} object.
+ * @param valueHeading a {@link java.lang.String} object.
+ * @param map a {@link java.util.Map} object.
+ * @return a {@link eu.etaxonomy.taxeditor.forms.KeyValueViewerElement} object.
+ */
public KeyValueViewerElement createKeyValueViewerElement(ICdmFormElement parentElement, String keyHeading, String valueHeading, Map<Object, Object> map){
KeyValueViewerElement element = new KeyValueViewerElement(this, parentElement, keyHeading, valueHeading, map);
adapt(element);
REFERENCE_SYSTEM
}
+ /**
+ * <p>createTermComboElement</p>
+ *
+ * @param termComboType a {@link eu.etaxonomy.taxeditor.forms.CdmFormFactory.TermComboType} object.
+ * @param parentElement a {@link eu.etaxonomy.taxeditor.forms.ICdmFormElement} object.
+ * @param labelString a {@link java.lang.String} object.
+ * @param selection a {@link eu.etaxonomy.cdm.model.common.DefinedTermBase} object.
+ * @param style a int.
+ * @return a {@link eu.etaxonomy.taxeditor.forms.term.AbstractTermComboElement} object.
+ */
public AbstractTermComboElement createTermComboElement(TermComboType termComboType, ICdmFormElement parentElement, String labelString, DefinedTermBase selection, int style){
AbstractTermComboElement element = null;
NOMENCLATURALCODE
}
+ /**
+ * <p>createEnumComboElement</p>
+ *
+ * @param enumComboType a {@link eu.etaxonomy.taxeditor.forms.CdmFormFactory.EnumComboType} object.
+ * @param parentElement a {@link eu.etaxonomy.taxeditor.forms.ICdmFormElement} object.
+ * @param style a int.
+ * @return a {@link eu.etaxonomy.taxeditor.forms.term.AbstractEnumComboElement} object.
+ */
public AbstractEnumComboElement createEnumComboElement(EnumComboType enumComboType, ICdmFormElement parentElement, int style){
AbstractEnumComboElement element = null;
}
/**
- *
- * @param parent
- * @param imageUri
- * @param style
- * @return
+ * <p>createBrowserElement</p>
+ *
+ * @param imageUri a {@link java.net.URI} object.
+ * @param style a int.
+ * @param parentElement a {@link eu.etaxonomy.taxeditor.forms.ICdmFormElement} object.
+ * @return a {@link eu.etaxonomy.taxeditor.forms.BrowserElement} object.
*/
public BrowserElement createBrowserElement(ICdmFormElement parentElement, URI imageUri, int style){
BrowserElement element = new BrowserElement(this, parentElement, imageUri, style);
return element;
}
+ /**
+ * <p>createImageElement</p>
+ *
+ * @param parentElement a {@link eu.etaxonomy.taxeditor.forms.ICdmFormElement} object.
+ * @param imageUri a {@link java.net.URI} object.
+ * @param style a int.
+ * @return a {@link eu.etaxonomy.taxeditor.forms.ImageElement} object.
+ */
public ImageElement createImageElement(ICdmFormElement parentElement, URI imageUri, int style) {
ImageElement element = new ImageElement(this, parentElement, imageUri, style);
adapt(element);
}
/**
- *
- * @param parent
- * @param labelString
- * @param initialText
- * @param style
- * @return
+ * <p>createTextActionElement</p>
+ *
+ * @param labelString a {@link java.lang.String} object.
+ * @param initialText a {@link java.lang.String} object.
+ * @param style a int.
+ * @param parentElement a {@link eu.etaxonomy.taxeditor.forms.ICdmFormElement} object.
+ * @param buttonLabel a {@link java.lang.String} object.
+ * @return a {@link eu.etaxonomy.taxeditor.forms.TextActionElement} object.
*/
public TextActionElement createTextActionElement(ICdmFormElement parentElement, String labelString, String buttonLabel, String initialText, int style){
TextActionElement element = new TextActionElement(this, parentElement, labelString, buttonLabel, initialText, style);
}
/**
- * @param parent
- * @param string
- * @param b
- * @param taxonBasePropertySection
- * @return
+ * <p>createCheckbox</p>
+ *
+ * @param parentElement a {@link eu.etaxonomy.taxeditor.forms.ICdmFormElement} object.
+ * @param label a {@link java.lang.String} object.
+ * @param initialState a boolean.
+ * @param style a int.
+ * @return a {@link eu.etaxonomy.taxeditor.forms.CheckboxElement} object.
*/
public CheckboxElement createCheckbox(ICdmFormElement parentElement, String label, boolean initialState, int style) {
CheckboxElement element = new CheckboxElement(this, parentElement, label, initialState, style | orientation);
/**
* Creates a section as a part of the form.
- *
- * @param parent
- * the section parent
- * @param sectionStyle
- * the section style
+ *
* @return the section widget
+ * @param section a {@link eu.etaxonomy.taxeditor.forms.AbstractFormSection} object.
*/
public Section adapt(AbstractFormSection section) {
section.setMenu(section.getLayoutComposite().getMenu());
}
}
+ /**
+ * <p>createToggleableTextField</p>
+ *
+ * @param parentElement a {@link eu.etaxonomy.taxeditor.forms.ICdmFormElement} object.
+ * @param labelString a {@link java.lang.String} object.
+ * @param initialText a {@link java.lang.String} object.
+ * @param initialState a boolean.
+ * @param style a int.
+ * @return a {@link eu.etaxonomy.taxeditor.forms.ToggleableTextElement} object.
+ */
public ToggleableTextElement createToggleableTextField(ICdmFormElement parentElement,
String labelString, String initialText, boolean initialState, int style) {
ToggleableTextElement element = new ToggleableTextElement(this, parentElement,
return element;
}
+ /**
+ * <p>createTimePeriodElement</p>
+ *
+ * @param parentElement a {@link eu.etaxonomy.taxeditor.forms.ICdmFormElement} object.
+ * @param labelString a {@link java.lang.String} object.
+ * @param timePeriod a {@link eu.etaxonomy.cdm.model.common.TimePeriod} object.
+ * @param style a int.
+ * @return a {@link eu.etaxonomy.taxeditor.forms.TimePeriodElement} object.
+ */
public TimePeriodElement createTimePeriodElement(
ICdmFormElement parentElement, String labelString, TimePeriod timePeriod, int style) {
TimePeriodElement element = new TimePeriodElement(this, parentElement, labelString, timePeriod, style);
/**
- * @param formElement
- * @param exactLocation
- * @param style
- * @return
+ * <p>createPointElement</p>
+ *
+ * @param style a int.
+ * @param parentElement a {@link eu.etaxonomy.taxeditor.forms.ICdmFormElement} object.
+ * @param point a {@link eu.etaxonomy.cdm.model.location.Point} object.
+ * @return a {@link eu.etaxonomy.taxeditor.forms.PointElement} object.
*/
public PointElement createPointElement(ICdmFormElement parentElement,
Point point, int style) {
return element;
}
+ /**
+ * <p>createDateDetailSection</p>
+ *
+ * @param parentElement a {@link eu.etaxonomy.taxeditor.forms.ICdmFormElement} object.
+ * @param style a int.
+ * @return a {@link eu.etaxonomy.taxeditor.forms.DateDetailSection} object.
+ */
public DateDetailSection createDateDetailSection(ICdmFormElement parentElement, int style){
DateDetailSection section = new DateDetailSection(this, parentElement, style);
parentElement.addElement(section);
return section;
}
+ /**
+ * <p>createPartialElement</p>
+ *
+ * @param parentElement a {@link eu.etaxonomy.taxeditor.forms.ICdmFormElement} object.
+ * @param labelString a {@link java.lang.String} object.
+ * @param partial a {@link org.joda.time.Partial} object.
+ * @param style a int.
+ * @return a {@link eu.etaxonomy.taxeditor.forms.PartialElement} object.
+ */
public PartialElement createPartialElement(ICdmFormElement parentElement, String labelString, Partial partial, int style){
PartialElement element = new PartialElement(this, parentElement, labelString, style);
adapt(element);
return element;
}
+ /**
+ * <p>addSelectionListener</p>
+ *
+ * @param listener a {@link org.eclipse.swt.events.SelectionListener} object.
+ */
public void addSelectionListener(SelectionListener listener){
selectionListenerList.add(listener);
}
+ /**
+ * <p>removeSelectionListener</p>
+ *
+ * @param listener a {@link org.eclipse.swt.events.SelectionListener} object.
+ */
public void removeSelectionListener(SelectionListener listener){
if(listener == null){
EditorUtil.error(this.getClass(), "Tried to remove a selection listener from this factories listeners but was null", null);
}
}
+ /**
+ * <p>addPropertyChangeListener</p>
+ *
+ * @param listener a {@link org.eclipse.jface.util.IPropertyChangeListener} object.
+ */
public void addPropertyChangeListener(IPropertyChangeListener listener) {
propertyChangeListeners.add(listener);
}
+ /**
+ * <p>removePropertyChangeListener</p>
+ *
+ * @param listener a {@link org.eclipse.jface.util.IPropertyChangeListener} object.
+ */
public void removePropertyChangeListener(IPropertyChangeListener listener){
propertyChangeListeners.remove(listener);
}
+ /**
+ * <p>createHorizontalSeparator</p>
+ *
+ * @param parentElement a {@link eu.etaxonomy.taxeditor.forms.ICdmFormElement} object.
+ * @param style a int.
+ * @return a {@link org.eclipse.swt.widgets.Label} object.
+ */
public Label createHorizontalSeparator(ICdmFormElement parentElement, int style) {
Label separator = this.createSeparator(parentElement.getLayoutComposite(), SWT.HORIZONTAL | style);
separator.setLayoutData(FILL_HORIZONTALLY());
return separator;
}
+ /**
+ * <p>createVersionElement</p>
+ *
+ * @param parentElement a {@link eu.etaxonomy.taxeditor.forms.ICdmFormElement} object.
+ * @param entity a {@link eu.etaxonomy.cdm.model.common.VersionableEntity} object.
+ * @param style a int.
+ * @return a {@link eu.etaxonomy.taxeditor.section.supplemental.VersionElement} object.
+ */
public VersionElement createVersionElement(ICdmFormElement parentElement, VersionableEntity entity,
int style) {
VersionElement element = new VersionElement(this, parentElement, entity, style);
return element;
}
+ /**
+ * <p>createVersionSection</p>
+ *
+ * @param parentElement a {@link eu.etaxonomy.taxeditor.forms.ICdmFormElement} object.
+ * @param style a int.
+ * @return a {@link eu.etaxonomy.taxeditor.section.supplemental.VersionSection} object.
+ */
public VersionSection createVersionSection(ICdmFormElement parentElement, int style) {
VersionSection section = new VersionSection(this, parentElement, style);
parentElement.addElement(section);
return section;
}
+ /**
+ * <p>createEmptyElement</p>
+ *
+ * @param parentElement a {@link eu.etaxonomy.taxeditor.forms.ICdmFormElement} object.
+ * @return a {@link eu.etaxonomy.taxeditor.section.EmptyElement} object.
+ */
public EmptyElement createEmptyElement(ICdmFormElement parentElement) {
EmptyElement element = new EmptyElement(this, parentElement, null, SWT.NULL);
adapt(element);
return element;
}
+ /**
+ * <p>createHeadlineSection</p>
+ *
+ * @param parentElement a {@link eu.etaxonomy.taxeditor.forms.ICdmFormElement} object.
+ * @return a {@link eu.etaxonomy.taxeditor.section.supplemental.HeadlineSection} object.
+ */
public HeadlineSection createHeadlineSection(ICdmFormElement parentElement) {
HeadlineSection section = new HeadlineSection(this, parentElement, SWT.NULL);
parentElement.addElement(section);
}
+ /**
+ * <p>createParsingMessageElement</p>
+ *
+ * @param parentElement a {@link eu.etaxonomy.taxeditor.forms.ICdmFormElement} object.
+ * @param parserProblem a {@link eu.etaxonomy.cdm.strategy.parser.ParserProblem} object.
+ * @param style a int.
+ * @return a {@link eu.etaxonomy.taxeditor.section.taxon.ParsingMessageElement} object.
+ */
public ParsingMessageElement createParsingMessageElement(
ICdmFormElement parentElement, ParserProblem parserProblem, int style) {
ParsingMessageElement element = new ParsingMessageElement(this, parentElement, parserProblem, style);
}
/**
- *
- * @param detailType
- * @param parentElement
- * @param selectionProvider
- * @param style
- * @return
+ * <p>createCdmDetailSection</p>
+ *
+ * @param detailType a {@link eu.etaxonomy.taxeditor.forms.CdmFormFactory.DetailType} object.
+ * @param parentElement a {@link eu.etaxonomy.taxeditor.forms.ICdmFormElement} object.
+ * @param selectionProvider a {@link org.eclipse.jface.viewers.ISelectionProvider} object.
+ * @param style a int.
+ * @param conversation a {@link eu.etaxonomy.cdm.api.conversation.ConversationHolder} object.
+ * @return a {@link eu.etaxonomy.taxeditor.forms.AbstractFormSection} object.
*/
public AbstractFormSection createCdmDetailSection(DetailType detailType, ConversationHolder conversation, ICdmFormElement parentElement, ISelectionProvider selectionProvider, int style){
AbstractFormSection section = null;
}
/**
- *
- * @param detailType
- * @param parent
- * @param style
- * @return
+ * <p>createCdmDetailElement</p>
+ *
+ * @param detailType a {@link eu.etaxonomy.taxeditor.forms.CdmFormFactory.DetailType} object.
+ * @param style a int.
+ * @param parentElement a {@link eu.etaxonomy.taxeditor.forms.ICdmFormElement} object.
+ * @return a {@link eu.etaxonomy.taxeditor.section.AbstractCdmDetailElement} object.
*/
public AbstractCdmDetailElement createCdmDetailElement(DetailType detailType, ICdmFormElement parentElement, int style){
AbstractCdmDetailElement element = null;
}
/**
- *
- * @param entityDetailType
- * @param parent
- * @param style
- * @return
+ * <p>createEntityDetailSection</p>
+ *
+ * @param entityDetailType a {@link eu.etaxonomy.taxeditor.forms.CdmFormFactory.EntityDetailType} object.
+ * @param style a int.
+ * @param conversation a {@link eu.etaxonomy.cdm.api.conversation.ConversationHolder} object.
+ * @param parentElement a {@link eu.etaxonomy.taxeditor.forms.ICdmFormElement} object.
+ * @return a {@link eu.etaxonomy.taxeditor.forms.AbstractFormSection} object.
*/
public AbstractFormSection createEntityDetailSection(EntityDetailType entityDetailType, ConversationHolder conversation, ICdmFormElement parentElement, int style){
AbstractFormSection section = null;
}
/**
- *
- * @param parent
- * @param entity
- * @param removeListener
- * @param style
- * @return
+ * <p>createEntityCollectionElement</p>
+ *
+ * @param removeListener a {@link org.eclipse.swt.events.SelectionListener} object.
+ * @param style a int.
+ * @param parentElement a {@link eu.etaxonomy.taxeditor.forms.AbstractFormSection} object.
+ * @param versionableEntity a {@link eu.etaxonomy.cdm.model.common.IVersionableEntity} object.
+ * @param backgroundColor a {@link org.eclipse.swt.graphics.Color} object.
+ * @return a {@link eu.etaxonomy.taxeditor.section.AbstractEntityCollectionElement} object.
*/
public AbstractEntityCollectionElement createEntityCollectionElement(AbstractFormSection parentElement, IVersionableEntity versionableEntity, SelectionListener removeListener, Color backgroundColor, int style){
AbstractEntityCollectionElement element = null;
}
/**
- *
+ * <p>createSelectionElement</p>
+ *
+ * @param selectionType a {@link eu.etaxonomy.taxeditor.forms.CdmFormFactory.SelectionType} object.
+ * @param parentElement a {@link eu.etaxonomy.taxeditor.forms.ICdmFormElement} object.
+ * @param labelString a {@link java.lang.String} object.
* @param selectionType
- * @param parentElement
- * @param labelString
- * @param selection
- * @param style
- * @return
+ * @param selection a {@link eu.etaxonomy.cdm.model.common.IAnnotatableEntity} object.
+ * @param style a int.
+ * @param conversation a {@link eu.etaxonomy.cdm.api.conversation.ConversationHolder} object.
+ * @return a {@link eu.etaxonomy.taxeditor.forms.selection.AbstractSelectionElement} object.
*/
public AbstractSelectionElement createSelectionElement(SelectionType selectionType, ConversationHolder conversation, ICdmFormElement parentElement, String labelString, IAnnotatableEntity selection, int style){
AbstractSelectionElement element = null;
return element;
}
+ /**
+ * <p>createNamedAreaSelectionElement</p>
+ *
+ * @param parentElement a {@link eu.etaxonomy.taxeditor.forms.ICdmFormElement} object.
+ * @param conversation a {@link eu.etaxonomy.cdm.api.conversation.ConversationHolder} object.
+ * @param labelString a {@link java.lang.String} object.
+ * @param selection a {@link eu.etaxonomy.cdm.model.location.NamedArea} object.
+ * @param style a int.
+ * @return a {@link eu.etaxonomy.taxeditor.forms.selection.NamedAreaSelectionElement} object.
+ */
public NamedAreaSelectionElement createNamedAreaSelectionElement(ICdmFormElement parentElement, ConversationHolder conversation, String labelString, NamedArea selection, int style){
NamedAreaSelectionElement element = new NamedAreaSelectionElement(this, conversation, parentElement, labelString, selection, style);
adapt(element);
return element;
}
+ /** {@inheritDoc} */
public LabelElement createLabel(ICdmFormElement parentElement, String text) {
LabelElement labelElement = new LabelElement(this, parentElement, text);
adapt(labelElement);
return labelElement;
}
+ /**
+ * <p>Getter for the field <code>selectionProvider</code>.</p>
+ *
+ * @return a {@link org.eclipse.jface.viewers.ISelectionProvider} object.
+ */
public ISelectionProvider getSelectionProvider() {
return selectionProvider;
}
+ /**
+ * <p>createDetailedDescriptionDetailElement</p>
+ *
+ * @param parentElement a {@link eu.etaxonomy.taxeditor.forms.ICdmFormElement} object.
+ * @param entity a {@link eu.etaxonomy.cdm.model.description.DescriptionElementBase} object.
+ * @param style a int.
+ * @return a {@link eu.etaxonomy.taxeditor.section.description.detail.AbstractDetailedDescriptionDetailElement} object.
+ */
public AbstractDetailedDescriptionDetailElement createDetailedDescriptionDetailElement(
ICdmFormElement parentElement, DescriptionElementBase entity, int style) {
AbstractDetailedDescriptionDetailElement detailedDescriptionElement = null;
/**
* Creates a styled text as a part of the form.
- *
+ *
* @param parent
* the text parent
* @param value
BGBM BDI Projects / taxeditor.git / blobdiff