Project

General

Profile

« Previous | Next » 

Revision 3be6ef3e

Added by Niels Hoffmann over 13 years ago

performed javacscript:fix and worked on documentation

View differences:

taxeditor-editor/src/main/java/eu/etaxonomy/taxeditor/forms/AbstractCdmEntityWizardPage.java
24 24
import eu.etaxonomy.taxeditor.section.AbstractCdmDetailElement;
25 25

  
26 26
/**
27
 * <p>Abstract AbstractCdmEntityWizardPage class.</p>
28
 *
27 29
 * @author n.hoffmann
28 30
 * @created Jun 1, 2010
29 31
 * @version 1.0
......
36 38
	AbstractCdmDetailElement<T> detailElement;
37 39
	private ConversationHolder conversation;
38 40
	
41
	/**
42
	 * <p>Constructor for AbstractCdmEntityWizardPage.</p>
43
	 *
44
	 * @param formFactory a {@link eu.etaxonomy.taxeditor.forms.CdmFormFactory} object.
45
	 * @param conversation a {@link eu.etaxonomy.cdm.api.conversation.ConversationHolder} object.
46
	 * @param entity a T object.
47
	 * @param <T> a T object.
48
	 */
39 49
	protected AbstractCdmEntityWizardPage(CdmFormFactory formFactory, ConversationHolder conversation, T entity) {
40 50
		super("page");
41 51
		this.formFactory = formFactory;
......
58 68
	 * (non-Javadoc)
59 69
	 * @see org.eclipse.jface.dialogs.IDialogPage#createControl(org.eclipse.swt.widgets.Composite)
60 70
	 */
71
	/** {@inheritDoc} */
61 72
	public void createControl(Composite parent) {
62 73
		Composite control = formFactory.createComposite(parent);
63 74
		
......
74 85
		setControl(control);
75 86
	}
76 87
	
88
	/**
89
	 * <p>Getter for the field <code>entity</code>.</p>
90
	 *
91
	 * @return a T object.
92
	 */
77 93
	public T getEntity() {
78 94
		return entity;
79 95
	}
80 96
	
81 97
	/**
82 98
	 * Creates the detail element for this wizard page
83
	 * 
84
	 * @param rootElement
99
	 *
100
	 * @param rootElement a {@link eu.etaxonomy.taxeditor.forms.ICdmFormElement} object.
101
	 * @return a {@link eu.etaxonomy.taxeditor.section.AbstractCdmDetailElement} object.
85 102
	 */
86 103
	public abstract AbstractCdmDetailElement createElement(ICdmFormElement rootElement);
87 104
	
......
110 127
		public void update(CdmDataChangeMap changeEvents) {}
111 128
	}
112 129
	
130
	/**
131
	 * <p>getConversationHolder</p>
132
	 *
133
	 * @return a {@link eu.etaxonomy.cdm.api.conversation.ConversationHolder} object.
134
	 */
113 135
	public ConversationHolder getConversationHolder() {
114 136
		return conversation;
115 137
	}
116 138
	
139
	/** {@inheritDoc} */
117 140
	@Override
118 141
	public void dispose() {
119 142
		super.dispose();
120 143
		detailElement.removeElements();
121 144
	}
122 145
	
146
	/**
147
	 * <p>Getter for the field <code>detailElement</code>.</p>
148
	 *
149
	 * @return a {@link eu.etaxonomy.taxeditor.section.AbstractCdmDetailElement} object.
150
	 */
123 151
	public AbstractCdmDetailElement<T> getDetailElement() {
124 152
		return detailElement;
125 153
	}
126 154
	
155
	/** {@inheritDoc} */
127 156
	public void update(CdmDataChangeMap changeEvents) {}
128 157
}

Also available in: Unified diff