Class JMTToolBar

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JToolBar

jmt.framework.gui.components.JMTToolBar

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, SwingConstants

Direct Known Subclasses:

ComponentBar

public class JMTToolBar
extends JToolBar

Name: JMTToolbar

Description: A generic toolbar with many enhancements to be used by JMT. Image name can be stored inside Action or explicitly inserted. Pressed, rollover and selected (toggled) buttons requires images with the appropriate suffixes.

Date: 30/gen/07 Time: 10:44:05

Version:

1.0

Author:

Bertoli Marco

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	JMTToolBar.ButtonWithGroup	Inner class used to store buttons together with their button group (if any)

Nested classes/interfaces inherited from class JToolBar

JToolBar.AccessibleJToolBar, JToolBar.Separator

Nested classes/interfaces inherited from class JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class Component

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

Field Summary

Fields

Modifier and Type	Field	Description
protected HashMap<Integer, JMTButtonGroup>	buttonGroups	A map with all button groups with associated group
protected HashMap<Action, JMTToolBar.ButtonWithGroup>	buttons	A map with all buttons with associated component and groups
protected ImageLoader	imageLoader	Component used to load images

Fields inherited from class JComponent

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

Fields inherited from class Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface ImageObserver

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

Fields inherited from interface SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Constructor Summary

Constructors

Constructor	Description
JMTToolBar(ImageLoader loader)	Builds a new toolbar

Method Summary

Modifier and Type	Method	Description
JButton	addButton(Action action, String iconName)	Adds a new button to this toolbar.
JButton	addButton(AbstractJMTAction action)	Adds a new button to this toolbar.
AbstractButton	addGenericButton(AbstractJMTAction action)	Adds a button deriving all properties from specified action
void	addSeparator()
JToggleButton	addToggleButton(AbstractJMTAction action)	Adds a new button toggle to this toolbar.
JToggleButton	addToggleButton(AbstractJMTAction action, int group)	Adds a new button toggle to this toolbar.
JToggleButton	addToggleButton(AbstractJMTAction action, String iconName)	Adds a new button toggle to this toolbar.
JToggleButton	addToggleButton(AbstractJMTAction action, String iconName, int group)	Adds a new button toggle to this toolbar.
void	clearButtonGroupSelection(int group)	Clears selection of a button group
void	clickButton(AbstractJMTAction action)	Clicks a given button
void	enableButtonGroup(int group, boolean value)	Enables or disables every button of a button group
void	enableButtons(boolean enable)	Enables or disables all buttons of this toolbar
HashSet<AbstractButton>	getAllButtons()	Returns all buttons inside this toolbar
AbstractButton	getButton(AbstractJMTAction action)	Returns a button, given its name
JMTButtonGroup	getButtonGroup(int group)	Returns a button group
protected JMTButtonGroup	getOrCreateGroup(int group)	Returns a button group if present, otherwise creates and adds it.
ArrayList<JComponent>	populateToolbar(Collection<AbstractJMTAction> abstractJMTactions)	Populates this toolbar reading all properties from specified actions.
ArrayList<AbstractButton>	populateToolbar(AbstractJMTAction[] abstractJMTactions)	Populates this toolbar reading all properties from specified actions.
AbstractButton	removeButton(AbstractJMTAction action)	Removes any type of button (including toggle ones) from this toolbar

Methods inherited from class JToolBar

add, addImpl, addSeparator, createActionChangeListener, createActionComponent, getAccessibleContext, getComponentAtIndex, getComponentIndex, getMargin, getOrientation, getUI, getUIClassID, isBorderPainted, isFloatable, isRollover, paintBorder, paramString, setBorderPainted, setFloatable, setLayout, setMargin, setOrientation, setRollover, setUI, updateUI

Methods inherited from class 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, 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, 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 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, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, transferFocusDownCycle, validate, validateTree

Methods inherited from class 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 Object

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

Field Details

imageLoader

protected ImageLoader imageLoader

Component used to load images

buttons

protected HashMap<Action, JMTToolBar.ButtonWithGroup> buttons

A map with all buttons with associated component and groups

buttonGroups

protected HashMap<Integer, JMTButtonGroup> buttonGroups

A map with all button groups with associated group

Constructor Details

JMTToolBar

public JMTToolBar(ImageLoader loader)

Builds a new toolbar

