no.g9.client.component

Class G9ToolBar

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JToolBar

no.g9.client.component.G9ToolBar

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, SwingConstants

public class G9ToolBar
extends JToolBar

Internal use!

Extends JToolBar with the capability of merging tool bars using the mergeToolBars(G9DialogFrame). (The Java 5.0 swing framework does not include support for multiple toolbars, as you find in e.g. MS Office. Due to this fact, this implementations is not written to suppor multiple toolbars.)

See Also:

Serialized Form

Nested Class Summary

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

JToolBar.AccessibleJToolBar, JToolBar.Separator

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

JComponent.AccessibleJComponent

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

Container.AccessibleAWTContainer

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

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

Field Summary

Fields inherited from class javax.swing.JComponent

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

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.SwingConstants

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

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
G9ToolBar(G9DialogFrame parentFrame) Default constructor.
G9ToolBar(G9DialogFrame parentFrame, List<Component> myComponents) Constructor.

Method Summary

Modifier and Type	Method and Description
Component	add(Component c) Adds the component argument to this tool bar.
Component[]	getG9Components() Returns an array containing all components added by using the add(Component) method.
boolean	isModal() Return true if this menubar is modal otherwise false.
boolean	isRemoveConsecutiveSeparators() Return true if consecutive separators are to be reduced to one
static boolean	isUseOldMerge()
void	mergeToolBars(G9DialogFrame activeDialog) Merges the tool bar held by the argument dialog with the applicaition tool bar.
void	setEnabledWholeToolBar(boolean enable) Enable or disable all toolbar items.
void	setModal(boolean isModal) Enable or disable the modal status of this tool bar.
void	setRemoveConsecutiveSeparators(boolean removeConsecutiveSeparators) If set to true, consecutive separators are reduced to one
static void	setUseOldMerge(boolean useOldMerge)

Methods inherited from class javax.swing.JToolBar

add, addImpl, addSeparator, 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 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, 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 java.awt.Container

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

G9ToolBar

public G9ToolBar(G9DialogFrame parentFrame)

Default constructor. Creates a new G9ToolBar

Parameters:

parentFrame - the owner of this tool bar.

G9ToolBar

public G9ToolBar(G9DialogFrame parentFrame,
                 List<Component> myComponents)

Constructor. Creates a new G9ToolBar

Parameters:

parentFrame - the owner of this tool bar

myComponents - the components on this tool bar

Method Detail

getG9Components

public Component[] getG9Components()

Returns an array containing all components added by using the add(Component) method.

Returns:

an array containing all the components of this toolbar.

setRemoveConsecutiveSeparators

public void setRemoveConsecutiveSeparators(boolean removeConsecutiveSeparators)

If set to true, consecutive separators are reduced to one

Parameters:

removeConsecutiveSeparators - The flag to set.

isRemoveConsecutiveSeparators

public boolean isRemoveConsecutiveSeparators()

Return true if consecutive separators are to be reduced to one

Returns:

Returns true if consecutive separators are to be reduced to one.

setEnabledWholeToolBar

public void setEnabledWholeToolBar(boolean enable)

Enable or disable all toolbar items.

Parameters:

enable - if true enable, else disable.

setModal

public void setModal(boolean isModal)

Enable or disable the modal status of this tool bar. Note that modality is only meaningfull for the application main frame tool bar. For other internal dialogs, the behavior is to enable or disable the internal dialogs own tool bar.

Parameters:

isModal - Puts this menu bar into modal mode if true otherwise the menu bar is put back to normal mode.

isModal

public boolean isModal()

Return true if this menubar is modal otherwise false.

Returns:

Returns true if this menubar is modal otherwise false.

mergeToolBars

public void mergeToolBars(G9DialogFrame activeDialog)

Merges the tool bar held by the argument dialog with the applicaition tool bar.

Tool bars are merged using one of the following algoritms:

• If the useOldMerge property is false, the merge position is intially last in the application tool bar. Then, the dialog's tool bar is scanned from the beginnig. For each component the following algoritm is applied:
  1. If the component matches one in the application tool bar, the application tool bar component is replaced with the dialog's tool bar component, and merge position is set to the position of the component in the application tool bar.
  2. Else, if the component does not match a component in the application tool bar, the component is inserted at the current merge position, shifting subsequent components to the right.

  Eksample: The application tool bar has the following components
  {A, B, C, D} and the dialog tool bar has
  {X, A, Y, B, D , Z}, the result is:
  {A, Y, B, C, D, Z, X}

• If the useOldMerge property is true the following algoritm is applied:
  1. Substitute components from the application tool bar with components from the dialog tool bar that match.
  2. Add all components in the application tool bar
  3. Add all components in the dialog tool bar

  This algoritm will place un-merged application tool bar components first. Example:

  Application tool bar: {A, B, C}
  Dialog tool bar: {A, X, B, Y}
  Merged tool bar: {C, A, X, B, Y}

Parameters:

activeDialog - the dialog that holds the tool bar to be merged.

add

public Component add(Component c)

Adds the component argument to this tool bar. If c is a separator then the orientation is set properly.

Overrides:

add in class Container

Parameters:

c - the component to add

Returns:

the component that was added

isUseOldMerge

public static boolean isUseOldMerge()

Returns:

the useOldMerge

See Also:

mergeToolBars(G9DialogFrame)

setUseOldMerge

public static void setUseOldMerge(boolean useOldMerge)

Parameters:

useOldMerge - the useOldMerge to set

See Also:

mergeToolBars(G9DialogFrame)