pub.vlsolutions.swing.toolbars

Class ToolBarContainer

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

pub.vlsolutions.swing.toolbars.ToolBarContainer

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public class ToolBarContainer
extends javax.swing.JPanel

The container for toolbar panels.

The layout used is BorderLayout and the CENTER component is dedicated to the user (the other 4 places (NORTH, EAST, WEST and SOUTH are used to display the toolbar panels)).

The ToolBarContainer is a JPanel with a BorderLayout, containing a user component and a maximum of four ToolBarPanels.

Loading and saving toolbar configurations is done with the ToolBarIO utility class, and works if VLToolbars are registered (given a name and made know to their container by registerToolBar(VLToolBar) ).

Author:

Lilian Chamontin, VLSolutions

See Also:

Serialized Form

Nested Class Summary

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.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

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

Constructors

Constructor and Description
ToolBarContainer()

Method Summary

Methods

Modifier and Type	Method and Description
void	add(java.awt.Component comp, java.lang.Object constraints) Overriden to track component constraints
static ToolBarContainer	createDefaultContainer(boolean topToolbar, boolean leftToolBar, boolean bottomToolBar, boolean rightToolBar) Creates a default ToolBarContainer with preinstalled toolbar panels on the borders with the LEADING alignment.
static ToolBarContainer	createDefaultContainer(boolean topToolbar, boolean leftToolBar, boolean bottomToolBar, boolean rightToolBar, int alignment) Creates a default ToolBarContainer with preinstalled toolbar panels on the borders with the specified alignment The value of the alignment argument must be one of FlowLayout.LEFT, FlowLayout.RIGHT, FlowLayout.CENTER, FlowLayout.LEADING, or FlowLayout.TRAILING.
java.awt.Component	getComponentAt(java.lang.Object constraints) Returns the component for a given BorderLayout constraints
java.lang.Object	getConstraints(java.awt.Component comp) Returns the BorderLayout constraints of the given component
java.util.List	getRegisteredToolBars() Returns the list of currently registered toolbars.
VLToolBar	getToolBarByName(java.lang.String name) Returns the registered toolbar associated with the given name, or null if not found
ToolBarPanel	getToolBarPanelAt(java.lang.Object constraints) Returns the ToolBarPanel for a given BorderLayout constraints
void	registerToolBar(VLToolBar toolbar) Registers a new ToolBar.
void	remove(java.awt.Component comp) Overriden to keep track of component constraints
void	remove(int index) Overriden to keep track of component constraints
void	removeAll() Overriden to keep track of component constraints
void	unregisterToolBar(VLToolBar toolbar) Unregisters a ToolBar.

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, 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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, 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, setEnabled, 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, 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, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, 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, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

ToolBarContainer

public ToolBarContainer()

Method Detail

registerToolBar

public void registerToolBar(VLToolBar toolbar)

Registers a new ToolBar.

Registering is used when reading a xml configuration

unregisterToolBar

public void unregisterToolBar(VLToolBar toolbar)

Unregisters a ToolBar.

Registering is used when reading a xml configuration

getToolBarByName

public VLToolBar getToolBarByName(java.lang.String name)

Returns the registered toolbar associated with the given name, or null if not found

getRegisteredToolBars

public java.util.List getRegisteredToolBars()

Returns the list of currently registered toolbars.

(eturns a new list at each invocation.)

add

public void add(java.awt.Component comp,
       java.lang.Object constraints)

Overriden to track component constraints

Overrides:

add in class java.awt.Container

remove

public void remove(java.awt.Component comp)

Overriden to keep track of component constraints

Overrides:

remove in class java.awt.Container

remove

public void remove(int index)

Overriden to keep track of component constraints

Overrides:

remove in class java.awt.Container

removeAll

public void removeAll()

Overriden to keep track of component constraints

Overrides:

removeAll in class java.awt.Container

getComponentAt

public java.awt.Component getComponentAt(java.lang.Object constraints)

Returns the component for a given BorderLayout constraints

getToolBarPanelAt

public ToolBarPanel getToolBarPanelAt(java.lang.Object constraints)

Returns the ToolBarPanel for a given BorderLayout constraints

getConstraints

public java.lang.Object getConstraints(java.awt.Component comp)

Returns the BorderLayout constraints of the given component

createDefaultContainer

public static ToolBarContainer createDefaultContainer(boolean topToolbar,
                                      boolean leftToolBar,
                                      boolean bottomToolBar,
                                      boolean rightToolBar)

Creates a default ToolBarContainer with preinstalled toolbar panels on the borders with the LEADING alignment.

The toolbarPanels are then accessible with getToolBarPanelAt(constraints) where constraints values are BorderLayout.NORTH, EAST, WEST and SOUTH.

createDefaultContainer

public static ToolBarContainer createDefaultContainer(boolean topToolbar,
                                      boolean leftToolBar,
                                      boolean bottomToolBar,
                                      boolean rightToolBar,
                                      int alignment)

Creates a default ToolBarContainer with preinstalled toolbar panels on the borders with the specified alignment The value of the alignment argument must be one of FlowLayout.LEFT, FlowLayout.RIGHT, FlowLayout.CENTER, FlowLayout.LEADING, or FlowLayout.TRAILING.

The toolbarPanels are then accessible with getToolBarPanelAt(constraints) where constraints values are BorderLayout.NORTH, EAST, WEST and SOUTH.