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/term/AbstractTermComboElement.java
34 34
import eu.etaxonomy.taxeditor.store.CdmStore;
35 35

  
36 36
/**
37
 * 
37
 * <p>Abstract AbstractTermComboElement class.</p>
38
 *
38 39
 * @author n.hoffmann
39 40
 * @created Nov 5, 2009
40 41
 * @version 1.0
......
59 60
	private Composite msgComposite;
60 61
	
61 62
	/**
62
	 * @param parentElement
63
	 * @param style
63
	 * <p>Constructor for AbstractTermComboElement.</p>
64
	 *
65
	 * @param parentElement a {@link eu.etaxonomy.taxeditor.forms.ICdmFormElement} object.
66
	 * @param style a int.
67
	 * @param formFactory a {@link eu.etaxonomy.taxeditor.forms.CdmFormFactory} object.
68
	 * @param labelString a {@link java.lang.String} object.
69
	 * @param selection a T object.
70
	 * @param visibleItems a int.
71
	 * @param <T> a T object.
64 72
	 */
65 73
	public AbstractTermComboElement(CdmFormFactory formFactory, ICdmFormElement parentElement, String labelString, T selection, int visibleItems, int style) {
66 74
		super(formFactory, parentElement);
......
87 95
        }
88 96
	}
89 97

  
98
	/**
99
	 * <p>Getter for the field <code>selection</code>.</p>
100
	 *
101
	 * @return a T object.
102
	 */
90 103
	public T getSelection(){
91 104
		return selection;
92 105
	}
93 106
	
107
	/**
108
	 * <p>Setter for the field <code>selection</code>.</p>
109
	 *
110
	 * @param selection a T object.
111
	 */
94 112
	public void setSelection(T selection){
95 113
		Listener[] listeners = combo.getListeners(SWT.Selection);
96 114
		
......
171 189
	 * (non-Javadoc)
172 190
	 * @see eu.etaxonomy.taxeditor.forms.IEnableableFormElement#setEnabled(boolean)
173 191
	 */
192
	/** {@inheritDoc} */
174 193
	public void setEnabled(boolean enabled) {
175 194
		combo.setEnabled(enabled);
176 195
	}
177 196
	
178 197
	/**
179
	 * @return
198
	 * <p>preferredTerms</p>
199
	 *
200
	 * @return a {@link java.util.List} object.
180 201
	 */
181 202
	protected abstract List<T> preferredTerms();
182 203
	
183 204
	/**
184 205
	 * May be overridden by derived classes if the desired label string does not
185 206
	 * reside in term.getLabel();
186
	 * 
187
	 * @param term
188
	 * @return
207
	 *
208
	 * @param term a T object.
209
	 * @return a {@link java.lang.String} object.
189 210
	 */
190 211
	protected String getLabel(T term){
191 212
		return term.getLabel(CdmStore.getDefaultLanguage());
......
211 232
//		setSelection(term);
212 233
	}
213 234
	
235
	/**
236
	 * <p>addSelectionListener</p>
237
	 *
238
	 * @param listener a {@link org.eclipse.swt.events.SelectionListener} object.
239
	 */
214 240
	public void addSelectionListener(SelectionListener listener){
215 241
		combo.addSelectionListener(listener);
216 242
	}
217 243
	
244
	/**
245
	 * <p>removeSelectionListener</p>
246
	 *
247
	 * @param listener a {@link org.eclipse.swt.events.SelectionListener} object.
248
	 */
218 249
	public void removeSelectionListener(SelectionListener listener){
219 250
		combo.removeSelectionListener(listener);
220 251
	}
......
222 253
	/* (non-Javadoc)
223 254
	 * @see org.eclipse.swt.events.SelectionListener#widgetSelected(org.eclipse.swt.events.SelectionEvent)
224 255
	 */
256
	/** {@inheritDoc} */
225 257
	public void widgetSelected(SelectionEvent e) {
226 258
		selection = terms.get(combo.getSelectionIndex());
227 259
		firePropertyChangeEvent(new CdmPropertyChangeEvent(this, e));
......
230 262
	/* (non-Javadoc)
231 263
	 * @see java.beans.PropertyChangeListener#propertyChange(java.beans.PropertyChangeEvent)
232 264
	 */
265
	/** {@inheritDoc} */
233 266
	public void propertyChange(PropertyChangeEvent event) {
234 267
		super.propertyChange(event);
235 268
		if (event != null && PreferencesUtil.PREFERRED_TERMS_CHANGE.equals(event.getProperty())) {
......
237 270
		}
238 271
	}
239 272
	
273
	/** {@inheritDoc} */
240 274
	public void setSelected(boolean selected) {
241 275
		label.setBackground(getColor(selected));
242 276
	}
243 277
	
278
	/** {@inheritDoc} */
244 279
	public void widgetDisposed(DisposeEvent e) {
245 280
		PreferencesUtil.getPreferenceStore().removePropertyChangeListener(this);
246 281
	}
247 282
	
248 283
	// not used
284
	/** {@inheritDoc} */
249 285
	public void widgetDefaultSelected(SelectionEvent e) {}
250 286
	
287
	/** {@inheritDoc} */
251 288
	public void setIrrelevant(boolean irrelevant) {
252 289
		String colorId = irrelevant ? Resources.COLOR_COMPOSITE_IRRELEVANT : Resources.COLOR_COMPOSITE_BACKGROUND;
253 290
		
......
255 292
		combo.setBackground(color);
256 293
	}
257 294
	
295
	/** {@inheritDoc} */
258 296
	@Override
259 297
	public void setBackground(Color color) {
260 298
		if(label != null)

Also available in: Unified diff