performed javacscript:fix and worked on documentation
[taxeditor.git] / taxeditor-store / src / main / java / eu / etaxonomy / taxeditor / preference / menu / RankMenuPreferences.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.preference.menu;
10
11 import org.eclipse.swt.SWT;
12 import org.eclipse.swt.events.SelectionAdapter;
13 import org.eclipse.swt.events.SelectionEvent;
14 import org.eclipse.swt.widgets.Button;
15 import org.eclipse.swt.widgets.Composite;
16 import org.eclipse.ui.IWorkbenchPreferencePage;
17
18 import eu.etaxonomy.cdm.model.name.Rank;
19 import eu.etaxonomy.taxeditor.preference.PreferencesUtil;
20 import eu.etaxonomy.taxeditor.store.TermStore;
21
22 /**
23 * Allows the user to choose which <code>Rank</code>s to display in the
24 * <code>PropertySheet</code> drop-down menu for <code>TaxonNameBase</code>.
25 *
26 * @author p.ciardelli
27 * @author n.hoffmann
28 * @created 17.09.2008
29 * @version 1.0
30 */
31 public class RankMenuPreferences extends AbstractMenuPreferences<Rank> implements
32 IWorkbenchPreferencePage {
33
34 /** Constant <code>PLUGIN_ID="eu.etaxonomy.taxeditor.preferences.rank"{trunked}</code> */
35 public static final String PLUGIN_ID = "eu.etaxonomy.taxeditor.preferences.ranks";
36
37 /**
38 * <p>Constructor for RankMenuPreferences.</p>
39 */
40 public RankMenuPreferences() {
41 super(TermStore.getRanks(),
42 "Rank Preferences",
43 "Choose which ranks to display in the property sheet drop-down menu.",
44 false);
45 }
46
47 /* (non-Javadoc)
48 * @see eu.etaxonomy.taxeditor.preference.menu.AbstractMenuPreferences#createAdditionalContent(org.eclipse.swt.widgets.Composite)
49 */
50 /** {@inheritDoc} */
51 @Override
52 protected void createAdditionalContent(Composite container) {
53
54 // TODO create option to sort ranks either alphabetically or hierarchically (asc- or descending)
55
56 final Button checkbox = new Button(container, SWT.CHECK);
57 checkbox.setText("Sort ranks hierarchically (default is alphabetically)");
58
59 checkbox.setSelection(PreferencesUtil.getSortRanksHierarchichally());
60
61 checkbox.addSelectionListener(new SelectionAdapter() {
62 /* (non-Javadoc)
63 * @see org.eclipse.swt.events.SelectionAdapter#widgetSelected(org.eclipse.swt.events.SelectionEvent)
64 */
65 @Override
66 public void widgetSelected(SelectionEvent e) {
67 PreferencesUtil.setSortRanksHierarchichally(checkbox.getSelection());
68 refresh(TermStore.getRanks());
69 }
70 });
71
72 }
73
74 /* (non-Javadoc)
75 * @see eu.etaxonomy.taxeditor.preference.menu.AbstractMenuPreferences#getTermClass()
76 */
77 /** {@inheritDoc} */
78 @Override
79 protected Class<Rank> getTermClass() {
80 return Rank.class;
81 }
82
83 }