Package edu.cnu.mdi.dialog

Class ButtonPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

edu.cnu.mdi.dialog.ButtonPanel

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class ButtonPanel
extends JPanel

A reusable panel for buttons. The constructor takes an array of button labels and an optional action listener. The buttons are created and added to the panel, and the action listener is added to each button. The buttons can be enabled or disabled by index, or all at once by using index -1. The class also provides a static method for creating a button panel with combinations of OK, Cancel, Apply, and Delete buttons. Subclasses can override the userSetup() method to add additional components before the buttons are added.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	APPLY_LABEL	Constant string for "apply" label
static final int	APPLY_RESPONSE	Constant indicating an "apply" response
protected JButton[]	buttons	The buttons
static final String	CANCEL_LABEL	Constant string for "cancel" label
static final int	CANCEL_RESPONSE	Constant indicating a "cancel" response
static final String	DELETE_LABEL	Constant string for "delete" label
static final int	DELETE_RESPONSE	Constant indicating a "delete" response
protected String[]	labels	The labels
static final String	OK_LABEL	Constant string for "ok" label
static final int	OK_RESPONSE	Constant indicating an "ok" response
static final int	USE_APPLY	Bit indicating using Apply button
static final int	USE_CANCEL	Bit indicating using Cancel button
static final int	USE_DELETE	Bit indicating using Delete button
static final int	USE_OK	Bit indicating using OK button
static final int	USE_OKCANCEL	Bit indicating using OK and Cancel buttons
static final int	USE_OKCANCELAPPLY	Bit indicating using OK, Cancel, and Apply buttons
static final int	USE_OKCANCELDELETE	Bit indicating using OK, Cancel, and Delete buttons

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor	Description
ButtonPanel(String[] labels)	The constructor.
ButtonPanel(String[] labels, ActionListener alist)	The constructor.
ButtonPanel(String[] labels, ActionListener alist, int spacing)	The constructor.
ButtonPanel(String[] labels, ActionListener alist, int spacing, int alignment)	The constructor.

Method Summary

Modifier and Type	Method	Description
protected void	addButtons(ActionListener alist)	Add the buttons to the panel.
static ButtonPanel	closeOutPanel(int opt, ActionListener actionListener, int spacing)	Makes a button panel with combinations of OK, Cancel, Apply, and Delete.
Insets	getInsets()
void	setEnabled(int index, boolean state)	Enable or disable a button.
void	setToolTip(int index, String tip)	Set tooltip
protected void	userSetup()	Place for subclasses to add something else

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Details

USE_OK

public static final int USE_OK

Bit indicating using OK button

See Also:

• Constant Field Values

USE_CANCEL

public static final int USE_CANCEL

Bit indicating using Cancel button

See Also:

• Constant Field Values

USE_APPLY

public static final int USE_APPLY

Bit indicating using Apply button

See Also:

• Constant Field Values

USE_DELETE

public static final int USE_DELETE

Bit indicating using Delete button

See Also:

• Constant Field Values

USE_OKCANCEL

public static final int USE_OKCANCEL

Bit indicating using OK and Cancel buttons

See Also:

• Constant Field Values

USE_OKCANCELAPPLY

public static final int USE_OKCANCELAPPLY

Bit indicating using OK, Cancel, and Apply buttons

See Also:

• Constant Field Values

USE_OKCANCELDELETE

public static final int USE_OKCANCELDELETE

Bit indicating using OK, Cancel, and Delete buttons

See Also:

• Constant Field Values

OK_RESPONSE

public static final int OK_RESPONSE

Constant indicating an "ok" response

See Also:

• Constant Field Values

CANCEL_RESPONSE

public static final int CANCEL_RESPONSE

Constant indicating a "cancel" response

See Also:

• Constant Field Values

APPLY_RESPONSE

public static final int APPLY_RESPONSE

Constant indicating an "apply" response

See Also:

• Constant Field Values

DELETE_RESPONSE

public static final int DELETE_RESPONSE

Constant indicating a "delete" response

See Also:

• Constant Field Values

OK_LABEL

public static final String OK_LABEL

Constant string for "ok" label

See Also:

• Constant Field Values

CANCEL_LABEL

public static final String CANCEL_LABEL

Constant string for "cancel" label

See Also:

• Constant Field Values

APPLY_LABEL

public static final String APPLY_LABEL

Constant string for "apply" label

See Also:

• Constant Field Values

DELETE_LABEL

public static final String DELETE_LABEL

Constant string for "delete" label

See Also:

• Constant Field Values

buttons

protected JButton[] buttons

The buttons

labels

protected String[] labels

The labels

Constructor Details

ButtonPanel

public ButtonPanel(String[] labels)

The constructor.

Parameters:

labels - The button labels.

ButtonPanel

public ButtonPanel(String[] labels,
 ActionListener alist)

The constructor.

Parameters:

labels - The button labels.

alist - Optional action listener.

ButtonPanel

public ButtonPanel(String[] labels,
 ActionListener alist,
 int spacing)

The constructor.

Parameters:

labels - The button labels.

alist - Optional action listener.

spacing - The spacing between labels.

ButtonPanel

public ButtonPanel(String[] labels,
 ActionListener alist,
 int spacing,
 int alignment)

The constructor.

Parameters:

labels - the button labels.

alist - optional action listener.

spacing - the spacing between labels.

alignment - the layout alignment

Method Details

userSetup

protected void userSetup()

Place for subclasses to add something else

addButtons

protected void addButtons(ActionListener alist)

Add the buttons to the panel.

Parameters:

alist - An action listener.

setEnabled

public void setEnabled(int index,
 boolean state)

Enable or disable a button.

Parameters:

index - the index of the button. If -1, applies to all.

state - if true, enable, else disable.

setToolTip

public void setToolTip(int index,
 String tip)

Set tooltip

Parameters:

index - The index of the button.

tip - tooltip string

getInsets

public Insets getInsets()

Overrides:

getInsets in class JComponent

closeOutPanel

public static ButtonPanel closeOutPanel(int opt,
 ActionListener actionListener,
 int spacing)

Makes a button panel with combinations of OK, Cancel, Apply, and Delete.

Parameters:

opt - Bitwise combination of USE_OK, USE_CANCEL, USE_APPLY, USE_DELETE

actionListener - Action listener for button clicks

spacing - The spacing between labels.