com.quadrique.jbuildingblocks.gui
Class ButtonAreaBase

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  com.quadrique.jbuildingblocks.gui.ButtonAreaBase

All Implemented Interfaces:

ActionListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible

Direct Known Subclasses:

ButtonArea, ButtonAreaSideBar

public class ButtonAreaBase
extends JPanel
implements ActionListener

This class implements a generic buttons area. It groups all the common and generic features but does not cover any presentation logic (which is left to be implemented in the sub-classes)

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

ButtonAreaBase()
constructor

Method Summary

void	actionPerformed(ActionEvent zEvent) This method is called whenever one of the buttons in the buttons bar is selected by the user
void	addButton(JButton zButton, int zButtonId) This method adds a button to the ButtonArea
void	addButtonSelectedEventListener(ButtonAreaListener zListener) Call this method to receive a ButtonAreaEvent whenever a button is selected
JButton	getButton(int zButtonId) This method retrieves the button that is associated to the given button identifier
int	getNbOfButtons()
void	removeButtonSelectedEventListener(ButtonAreaListener zListener) Call this method to remove a previously registered listener
void	setEnabled(int zButtonId, boolean zState) This method is called to enable/disable a button in the button area

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

ButtonAreaBase

public ButtonAreaBase()

constructor

Method Detail

addButton

public void addButton(JButton zButton,
                      int zButtonId)

This method adds a button to the ButtonArea

Parameters:

zButton - the button to add

zButtonId - the identifier of the button (must be unique, this routine does not check for identifier uniqueness). The button identifier is used to determine which button has been selected or to specify which button you want to access (e.g. to set the focus or to enable/disable a specific button).

addButtonSelectedEventListener

public void addButtonSelectedEventListener(ButtonAreaListener zListener)

Call this method to receive a ButtonAreaEvent whenever a button is selected

Parameters:

zListener - Reference to the object implementing the ButtonAreaListener interface.

See Also:

ButtonAreaListener, ButtonAreaEvent

removeButtonSelectedEventListener

public void removeButtonSelectedEventListener(ButtonAreaListener zListener)

Call this method to remove a previously registered listener

Parameters:

zListener - Reference to the object implementing the ButtonAreaListener interface.

See Also:

ButtonAreaListener, ButtonAreaEvent

setEnabled

public void setEnabled(int zButtonId,
                       boolean zState)

This method is called to enable/disable a button in the button area

Parameters:

zButtonId - the identifier of the button (i.e. the identifier value that you used for the zButtonId parameter in ButtonArea.addButton()).

zState - true if the button is to be enabled, false otherwise

actionPerformed

public void actionPerformed(ActionEvent zEvent)

This method is called whenever one of the buttons in the buttons bar is selected by the user

Specified by:

actionPerformed in interface ActionListener

Parameters:

zEvent - the ActionEvent instance

getButton

public JButton getButton(int zButtonId)

This method retrieves the button that is associated to the given button identifier

Parameters:

zButtonId - the identifier of the button (i.e. the identifier value that you used for the zButtonId parameter in ButtonArea.addButton())

Returns:

the JButton instance corresponding to the given button identifier, null if noe has been found

See Also:

addButton(javax.swing.JButton, int)

getNbOfButtons

public int getNbOfButtons()

Returns:

the current number of buttons in the area