Parameters:

loader - component used to load images

Method Details

addButton

public JButton addButton(Action action,
 String iconName)

Adds a new button to this toolbar.

Parameters:

action - action associated to the button

iconName - image to be displayed on the button. If null the image from the action is used. If this is reset too, the name is displayed.

Returns:

created button

addButton

public JButton addButton(AbstractJMTAction action)

Adds a new button to this toolbar.

Parameters:

action - action associated to the button

Returns:

created button

addToggleButton

public JToggleButton addToggleButton(AbstractJMTAction action,
 String iconName,
 int group)

Adds a new button toggle to this toolbar.

Parameters:

action - action associated to the button

iconName - image to be displayed on the button. If null the image from the action is used. If this is reset too, the name is displayed.

group - identifier of button group. Each button belonging to the same group cannot be pressed together. Groups are created here, if group is less than zero means no grouping.

Returns:

created button

addToggleButton

public JToggleButton addToggleButton(AbstractJMTAction action,
 String iconName)

Adds a new button toggle to this toolbar. This button has no group.

Parameters:

action - action associated to the button

iconName - image to be displayed on the button. If null the image from the action is used. If this is reset too, the name is displayed.

Returns:

created button

addToggleButton

public JToggleButton addToggleButton(AbstractJMTAction action,
 int group)

Adds a new button toggle to this toolbar.

Parameters:

action - action associated to the button

group - identifier of button group. Each button belonging to the same group cannot be pressed together. Groups are created here, if group is less than zero means no grouping.

Returns:

created button

addToggleButton

public JToggleButton addToggleButton(AbstractJMTAction action)

Adds a new button toggle to this toolbar. This button has no group.

Parameters:

action - action associated to the button

Returns:

created button

addGenericButton

public AbstractButton addGenericButton(AbstractJMTAction action)

Adds a button deriving all properties from specified action

Parameters:

action - action associated to the button

Returns:

created button

removeButton

public AbstractButton removeButton(AbstractJMTAction action)

Removes any type of button (including toggle ones) from this toolbar

Parameters:

action - action of the button to be removed

Returns:

removed button

addSeparator

public void addSeparator()

Overrides:

addSeparator in class JToolBar

getButtonGroup

public JMTButtonGroup getButtonGroup(int group)

Returns a button group

Parameters:

group - identifier of button group

Returns:

the button group or null if it does not exists

getButton

public AbstractButton getButton(AbstractJMTAction action)

Returns a button, given its name

Parameters:

action - action of the button to be returned

Returns:

found button

enableButtonGroup

public void enableButtonGroup(int group,
 boolean value)

Enables or disables every button of a button group

Parameters:

group - group to be enabled or disabled

value - true to enable the group, false to disable it.

clearButtonGroupSelection

public void clearButtonGroupSelection(int group)

Clears selection of a button group

Parameters:

group - group to be deselected

clickButton

public void clickButton(AbstractJMTAction action)

Clicks a given button

Parameters:

action - action of the button to be clicked

getAllButtons

public HashSet<AbstractButton> getAllButtons()

Returns all buttons inside this toolbar

Returns:

a set with all buttons

enableButtons

public void enableButtons(boolean enable)

Enables or disables all buttons of this toolbar

Parameters:

enable - true to enable every button, false to disable them

populateToolbar

public ArrayList<JComponent> populateToolbar(Collection<AbstractJMTAction> abstractJMTactions)

Populates this toolbar reading all properties from specified actions. null values are used to add a separator.

Parameters:

abstractJMTactions - a collection of AbstractJMTAction with all actions to be added

Returns:

an ArrayList with all added objects (each element is instanceof AbstractButton)

See Also:

• AbstractJMTAction

populateToolbar

public ArrayList<AbstractButton> populateToolbar(AbstractJMTAction[] abstractJMTactions)

Populates this toolbar reading all properties from specified actions. null values are used to add a separator.

Parameters:

abstractJMTactions - an array of AbstractJMTAction with all actions to be added

Returns:

an ArrayList with all added objects (each element is instanceof AbstractButton)

See Also:

• AbstractJMTAction

getOrCreateGroup

protected JMTButtonGroup getOrCreateGroup(int group)

Returns a button group if present, otherwise creates and adds it.

Parameters:

group - group to be get

Returns:

created group