query = new Query();
getContentPane().add(query);
String[] options = {"water", "soda", "juice", "none"};
query.addRadioButtons("radio", "Radio buttons", options, "water");
@author Edward A. Lee, Manda Sutijono, Elaine Cheong, Contributor: Peter Reutemann, Christoph Daniel Schulze
@version $Id: Query.java 70402 2014-10-23 00:52:20Z cxh $
@since Ptolemy II 0.3
@Pt.ProposedRating Yellow (eal)
@Pt.AcceptedRating Red (eal)
*/
@SuppressWarnings("serial")
public class Query extends JPanel {
/** Construct a panel with no entries in it.
*/
public Query() {
_grid = new GridBagLayout();
_constraints = new GridBagConstraints();
_constraints.fill = GridBagConstraints.HORIZONTAL;
// If the next line is commented out, then the PtolemyApplet
// model parameters will have an entry that is less than one
// character wide unless the window is made to be fairly large.
_constraints.weightx = 1.0;
_constraints.anchor = GridBagConstraints.NORTHWEST;
_entryPanel.setLayout(_grid);
// It's not clear whether the following has any real significance...
// _entryPanel.setOpaque(true);
setLayout(new BoxLayout(this, BoxLayout.Y_AXIS));
_entryPanel.setAlignmentX(Component.LEFT_ALIGNMENT);
// Add a message panel into which a message can be placed using
// setMessage().
_messageArea = new JTextArea("");
_messageArea.setFont(new Font("SansSerif", Font.PLAIN, 12));
_messageArea.setEditable(false);
_messageArea.setLineWrap(true);
_messageArea.setWrapStyleWord(true);
// It seems like setLineWrap is somewhat broken. Really,
// setLineWrap works best with scrollbars. We have
// a couple of choices: use scrollbars or hack in something
// that guesses the number of lines. Note that to
// use scrollbars, the tutorial at
// http://java.sun.com/docs/books/tutorial/uiswing/components/simpletext.html#textarea
// suggests: "If you put a text area in a scroll pane, be
// sure to set the scroll pane's preferred size or use a
// text area constructor that sets the number of rows and
// columns for the text area."
_messageArea.setBackground(null);
_messageArea.setAlignmentX(Component.LEFT_ALIGNMENT);
_messageScrollPane = new JScrollPane(_messageArea);
_messageScrollPane
.setVerticalScrollBarPolicy(ScrollPaneConstants.VERTICAL_SCROLLBAR_AS_NEEDED);
// Get rid of the border.
_messageScrollPane.setBorder(BorderFactory.createEmptyBorder());
_messageScrollPane.getViewport().setBackground(null);
// Useful for debugging:
//_messageScrollPane.setBorder(
// BorderFactory.createLineBorder(Color.pink));
// We add the _messageScrollPane when we first use it.
_entryScrollPane = new JScrollPane(_entryPanel);
// Get rid of the border.
_entryScrollPane.setBorder(BorderFactory.createEmptyBorder());
_entryScrollPane.getViewport().setBackground(null);
_entryScrollPane.setBackground(null);
add(_entryScrollPane);
// Setting the background to null allegedly means it inherits the
// background color from the container.
_entryPanel.setBackground(null);
}
///////////////////////////////////////////////////////////////////
//// public methods ////
/** Create an on-off check box.
* @param name The name used to identify the entry (when calling get).
* @param label The label to attach to the entry.
* @param defaultValue The default value (true for on).
* @return The check box.
*/
public JCheckBox addCheckBox(String name, String label, boolean defaultValue) {
JLabel lbl = new JLabel(label + ": ");
lbl.setBackground(_background);
JCheckBox checkbox = new JCheckBox();
checkbox.setBackground(_background);
checkbox.setOpaque(false);
checkbox.setSelected(defaultValue);
_addPair(name, lbl, checkbox, checkbox);
// Add the listener last so that there is no notification
// of the first value.
checkbox.addItemListener(new QueryItemListener(this, name));
return checkbox;
}
/** Create an uneditable choice menu.
* @param name The name used to identify the entry (when calling get).
* @param label The label to attach to the entry.
* @param values The list of possible choices.
* @param defaultChoice Default choice.
* @return The combo box for the choice.
*/
public JComboBox addChoice(String name, String label, Object[] values,
Object defaultChoice) {
return addChoice(name, label, values, defaultChoice, false);
}
/** Create a choice menu.
* @param name The name used to identify the entry (when calling get).
* @param label The label to attach to the entry.
* @param values The list of possible choices.
* @param defaultChoice Default choice.
* @param editable True if an arbitrary choice can be entered, in addition
* to the choices in values.
* @return The combo box for the choice.
*/
public JComboBox addChoice(String name, String label, Object[] values,
Object defaultChoice, boolean editable) {
return addChoice(name, label, values, defaultChoice, editable,
Color.white, Color.black);
}
/** Create a choice menu.
* @param name The name used to identify the entry (when calling get).
* @param label The label to attach to the entry.
* @param values The list of possible choices.
* @param defaultChoice Default choice.
* @param editable True if an arbitrary choice can be entered, in addition
* to the choices in values.
* @param background The background color for the editable part.
* @param foreground The foreground color for the editable part.
* @return The combo box for the choice.
*/
public JComboBox addChoice(String name, String label, Object[] values,
Object defaultChoice, boolean editable, final Color background,
final Color foreground) {
JLabel lbl = new JLabel(label + ": ");
lbl.setBackground(_background);
JComboBox combobox = new JComboBox(values);
combobox.setEditable(editable);
// NOTE: Typical of Swing, the following does not set
// the background color. So we have to specify a
// custom editor. #$(#&$#(@#!!
// combobox.setBackground(background);
combobox.setEditor(new BasicComboBoxEditor() {
@Override
public Component getEditorComponent() {
Component result = super.getEditorComponent();
result.setBackground(background);
result.setForeground(foreground);
return result;
}
});
combobox.setSelectedItem(defaultChoice);
_addPair(name, lbl, combobox, combobox);
// Add the listener last so that there is no notification
// of the first value.
combobox.addItemListener(new QueryItemListener(this, name));
return combobox;
}
/** Create a ColorChooser.
* @param name The name used to identify the entry (when calling get).
* @param label The label to attach to the entry.
* @param defaultColor The default color to use.
* @return The color chooser.
*/
public QueryColorChooser addColorChooser(String name, String label,
String defaultColor) {
JLabel lbl = new JLabel(label + ": ");
lbl.setBackground(_background);
QueryColorChooser colorChooser = new QueryColorChooser(this, name,
defaultColor);
_addPair(name, lbl, colorChooser, colorChooser);
return colorChooser;
}
/** Create a simple one-line text display, a non-editable value that
* is set externally using the setDisplay() method.
* @param name The name used to identify the entry (when calling get).
* @param label The label to attach to the entry.
* @param theValue Default string to display.
* @return The text area that displays the value.
*/
public JTextArea addDisplay(String name, String label, String theValue) {
JLabel lbl = new JLabel(label + ": ");
lbl.setBackground(_background);
// NOTE: JLabel would be a reasonable choice here, but at
// least in the current version of swing, JLabel.setText() does
// not work.
JTextArea displayField = new JTextArea(theValue, 1, 10);
displayField.setEditable(false);
displayField.setBackground(_background);
_addPair(name, lbl, displayField, displayField);
return displayField;
}
/** Create a FileChooser that selects files only, not directories, and
* has the default colors (white in the background, black in the
* foreground).
* @param name The name used to identify the entry (when calling get).
* @param label The label to attach to the entry.
* @param defaultName The default file name to use.
* @param base The URI with respect to which to give
* relative file names, or null to give absolute file name.
* @param startingDirectory The directory to open the file chooser in.
*/
public void addFileChooser(String name, String label, String defaultName,
URI base, File startingDirectory) {
addFileChooser(name, label, defaultName, base, startingDirectory, true,
false, false, Color.white, Color.black);
}
/** Create a FileChooser that selects files only, not directories, and
* has the default colors (white in the background, black in the
* foreground).
* @param name The name used to identify the entry (when calling get).
* @param label The label to attach to the entry.
* @param defaultName The default file name to use.
* @param base The URI with respect to which to give
* relative file names, or null to give absolute file name.
* @param startingDirectory The directory to open the file chooser in.
* @param save Whether the file is to be saved or opened.
*/
public void addFileChooser(String name, String label, String defaultName,
URI base, File startingDirectory, boolean save) {
addFileChooser(name, label, defaultName, base, startingDirectory, true,
false, save, Color.white, Color.black);
}
/** Create a FileChooser with default colors (white in the foreground,
* black in the background).
* @param name The name used to identify the entry (when calling get).
* @param label The label to attach to the entry.
* @param defaultName The default file name to use.
* @param base The URI with respect to which to give
* relative file names, or null to give absolute file name.
* @param startingDirectory The directory to open the file chooser in.
* @param allowFiles True if regular files may be chosen.
* @param allowDirectories True if directories may be chosen.
*/
public void addFileChooser(String name, String label, String defaultName,
URI base, File startingDirectory, boolean allowFiles,
boolean allowDirectories) {
addFileChooser(name, label, defaultName, base, startingDirectory,
allowFiles, allowDirectories, false, Color.white, Color.black);
}
/** Create a FileChooser that selects files only, not directories.
* @param name The name used to identify the entry (when calling get).
* @param label The label to attach to the entry.
* @param defaultName The default file name to use.
* @param base The URI with respect to which to give
* relative file names, or null to give absolute file name.
* @param startingDirectory The directory to open the file chooser in.
* @param background The background color for the text entry box.
* @param foreground The foreground color for the text entry box.
*/
public void addFileChooser(String name, String label, String defaultName,
URI base, File startingDirectory, Color background, Color foreground) {
addFileChooser(name, label, defaultName, base, startingDirectory, true,
false, false, background, foreground);
}
/** Create a FileChooser.
* @param name The name used to identify the entry (when calling get).
* @param label The label to attach to the entry.
* @param defaultName The default file name to use.
* @param base The URI with respect to which to give
* relative file names, or null to give absolute file name.
* @param startingDirectory The directory to open the file chooser in.
* @param allowFiles True if regular files may be chosen.
* @param allowDirectories True if directories may be chosen.
* @param background The background color for the text entry box.
* @param foreground The foreground color for the text entry box.
* @return The file chooser.
*/
public QueryFileChooser addFileChooser(String name, String label,
String defaultName, URI base, File startingDirectory,
boolean allowFiles, boolean allowDirectories, Color background,
Color foreground) {
return addFileChooser(name, label, defaultName, base,
startingDirectory, allowFiles, allowDirectories, false,
background, foreground);
}
/** Create a FileChooser.
* @param name The name used to identify the entry (when calling get).
* @param label The label to attach to the entry.
* @param defaultName The default file name to use.
* @param base The URI with respect to which to give
* relative file names, or null to give absolute file name.
* @param startingDirectory The directory to open the file chooser in.
* @param allowFiles True if regular files may be chosen.
* @param allowDirectories True if directories may be chosen.
* @param save Whether the file is to be saved or opened.
* @param background The background color for the text entry box.
* @param foreground The foreground color for the text entry box.
* @return The file chooser.
*/
public QueryFileChooser addFileChooser(String name, String label,
String defaultName, URI base, File startingDirectory,
boolean allowFiles, boolean allowDirectories, boolean save,
Color background, Color foreground) {
return addFileChooser(name, label, defaultName, base,
startingDirectory, allowFiles, allowDirectories, save,
background, foreground, null);
}
/** Create a FileChooser.
* @param name The name used to identify the entry (when calling get).
* @param label The label to attach to the entry.
* @param defaultName The default file name to use.
* @param base The URI with respect to which to give
* relative file names, or null to give absolute file name.
* @param startingDirectory The directory to open the file chooser in.
* @param allowFiles True if regular files may be chosen.
* @param allowDirectories True if directories may be chosen.
* @param save Whether the file is to be saved or opened.
* @param background The background color for the text entry box.
* @param foreground The foreground color for the text entry box.
* @param filter A filename filter, or null to not have one.
* @return The file chooser.
*/
public QueryFileChooser addFileChooser(String name, String label,
String defaultName, URI base, File startingDirectory,
boolean allowFiles, boolean allowDirectories, boolean save,
Color background, Color foreground, FilenameFilter filter) {
JLabel lbl = new JLabel(label + ": ");
lbl.setBackground(_background);
QueryFileChooser fileChooser = new QueryFileChooser(this, name,
defaultName, base, startingDirectory, allowFiles,
allowDirectories, save, background, foreground, filter);
_addPair(name, lbl, fileChooser, fileChooser);
return fileChooser;
}
/** Create a single-line entry box with the specified name, label, and
* default value. To control the width of the box, call setTextWidth()
* first.
* @param name The name used to identify the entry (when accessing
* the entry).
* @param label The label to attach to the entry.
* @param defaultValue Default value to appear in the entry box.
*/
public void addLine(String name, String label, String defaultValue) {
addLine(name, label, defaultValue, Color.white, Color.black);
}
/** Create a single-line entry box with the specified name, label,
* default value, and background color. To control the width of
* the box, call setTextWidth() first.
* @param name The name used to identify the entry (when accessing
* the entry).
* @param label The label to attach to the entry.
* @param defaultValue Default value to appear in the entry box.
* @param background The background color.
* @param foreground The foreground color.
*/
public void addLine(String name, String label, String defaultValue,
Color background, Color foreground) {
JLabel lbl = new JLabel(label + ": ");
lbl.setBackground(_background);
JTextField entryBox = new JTextField(defaultValue, _width);
entryBox.setBackground(background);
entryBox.setForeground(foreground);
_addPair(name, lbl, entryBox, entryBox);
// Add the listener last so that there is no notification
// of the first value.
entryBox.addActionListener(new QueryActionListener(this, name));
// Add a listener for loss of focus. When the entry gains
// and then loses focus, listeners are notified of an update,
// but only if the value has changed since the last notification.
// FIXME: Unfortunately, Java calls this listener some random
// time after the window has been closed. It is not even a
// a queued event when the window is closed. Thus, we have
// a subtle bug where if you enter a value in a line, do not
// hit return, and then click on the X to close the window,
// the value is restored to the original, and then sometime
// later, the focus is lost and the entered value becomes
// the value of the parameter. I don't know of any workaround.
entryBox.addFocusListener(new QueryFocusListener(this, name));
}
/** Create a single-line password box with the specified name, label, and
* default value. To control the width of the box, call setTextWidth()
* first. A value that is entered in the password box should be
* accessed using getCharArrayValue(). The value returned by
* stringValue() is whatever you specify as a defaultValue.
* @param name The name used to identify the entry (when accessing
* the entry).
* @param label The label to attach to the entry.
* @param defaultValue Default value to appear in the entry box.
* @return The password field for the input.
* @since Ptolemy II 3.1
*/
public JPasswordField addPassword(String name, String label,
String defaultValue) {
return addPassword(name, label, defaultValue, Color.white, Color.black);
}
/** Create a single-line password box with the specified name,
* label, and default value. To control the width of the box,
* call setTextWidth() first.
* To get the value, call getCharArrayValue().
* Calling getStringValue() on a password entry will result in an
* error because it is less secure to pass around passwords as
* Strings than as arrays of characters.
* The underlying class that is used to implement the password * facility is javax.swing.JPasswordField. For details about how to * use JPasswordField, see the * Java Tutorial * * @param name The name used to identify the entry (when accessing * the entry). * @param label The label to attach to the entry. * @param defaultValue Default value to appear in the entry box. * @param background The background color. * @param foreground The foreground color. * @return The password field for the input. * @since Ptolemy II 3.1 */ public JPasswordField addPassword(String name, String label, String defaultValue, Color background, Color foreground) { JLabel lbl = new JLabel(label + ": "); lbl.setBackground(_background); JPasswordField entryBox = new JPasswordField(defaultValue, _width); entryBox.setBackground(background); entryBox.setForeground(foreground); _addPair(name, lbl, entryBox, entryBox); // Add the listener last so that there is no notification // of the first value. entryBox.addActionListener(new QueryActionListener(this, name)); // Add a listener for loss of focus. When the entry gains // and then loses focus, listeners are notified of an update, // but only if the value has changed since the last notification. // FIXME: Unfortunately, Java calls this listener some random // time after the window has been closed. It is not even a // a queued event when the window is closed. Thus, we have // a subtle bug where if you enter a value in a line, do not // hit return, and then click on the X to close the window, // the value is restored to the original, and then sometime // later, the focus is lost and the entered value becomes // the value of the parameter. I don't know of any workaround. entryBox.addFocusListener(new QueryFocusListener(this, name)); return entryBox; } /** Add a listener. The changed() method of the listener will be * called when any of the entries is changed. Note that "line" * entries only trigger this call when Return or Enter is pressed, or * when the entry gains and then loses the keyboard focus. * Notice that the currently selected line loses focus when the * panel is destroyed, so notification of any changes that * have been made will be done at that time. That notification * will occur in the UI thread, and may be later than expected. * Notification due to loss of focus only occurs if the value * of the entry has changed since the last notification. * If the listener has already been added, then do nothing. * @param listener The listener to add. * @see #removeQueryListener(QueryListener) */ public void addQueryListener(QueryListener listener) { if (_listeners == null) { _listeners = new Vector(); } if (_listeners.contains(listener)) { return; } _listeners.add(listener); } /** Create a bank of radio buttons. A radio button provides a list of * choices, only one of which may be chosen at a time. * @param name The name used to identify the entry (when calling get). * @param label The label to attach to the entry. * @param values The list of possible choices. * @param defaultValue Default value. */ public void addRadioButtons(String name, String label, String[] values, String defaultValue) { JLabel lbl = new JLabel(label + ": "); lbl.setBackground(_background); FlowLayout flow = new FlowLayout(); flow.setAlignment(FlowLayout.LEFT); // This must be a JPanel, not a Panel, or the scroll bars won't work. JPanel buttonPanel = new JPanel(flow); ButtonGroup group = new ButtonGroup(); QueryActionListener listener = new QueryActionListener(this, name); // Regrettably, ButtonGroup provides no method to find out // which button is selected, so we have to go through a // song and dance here... JRadioButton[] buttons = new JRadioButton[values.length]; for (int i = 0; i < values.length; i++) { JRadioButton checkbox = new JRadioButton(values[i]); buttons[i] = checkbox; checkbox.setBackground(_background); // The following (essentially) undocumented method does nothing... // checkbox.setContentAreaFilled(true); checkbox.setOpaque(false); if (values[i].equals(defaultValue)) { checkbox.setSelected(true); } group.add(checkbox); buttonPanel.add(checkbox); // Add the listener last so that there is no notification // of the first value. checkbox.addActionListener(listener); } _addPair(name, lbl, buttonPanel, buttons); } /** Create a bank of buttons that provides a list of * choices, any subset of which may be chosen at a time. * @param name The name used to identify the entry (when calling get). * @param label The label to attach to the entry. * @param values The list of possible choices. * @param initiallySelected The initially selected choices, or null * to indicate that none are selected. */ public void addSelectButtons(String name, String label, String[] values, Set initiallySelected) { JLabel lbl = new JLabel(label + ": "); lbl.setBackground(_background); FlowLayout flow = new FlowLayout(); flow.setAlignment(FlowLayout.LEFT); // This must be a JPanel, not a Panel, or the scroll bars won't work. JPanel buttonPanel = new JPanel(flow); QueryActionListener listener = new QueryActionListener(this, name); if (initiallySelected == null) { initiallySelected = new HashSet(); } JRadioButton[] buttons = new JRadioButton[values.length]; for (int i = 0; i < values.length; i++) { JRadioButton checkbox = new JRadioButton(values[i]); buttons[i] = checkbox; checkbox.setBackground(_background); // The following (essentially) undocumented method does nothing... // checkbox.setContentAreaFilled(true); checkbox.setOpaque(false); if (initiallySelected.contains(values[i])) { checkbox.setSelected(true); } buttonPanel.add(checkbox); // Add the listener last so that there is no notification // of the first value. checkbox.addActionListener(listener); } _addPair(name, lbl, buttonPanel, buttons); } /** Create a horizontal separator between components. */ public void addSeparator() { JPanel panel = new JPanel(); panel.setLayout(new BorderLayout()); JPanel top = new JPanel(); top.setPreferredSize(new Dimension(-1, 5)); panel.add(top, BorderLayout.NORTH); JSeparator separator = new JSeparator(SwingConstants.HORIZONTAL); panel.add(separator, BorderLayout.CENTER); JPanel bottom = new JPanel(); bottom.setPreferredSize(new Dimension(-1, 5)); panel.add(bottom, BorderLayout.SOUTH); _constraints.gridwidth = GridBagConstraints.REMAINDER; _constraints.insets = _insets; _grid.setConstraints(panel, _constraints); _entryPanel.add(panel); _recalculatePreferredSize(panel); } /** Create a slider with the specified name, label, default * value, maximum, and minimum. * @param name The name used to identify the slider. * @param label The label to attach to the slider. * @param defaultValue Initial position of slider. * @param maximum Maximum value of slider. * @param minimum Minimum value of slider. * @return The slider. * @exception IllegalArgumentException If the desired default value * is not between the minimum and maximum. */ public JSlider addSlider(String name, String label, int defaultValue, int minimum, int maximum) throws IllegalArgumentException { return addSlider(name, label, defaultValue, minimum, maximum, null, null); } /** Create a slider with the specified name, label, default value, * maximum, minimum, and label texts for the maximum and minimum * slider positions. * @param name The name used to identify the slider. * @param label The label to attach to the slider. * @param defaultValue Initial position of slider. * @param maximum Maximum value of slider. * @param minimum Minimum value of slider. * @param minLabelText Text to be displayed at the slider's minimum * setting. Set to {@code null} or the empty * String to hide the minimum label. * @param maxLabelText Text to be displayed at the slider's maximum * setting. Set to {@code null} or the empty * String to hide the maximum label. * @return The slider. * @exception IllegalArgumentException If the desired default value * is not between the minimum and maximum. */ public JSlider addSlider(String name, String label, int defaultValue, int minimum, int maximum, String minLabelText, String maxLabelText) throws IllegalArgumentException { JLabel lbl = new JLabel(label + ": "); if (minimum > maximum) { int temp = minimum; minimum = maximum; maximum = temp; } if (defaultValue > maximum || defaultValue < minimum) { throw new IllegalArgumentException("Desired default " + "value \"" + defaultValue + "\" does not fall " + "between the minimum and maximum."); } JSlider slider = new JSlider(minimum, maximum, defaultValue); // Determine if minimum and maximum labels have to be created if (minLabelText == null || minLabelText.isEmpty() || maxLabelText == null || maxLabelText.isEmpty()) { _addPair(name, lbl, slider, slider); } else { // Add labels to the slider and put everything into a panel JPanel panel = new JPanel(); panel.setLayout(new GridBagLayout()); // Configure and add the slider GridBagConstraints c = new GridBagConstraints(); c.fill = GridBagConstraints.HORIZONTAL; c.gridx = 0; c.gridy = 0; c.gridwidth = 2; c.weightx = 1.0; slider.setPaintTicks(true); slider.setMajorTickSpacing(maximum - minimum); panel.add(slider, c); // Insets to leave some space below the slider's labels, if any Insets labelInsets = new Insets(0, 0, 10, 0); // Minimum label if (minLabelText != null && minLabelText.length() > 0) { JLabel minLabel = new JLabel(minLabelText); c = new GridBagConstraints(); c.anchor = GridBagConstraints.LINE_START; c.gridx = 0; c.gridy = 1; c.insets = labelInsets; panel.add(minLabel, c); } // Maximum label if (maxLabelText != null && maxLabelText.length() > 0) { JLabel maxLabel = new JLabel(maxLabelText); c = new GridBagConstraints(); c.anchor = GridBagConstraints.LINE_END; c.gridx = 1; c.gridy = 1; c.insets = labelInsets; panel.add(maxLabel, c); } _addPair(name, lbl, panel, slider); } slider.addChangeListener(new SliderListener(this, name)); return slider; } /** Add text to the query. * @param text The text to be added. * @param color The color of the text to be added. * @param alignment The alignment, which is a value suitable * for the JPanel() constructor. */ public void addText(String text, Color color, int alignment) { JPanel panel = new JPanel(); panel.setLayout(new BorderLayout()); JPanel top = new JPanel(); top.setPreferredSize(new Dimension(-1, 5)); panel.add(top, BorderLayout.NORTH); JLabel label = new JLabel(text, alignment); label.setForeground(color); panel.add(label, BorderLayout.CENTER); JPanel bottom = new JPanel(); bottom.setPreferredSize(new Dimension(-1, 5)); panel.add(bottom, BorderLayout.SOUTH); _constraints.gridwidth = GridBagConstraints.REMAINDER; _constraints.insets = _insets; _grid.setConstraints(panel, _constraints); _entryPanel.add(panel); _recalculatePreferredSize(panel); } /** Create a text area. * @param name The name used to identify the entry (when calling get). * @param label The label to attach to the entry. * @param theValue The value of this text area */ public void addTextArea(String name, String label, String theValue) { addTextArea(name, label, theValue, Color.white, Color.black, _height, _width); } /** Create a text area. * @param name The name used to identify the entry (when calling get). * @param label The label to attach to the entry. * @param theValue The value of this text area. * @param background The background color. * @param foreground The foreground color. */ public void addTextArea(String name, String label, String theValue, Color background, Color foreground) { addTextArea(name, label, theValue, background, foreground, _height, _width); } /** Create a text area with the specified height and width (in * characters). * @param name The name used to identify the entry (when calling get). * @param label The label to attach to the entry. * @param theValue The value of this text area. * @param background The background color. * @param foreground The foreground color. * @param height The height. * @param width The width. * @return The text area. */ public JTextArea addTextArea(String name, String label, String theValue, Color background, Color foreground, int height, int width) { JLabel lbl = new JLabel(label + ": "); lbl.setBackground(_background); JTextArea textArea = new JTextArea(theValue, height, width); textArea.setEditable(true); textArea.setBackground(background); textArea.setForeground(foreground); QueryScrollPane textPane = new QueryScrollPane(textArea); _addPair(name, lbl, textPane, textPane); textArea.addFocusListener(new QueryFocusListener(this, name)); textArea.setFocusTraversalKeys( KeyboardFocusManager.FORWARD_TRAVERSAL_KEYS, null); textArea.setFocusTraversalKeys( KeyboardFocusManager.BACKWARD_TRAVERSAL_KEYS, null); textArea.getInputMap().put(KeyStroke.getKeyStroke("shift ENTER"), "TRANSFER_TEXT"); final JTextArea area = textArea; textArea.getActionMap().put("TRANSFER_TEXT", new AbstractAction() { @Override public void actionPerformed(ActionEvent e) { // This code is necessary for r64799: Behavior of a // dialogue: shift+ENTER = new line, ENTER = commit // This was not consistent with the dialogue of // transitions in modal models, in fact, it was not // possible to add new lines to, e.g. guard // expressions, anymore. Changed to new ENTER, // shift+ENTER behavior. area.insert("\n", area.getCaretPosition()); if (area.getRows() < 4) { area.setRows(area.getRows() + 1); area.revalidate(); Component parent = area.getParent(); while (parent != null && !(parent instanceof EditableParametersDialog)) { parent = parent.getParent(); } if (parent instanceof EditableParametersDialog) { // We use an interface her to avoid a // dependency on // ptolemy.actor.gui.EditParametersDialog. EditableParametersDialog dialog = (EditableParametersDialog) parent; dialog.doLayoutAndPack(); } } } }); return textArea; } /** Get the current value in the entry with the given name * and return as a boolean. If the entry is not a checkbox, * then throw an exception. * @param name The name of the entry. * @deprecated Use getBooleanValue(String name) instead. * @return The state of the checkbox. * @exception NoSuchElementException If there is no item with the * specified name. Note that this is a runtime exception, so it * need not be declared explicitly. * @exception IllegalArgumentException If the entry is not a * checkbox. This is a runtime exception, so it * need not be declared explicitly. */ @Deprecated public boolean booleanValue(String name) throws NoSuchElementException, IllegalArgumentException { return getBooleanValue(name); } /** Get the current value in the entry with the given name * and return as a double value. If the entry is not a line, * then throw an exception. If the value of the entry is not * a double, then throw an exception. * @param name The name of the entry. * @deprecated Use getDoubleValue(String name) instead. * @return The value currently in the entry as a double. * @exception NoSuchElementException If there is no item with the * specified name. Note that this is a runtime exception, so it * need not be declared explicitly. * @exception NumberFormatException If the value of the entry cannot * be converted to a double. This is a runtime exception, so it * need not be declared explicitly. * @exception IllegalArgumentException If the entry is not a * line. This is a runtime exception, so it * need not be declared explicitly. */ @Deprecated public double doubleValue(String name) throws IllegalArgumentException, NoSuchElementException, NumberFormatException { return getDoubleValue(name); } /** Get the current value in the entry with the given name * and return as a boolean. If the entry is not a checkbox, * then throw an exception. * @param name The name of the entry. * @return The state of the checkbox. * @exception NoSuchElementException If there is no item with the * specified name. Note that this is a runtime exception, so it * need not be declared explicitly. * @exception IllegalArgumentException If the entry is not a * checkbox. This is a runtime exception, so it * need not be declared explicitly. */ public boolean getBooleanValue(String name) throws NoSuchElementException, IllegalArgumentException { Object result = _entries.get(name); if (result == null) { throw new NoSuchElementException("No item named \"" + name + "\" in the query box."); } if (result instanceof JToggleButton) { return ((JToggleButton) result).isSelected(); } else { throw new IllegalArgumentException("Item named \"" + name + "\" is not a radio button, and hence does not have " + "a boolean value."); } } /** Get the current value in the entry with the given name * and return as an array of characters. *
If the entry is a password field, then it is recommended for * strong security that each element of the array be set to 0 * after use. * @param name The name of the entry. * @return The state of the entry * @exception NoSuchElementException If there is no item with the * specified name. Note that this is a runtime exception, so it * need not be declared explicitly. * @exception IllegalArgumentException If the entry type does not * have a string representation (this should not be thrown). * This is a runtime exception, so it need not be declared explicitly. * @since Ptolemy II 3.1 */ public char[] getCharArrayValue(String name) throws NoSuchElementException, IllegalArgumentException { Object result = _entries.get(name); if (result == null) { throw new NoSuchElementException("No item named \"" + name + "\" in the query box."); } if (result instanceof JPasswordField) { // Calling JPasswordField.getText() is deprecated return ((JPasswordField) result).getPassword(); } else { return getStringValue(name).toCharArray(); } } /** Get the current value in the entry with the given name * and return as a double value. If the entry is not a line, * then throw an exception. If the value of the entry is not * a double, then throw an exception. * @param name The name of the entry. * @return The value currently in the entry as a double. * @exception NoSuchElementException If there is no item with the * specified name. Note that this is a runtime exception, so it * need not be declared explicitly. * @exception NumberFormatException If the value of the entry cannot * be converted to a double. This is a runtime exception, so it * need not be declared explicitly. * @exception IllegalArgumentException If the entry is not a * line. This is a runtime exception, so it * need not be declared explicitly. */ public double getDoubleValue(String name) throws IllegalArgumentException, NoSuchElementException, NumberFormatException { Object result = _entries.get(name); if (result == null) { throw new NoSuchElementException("No item named \"" + name + " \" in the query box."); } if (result instanceof JPasswordField) { // Note that JPasswordField extends JTextField, so // we should check for JPasswordField first. throw new IllegalArgumentException("For security reasons, " + "calling getDoubleValue() on a password field is " + "not permitted. Instead, call getCharArrayValue()"); } else if (result instanceof JTextField) { return Double.parseDouble(((JTextField) result).getText()); } else { throw new IllegalArgumentException("Item named \"" + name + "\" is not a text line, and hence cannot be converted " + "to a double value."); } } /** Get the current value in the entry with the given name * and return as an integer. If the entry is not a line, * choice, or slider, then throw an exception. * If it is a choice or radio button, then return the * index of the first selected item. * @param name The name of the entry. * @return The value currently in the entry as an integer. * @exception NoSuchElementException If there is no item with the * specified name. Note that this is a runtime exception, so it * need not be declared explicitly. * @exception NumberFormatException If the value of the entry cannot * be converted to an integer. This is a runtime exception, so it * need not be declared explicitly. * @exception IllegalArgumentException If the entry is not a * choice, line, or slider. This is a runtime exception, so it * need not be declared explicitly. */ public int getIntValue(String name) throws IllegalArgumentException, NoSuchElementException, NumberFormatException { Object result = _entries.get(name); if (result == null) { throw new NoSuchElementException("No item named \"" + name + " \" in the query box."); } if (result instanceof JPasswordField) { // Note that JPasswordField extends JTextField, so // we should check for JPasswordField first. throw new IllegalArgumentException("For security reasons, " + "calling getIntValue() on a password field is " + "not permitted. Instead, call getCharArrayValue()"); } else if (result instanceof JTextField) { return Integer.parseInt(((JTextField) result).getText()); } else if (result instanceof JSlider) { return ((JSlider) result).getValue(); } else if (result instanceof JComboBox) { return ((JComboBox) result).getSelectedIndex(); } else if (result instanceof JToggleButton[]) { // Regrettably, ButtonGroup gives no way to determine // which button is selected, so we have to search... JToggleButton[] buttons = (JToggleButton[]) result; for (int i = 0; i < buttons.length; i++) { if (buttons[i].isSelected()) { return i; } } // In theory, we shouldn't get here, but the compiler // is unhappy without a return. return -1; } else { throw new IllegalArgumentException("Item named \"" + name + "\" is not a text line or slider, and hence " + "cannot be converted to " + "an integer value."); } } /** Return the preferred height, but set the width to the maximum * possible value. Currently (JDK 1.3), only BoxLayout pays any * attention to getMaximumSize(). * * @return The maximum desired size. */ @Override public Dimension getMaximumSize() { // Unfortunately, if we don't have a message, then we end up with // an empty space that is difficult to control the size of, which // requires us to set the maximum size to be the same as // the preferred size // If you change this, be sure to try applets that have both // horizontal and vertical layout. Dimension preferred = getPreferredSize(); preferred.width = Short.MAX_VALUE; return preferred; } /** Get the current value in the entry with the given name, * and return as an Object. This is different from {@link * #getStringValue(String)} in that if the entry is a combo box, the * selected object is returned, which need not be a string. * All entry types support this. * Note that this method should be called from the event dispatch * thread, since it needs to query to UI widgets for their current * values. If it is called from another thread, there is no * assurance that the value returned will be the current value. * @param name The name of the entry. * @return The value currently in the entry as a String, unless * the entry is a combo box, in which case the selected object * is returned, or null is returned if no object is selected. * @exception NoSuchElementException If there is no item with the * specified name. Note that this is a runtime exception, so it * need not be declared explicitly. * @exception IllegalArgumentException If the entry type does not * have a string representation (this should not be thrown). */ public Object getObjectValue(String name) throws NoSuchElementException, IllegalArgumentException { Object result = _entries.get(name); if (result == null) { throw new NoSuchElementException("No item named \"" + name + " \" in the query box."); } if (result instanceof JTextField) { return ((JTextField) result).getText(); } else if (result instanceof QueryColorChooser) { return ((QueryColorChooser) result).getSelectedColor(); } else if (result instanceof QueryFileChooser) { return ((QueryFileChooser) result).getSelectedFileName(); } else if (result instanceof JTextArea) { return ((JTextArea) result).getText(); } else if (result instanceof JToggleButton) { // JRadioButton and JCheckButton are subclasses of JToggleButton JToggleButton toggleButton = (JToggleButton) result; if (toggleButton.isSelected()) { return "true"; } else { return "false"; } } else if (result instanceof JSlider) { return "" + ((JSlider) result).getValue(); } else if (result instanceof JComboBox) { return ((JComboBox) result).getSelectedItem(); } else if (result instanceof JToggleButton[]) { // JRadioButton and JCheckButton are subclasses of JToggleButton // Regrettably, ButtonGroup gives no way to determine // which button is selected, so we have to search... JToggleButton[] buttons = (JToggleButton[]) result; StringBuffer toReturn = null; for (JToggleButton button : buttons) { if (button.isSelected()) { if (toReturn == null) { toReturn = new StringBuffer(button.getText()); } else { toReturn.append(", " + button.getText()); } } } if (toReturn == null) { toReturn = new StringBuffer(); } return toReturn.toString(); } else if (result instanceof QueryScrollPane) { return ((QueryScrollPane) result).getText(); } else if (result instanceof SettableQueryChooser) { return ((SettableQueryChooser) result).getQueryValue(); } else { throw new IllegalArgumentException("Query class cannot generate" + " a string representation for entries of type " + result.getClass()); } } /** Get the current value in the entry with the given name, * and return as a String. All entry types support this. * Note that this method should be called from the event dispatch * thread, since it needs to query to UI widgets for their current * values. If it is called from another thread, there is no * assurance that the value returned will be the current value. * @param name The name of the entry. * @return The value currently in the entry as a String. * @exception NoSuchElementException If there is no item with the * specified name. Note that this is a runtime exception, so it * need not be declared explicitly. * @exception IllegalArgumentException If the entry type does not * have a string representation (this should not be thrown). */ public String getStringValue(String name) throws NoSuchElementException, IllegalArgumentException { // NOTE: getObjectValue() may return null if the entry // is a combo box and no object is selected. In that case, // return an empty string. Object result = getObjectValue(name); if (result != null) { return result.toString(); } return ""; } /** Get the preferred number of lines to be used for entry boxes created * in using addTextArea(). The preferred height is set using * setTextHeight(). * @return The preferred height in lines. * @see #addTextArea(String, String, String) * @see #setTextHeight(int) */ public int getTextHeight() { return _height; } /** Get the preferred width in characters to be used for entry * boxes created in using addLine(). The preferred width is set * using setTextWidth(). * @return The preferred width of an entry box in characters. * @see #setTextWidth(int) */ public int getTextWidth() { return _width; } /** Return whether an entry exists with the specified name. * * @param name The name. * @return True if the entry exists; false otherwise. */ public boolean hasEntry(String name) { return _entries.containsKey(name); } /** Get the current value in the entry with the given name * and return as an integer. If the entry is not a line, * choice, or slider, then throw an exception. * If it is a choice or radio button, then return the * index of the first selected item. * @param name The name of the entry. * @deprecated Use getIntValue(String name) instead. * @return The value currently in the entry as an integer. * @exception NoSuchElementException If there is no item with the * specified name. Note that this is a runtime exception, so it * need not be declared explicitly. * @exception NumberFormatException If the value of the entry cannot * be converted to an integer. This is a runtime exception, so it * need not be declared explicitly. * @exception IllegalArgumentException If the entry is not a * choice, line, or slider. This is a runtime exception, so it * need not be declared explicitly. */ @Deprecated public int intValue(String name) throws IllegalArgumentException, NoSuchElementException, NumberFormatException { return getIntValue(name); } /** Notify listeners of the current value of all entries, unless * those entries have not changed since the last notification. */ public void notifyListeners() { Iterator names = _entries.keySet().iterator(); while (names.hasNext()) { String name = (String) names.next(); _notifyListeners(name); } } /** Remove a listener. If the listener has not been added, then * do nothing. * @param listener The listener to remove. * @see #addQueryListener(QueryListener) */ public void removeQueryListener(QueryListener listener) { if (_listeners == null) { return; } _listeners.remove(listener); } /** Set the value in the entry with the given name. * The second argument must be a string that can be parsed to the * proper type for the given entry, or an exception is thrown. * Note that this does NOT trigger the notification of listeners, and * intended to allow a way to set the query to reflect the current state. * @param name The name used to identify the entry (when calling get). * @param value The value to set the entry to. * @exception NoSuchElementException If there is no item with the * specified name. Note that this is a runtime exception, so it * need not be declared explicitly. * @exception IllegalArgumentException If the value does not parse * to the appropriate type. */ public void set(String name, String value) throws NoSuchElementException, IllegalArgumentException { Object result = _entries.get(name); if (result == null) { throw new NoSuchElementException("No item named \"" + name + " \" in the query box."); } // FIXME: Surely there is a better way to do this... // We should define a set of inner classes, one for each entry type. // Currently, this has to be updated each time a new entry type // is added. if (result instanceof JTextField) { ((JTextField) result).setText(value); } else if (result instanceof JTextArea) { ((JTextArea) result).setText(value); } else if (result instanceof QueryScrollPane) { ((QueryScrollPane) result).setText(value); } else if (result instanceof JToggleButton) { // JRadioButton and JCheckButton are subclasses of JToggleButton Boolean flag = Boolean.parseBoolean(value); setBoolean(name, flag.booleanValue()); } else if (result instanceof JSlider) { Integer parsed = Integer.parseInt(value); ((JSlider) result).setValue(parsed.intValue()); } else if (result instanceof JComboBox) { ((JComboBox) result).setSelectedItem(value); } else if (result instanceof JToggleButton[]) { // First, parse the value, which may be a comma-separated list. Set selectedValues = new HashSet(); StringTokenizer tokenizer = new StringTokenizer(value, ","); while (tokenizer.hasMoreTokens()) { selectedValues.add(tokenizer.nextToken().trim()); } JToggleButton[] buttons = (JToggleButton[]) result; for (JToggleButton button : buttons) { if (selectedValues.contains(button.getText())) { button.setSelected(true); } else { button.setSelected(false); } } } else if (result instanceof QueryColorChooser) { ((QueryColorChooser) result).setColor(value); } else if (result instanceof SettableQueryChooser) { ((SettableQueryChooser) result).setQueryValue(value); } else if (result instanceof QueryFileChooser) { ((QueryFileChooser) result).setFileName(value); } else { throw new IllegalArgumentException("Query class cannot set" + " a string representation for entries of type " + result.getClass()); } // Record the new value as if it was the previously notified // value. Thus, any future change from this value will trigger // notification. _previous.put(name, value); } /** Set the value in the entry with the given name and notify listeners. * The second argument must be a string that can be parsed to the * proper type for the given entry, or an exception is thrown. * @param name The name used to identify the entry (when calling get). * @param value The value to set the entry to. * @exception NoSuchElementException If there is no item with the * specified name. Note that this is a runtime exception, so it * need not be declared explicitly. * @exception IllegalArgumentException If the value does not parse * to the appropriate type. */ public void setAndNotify(String name, String value) throws NoSuchElementException, IllegalArgumentException { set(name, value); _notifyListeners(name); } /** Set the background color for all the widgets. * @param color The background color. */ @Override public void setBackground(Color color) { super.setBackground(color); _background = color; // Set the background of any components that already exist. Component[] components = getComponents(); for (int i = 0; i < components.length; i++) { if (!(components[i] instanceof JTextField)) { components[i].setBackground(_background); } } } /** Set the current value in the entry with the given name. * If the entry is not a checkbox, then throw an exception. * Notify listeners that the value has changed. * @param name The name of the entry. * @param value The new value of the entry. * @exception NoSuchElementException If there is no item with the * specified name. Note that this is a runtime exception, so it * need not be declared explicitly. * @exception IllegalArgumentException If the entry is not a * checkbox. This is a runtime exception, so it * need not be declared explicitly. */ public void setBoolean(String name, boolean value) throws NoSuchElementException, IllegalArgumentException { Object result = _entries.get(name); if (result == null) { throw new NoSuchElementException("No item named \"" + name + "\" in the query box."); } if (result instanceof JToggleButton) { // JRadioButton and JCheckButton are subclasses of JToggleButton ((JToggleButton) result).setSelected(value); } else { throw new IllegalArgumentException("Item named \"" + name + "\" is not a radio button, and hence does not have " + "a boolean value."); } _notifyListeners(name); } /** Specify the number of columns to use. * The default is one. If an integer larger than one is specified * here, then the queries will be arranged using the specified number * of columns. As queries are added, they are put in the first row * until that row is full. Then they are put in the second row, etc. * @param columns The number of columns. */ public void setColumns(int columns) { if (columns <= 0) { throw new IllegalArgumentException( "Query.setColumns() requires a strictly positive " + "argument."); } _columns = columns; } /** Set the displayed text of an entry that has been added using * addDisplay. * Notify listeners that the value has changed. * @param name The name of the entry. * @param value The string to display. * @exception NoSuchElementException If there is no entry with the * specified name. Note that this is a runtime exception, so it * need not be declared explicitly. * @exception IllegalArgumentException If the entry is not a * display. This is a runtime exception, so it * need not be declared explicitly. */ public void setDisplay(String name, String value) throws NoSuchElementException, IllegalArgumentException { Object result = _entries.get(name); if (result == null) { throw new NoSuchElementException("No item named \"" + name + " \" in the query box."); } if (result instanceof JTextArea) { JTextArea label = (JTextArea) result; label.setText(value); } else { throw new IllegalArgumentException("Item named \"" + name + "\" is not a display, and hence cannot be set using " + "setDisplay()."); } _notifyListeners(name); } /** For line, display, check box, slider, radio button, or choice * entries made, if the second argument is false, then it will * be disabled. * @param name The name of the entry. * @param value If false, disables the entry. */ public void setEnabled(String name, boolean value) { Object result = _entries.get(name); if (result == null) { throw new NoSuchElementException("No item named \"" + name + " \" in the query box."); } if (result instanceof JComponent) { ((JComponent) result).setEnabled(value); } else if (result instanceof JToggleButton[]) { JToggleButton[] buttons = (JToggleButton[]) result; for (JToggleButton button : buttons) { button.setEnabled(value); } } } /** Set the insets for the GridBagLayout manager used to layout the * components. * * @param insets The insets. */ public void setInsets(Insets insets) { _insets = insets; } /** Set the displayed text of an item that has been added using * addLine. Notify listeners that the value has changed. * @param name The name of the entry. * @param value The string to display. * @exception NoSuchElementException If there is no item with the * specified name. Note that this is a runtime exception, so it * need not be declared explicitly. * @exception IllegalArgumentException If the entry is not a * display. This is a runtime exception, so it * need not be declared explicitly. */ public void setLine(String name, String value) { Object result = _entries.get(name); if (result == null) { throw new NoSuchElementException("No item named \"" + name + " \" in the query box."); } if (result instanceof JTextField) { JTextField line = (JTextField) result; line.setText(value); } else { throw new IllegalArgumentException("Item named \"" + name + "\" is not a line, and hence cannot be set using " + "setLine()."); } _notifyListeners(name); } /** Specify a message to be displayed above the query. * @param message The message to display. */ public void setMessage(String message) { if (!_messageScrollPaneAdded) { _messageScrollPaneAdded = true; add(_messageScrollPane, 1); // Add a spacer. add(Box.createRigidArea(new Dimension(0, 10)), 2); } _messageArea.setText(message); // I'm not sure why we need to add 1 here? int lineCount = _messageArea.getLineCount() + 1; // Keep the line count to less than 30 lines. If // we have more than 30 lines, we get a scroll bar. if (lineCount > 30) { lineCount = 30; } _messageArea.setRows(lineCount); _messageArea.setColumns(_width); // In case size has changed. validate(); } /** Set the position of an item that has been added using * addSlider. Notify listeners that the value has changed. * @param name The name of the entry. * @param value The value to set the slider position. * @exception NoSuchElementException If there is no item with the * specified name. Note that this is a runtime exception, so it * need not be declared explicitly. * @exception IllegalArgumentException If the entry is not a * slider. This is a runtime exception, so it * need not be declared explicitly. */ public void setSlider(String name, int value) { Object result = _entries.get(name); if (result == null) { throw new NoSuchElementException("No item named \"" + name + " \" in the query box."); } if (result instanceof JSlider) { JSlider theSlider = (JSlider) result; // Set the new slider position. theSlider.setValue(value); } else { throw new IllegalArgumentException("Item named \"" + name + "\" is not a slider, and hence cannot be set using " + "setSlider()."); } _notifyListeners(name); } /** Specify the preferred height to be used for entry boxes created * in using addTextArea(). If this is called multiple times, then * it only affects subsequent calls. * @param characters The preferred height. * @see #addTextArea(String, String, String) * @see #getTextHeight() */ public void setTextHeight(int characters) { _height = characters; } /** Specify the preferred width to be used for entry boxes created * in using addLine(). If this is called multiple times, then * it only affects subsequent calls. * @param characters The preferred width. * @see #getTextWidth() */ public void setTextWidth(int characters) { _width = characters; } /** Specify a tool tip to appear when the mouse lingers over the label. * @param name The name of the entry. * @param tip The text of the tool tip. */ public void setToolTip(String name, String tip) { JLabel label = (JLabel) _labels.get(name); if (label != null) { label.setToolTipText(tip); } } /** Convert the specified string to a color. The string * has the form "{r, g, b, a}", where each of the letters * is a number between 0.0 and 1.0, representing red, green, * blue, and alpha. * @param description The description of the color, or white * if any parse error occurs. * @return A string representing the color. */ public static Color stringToColor(String description) { String[] specArray = description.split("[{},]"); float red = 0f; float green = 0f; float blue = 0f; float alpha = 1.0f; // If any exceptions occur during the attempt to parse, // then just use the default color. try { int i = 0; // Ignore any blank strings that this simple parsing produces. while (specArray[i].trim().equals("")) { i++; } if (specArray.length > i) { red = Float.parseFloat(specArray[i]); } i++; while (specArray[i].trim().equals("")) { i++; } if (specArray.length > i) { green = Float.parseFloat(specArray[i]); } i++; while (specArray[i].trim().equals("")) { i++; } if (specArray.length > i) { blue = Float.parseFloat(specArray[i]); } i++; while (specArray[i].trim().equals("")) { i++; } if (specArray.length > i) { alpha = Float.parseFloat(specArray[i]); } } catch (Exception ex) { // Ignore and use default color. } return new Color(red, green, blue, alpha); } /** Get the current value in the entry with the given name, * and return as a String. All entry types support this. * Note that this method should be called from the event dispatch * thread, since it needs to query to UI widgets for their current * values. If it is called from another thread, there is no * assurance that the value returned will be the current value. * @param name The name of the entry. * @deprecated Use getStringValue(String name) instead. * @return The value currently in the entry as a String. * @exception NoSuchElementException If there is no item with the * specified name. Note that this is a runtime exception, so it * need not be declared explicitly. * @exception IllegalArgumentException If the entry type does not * have a string representation (this should not be thrown). */ @Deprecated public String stringValue(String name) throws NoSuchElementException, IllegalArgumentException { return getStringValue(name); } /////////////////////////////////////////////////////////////////// //// public variables //// /** The default height of entries created with addText(). */ public static final int DEFAULT_ENTRY_HEIGHT = 10; /** The default width of entries created with addLine(). */ public static final int DEFAULT_ENTRY_WIDTH = 30; /////////////////////////////////////////////////////////////////// //// protected methods //// /** Add a label and a widget to the panel. * @param name The name of the entry. * @param label The label. * @param widget The interactive entry to the right of the label. * @param entry The object that contains user data. */ protected void _addPair(String name, JLabel label, Component widget, Object entry) { // Surely there is a better layout manager in swing... // Note that Box and BoxLayout do not work because they do not // support gridded layout. _constraints.gridwidth = 1; _constraints.insets = _leftPadding; _constraints.weightx = 0; _grid.setConstraints(label, _constraints); _entryPanel.add(label); _constraints.insets = _insets; if (_columns > 1 && (_entries.size() + 1) % _columns != 0) { _constraints.gridwidth = 1; } else { _constraints.gridwidth = GridBagConstraints.REMAINDER; } _constraints.weightx = 1; _grid.setConstraints(widget, _constraints); _entryPanel.add(widget); _entries.put(name, entry); _labels.put(name, label); _previous.put(name, getObjectValue(name)); _recalculatePreferredSize(widget); } /** Recalculate the preferred size of the entry panel. * @param widget The widget added to the entry panel. */ protected void _recalculatePreferredSize(Component widget) { Dimension preferredSize = _entryPanel.getPreferredSize(); // Add some slop to the width to take in to account // the width of the vertical scrollbar. preferredSize.width += 25; // Applets seem to need this, see CT/SigmaDelta _widgetsHeight += widget.getPreferredSize().height + _insets.top + _insets.bottom; preferredSize.height = _widgetsHeight; Toolkit tk = Toolkit.getDefaultToolkit(); if (preferredSize.height > tk.getScreenSize().height) { // Fudge factor to keep this window smaller than the screen // height. CGSUnitBase and the Code Generator are good tests. preferredSize.height = (int) (tk.getScreenSize().height * 0.75); _entryScrollPane.setPreferredSize(preferredSize); } _entryScrollPane.setPreferredSize(preferredSize); // Call revalidate for the scrollbar. _entryPanel.revalidate(); } /** Resize the textArea and repack the containing ComponentDialog. * This method is used to handle scrollbars in entries when the * user types in more text than will fit in a line or else uses * shift-enter to create a newline in an entry. * @param textArea The text area to be have its rows set and its parent packed. * @param minimumNumberOfRows If the text area has less than this * number of rows, then one row is added and the parent * ComponentDialog of the text area is repacked. */ protected static void _textAreaSetRowsAndRepackParent(JTextArea textArea, int minimumNumberOfRows) { // This method is based on code by Patricia Derler that was // originally in PtolemyQuery. // One test for this is to drag in a StringConst and type in // lots of characters. You should get a scrollbar. See // http://bugzilla.ecoinformatics.org/show_bug.cgi?id=5587 if (textArea.getRows() < minimumNumberOfRows) { textArea.setRows(textArea.getRows() + 1); textArea.revalidate(); Component parent = textArea.getParent(); while (parent != null && !(parent instanceof ComponentDialog)) { parent = parent.getParent(); } if (parent instanceof ComponentDialog) { ComponentDialog dialog = (ComponentDialog) parent; dialog.doLayout(); dialog.pack(); } } } /////////////////////////////////////////////////////////////////// //// protected variables //// /** The background color as set by setBackground(). * This defaults to null, which indicates that the background * is the same as the container. */ protected Color _background = null; /** Standard constraints for use with _grid. */ protected GridBagConstraints _constraints; /** The hashtable of items in the query. */ protected Map _entries = new HashMap(); /** Layout control. */ protected GridBagLayout _grid; /** List of registered listeners. */ protected Vector _listeners; /////////////////////////////////////////////////////////////////// //// friendly methods //// /** Notify all registered listeners that something changed for the * specified entry, if it indeed has changed. The getStringValue() * method is used to check the current value against the previously * notified value, or the original value if there have been no * notifications. * @param name The entry that may have changed. */ void _notifyListeners(String name) { if (_listeners != null) { String previous = (String) _previous.get(name); String newValue = getStringValue(name); if (newValue.equals(previous)) { return; } // Store the new value to prevent repeated notification. // This must be done before listeners are notified, because // the notified listeners might do something that again triggers // notification, and we do not want that notification to occur // if the value has not changed. _previous.put(name, newValue); Enumeration listeners = _listeners.elements(); while (listeners.hasMoreElements()) { QueryListener queryListener = (QueryListener) listeners .nextElement(); queryListener.changed(name); } } } /////////////////////////////////////////////////////////////////// //// private variables //// // The number of columns. private int _columns = 1; // A panel within which the entries are placed. private JPanel _entryPanel = new JPanel(); // A scroll pane that contains the _entryPanel. private JScrollPane _entryScrollPane; // The number of lines in a text box. private int _height = DEFAULT_ENTRY_HEIGHT; // The hashtable of labels in the query. private Map _labels = new HashMap(); // Left padding insets. private Insets _leftPadding = new Insets(0, 10, 0, 0); // Area for messages. private JTextArea _messageArea = null; // A scroll pane that contains the _messageArea. private JScrollPane _messageScrollPane; // True if we have added the _messageScrollPane private boolean _messageScrollPaneAdded = false; // No padding insets. private Insets _insets = new Insets(0, 0, 0, 0); // The hashtable of previous values, indexed by entry name. private Map _previous = new HashMap(); // The sum of the height of the widgets added using _addPair // If you adjust this, try the GR/Pendulum demo, which has // only one parameter. private int _widgetsHeight = 20; // The number of horizontal characters in a text box. private int _width = DEFAULT_ENTRY_WIDTH; /////////////////////////////////////////////////////////////////// //// inner classes //// /** Listener for "line" and radio button entries. */ public static class QueryActionListener implements ActionListener { /** Construct a listener for line and radio button entries. * @param owner The owner query * @param name The name of the query */ public QueryActionListener(Query owner, String name) { _name = name; _owner = owner; } /** Call all registered QueryListeners. * @param event The event, ignored in this method. */ @Override public void actionPerformed(ActionEvent event) { _owner._notifyListeners(_name); } private Query _owner; private String _name; } /** Panel containing an entry box and button that opens a color chooser. */ public static class QueryColorChooser extends Box implements ActionListener { /** Create a panel containing an entry box and a color chooser. * @param owner The owner query * @param name The name of the query * @param defaultColor The initial default color of the color chooser. */ public QueryColorChooser(Query owner, String name, String defaultColor) { super(BoxLayout.X_AXIS); _owner = owner; //_defaultColor = defaultColor; _entryBox = new JTextField(defaultColor, _owner.getTextWidth()); _button = new JButton("Choose"); _button.addActionListener(this); add(_entryBox); add(_button); // Add the listener last so that there is no notification // of the first value. _entryBox.addActionListener(new QueryActionListener(_owner, name)); // Add a listener for loss of focus. When the entry gains // and then loses focus, listeners are notified of an update, // but only if the value has changed since the last notification. // FIXME: Unfortunately, Java calls this listener some random // time after the window has been closed. It is not even a // a queued event when the window is closed. Thus, we have // a subtle bug where if you enter a value in a line, do not // hit return, and then click on the X to close the window, // the value is restored to the original, and then sometime // later, the focus is lost and the entered value becomes // the value of the parameter. I don't know of any workaround. _entryBox.addFocusListener(new QueryFocusListener(_owner, name)); _name = name; } @Override public void actionPerformed(ActionEvent e) { // Read the current color from the text field. String spec = getSelectedColor().trim(); Color newColor = JColorChooser.showDialog(_owner, "Choose Color", stringToColor(spec)); if (newColor != null) { float[] components = newColor.getRGBComponents(null); StringBuffer string = new StringBuffer("{"); // Use the syntax of arrays. for (int j = 0; j < components.length; j++) { string.append(components[j]); if (j < components.length - 1) { string.append(","); } else { string.append("}"); } } _entryBox.setText(string.toString()); _owner._notifyListeners(_name); } } /** Get the selected color name. * @return the value of the text in the entry box. */ public String getSelectedColor() { return _entryBox.getText(); } /** Set selected color name. * @param name The value of the text in the entry box. */ public void setColor(String name) { _entryBox.setText(name); } /** Specify whether the entry is editable or not. * @param enabled False to disable changing the value. */ @Override public void setEnabled(boolean enabled) { _entryBox.setEditable(enabled); _button.setEnabled(enabled); } private JButton _button; private JTextField _entryBox; private String _name; private Query _owner; //private String _defaultColor; } /** Panel containing an entry box and file chooser. * */ public/*static*/class QueryFileChooser extends Box implements ActionListener { // This class cannot be static because the FileDialog needs to be owned // by the parent Query. /** Construct a query file chooser. The background will be white and * the foreground will be black. * @param owner The query object that owns the file chooser * @param name The name of the query object * @param defaultName The default name that appears in the text field * @param base The base for this query file chooser * @param startingDirectory the directory in which the file query is initially opened * @param allowFiles true if files are allowed to be selected. * @param allowDirectories if directories are allowed to be selected. */ public QueryFileChooser(Query owner, String name, String defaultName, URI base, File startingDirectory, boolean allowFiles, boolean allowDirectories) { this(owner, name, defaultName, base, startingDirectory, allowFiles, allowDirectories, false, Color.white, Color.black); } /** Construct a query file chooser. * @param owner The query object that owns the file chooser * @param name The name of the query object * @param defaultName The default name that appears in the text field * @param base The base for this query file chooser * @param startingDirectory the directory in which the file query is initially opened * @param allowFiles true if files are allowed to be selected. * @param allowDirectories if directories are allowed to be selected. * @param save Whether the file is to be saved or opened. * @param background The color of the background. * @param foreground The color of the foreground. */ public QueryFileChooser(Query owner, String name, String defaultName, URI base, File startingDirectory, boolean allowFiles, boolean allowDirectories, boolean save, Color background, Color foreground) { this(owner, name, defaultName, base, startingDirectory, allowFiles, allowDirectories, save, background, foreground, null); } /** Construct a query file chooser. * @param owner The query object that owns the file chooser * @param name The name of the query object * @param defaultName The default name that appears in the text field * @param base The base for this query file chooser * @param startingDirectory the directory in which the file query is initially opened * @param allowFiles true if files are allowed to be selected. * @param allowDirectories if directories are allowed to be selected. * @param save Whether the file is to be saved or opened. * @param background The color of the background. * @param foreground The color of the foreground. * @param filter A filter for filenames, or null to not give one. */ public QueryFileChooser(Query owner, String name, String defaultName, URI base, File startingDirectory, boolean allowFiles, boolean allowDirectories, boolean save, Color background, Color foreground, FilenameFilter filter) { super(BoxLayout.X_AXIS); _owner = owner; _base = base; _save = save; _startingDirectory = startingDirectory; if (!allowFiles && !allowDirectories) { throw new IllegalArgumentException( "QueryFileChooser: nothing to be chosen."); } _allowFiles = allowFiles; _allowDirectories = allowDirectories; _entryBox = new JTextField(defaultName, _owner.getTextWidth()); _entryBox.setBackground(background); _entryBox.setForeground(foreground); _button = new JButton("Browse "); _button.addActionListener(this); add(_entryBox); add(_button); // Add the listener last so that there is no notification // of the first value. _entryBox.addActionListener(new QueryActionListener(_owner, name)); // Add a listener for loss of focus. When the entry gains // and then loses focus, listeners are notified of an update, // but only if the value has changed since the last notification. // FIXME: Unfortunately, Java calls this listener some random // time after the window has been closed. It is not even a // a queued event when the window is closed. Thus, we have // a subtle bug where if you enter a value in a line, do not // hit return, and then click on the X to close the window, // the value is restored to the original, and then sometime // later, the focus is lost and the entered value becomes // the value of the parameter. I don't know of any workaround. _entryBox.addFocusListener(new QueryFocusListener(_owner, name)); _name = name; _filter = filter; } /** Create a file browser dialog and get the user input. If * {@link ptolemy.gui.PtGUIUtilities#useFileDialog()} returns * true, then {@link #_actionPerformedFileDialog(ActionEvent)} uses * this method. Otherwise, {@link #_actionPerformedJFileChooser(ActionEvent)} * is used. */ @Override public void actionPerformed(ActionEvent event) { if (PtGUIUtilities.useFileDialog()) { _actionPerformedFileDialog(event); } else { _actionPerformedJFileChooser(event); } } /** Get the selected file name. * @return the value of the text in the entry box. */ public String getSelectedFileName() { return _entryBox.getText(); } /** Specify whether the entry is editable or not. * @param enabled False to disable changing the value. */ @Override public void setEnabled(boolean enabled) { _entryBox.setEditable(enabled); _button.setEnabled(enabled); } /** Set selected file name. * @param name The value of the text in the entry box. */ public void setFileName(String name) { _entryBox.setText(name); } /** Create a java.awt.FileDialog and get the user input. If * {@link ptolemy.gui.PtGUIUtilities#useFileDialog()} returns * true, then {@link #actionPerformed(ActionEvent)} uses this method. * Otherwise, {@link #_actionPerformedJFileChooser(ActionEvent)} is used. *
Under Mac OS X, this method is preferred over * _actionPerformedJFileChooser().
* *Under Bash, to test this method, use:
*
* export JAVAFLAGS=-Dptolemy.ptII.useFileDialog=true
* $PTII/bin/vergil ~/ptII/ptolemy/actor/lib/io/test/auto/FileReader.xml
*
*/
private void _actionPerformedFileDialog(ActionEvent e) {
FileDialog fileDialog = new FileDialog(
JOptionPane.getFrameForComponent(Query.this), "Select",
FileDialog.LOAD);
if (_startingDirectory != null) {
fileDialog.setDirectory(_startingDirectory.toString());
}
String fileName = getSelectedFileName().trim();
if (!fileName.equals("")) {
fileDialog.setFile(fileName);
}
// Use a system property to determine whether to allow choosing
// directories only or both directories and files.
// FIXME: This doesn't really do the right thing.
// If _allowDirectories is set, then you cannot select files!
// Also, this seems like a poor mechanism, since it sets a property
// that affects anything running in this JVM!
if (_allowDirectories) {
System.setProperty("apple.awt.fileDialogForDirectories", "true");
} else {
System.setProperty("apple.awt.fileDialogForDirectories",
"false");
}
if (_filter != null) {
fileDialog.setFilenameFilter(_filter);
}
fileDialog.show();
if (fileDialog.getFile() == null) {
return;
}
File file = null;
// FIXME: should we set both of these?
_startingDirectory = new File(fileDialog.getDirectory());
//_base = new File(fileDialog.getDirectory()).toURI();
if (_startingDirectory != null) {
file = new File(_startingDirectory, fileDialog.getFile());
} else {
String currentWorkingDirectory = null;
try {
currentWorkingDirectory = System.getProperty("user.dir");
} catch (Throwable throwable) {
// Ignore, we are probably in an applet.
}
if (currentWorkingDirectory != null) {
file = new File(currentWorkingDirectory,
fileDialog.getFile());
} else {
file = new File(fileDialog.getFile());
}
}
if (file.exists() && fileDialog.getMode() == FileDialog.SAVE) {
// Ask for confirmation before overwriting a file.
String queryString = file.getName()
+ " already exists. Overwrite?";
int selected = JOptionPane.showOptionDialog(null, queryString,
"Confirm save", JOptionPane.YES_NO_OPTION,
JOptionPane.QUESTION_MESSAGE, null, null, null);
if (selected == 1) {
return;
}
}
// FIXME: lots of duplicated code here. Consider creating
// a method that takes a File argument?
if (_base == null) {
// Absolute file name.
try {
_entryBox.setText(new File(fileDialog.getDirectory(),
fileDialog.getFile()).getCanonicalPath());
} catch (IOException ex) {
// If we can't get a path, then just use the name.
_entryBox.setText(fileDialog.getFile());
}
} else {
// Relative file name.
File selectedFile = new File(fileDialog.getDirectory(),
fileDialog.getFile());
// FIXME: There is a bug here under Windows XP
// at least... Sometimes, the drive ID (like c:)
// is lower case, and sometimes it's upper case.
// When we open a MoML file, it's upper case.
// When we do "save as", it's lower case.
// This despite the fact that both use the same
// file browser to determine the file name.
// Beats me... Consequence is that if you save as,
// then the following relativize call doesn't work
// until you close and reopen the file.
try {
selectedFile = selectedFile.getCanonicalFile();
} catch (IOException ex) {
// Ignore, since we can't do much about it anyway.
}
URI relativeURI = _base.relativize(selectedFile.toURI());
if (relativeURI != null && relativeURI.getScheme() != null
&& relativeURI.getScheme().equals("file")) {
// Fix for "undesired file:\ prefix added by FileParameter"
// http://bugzilla.ecoinformatics.org/show_bug.cgi?id=4022
String pathName = relativeURI.getPath();
// Sigh. Under Windows, getPath() returns a leading /
file = new File(pathName.replace("%20", " "));
try {
_entryBox.setText(file.getCanonicalPath().replace('\\',
'/'));
} catch (IOException ex) {
_entryBox.setText(file.toString());
}
} else {
_entryBox.setText(relativeURI.toString());
}
}
_owner._notifyListeners(_name);
}
/** Create a javax.swing.JFileChooser and get the user input.
* If {@link ptolemy.gui.PtGUIUtilities#useFileDialog()} returns false,
* then {@link #actionPerformed(ActionEvent)} uses this method. Otherwise,
* {@link #_actionPerformedFileDialog(ActionEvent)} is used.
* Under Bash, to test this method, use:
*
* export JAVAFLAGS=-Dptolemy.ptII.useFileDialog=false
* $PTII/bin/vergil ~/ptII/ptolemy/actor/lib/io/test/auto/FileReader.xml
*
*/
private void _actionPerformedJFileChooser(ActionEvent e) {
// Swap backgrounds and avoid white boxes in "common places" dialog
JFileChooserBugFix jFileChooserBugFix = new JFileChooserBugFix();
Color background = null;
try {
background = jFileChooserBugFix.saveBackground();
// NOTE: If the last argument is null, then choose a
// default dir.
JFileChooser fileChooser = new JFileChooser(_startingDirectory) {
@Override
public void approveSelection() {
File file = getSelectedFile();
if (file.exists() && getDialogType() == SAVE_DIALOG) {
String queryString = file.getName()
+ " already exists. Overwrite?";
int selected = JOptionPane.showOptionDialog(null,
queryString, "Confirm save",
JOptionPane.YES_NO_OPTION,
JOptionPane.QUESTION_MESSAGE, null, null,
null);
if (selected == 0) {
super.approveSelection();
}
} else {
super.approveSelection();
}
}
};
String fileName = getSelectedFileName().trim();
if (!fileName.equals("")) {
fileChooser.setSelectedFile(new File(fileName));
}
fileChooser.setApproveButtonText("Select");
// FIXME: The following doesn't have any effect.
fileChooser.setApproveButtonMnemonic('S');
if (_allowFiles && _allowDirectories) {
fileChooser
.setFileSelectionMode(JFileChooser.FILES_AND_DIRECTORIES);
} else if (_allowFiles && !_allowDirectories) {
// This is the default.
fileChooser.setFileSelectionMode(JFileChooser.FILES_ONLY);
} else if (!_allowFiles && _allowDirectories) {
fileChooser
.setFileSelectionMode(JFileChooser.DIRECTORIES_ONLY);
} else {
// Usually, we would use InternalErrorException
// here, but if we do, then this package would
// depend on kernel.util, which causes problems
// when we ship Ptplot.
throw new RuntimeException(
"QueryFileChooser: nothing to be chosen.");
}
int returnValue = _save ? fileChooser.showSaveDialog(_owner)
: fileChooser.showOpenDialog(_owner);
if (returnValue == JFileChooser.APPROVE_OPTION) {
if (_base == null) {
// Absolute file name.
try {
_entryBox.setText(fileChooser.getSelectedFile()
.getCanonicalPath());
} catch (IOException ex) {
// If we can't get a path, then just use the name.
_entryBox.setText(fileChooser.getSelectedFile()
.getName());
}
} else {
// Relative file name.
File selectedFile = fileChooser.getSelectedFile();
// FIXME: There is a bug here under Windows XP
// at least... Sometimes, the drive ID (like c:)
// is lower case, and sometimes it's upper case.
// When we open a MoML file, it's upper case.
// When we do "save as", it's lower case.
// This despite the fact that both use the same
// file browser to determine the file name.
// Beats me... Consequence is that if you save as,
// then the following relativize call doesn't work
// until you close and reopen the file.
try {
selectedFile = selectedFile.getCanonicalFile();
} catch (IOException ex) {
// Ignore, since we can't do much about it anyway.
}
URI relativeURI = _base
.relativize(selectedFile.toURI());
if (relativeURI != null
&& relativeURI.getScheme() != null
&& relativeURI.getScheme().equals("file")) {
// Fix for "undesired file:\ prefix added by FileParameter"
// http://bugzilla.ecoinformatics.org/show_bug.cgi?id=4022
String pathName = relativeURI.getPath();
// Sigh. Under Windows, getPath() returns a leading /
File file = new File(pathName.replace("%20", " "));
try {
_entryBox.setText(file.getCanonicalPath()
.replace('\\', '/'));
} catch (IOException ex) {
_entryBox.setText(file.toString());
}
} else {
_entryBox.setText(relativeURI.toString());
}
}
_owner._notifyListeners(_name);
}
} finally {
jFileChooserBugFix.restoreBackground(background);
}
}
private Query _owner;
private URI _base;
private JButton _button;
private JTextField _entryBox;
private String _name;
private boolean _save;
private File _startingDirectory;
private boolean _allowFiles;
private boolean _allowDirectories;
private FilenameFilter _filter;
}
/** Listener for line entries, for when they lose the focus.
*/
public static class QueryFocusListener implements FocusListener {
/** Construct a listener for when line entries lose the focus.
* @param owner The query object that owns the file chooser
* @param name The name of the query object
*/
public QueryFocusListener(Query owner, String name) {
_name = name;
_owner = owner;
}
@Override
public void focusGained(FocusEvent e) {
// Nothing to do.
}
@Override
public void focusLost(FocusEvent e) {
// NOTE: Java's lame AWT has no reliable way
// to take action on window closing, so this focus lost
// notification is the only reliable way we have of reacting
// to a closing window. If the previous
// notification was an erroneous one and the value has not
// changed, then no further notification occurs.
// This could be a problem for some users of this class.
_owner._notifyListeners(_name);
}
private Query _owner;
private String _name;
}
/** Listener for "CheckBox" and "Choice" entries.
*/
public static class QueryItemListener implements ItemListener {
/** Create a listener for the CheckBox and Choice entries.
* @param owner The owner query
* @param name The name of the query
*/
public QueryItemListener(Query owner, String name) {
_name = name;
_owner = owner;
}
/** Call all registered QueryListeners. */
@Override
public void itemStateChanged(ItemEvent e) {
_owner._notifyListeners(_name);
}
private Query _owner;
private String _name;
}
/** Inner class to tie textArea to scroll pane. */
static class QueryScrollPane extends JScrollPane {
// FindBugs suggests making this class static so as to decrease
// the size of instances and avoid dangling references.
public JTextArea textArea;
QueryScrollPane(JTextArea c) {
super(c);
textArea = c;
// Set the undo listener
textArea.getDocument().addUndoableEditListener(
new UndoListener(textArea));
}
@Override
public JScrollBar getHorizontalScrollBar() {
// If the user types in lots of characters, eventually
// create a scrollbar and make the textArea bigger. Note
// that
// http://docs.oracle.com/javase/tutorial/uiswing/components/textarea.html
// says: "If you need to obtain only one line of input
// from the user, you should use a text field."
JScrollBar scrollBar = super.getHorizontalScrollBar();
if (scrollBar != null) {
if (scrollBar.isDisplayable() && scrollBar.getHeight() > 0) {
Query._textAreaSetRowsAndRepackParent(textArea, 2);
}
}
return scrollBar;
}
@Override
public Dimension getPreferredSize() {
// For another possible solution, see
// http://stackoverflow.com/questions/9370561/enabling-scroll-bars-when-jtextarea-exceeds-certain-amount-of-lines
// If we have a TextArea, display as many parameters as we
// can of the TextArea before adding a scrollbar for all
// the parameters.
if (textArea.getLineCount() > 1) {
return textArea.getPreferredSize();
} else {
return super.getPreferredSize();
}
}
public String getText() {
String retval = textArea.getText();
return retval;
}
public void setText(String s) {
textArea.setText(s);
}
}
/** Listener for changes in slider.
*/
public static class SliderListener implements ChangeListener {
/** Construct a listener for changes in a slider.
* @param owner The query object that owns slider.
* @param name The name of the query object
*/
public SliderListener(Query owner, String name) {
_name = name;
_owner = owner;
}
/** Call all registered QueryListeners. */
@Override
public void stateChanged(ChangeEvent event) {
_owner._notifyListeners(_name);
}
private Query _owner;
private String _name;
}
}