Merge branch 'release/5.19.0'
[taxeditor.git] / eu.etaxonomy.taxeditor.store / src / main / java / eu / etaxonomy / taxeditor / ui / section / description / ScopeSection.java
1 /**
2 * Copyright (C) 2007 EDIT
3 * European Distributed Institute of Taxonomy
4 * http://www.e-taxonomy.eu
5 *
6 * The contents of this file are subject to the Mozilla Public License Version 1.1
7 * See LICENSE.TXT at the top of this package for the full license terms.
8 */
9 package eu.etaxonomy.taxeditor.ui.section.description;
10
11 import java.util.Collection;
12 import java.util.Comparator;
13
14 import eu.etaxonomy.cdm.api.conversation.ConversationHolder;
15 import eu.etaxonomy.cdm.model.description.TaxonDescription;
16 import eu.etaxonomy.cdm.model.term.DefinedTerm;
17 import eu.etaxonomy.taxeditor.ui.element.CdmFormFactory;
18 import eu.etaxonomy.taxeditor.ui.element.ICdmFormElement;
19 import eu.etaxonomy.taxeditor.ui.section.DefaultCdmBaseComparator;
20 import eu.etaxonomy.taxeditor.ui.section.occurrence.dna.AbstractUnboundEntityCollectionSection;
21
22 /**
23 * <p>ScopeSection class.</p>
24 *
25 * @author n.hoffmann
26 * @created Mar 18, 2010
27 * @version 1.0
28 */
29 public class ScopeSection extends AbstractUnboundEntityCollectionSection<TaxonDescription, DefinedTerm> {
30
31 /**
32 * <p>Constructor for ScopeSection.</p>
33 *
34 * @param cdmFormFactory a {@link eu.etaxonomy.taxeditor.ui.element.CdmFormFactory} object.
35 * @param conversation a {@link eu.etaxonomy.cdm.api.conversation.ConversationHolder} object.
36 * @param parentElement a {@link eu.etaxonomy.taxeditor.ui.element.ICdmFormElement} object.
37 * @param style a int.
38 */
39 public ScopeSection(CdmFormFactory cdmFormFactory, ConversationHolder conversation, ICdmFormElement parentElement, int style) {
40 super(cdmFormFactory, conversation, parentElement, "Scope", style);
41 }
42
43 @Override
44 public void addElement(DefinedTerm element) {
45 getEntity().addScope(element);
46 }
47
48 /** {@inheritDoc} */
49 @Override
50 public DefinedTerm createNewElement() {
51 return null;
52 }
53
54 @Override
55 public String getEmptyString() {
56 return "No scopes yet.";
57 }
58
59 @Override
60 protected String getTooltipString() {
61 return "Create a new scope";
62 }
63
64 @Override
65 public void removeElement(DefinedTerm element) {
66 getEntity().removeScope(element);
67 }
68
69 @Override
70 protected Collection<DefinedTerm> getEntityCollection(TaxonDescription entity) {
71 return entity.getScopes();
72 }
73
74 @Override
75 public Comparator<DefinedTerm> getComparator() {
76 return new DefaultCdmBaseComparator<>();
77 }
78
79 @Override
80 public DefinedTerm addExisting() {
81 return null;
82 }
83
84 @Override
85 public boolean allowAddExisting() {
86 return false;
87 }
88 }