org.pf.swing
Class RadioButtonGroupBox

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  org.pf.swing.RadioButtonGroupBox

All Implemented Interfaces:

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

public class RadioButtonGroupBox
extends javax.swing.JPanel
implements java.awt.event.ActionListener

This is a container component for radio buttons that simplifies usage of a group of radio buttons and the selection change handling.

It support change listeners, which get called whenever the selected radio button changes. Then the getSource() of the ChangeEvent contains the RadioButtonGroup object which can be asked for the currently selected value.

Version:

1.0

Author:

Manfred Duchrow

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JComponent.AccessibleJComponent

Field Summary

static java.lang.String	NEW_BUTTON_SET_CMD
static int	NEW_BUTTON_SET_ID

Fields inherited from class javax.swing.JComponent

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

RadioButtonGroupBox()
Initialize the new instance with a default layout direction (BoxLayout.X_AXIS).

RadioButtonGroupBox(int axis)
Initialize the new instance with a layout direction.

RadioButtonGroupBox(java.awt.LayoutManager layout)
Initialize the new instance with the given layout.

Method Summary

void	actionPerformed(java.awt.event.ActionEvent event) Just public due to interface implementation
java.awt.Component	add(RadioButton radioButton) Adds the given radio button to the box
java.awt.Component	add(RadioButton radioButton, int index) Adds the given radio button to the box
void	add(RadioButton radioButton, java.lang.Object constraints) Adds the given radio button to the box
void	add(RadioButton radioButton, java.lang.Object constraints, int index) Adds the given radio button to the box
java.awt.Component	add(java.lang.String name, RadioButton radioButton) Adds the given radio button to the box
void	addActionListener(java.awt.event.ActionListener listener) Add the given listener to the collection of change listeners
RadioButtonGroup	getButtonGroup() Returns the button group associated with this button box
java.lang.Object	getSelectedValue() Returns the value associated with the button currently selected.
void	remove(RadioButton button) Remove the specified radio button from this box
void	removeActionListener(java.awt.event.ActionListener listener) Removes the given listener from the collection of change listeners

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, 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, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, 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, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, 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, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, 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, 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

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

NEW_BUTTON_SET_ID

public static final int NEW_BUTTON_SET_ID

See Also:

Constant Field Values

NEW_BUTTON_SET_CMD

public static final java.lang.String NEW_BUTTON_SET_CMD

See Also:

Constant Field Values

Constructor Detail

RadioButtonGroupBox

public RadioButtonGroupBox()

Initialize the new instance with a default layout direction (BoxLayout.X_AXIS).

RadioButtonGroupBox

public RadioButtonGroupBox(int axis)

Initialize the new instance with a layout direction.

Parameters:

axis - The layout of the radio buttons (either BoxLayout.X_AXIS or BoxLayout.Y_AXIS)

RadioButtonGroupBox

public RadioButtonGroupBox(java.awt.LayoutManager layout)

Initialize the new instance with the given layout.

Parameters:

layout - The layout for this new component

Method Detail

getButtonGroup

public RadioButtonGroup getButtonGroup()

Returns the button group associated with this button box

add

public java.awt.Component add(RadioButton radioButton,
                              int index)

Adds the given radio button to the box

Parameters:

radioButton - The radio button to add

index - The position where to add the button

See Also:

Container.add(java.awt.Component, int)

add

public void add(RadioButton radioButton,
                java.lang.Object constraints,
                int index)

Adds the given radio button to the box

Parameters:

radioButton - The radio button to add

index - The position where to add the button

See Also:

Container.add(java.awt.Component, java.lang.Object, int)

add

public void add(RadioButton radioButton,
                java.lang.Object constraints)

Adds the given radio button to the box

Parameters:

radioButton - The radio button to add

See Also:

Container.add(java.awt.Component, java.lang.Object)

add

public java.awt.Component add(RadioButton radioButton)

Adds the given radio button to the box

Parameters:

radioButton - The radio button to add

See Also:

Container.add(java.awt.Component)

add

public java.awt.Component add(java.lang.String name,
                              RadioButton radioButton)

Adds the given radio button to the box

Parameters:

radioButton - The radio button to add

See Also:

Container.add(java.lang.String, java.awt.Component)

addActionListener

public void addActionListener(java.awt.event.ActionListener listener)

Add the given listener to the collection of change listeners

remove

public void remove(RadioButton button)

Remove the specified radio button from this box

See Also:

Container.remove(java.awt.Component)

removeActionListener

public void removeActionListener(java.awt.event.ActionListener listener)

Removes the given listener from the collection of change listeners

getSelectedValue

public java.lang.Object getSelectedValue()

Returns the value associated with the button currently selected. If none is selected, null will be returned.

actionPerformed

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

Just public due to interface implementation

Specified by:

actionPerformed in interface java.awt.event.ActionListener

See Also:

ActionListener.actionPerformed(java.awt.event.ActionEvent)