performed javacscript:fix and worked on documentation
[taxeditor.git] / taxeditor-editor / src / main / java / eu / etaxonomy / taxeditor / section / occurrence / CollectingAreasDetailSection.java
1 // $Id$
2 /**
3 * Copyright (C) 2007 EDIT
4 * European Distributed Institute of Taxonomy
5 * http://www.e-taxonomy.eu
6 *
7 * The contents of this file are subject to the Mozilla Public License Version 1.1
8 * See LICENSE.TXT at the top of this package for the full license terms.
9 */
10
11 package eu.etaxonomy.taxeditor.section.occurrence;
12
13 import java.util.Collection;
14
15 import eu.etaxonomy.cdm.api.conversation.ConversationHolder;
16 import eu.etaxonomy.cdm.api.facade.DerivedUnitFacade;
17 import eu.etaxonomy.cdm.model.location.NamedArea;
18 import eu.etaxonomy.taxeditor.forms.CdmFormFactory;
19 import eu.etaxonomy.taxeditor.forms.ICdmFormElement;
20 import eu.etaxonomy.taxeditor.section.AbstractEntityCollectionSection;
21
22 /**
23 * <p>CollectingAreasDetailSection class.</p>
24 *
25 * @author n.hoffmann
26 * @created Oct 14, 2010
27 * @version 1.0
28 */
29 public class CollectingAreasDetailSection extends
30 AbstractEntityCollectionSection<DerivedUnitFacade, NamedArea> {
31
32 /**
33 * <p>Constructor for CollectingAreasDetailSection.</p>
34 *
35 * @param formFactory a {@link eu.etaxonomy.taxeditor.forms.CdmFormFactory} object.
36 * @param conversation a {@link eu.etaxonomy.cdm.api.conversation.ConversationHolder} object.
37 * @param parentElement a {@link eu.etaxonomy.taxeditor.forms.ICdmFormElement} object.
38 * @param style a int.
39 */
40 public CollectingAreasDetailSection(CdmFormFactory formFactory,
41 ConversationHolder conversation, ICdmFormElement parentElement, int style) {
42 super(formFactory, conversation, parentElement, "Collecting Areas", style);
43 }
44
45 /* (non-Javadoc)
46 * @see eu.etaxonomy.taxeditor.section.AbstractEntityCollectionSection#getCollection(java.lang.Object)
47 */
48 /** {@inheritDoc} */
49 @Override
50 public Collection<NamedArea> getCollection(DerivedUnitFacade entity) {
51 return entity.getCollectingAreas();
52 }
53
54 /* (non-Javadoc)
55 * @see eu.etaxonomy.taxeditor.section.AbstractEntityCollectionSection#createNewElement()
56 */
57 /** {@inheritDoc} */
58 @Override
59 public NamedArea createNewElement() {
60 return NamedArea.NewInstance();
61 }
62
63 /* (non-Javadoc)
64 * @see eu.etaxonomy.taxeditor.section.AbstractEntityCollectionSection#addElement(eu.etaxonomy.cdm.model.common.IVersionableEntity)
65 */
66 /** {@inheritDoc} */
67 @Override
68 public void addElement(NamedArea element) {
69 getEntity().addCollectingArea(element);
70 }
71
72 /* (non-Javadoc)
73 * @see eu.etaxonomy.taxeditor.section.AbstractEntityCollectionSection#removeElement(eu.etaxonomy.cdm.model.common.IVersionableEntity)
74 */
75 /** {@inheritDoc} */
76 @Override
77 public void removeElement(NamedArea element) {
78 getEntity().removeCollectingArea(element);
79 }
80
81 /* (non-Javadoc)
82 * @see eu.etaxonomy.taxeditor.section.AbstractEntityCollectionSection#getEmptyString()
83 */
84 /** {@inheritDoc} */
85 @Override
86 public String getEmptyString() {
87 return "No collecting areas yet.";
88 }
89
90 /* (non-Javadoc)
91 * @see eu.etaxonomy.taxeditor.section.AbstractEntityCollectionSection#getTooltipString()
92 */
93 /** {@inheritDoc} */
94 @Override
95 protected String getTooltipString() {
96 return "Add a collecting area";
97 }
98
99 }