net.wotonomy.ui.swing.components
Class RadioButtonPanel

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  net.wotonomy.ui.swing.components.ButtonPanel
                      net.wotonomy.ui.swing.components.RadioButtonPanel

All Implemented Interfaces:

java.awt.event.ActionListener, java.awt.event.MouseMotionListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible

public class RadioButtonPanel
extends ButtonPanel

RadioButtonPanel is a simple extension of ButtonPanel. Differences are that it uses radio buttons and the default alignment is vertical. The radio buttons are placed in a ButtonGroup and the panel defaults to having no buttons selected.

Version:

$Revision: 904 $ $Date: 2006-02-18 23:19:05 +0000 (Sat, 18 Feb 2006) $

Author:

michael@mpowers.net, $Author: cgruber $

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class net.wotonomy.ui.swing.components.ButtonPanel

ButtonPanel.ActionChangeListener

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

javax.swing.JPanel.AccessibleJPanel

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

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Container.AccessibleAWTContainer

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

protected javax.swing.ButtonGroup	buttonGroup A ButtonGroup to help manage button state.
protected javax.swing.JRadioButton	hiddenButton ButtonGroup does not make it easy to unselect all buttons.

Fields inherited from class net.wotonomy.ui.swing.components.ButtonPanel

actionListener, ADD, buttonContainer, buttonList, buttonPanelLayout, CANCEL, CLEAR_ALL, insets, NO, OK, REFRESH, REMOVE, SAVE, STATE_CHANGED, YES

Fields inherited from class javax.swing.JComponent

accessibleContext, 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

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

RadioButtonPanel()
Constructs a RadioButtonPanel.

RadioButtonPanel(java.lang.String[] buttonList)
Constructs a ButtonPanel using specified buttons.

Method Summary

protected java.awt.Component	createComponentWithLabel(java.lang.String aLabel) Overridden to return a JRadioButton.
java.lang.String	getValue() Gets the name of the currently selected button.
boolean	getValue(java.lang.String aValue) Tests whether the specified value is checked.
protected void	initLayout() Overridden to set vertical-center alignment and 2-pixel vgap.
void	setValue(java.lang.String aName) Selects the button whose name matches the given text value.

Methods inherited from class net.wotonomy.ui.swing.components.ButtonPanel

actionPerformed, addActionListener, addComponentToPanel, broadcastEvent, getAlignment, getButton, getHgap, getInsets, getLabels, getVgap, main, mouseDragged, mouseMoved, removeActionListener, setAlignment, setEnabled, setHgap, setInsets, setLabels, setLabels, setVgap

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, 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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, 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, 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, transferFocusBackward, 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, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, 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, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

buttonGroup

protected javax.swing.ButtonGroup buttonGroup

A ButtonGroup to help manage button state.

hiddenButton

protected javax.swing.JRadioButton hiddenButton

ButtonGroup does not make it easy to unselect all buttons. The preferred way to do it is actually to create a hidden button.

Constructor Detail

RadioButtonPanel

public RadioButtonPanel()

Constructs a RadioButtonPanel. Three buttons are created so the panel is filled when used in a GUI-builder environment.

RadioButtonPanel

public RadioButtonPanel(java.lang.String[] buttonList)

Constructs a ButtonPanel using specified buttons.

Parameters:

buttonList - An array containing the strings to be used in labeling the buttons.

Method Detail

initLayout

protected void initLayout()

Overridden to set vertical-center alignment and 2-pixel vgap.

Overrides:

initLayout in class ButtonPanel

createComponentWithLabel

protected java.awt.Component createComponentWithLabel(java.lang.String aLabel)

Overridden to return a JRadioButton.

Overrides:

createComponentWithLabel in class ButtonPanel

Parameters:

aLabel - The label for the component that will be created.

Returns:

The newly created component.

setValue

public void setValue(java.lang.String aName)

Selects the button whose name matches the given text value.

Parameters:

newText - A String matching the name of one of the buttons. If null, empty, or not matching, all buttons are deselected.

getValue

public java.lang.String getValue()

Gets the name of the currently selected button.

Returns:

A string matching the name of the currently selected button, or null of no button is selected.

getValue

public boolean getValue(java.lang.String aValue)

Tests whether the specified value is checked.

Parameters:

aValue - A value to be tested.

Returns:

True if the specified value is checked, otherwise false.