org.lsst.ccs.subsystem.common.ui

Class UiUtilities

java.lang.Object

org.lsst.ccs.subsystem.common.ui.UiUtilities

public class UiUtilities
extends Object

Some useful UI utility routines

Author:

saxton

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UiUtilities.ActionHandler

Constructor Summary

Constructors

Constructor and Description
UiUtilities(UiUtilities.ActionHandler handler) Constructor

Method Summary

Modifier and Type	Method and Description
static Dimension	getLabelSize(String text) Gets the size of a label with standard font.
static Dimension	getLabelSize(String text, Font font) Gets the size of a label.
static int	maxEnumLabelWidth(Class enumClass) Gets the maximum label width produced by the elements of an enumeration.
static int	maxEnumLabelWidth(Class enumClass, Font font) Gets the maximum label width produced by the elements of an enumeration.
static int	maxLabelWidth(String[] text, String term) Gets the maximum label width produced by a set of strings.
static int	maxLabelWidth(String[] text, String term, Font font) Gets the maximum label width produced by a set of strings.
static JPanel	newBorderedPanel(String title) Creates a bordered panel.
static JPanel	newBorderedPanel(String title, Font font) Creates a bordered panel.
JButton	newButton(String title, String name) Creates a button with default font.
JButton	newButton(String title, String name, boolean small) Creates a button with default font.
JButton	newButton(String title, String name, boolean small, Font font) Creates a button.
JButton	newButton(String title, String name, boolean small, Font lblFont, Font font) Creates a button.
JButton	newButton(String title, String name, Font font) Creates a button.
JCheckBox	newCheckBox(String title, String name) Creates a check box.
JCheckBox	newCheckBox(String title, String name, Font font) Creates a check box.
static JLabel	newLabel(String text, int width) Creates a label with the default font.
static JLabel	newLabel(String text, int width, Font font) Creates a label
JRadioButton	newRadioButton(String title, String name) Creates a radio button with the default font
JRadioButton	newRadioButton(String title, String name, boolean confirm) Creates a radio button.
JRadioButton	newRadioButton(String title, String name, Font font) Creates a radio button.
JRadioButton	newRadioButton(String title, String name, Font font, boolean confirm) Creates a radio button.
JTextField	newTextField(String text, String name) Creates a text field.
JTextField	newTextField(String text, String name, boolean small) Creates a text field.
JTextField	newTextField(String text, String name, boolean small, Font lblFont) Creates a text field.
JTextField	newTextField(String text, String name, boolean small, Font lblFont, Font font) Creates a text field.
JTextField	newTextField(String text, String name, Font font) Creates a text field.
TextFieldX	newTextFieldX(String text, String name, int type) Creates an extended text field.
TextFieldX	newTextFieldX(String text, String name, int type, boolean small) Creates an extended text field.
TextFieldX	newTextFieldX(String text, String name, int type, boolean small, Font lblFont) Creates an extended text field.
TextFieldX	newTextFieldX(String text, String name, int type, boolean small, Font lblFont, Font font) Creates an extended text field.
TextFieldX	newTextFieldX(String text, String name, int type, Font font) Creates an extended text field.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UiUtilities

public UiUtilities(UiUtilities.ActionHandler handler)

Constructor

Parameters:

handler - The action handler

Method Detail

newLabel

public static JLabel newLabel(String text,
                              int width)

Creates a label with the default font.

Parameters:

text - The label text

width - The desired label width, 0 if text determines it, or -1 if no width set

Returns:

The label

newLabel

public static JLabel newLabel(String text,
                              int width,
                              Font font)

Creates a label

Parameters:

text - The label text

width - The desired label width, 0 if text determines it, or -1 if no width set

font - The font to use

Returns:

The label

newRadioButton

public JRadioButton newRadioButton(String title,
                                   String name)

Creates a radio button with the default font

Parameters:

title - The button title

name - The name to be passed to the handler

Returns:

The radio button

newRadioButton

public JRadioButton newRadioButton(String title,
                                   String name,
                                   Font font)

Creates a radio button.

Parameters:

title - The button title

name - The name to be passed to the action handler

font - The font to use

Returns:

The radio button

newRadioButton

public JRadioButton newRadioButton(String title,
                                   String name,
                                   boolean confirm)

Creates a radio button.

Parameters:

title - The button title

name - The name to be passed to the action handler

confirm - True/false if there should be a Confirmation Dialog box.

Returns:

The radio button

newRadioButton

public JRadioButton newRadioButton(String title,
                                   String name,
                                   Font font,
                                   boolean confirm)

Creates a radio button.

Parameters:

title - The button title

name - The name to be passed to the action handler

font - The font to use

confirm - True/false if there should be a Confirmation Dialog box.

Returns:

The radio button

newButton

public JButton newButton(String title,
                         String name)

Creates a button with default font.

Parameters:

title - The button title

name - The name to be passed to the action handler

Returns:

The button

newButton

public JButton newButton(String title,
                         String name,
                         boolean small)

Creates a button with default font.

Parameters:

title - The button title

name - The name to be passed to the action handler

small - Create a less-tall button if true

Returns:

The button

newButton

public JButton newButton(String title,
                         String name,
                         Font font)

Creates a button.

Parameters:

title - The button title

name - The name to be passed to the action handler

font - The font to use

Returns:

The button

newButton

public JButton newButton(String title,
                         String name,
                         boolean small,
                         Font font)

Creates a button.

Parameters:

title - The button title

name - The name to be passed to the action handler

small - Create a less-tall button if true

font - The font to use

Returns:

The button

newButton

public JButton newButton(String title,
                         String name,
                         boolean small,
                         Font lblFont,
                         Font font)

