com.quadrique.jbuildingblocks.gui
Class PanelPairRadioComponent

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  com.quadrique.jbuildingblocks.gui.PanelBase
                      com.quadrique.jbuildingblocks.gui.PanelPairComponentComponent
                          com.quadrique.jbuildingblocks.gui.PanelPairRadioComponent

All Implemented Interfaces:

ActionListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible

public class PanelPairRadioComponent
extends PanelPairComponentComponent
implements ActionListener

This panel is used to lay out a set of component pairs. For each pair:

the left component is a radiobutton and is automatically created by the class

the right component is provided by the user

The radio buttons are all aligned vertically, the right components are aligned verticvally as well. Each right component can be set up to use the minimum (i.e. its preferred width) or maximum x space available

Author:

Hervé Rivere

See Also:

Serialized Form

Nested Class Summary

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

JComponent.AccessibleJComponent

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

Component.BaselineResizeBehavior

Field Summary

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

PanelPairRadioComponent(boolean zDrawBorder, String zTitle, boolean zIsReadOnly)
constructor

Method Summary

void	actionPerformed(ActionEvent zEvent) Whenever a radio button is selected, this routine is called.
void	addListener(PanelPairSelectionListener zListener) Call this method to register and to be notified of selection changes
int	addPair(boolean zIsSelected, JComponent zRightComponent, boolean zFillRightComponentXSpace, double zExtraYSpaceWeight) This method is called to add a pair of JRadioButton/JComponent
int	getSelectedRadioButtonIndex()
void	removeListener(PanelPairSelectionListener zListener) Call this method to remove a previously registered listener
void	reset()
void	selectRadioButton(int zButtonIndex) This routine is used to programmatically set the radio button that is selected.

Methods inherited from class com.quadrique.jbuildingblocks.gui.PanelPairComponentComponent

addPair

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, getBaseline, getBaselineResizeBehavior, 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, isPaintingForPrint, 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

Constructor Detail

PanelPairRadioComponent

public PanelPairRadioComponent(boolean zDrawBorder,
                               String zTitle,
                               boolean zIsReadOnly)

constructor

Parameters:

zDrawBorder - true if you want a group box (i.e. draw a border)

zTitle - the title of the group box (use null if you don't want a group box)

zIsReadOnly - true if the checkboxes cannot be modified b ythe end user

See Also:

PanelBase

Method Detail

reset

public void reset()

addPair

public int addPair(boolean zIsSelected,
                   JComponent zRightComponent,
                   boolean zFillRightComponentXSpace,
                   double zExtraYSpaceWeight)
            throws Exception

This method is called to add a pair of JRadioButton/JComponent

Parameters:

zIsSelected - true if the radio button is to be selected

zRightComponent - the component to display to the right of the checkbox

zFillRightComponentXSpace - if true, use the maximum amount of space available. If flase, use the component preferred width

zExtraYSpaceWeight - use 1.0 to give the right component the maximum height. Use 0.0 if you don't want the heigth to grow.

Returns:

the corresponding button identifier

Throws:

Exception - if an error occurs

getSelectedRadioButtonIndex

public int getSelectedRadioButtonIndex()

Returns:

the index of the selected radio button. The range is from 0 (for the first radio button added to the list) to n-1 (for the nth radio button that has been added to the list).

actionPerformed

public void actionPerformed(ActionEvent zEvent)

Whenever a radio button is selected, this routine is called.

Specified by:

actionPerformed in interface ActionListener

Parameters:

zEvent - the event

selectRadioButton

public void selectRadioButton(int zButtonIndex)
                       throws Exception

This routine is used to programmatically set the radio button that is selected.

Parameters:

zButtonIndex - the index of the radio button. The range is from 0 (for the first radio button added to the list) to n-1 (for the nth radio button that has been added to the list).

Throws:

Exception - if an error occurs

addListener

public void addListener(PanelPairSelectionListener zListener)
                 throws Exception

Call this method to register and to be notified of selection changes

Parameters:

zListener - Reference to an instance of a class that implements the PanelPairSelectionListener interface.

Throws:

Exception - if an error occurs

See Also:

PanelPairSelectionListener, PanelPairSelectionEvent

removeListener

public void removeListener(PanelPairSelectionListener zListener)

Call this method to remove a previously registered listener

Parameters:

zListener - Reference to an instance of a class that implements the PanelPairSelectionListener interface.

See Also:

SelectionListener