Package ucb.gui2

Class TopLevel

java.lang.Object

java.util.Observable

ucb.gui2.TopLevel

All Implemented Interfaces:

java.awt.event.ActionListener, java.util.EventListener

public class TopLevel
extends java.util.Observable
implements java.awt.event.ActionListener

A top-level window with optional menu bar. A TopLevel primarily exists to contain Widgets. The general technique is to extend TopLevel. Most of the methods here are protected: the intent is that any calls to them are from within your extension class, thus allowing the latter to retain control over its size, menu, etc.

Field Summary

Fields

Modifier and Type	Field	Description
protected javax.swing.JFrame	frame	The Swing frame representing this TopLevel object.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TopLevel(java.lang.String title, boolean exitOnClose)	A new TopLevel with the given TITLE (which window managers typically display on the border).

Method Summary

Modifier and Type	Method	Description
void	actionPerformed(java.awt.event.ActionEvent e)
protected void	add(Widget widget, LayoutSpec layout)	Add WIDGET, placed according to LAYOUT.
protected void	addButton(java.lang.String label, java.util.function.Consumer<java.lang.String> func, LayoutSpec layout)	Add a new button displaying LABEL, laid out according to LAYOUT, which when clicked calls FUNC, with the button and LABEL as its arguments.
protected void	addCheckBox(java.lang.String label, boolean selected, java.util.function.Consumer<java.lang.String> func, LayoutSpec layout)	Add a new check box displaying LABEL, laid out according to LAYOUT, which when clicked calls FUNC, with the button and LABEL as its arguments.
protected void	addLabel(java.lang.String text, java.lang.String id, LayoutSpec layout)	Add a label that initially displays the text TEXT, placed according to LAYOUT, and identified by the tag ID.
protected void	addLabel(java.lang.String text, LayoutSpec layout)	Add a new, anonymous label that displays the text TEXT, placed according to LAYOUT.
protected void	addMenuButton(java.lang.String label, java.util.function.Consumer<java.lang.String> func)	Add a new simple menu button labeled LABEL to my menus, which when clicked, invokes FUNC, sending the button itself and LABEL as arguments.
protected void	addMenuCheckBox(java.lang.String label, boolean selected, java.util.function.Consumer<java.lang.String> func)	Add a check box labeled LABEL to my menus, which when clicked, flips its state and invokes FUNC, sending the button itself and LABEL as arguments.
protected void	addMenuRadioButton(java.lang.String label, java.lang.String groupName, boolean selected, java.util.function.Consumer<java.lang.String> func)	Add a radio button labeled LABEL to my menus, belonging to the group of buttons called GROUPNAME.
protected void	addRadioButton(java.lang.String label, java.lang.String groupName, boolean selected, java.util.function.Consumer<java.lang.String> func, LayoutSpec layout)	Add a radio button labeled LABEL, placed according to LAYOUT, belonging to the group of buttons called GROUPNAME.
protected void	addSeparator(java.lang.String label)	Add a separator to the end of the menu labeled LABEL (which must exist) in my menu bar.
void	display(boolean visible)	If VISIBLE, display this TopLevel.
int	getHeight()	Return my current height in pixels.
java.lang.String	getTextInput(java.lang.String message, java.lang.String title, java.lang.String type, java.lang.String init)	Display a dialog box with message MESSAGE and title TITLE that prompts the user for textual input, with INIT providing the initial value of the text.
int	getWidth()	Return my current width in pixels.
protected boolean	isSelected(java.lang.String label)	Return true iff the button named LABEL is currently selected.
protected void	select(java.lang.String label, boolean val)	Set isSelected(LABEL) to VAL, if LABEL is a valid button.
protected void	setEnabled(boolean enable, java.lang.String... labels)	Set the enabled status of the buttons labeled LABELS[0], ...
protected void	setLabel(java.lang.String id, java.lang.String text)	Set the text of the existing label with tag ID to TEXT.
void	setMaximumSize(int width, int height)	Set my maximum size to WIDTH x HEIGHT pixels.
void	setMinimumSize(int width, int height)	Set my minimum size to WIDTH x HEIGHT pixels.
void	setPreferredFocus(Widget widget)	When the focus is in my window, request that WIDGET, which should be one of my components, get the focus.
void	setPreferredSize(int width, int height)	Set my preferred size to WIDTH x HEIGHT pixels.
void	showMessage(java.lang.String text, java.lang.String title, java.lang.String type)	Display the dismissable message TEXT of type TYPE in a separate dialog window with title TITLE.
int	showOptions(java.lang.String message, java.lang.String title, java.lang.String type, java.lang.String deflt, java.lang.String... labels)	Display a choice of optional responses, labeled LABELS[0],...,LABELS[n] in a separate dialog box with title TITLE and message MESSAGE.

Methods inherited from class java.lang.Object

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

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Field Detail

frame

protected final javax.swing.JFrame frame

The Swing frame representing this TopLevel object.

Constructor Detail

TopLevel

protected TopLevel(java.lang.String title,
                   boolean exitOnClose)

A new TopLevel with the given TITLE (which window managers typically display on the border). If EXITONCLOSE, then closing this window exits the application.

Method Detail

display

public void display(boolean visible)

If VISIBLE, display this TopLevel. Otherwise, make it invisible.

setPreferredSize

public void setPreferredSize(int width,
                             int height)

Set my preferred size to WIDTH x HEIGHT pixels.

setMinimumSize

public void setMinimumSize(int width,
                           int height)

Set my minimum size to WIDTH x HEIGHT pixels.

setMaximumSize

public void setMaximumSize(int width,
                           int height)

Set my maximum size to WIDTH x HEIGHT pixels.

getWidth

public int getWidth()

Return my current width in pixels.

