1 |
//---PACKAGE DECLARATION--- |
2 |
package uk.ac.ukc.iscream.conient.datacomponents; |
3 |
|
4 |
//---IMPORTS--- |
5 |
import javax.swing.JLabel; |
6 |
import javax.swing.JTextField; |
7 |
import java.awt.GridLayout; |
8 |
import javax.swing.SwingUtilities; |
9 |
|
10 |
/** |
11 |
* This is the most basic of DataComponents. |
12 |
* |
13 |
* It simply displays the value as a String |
14 |
* in a JTextField. |
15 |
* |
16 |
* @author $Author: ajm4 $ |
17 |
* @version $Id: StringDataComponent.java,v 1.9 2001/01/29 12:27:52 ajm4 Exp $ |
18 |
*/ |
19 |
public class StringDataComponent extends VisibleDataComponent { |
20 |
|
21 |
//---FINAL ATTRIBUTES--- |
22 |
|
23 |
/** |
24 |
* The current CVS revision of this class |
25 |
*/ |
26 |
public final String REVISION = "$Revision: 1.9 $"; |
27 |
|
28 |
/** |
29 |
* The default length of the JTextField |
30 |
*/ |
31 |
private final int DEFAULT_TEXT_LENGTH = 20; |
32 |
|
33 |
//---STATIC METHODS--- |
34 |
|
35 |
//---CONSTRUCTORS--- |
36 |
|
37 |
/** |
38 |
* Creates the component with a friendly name to be |
39 |
* used as label |
40 |
* |
41 |
* @param name the friendly name |
42 |
* @param attribute the data attribute we look after |
43 |
*/ |
44 |
public StringDataComponent(String name, String attribute) { |
45 |
_name = name; |
46 |
_attribute = attribute; |
47 |
_item = new JTextField("", DEFAULT_TEXT_LENGTH); |
48 |
_item.setEditable(false); |
49 |
_label = new JLabel(_name + ": "); |
50 |
_label.setHorizontalAlignment(JLabel.RIGHT); |
51 |
setLayout(new GridLayout(1, 2)); |
52 |
_item.setText("-uninitialised-"); |
53 |
add(_label); |
54 |
add(_item); |
55 |
} |
56 |
|
57 |
//---PUBLIC METHODS--- |
58 |
|
59 |
/** |
60 |
* This run method updates any Swing components |
61 |
* The setValue() method adds this component |
62 |
* to the Swing Event Dispatching Queue to |
63 |
* run this method. |
64 |
*/ |
65 |
public void run() { |
66 |
_item.setText(_cache); |
67 |
} |
68 |
|
69 |
/** |
70 |
* Overrides the {@link java.lang.Object#toString() Object.toString()} |
71 |
* method to provide clean logging (every class should have this). |
72 |
* |
73 |
* @return the name of this class and its CVS revision |
74 |
*/ |
75 |
public String toString() { |
76 |
return _name + "(" + _attribute + ")"; |
77 |
} |
78 |
|
79 |
//---PRIVATE METHODS--- |
80 |
|
81 |
//---ACCESSOR/MUTATOR METHODS--- |
82 |
|
83 |
/** |
84 |
* This takes the String value of the parameter that this component |
85 |
* is monitoring direct from the packet, it then performs all |
86 |
* approriate conversions and adds this class to the Swing Event |
87 |
* Dispatching queue. |
88 |
* |
89 |
* @param value the value for this data component |
90 |
* @throws DataFormatException if there was a problem converting the data for display |
91 |
*/ |
92 |
public void setValue(String value) throws DataFormatException { |
93 |
try { |
94 |
if(!_cache.equals(value)) { |
95 |
_cache = value; |
96 |
SwingUtilities.invokeLater(this); |
97 |
} |
98 |
} catch (Exception e) { |
99 |
throw new DataFormatException(value + " is an invalid data type for " + toString()); |
100 |
} |
101 |
} |
102 |
|
103 |
//---ATTRIBUTES--- |
104 |
|
105 |
/** |
106 |
* The friendly name of this component |
107 |
*/ |
108 |
private String _name; |
109 |
|
110 |
/** |
111 |
* The attribute that this component is concerned with |
112 |
*/ |
113 |
private String _attribute; |
114 |
|
115 |
/** |
116 |
* The friendly label for this component |
117 |
*/ |
118 |
protected JLabel _label; |
119 |
|
120 |
/** |
121 |
* Remebers what the last value was, so we |
122 |
* only update if we have to. |
123 |
*/ |
124 |
String _cache = ""; |
125 |
|
126 |
/** |
127 |
* The length of the JTextField |
128 |
*/ |
129 |
protected int _displayLength; |
130 |
|
131 |
/** |
132 |
* Just a normal label to display our value as a String |
133 |
*/ |
134 |
protected JTextField _item; |
135 |
|
136 |
//---STATIC ATTRIBUTES--- |
137 |
|
138 |
} |