Creates a button.

Parameters:

title - The button title

name - The name to be passed to the action handler

small - Create a less-tall button if true

lblFont - Font to use to determine less-tall height

font - The font to use

Returns:

The button

newTextField

public JTextField newTextField(String text,
                               String name)

Creates a text field.

Parameters:

text - The initial text, used to set its size

name - The name to be passed to the action handler

Returns:

The text field

newTextField

public JTextField newTextField(String text,
                               String name,
                               Font font)

Creates a text field.

Parameters:

text - The initial text, used to set its size

name - The name to be passed to the action handler

font - The font to use

Returns:

The text field

newTextField

public JTextField newTextField(String text,
                               String name,
                               boolean small)

Creates a text field.

Parameters:

text - The initial text, used to set its size

name - The name to be passed to the action handler

small - Create a less-tall field if true

Returns:

The text field

newTextField

public JTextField newTextField(String text,
                               String name,
                               boolean small,
                               Font lblFont)

Creates a text field.

Parameters:

text - The initial text, used to set its size

name - The name to be passed to the action handler

small - Create a less-tall field if true

lblFont - Font to use to determine less-tall height

Returns:

The text field

newTextField

public JTextField newTextField(String text,
                               String name,
                               boolean small,
                               Font lblFont,
                               Font font)

Creates a text field.

Parameters:

text - The initial text, used to set its size

name - The name to be passed to the action handler

small - Create a less-tall field if true

lblFont - Font to use to determine less-tall height

font - The font to use

Returns:

The text field

newTextFieldX

public TextFieldX newTextFieldX(String text,
                                String name,
                                int type)

Creates an extended text field.

Parameters:

text - The initial text, used to set its size

name - The name to be passed to the action handler

type - The type of field (TYPE_TEXT, TYPE_INT or TYPE_DOUBLE)

Returns:

The text field

newTextFieldX

public TextFieldX newTextFieldX(String text,
                                String name,
                                int type,
                                Font font)

Creates an extended text field.

Parameters:

text - The initial text, used to set its size

name - The name to be passed to the action handler

type - The type of field (TYPE_TEXT, TYPE_INT or TYPE_DOUBLE)

font - The font to use

Returns:

The text field

newTextFieldX

public TextFieldX newTextFieldX(String text,
                                String name,
                                int type,
                                boolean small)

Creates an extended text field.

Parameters:

text - The initial text, used to set its size

name - The name to be passed to the action handler

type - The type of field (TYPE_TEXT, TYPE_INT or TYPE_DOUBLE)

small - Create a less-tall field if true

Returns:

The text field

newTextFieldX

public TextFieldX newTextFieldX(String text,
                                String name,
                                int type,
                                boolean small,
                                Font lblFont)

Creates an extended text field.

Parameters:

text - The initial text, used to set its size

name - The name to be passed to the action handler

type - The type of field (TYPE_TEXT, TYPE_INT or TYPE_DOUBLE)

small - Create a less-tall field if true

lblFont - Font to use to determine less-tall height

Returns:

The text field

newTextFieldX

public TextFieldX newTextFieldX(String text,
                                String name,
                                int type,
                                boolean small,
                                Font lblFont,
                                Font font)

Creates an extended text field.

Parameters:

text - The initial text, used to set its size

name - The name to be passed to the action handler

type - The type of field (TYPE_TEXT, TYPE_INT or TYPE_DOUBLE)

small - Create a less-tall field if true

lblFont - Font to use to determine less-tall height

font - The font to use

Returns:

The text field

newCheckBox

public JCheckBox newCheckBox(String title,
                             String name)

Creates a check box.

Parameters:

title - The check box title

name - The name to be passed to the action handler

Returns:

The check box

newCheckBox

public JCheckBox newCheckBox(String title,
                             String name,
                             Font font)

Creates a check box.

Parameters:

title - The check box title

name - The name to be passed to the action handler

font - The font to use

Returns:

The check box

newBorderedPanel

public static JPanel newBorderedPanel(String title)

Creates a bordered panel.

Parameters:

title - The panel title, or null if no title required

Returns:

The panel

newBorderedPanel

public static JPanel newBorderedPanel(String title,
                                      Font font)

Creates a bordered panel.

Parameters:

title - The panel title, or null if no title required

font - The font to use

Returns:

The panel

maxLabelWidth

public static int maxLabelWidth(String[] text,
                                String term)

Gets the maximum label width produced by a set of strings.

Parameters:

text - An array of strings

term - The terminating string that will be appended to string

Returns:

The maximum width

maxLabelWidth

public static int maxLabelWidth(String[] text,
                                String term,
                                Font font)

Gets the maximum label width produced by a set of strings.

Parameters:

text - An array of strings

term - The terminating string that will be appended to string

font - The font to use

Returns:

The maximum width

maxEnumLabelWidth

public static int maxEnumLabelWidth(Class enumClass)

Gets the maximum label width produced by the elements of an enumeration.

Parameters:

enumClass - The enumeration class

Returns:

The maximum width

maxEnumLabelWidth

public static int maxEnumLabelWidth(Class enumClass,
                                    Font font)

Gets the maximum label width produced by the elements of an enumeration.

Parameters:

enumClass - The enumeration class

font - The font to use

Returns:

The maximum width

getLabelSize

public static Dimension getLabelSize(String text)

Gets the size of a label with standard font.

Parameters:

text - The label text

Returns:

The dimension of the label

getLabelSize

public static Dimension getLabelSize(String text,
                                     Font font)

Gets the size of a label.

Parameters:

text - The label text

font - The font to use

Returns:

The dimension of the label