getHeight

public int getHeight()

Return my current height in pixels.

addMenuButton

protected void addMenuButton(java.lang.String label,
                             java.util.function.Consumer<java.lang.String> func)

Add a new simple menu button labeled LABEL to my menus, which when clicked, invokes FUNC, sending the button itself and LABEL as arguments. A null value of FUNC indicates no action. LABEL has the form MENUNAME->SUBMENU1->...SUBMENUn->NAME, where n >= 0, (for example, "File->Open" or "File->New->Project"). This label denotes "the item labeled NAME in the submenu named SUBMENUn in the ... in the menu-bar entry MENUNAME. The new button appears at the end of its menu. Likewise, any previously non-existing menus get created at the end of the menu bar or their containing menu.

addMenuCheckBox

protected void addMenuCheckBox(java.lang.String label,
                               boolean selected,
                               java.util.function.Consumer<java.lang.String> func)

Add a check box labeled LABEL to my menus, which when clicked, flips its state and invokes FUNC, sending the button itself and LABEL as arguments. LABEL is as for addMenuButton. The box is initially checked iff CHECKED. A null value of FUNC indicates no action (aside from changing selection state).

addMenuRadioButton

protected void addMenuRadioButton(java.lang.String label,
                                  java.lang.String groupName,
                                  boolean selected,
                                  java.util.function.Consumer<java.lang.String> func)

Add a radio button labeled LABEL to my menus, belonging to the group of buttons called GROUPNAME. Initially, the button is selected iff SELECTED. Only one radio button in a group is selected at a time (see isSelected(java.lang.String)); when the user clicks one, it becomes selected and any other button in the group is deselected. If FUNC is non-null, it denotes a function that is invoked when the button is pressed, sending the button and LABEL as its arguments.

addSeparator

protected void addSeparator(java.lang.String label)

Add a separator to the end of the menu labeled LABEL (which must exist) in my menu bar. LABEL has the form MENUNAME->SUBMENU1->...->SUBMENUn.

isSelected

protected boolean isSelected(java.lang.String label)

Return true iff the button named LABEL is currently selected.

select

protected void select(java.lang.String label,
                      boolean val)

Set isSelected(LABEL) to VAL, if LABEL is a valid button.

setEnabled

protected void setEnabled(boolean enable,
                          java.lang.String... labels)

Set the enabled status of the buttons labeled LABELS[0], ... to ENABLE. An ENABLE value of false causes the buttons to become unresponsive, typically displaying as being grayed out.

addButton

protected void addButton(java.lang.String label,
                         java.util.function.Consumer<java.lang.String> func,
                         LayoutSpec layout)

Add a new button displaying LABEL, laid out according to LAYOUT, which when clicked calls FUNC, with the button and LABEL as its arguments.

addCheckBox

protected void addCheckBox(java.lang.String label,
                           boolean selected,
                           java.util.function.Consumer<java.lang.String> func,
                           LayoutSpec layout)

Add a new check box displaying LABEL, laid out according to LAYOUT, which when clicked calls FUNC, with the button and LABEL as its arguments. It is initially selected iff SELECTED.

addRadioButton

protected void addRadioButton(java.lang.String label,
                              java.lang.String groupName,
                              boolean selected,
                              java.util.function.Consumer<java.lang.String> func,
                              LayoutSpec layout)

Add a radio button labeled LABEL, placed according to LAYOUT, belonging to the group of buttons called GROUPNAME. Initially, the button is selected iff SELECTED. Only one radio button in a group is selected at a time (see isSelected(java.lang.String)); when the user clicks one, it becomes selected and any other button in the group is deselected. If FUNC is non-null, FUNC is invoked when pressed, sending the LABEL as argument.

add

protected void add(Widget widget,
                   LayoutSpec layout)

Add WIDGET, placed according to LAYOUT.

addLabel

protected void addLabel(java.lang.String text,
                        java.lang.String id,
                        LayoutSpec layout)

Add a label that initially displays the text TEXT, placed according to LAYOUT, and identified by the tag ID. If a label with the same ID already exists, its text is altered to TEXT.

setLabel

protected void setLabel(java.lang.String id,
                        java.lang.String text)

Set the text of the existing label with tag ID to TEXT.

addLabel

protected void addLabel(java.lang.String text,
                        LayoutSpec layout)

Add a new, anonymous label that displays the text TEXT, placed according to LAYOUT.

showMessage

public void showMessage(java.lang.String text,
                        java.lang.String title,
                        java.lang.String type)

Display the dismissable message TEXT of type TYPE in a separate dialog window with title TITLE. TYPE may be any of the strings "information", "warning", "error", or "plain", which modify the look of the message.

showOptions

public int showOptions(java.lang.String message,
                       java.lang.String title,
                       java.lang.String type,
                       java.lang.String deflt,
                       java.lang.String... labels)

Display a choice of optional responses, labeled LABELS[0],...,LABELS[n] in a separate dialog box with title TITLE and message MESSAGE. Returns the selected option (0 -- n), or -1 if the user closes the dialog window. DEFLT is the default label (may be null). TYPE may be "question", "information", "warning", "error", or "plain".

getTextInput

public java.lang.String getTextInput(java.lang.String message,
                                     java.lang.String title,
                                     java.lang.String type,
                                     java.lang.String init)

Display a dialog box with message MESSAGE and title TITLE that prompts the user for textual input, with INIT providing the initial value of the text. TYPE may be "question", "information", "warning", "error", or "plain". Return the user's input text, or null if the user closes the dialog window.

setPreferredFocus

public void setPreferredFocus(Widget widget)

When the focus is in my window, request that WIDGET, which should be one of my components, get the focus.

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

Specified by:

actionPerformed in interface java.awt.event.ActionListener