~ubuntu-branches/ubuntu/quantal/netbeans/quantal

« back to all changes in this revision

Viewing changes to xml/multiview/src/org/netbeans/modules/xml/multiview/ItemComboBoxHelper.java

  • Committer: Bazaar Package Importer
  • Author(s): Marek Slama
  • Date: 2008-01-29 14:11:22 UTC
  • Revision ID: james.westby@ubuntu.com-20080129141122-fnzjbo11ntghxfu7
Tags: upstream-6.0.1
ImportĀ upstreamĀ versionĀ 6.0.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
/*
 
2
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 
3
 *
 
4
 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
 
5
 *
 
6
 * The contents of this file are subject to the terms of either the GNU
 
7
 * General Public License Version 2 only ("GPL") or the Common
 
8
 * Development and Distribution License("CDDL") (collectively, the
 
9
 * "License"). You may not use this file except in compliance with the
 
10
 * License. You can obtain a copy of the License at
 
11
 * http://www.netbeans.org/cddl-gplv2.html
 
12
 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
 
13
 * specific language governing permissions and limitations under the
 
14
 * License.  When distributing the software, include this License Header
 
15
 * Notice in each file and include the License file at
 
16
 * nbbuild/licenses/CDDL-GPL-2-CP.  Sun designates this
 
17
 * particular file as subject to the "Classpath" exception as provided
 
18
 * by Sun in the GPL Version 2 section of the License file that
 
19
 * accompanied this code. If applicable, add the following below the
 
20
 * License Header, with the fields enclosed by brackets [] replaced by
 
21
 * your own identifying information:
 
22
 * "Portions Copyrighted [year] [name of copyright owner]"
 
23
 *
 
24
 * Contributor(s):
 
25
 *
 
26
 * The Original Software is NetBeans. The Initial Developer of the Original
 
27
 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
 
28
 * Microsystems, Inc. All Rights Reserved.
 
29
 *
 
30
 * If you wish your version of this file to be governed by only the CDDL
 
31
 * or only the GPL Version 2, indicate your decision by adding
 
32
 * "[Contributor] elects to include this software in this distribution
 
33
 * under the [CDDL or GPL Version 2] license." If you do not indicate a
 
34
 * single choice of license, a recipient has the option to distribute
 
35
 * your version of this file under either the CDDL, the GPL Version 2 or
 
36
 * to extend the choice of license to its licensees as provided above.
 
37
 * However, if you add GPL Version 2 code and therefore, elected the GPL
 
38
 * Version 2 license, then the option applies only if the new code is
 
39
 * made subject to such option by the copyright holder.
 
40
 */
 
41
 
 
42
package org.netbeans.modules.xml.multiview;
 
43
 
 
44
import javax.swing.*;
 
45
import java.awt.event.ActionEvent;
 
46
import java.awt.event.ActionListener;
 
47
 
 
48
/**
 
49
 * The class simplifies use of a combo box to show/set value of an item
 
50
 *
 
51
 * @author pfiala
 
52
 */
 
53
public abstract class ItemComboBoxHelper implements ActionListener, Refreshable {
 
54
    private XmlMultiViewDataSynchronizer synchronizer;
 
55
    private JComboBox comboBox;
 
56
 
 
57
    /**
 
58
     * Constructor initializes object by combo box and data object which will be handled
 
59
     *
 
60
     * @param synchronizer
 
61
     * @param comboBox   handled JComboBox.
 
62
     */
 
63
    public ItemComboBoxHelper(XmlMultiViewDataSynchronizer synchronizer, JComboBox comboBox) {
 
64
        this.synchronizer = synchronizer;
 
65
        this.comboBox = comboBox;
 
66
        comboBox.addActionListener(this);
 
67
        setValue(getItemValue());
 
68
    }
 
69
 
 
70
    /**
 
71
     * Invoked when an action occurs on a combo box.
 
72
     */
 
73
    public final void actionPerformed(ActionEvent e) {
 
74
        final String value = (String) comboBox.getSelectedItem();
 
75
        if (value == null || !value.equals(getItemValue())) {
 
76
            setItemValue(value);
 
77
            synchronizer.requestUpdateData();
 
78
        }
 
79
    }
 
80
 
 
81
    /**
 
82
     * Selects the item value in combo box.
 
83
     *
 
84
     * @param itemValue value of item to be selected in combo box
 
85
     */
 
86
    public void setValue(String itemValue) {
 
87
        comboBox.setSelectedItem(itemValue);
 
88
    }
 
89
 
 
90
    /**
 
91
     * Combo box getter
 
92
     *
 
93
     * @return handled combo box
 
94
     */
 
95
    public JComboBox getComboBox() {
 
96
        return comboBox;
 
97
    }
 
98
 
 
99
    /**
 
100
     * Retrieves the text value selected in the combo box.
 
101
     *
 
102
     * @return selected item of the combo box
 
103
     */
 
104
    public String getValue() {
 
105
        return (String) comboBox.getSelectedItem();
 
106
    }
 
107
 
 
108
    /**
 
109
     * Called by the helper in order to retrieve the value of the item.
 
110
     *
 
111
     * @return value of the handled item.
 
112
     */
 
113
    public abstract String getItemValue();
 
114
 
 
115
    /**
 
116
     * Called by the helper in order to set the value of the item
 
117
     *
 
118
     * @param value new value of the hanlded item
 
119
     */
 
120
    public abstract void setItemValue(String value);
 
121
 
 
122
    public void refresh() {
 
123
        setValue(getItemValue());
 
124
    }
 
125
}