org.PingOO.DLAI.lib.PWidget
Class PToolBar

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JToolBar
                          |
                          +--org.PingOO.DLAI.lib.PWidget.PToolBar

public class PToolBar
extends javax.swing.JToolBar
implements PComponent

Provides a tool bar that is localized localized tool tip capable.

Since:
PingOO 2.0
Version:
2.0
Author:
Fabrice Bouyé (bouye@cur-archamps.fr)
See Also:
JToolBar, PComponent, Serialized Form

Inner classes inherited from class javax.swing.JToolBar
javax.swing.JToolBar.AccessibleJToolBar, javax.swing.JToolBar.Separator
 
Inner classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent, javax.swing.JComponent.IntVector, javax.swing.JComponent.KeyboardBinding, javax.swing.JComponent.KeyboardState
 
Inner classes inherited from class java.awt.Component
java.awt.Component.AWTTreeLock
 
Field Summary
private  PManager manager
          The manager where this component will lokk for its resources.
protected  java.lang.String module
          Defines the module where to find this tool bar's text and tool tip.
private static java.util.Hashtable pListenerRegistry
          Registry of listeners created for Action-PButton linkage.
protected  java.lang.String toolTipKey
          Defines the key used to find this tool bar's tool tip.
 
Fields inherited from class javax.swing.JToolBar
floatable, listenerRegistry, margin, orientation, paintBorder, uiClassID
 
Fields inherited from class javax.swing.JComponent
_bounds, accessibleContext, alignmentX, alignmentY, ANCESTOR_USING_BUFFER, ancestorNotifier, autoscroller, border, changeSupport, clientProperties, flags, HAS_FOCUS, IS_DOUBLE_BUFFERED, IS_OPAQUE, IS_PAINTING_TILE, KEYBOARD_BINDINGS_KEY, listenerList, maximumSize, minimumSize, NEXT_FOCUS, paintImmediatelyClip, preferredSize, readObjectCallbacks, REQUEST_FOCUS_DISABLED, tmpRect, TOOL_TIP_TEXT_KEY, ui, uiClassID, UNDEFINED_CONDITION, vetoableChangeSupport, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
 
Fields inherited from class java.awt.Container
component, containerListener, containerSerializedDataVersion, dispatcher, layoutMgr, maxSize, ncomponents, serialVersionUID
 
Fields inherited from class java.awt.Component
actionListenerK, adjustmentListenerK, appContext, assert, background, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, changeSupport, componentListener, componentListenerK, componentOrientation, componentSerializedDataVersion, containerListenerK, cursor, dropTarget, enabled, eventMask, focusListener, focusListenerK, font, foreground, hasFocus, height, incRate, inputMethodListener, inputMethodListenerK, isInc, isPacked, itemListenerK, keyListener, keyListenerK, LEFT_ALIGNMENT, locale, LOCK, minSize, mouseListener, mouseListenerK, mouseMotionListener, mouseMotionListenerK, name, nameExplicitlySet, newEventsOnly, ownedWindowK, parent, peer, peerFont, popups, prefSize, RIGHT_ALIGNMENT, serialVersionUID, textListenerK, TOP_ALIGNMENT, valid, visible, width, windowListenerK, x, y
 
Constructor Summary
PToolBar()
          Creates a tool bar.
PToolBar(int orientation)
          Creates a tool bar.
PToolBar(java.lang.String toolTipKey)
          Creates a tool bar with a tool tip.
PToolBar(java.lang.String toolTipKey, int orientation)
          Creates a tool bar with a tool tip.
PToolBar(java.lang.String toolTipKey, java.lang.String module)
          Creates a tool bar with a tool tip plus the module where are stored the resources.
PToolBar(java.lang.String toolTipKey, java.lang.String module, int orientation)
          Creates a tool bar with tool tip plus the module where are stored the resources.
 
Method Summary
 javax.swing.JButton add(PAction action)
          Appends a new button to the end of the menu which dispatches the specified PAction object.
protected  java.beans.PropertyChangeListener createPActionChangeListener(PButton button)
          Creates a new listener for the action.
 PManager getManager()
          Returns the manager of this component.
 java.lang.String getModule()
          Returns the component's resources location.
 java.lang.String getTextKey()
          Returns the key used to find this component's text
 java.lang.String getToolTipKey()
          Returns the key used to find this button's tool tip.
 void remove(java.awt.Component component)
          Removes the specified component from this popup menu.
 void setLocalizedToolTipText(java.lang.String toolTipKey)
          Registers the text to display in a tool tip.
 void setManager(PManager manager)
          Sets the manager of this component.
 void setModule(java.lang.String module)
          Sets The module where the component will search its resources
 void updateFont()
          Update the component's font.
 void updateLanguage()
          Update the tool bar's text and tool tip with the default module.
 void updateLanguage(java.lang.String module)
          Update the tool bar's text and tool tip with the current module.
 
Methods inherited from class javax.swing.JToolBar
, add, addImpl, addSeparator, addSeparator, checkOrientation, createActionChangeListener, getAccessibleContext, getComponentAtIndex, getComponentIndex, getMargin, getOrientation, getUI, getUIClassID, isBorderPainted, isFloatable, paintBorder, paramString, setBorderPainted, setFloatable, setMargin, setOrientation, setUI, updateUI, writeObject
 
Methods inherited from class javax.swing.JComponent
_paintImmediately, addAncestorListener, addNotify, addPropertyChangeListener, addVetoableChangeListener, adjustPaintFlags, alwaysOnTop, bindingForKeyStroke, computeVisibleRect, computeVisibleRect, contains, createToolTip, enableSerialization, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperties, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getFlag, getGraphics, getHeight, getInsets, getInsets, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, isDoubleBuffered, isFocusCycleRoot, isFocusTraversable, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, keyboardBindings, paint, paintChildren, paintComponent, paintImmediately, paintImmediately, paintWithBuffer, processComponentKeyEvent, processFocusEvent, processKeyBinding, processKeyBindings, processKeyBindingsForAllComponents, processKeyEvent, processMouseMotionEvent, putClientProperty, readObject, rectangleIsObscured, registerKeyboardAction, registerKeyboardAction, registerWithKeyboardManager, removeAncestorListener, removeNotify, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setEnabled, setFlag, setFont, setForeground, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setUI, setVisible, shouldDebugGraphics, superProcessMouseMotionEvent, unregisterKeyboardAction, unregisterWithKeyboardManager, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, applyOrientation, countComponents, deliverEvent, dispatchEventImpl, dispatchEventToSelf, doLayout, eventEnabled, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents_NoClientCode, getComponents, getLayout, getMouseEventTarget, getWindow, initIDs, insets, invalidate, invalidateTree, isAncestorOf, layout, lightweightPrint, list, list, locate, minimumSize, nextFocus, paintComponents, postProcessKeyEvent, postsOldMouseEvents, preferredSize, preProcessKeyEvent, print, printComponents, printOneComponent, processContainerEvent, processEvent, proxyEnableEvents, proxyRequestFocus, remove, removeAll, removeContainerListener, setFocusOwner, setLayout, transferFocus, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addPropertyChangeListener, areInputMethodsEnabled, bounds, checkImage, checkImage, coalesceEvents, constructComponentName, contains, createImage, createImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont_NoClientCode, getFont, getFontMetrics, getForeground, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocationOnScreen, getName, getNativeContainer, getParent_NoClientCode, getParent, getPeer, getSize, getToolkit, getToolkitImpl, getTreeLock, getWindowForObject, gotFocus, handleEvent, hide, imageUpdate, inside, isDisplayable, isEnabled, isEnabledImpl, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, printAll, processComponentEvent, processInputMethodEvent, processMouseEvent, remove, removeComponentListener, removeFocusListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, wait, wait, wait
 

Field Detail

toolTipKey

protected java.lang.String toolTipKey
Defines the key used to find this tool bar's tool tip.

module

protected java.lang.String module
Defines the module where to find this tool bar's text and tool tip.

manager

private PManager manager
The manager where this component will lokk for its resources.

pListenerRegistry

private static java.util.Hashtable pListenerRegistry
Registry of listeners created for Action-PButton linkage.
This is needed so that references can be cleaned up at remove time to allow GC.
Constructor Detail

PToolBar

public PToolBar()
Creates a tool bar.
Parameters:
textKey - The key needed to retrieve the tool bar's text.

PToolBar

public PToolBar(int orientation)
Creates a tool bar.
Parameters:
orientation - The initial orientation (HORIZONTAL/VERTICAL).

PToolBar

public PToolBar(java.lang.String toolTipKey)
Creates a tool bar with a tool tip.
Parameters:
toolTipKey - The key needed to retrieve the tool bar's tool tip.

PToolBar

public PToolBar(java.lang.String toolTipKey,
                int orientation)
Creates a tool bar with a tool tip.
Parameters:
toolTipKey - The key needed to retrieve the tool bar's tool tip.
orientation - The initial orientation (HORIZONTAL/VERTICAL).

PToolBar

public PToolBar(java.lang.String toolTipKey,
                java.lang.String module)
Creates a tool bar with a tool tip plus the module where are stored the resources.
Parameters:
toolTipKey - The key needed to retrieve the tool bar's tool tip.
module - The module where to find the resources.

PToolBar

public PToolBar(java.lang.String toolTipKey,
                java.lang.String module,
                int orientation)
Creates a tool bar with tool tip plus the module where are stored the resources.
Parameters:
toolTipKey - The key needed to retrieve the tool bar's tool tip.
module - The module where to find the resources.
orientation - The initial orientation (HORIZONTAL/VERTICAL).
Method Detail

setManager

public void setManager(PManager manager)
Sets the manager of this component.
Specified by:
setManager in interface PComponent
Parameters:
manager - the new manager of this component, if manager is null, the component will use PManager.getInstance().

getManager

public PManager getManager()
Returns the manager of this component.
Specified by:
getManager in interface PComponent
Returns:
The manager of this component.

setModule

public void setModule(java.lang.String module)
Sets The module where the component will search its resources
Specified by:
setModule in interface PComponent
Parameters:
module - The new module. If null, the default resource set will be used.

setLocalizedToolTipText

public void setLocalizedToolTipText(java.lang.String toolTipKey)
Registers the text to display in a tool tip. The text displays when the cursor lingers over the component.
Parameters:
toolTipKey - The key used to get the localized tool tip.

updateFont

public void updateFont()
Update the component's font.
Specified by:
updateFont in interface PComponent

updateLanguage

public void updateLanguage()
Update the tool bar's text and tool tip with the default module.
Specified by:
updateLanguage in interface PComponent

updateLanguage

public void updateLanguage(java.lang.String module)
Update the tool bar's text and tool tip with the current module.
Specified by:
updateLanguage in interface PComponent
Parameters:
module - The module where the resources are stored.

getTextKey

public final java.lang.String getTextKey()
Returns the key used to find this component's text
Specified by:
getTextKey in interface PComponent
Returns:
The key used to find this button's text, null if the component does not support text.

getToolTipKey

public final java.lang.String getToolTipKey()
Returns the key used to find this button's tool tip.
Specified by:
getToolTipKey in interface PComponent
Returns:
The key used to find this button's tool tip, null if the component does not support tool tip.

getModule

public final java.lang.String getModule()
Returns the component's resources location.
Specified by:
getModule in interface PComponent
Returns:
The component's resources location or PComponent.DEFAULT_MODULE if the component has no defined module

add

public javax.swing.JButton add(PAction action)
Appends a new button to the end of the menu which dispatches the specified PAction object.
Parameters:
action - the Action to add to the menu
Returns:
The component that was added.

remove

public void remove(java.awt.Component component)
Removes the specified component from this popup menu.
Parameters:
component - the component to be removed from the menu.
Overrides:
remove in class javax.swing.JToolBar

createPActionChangeListener

protected java.beans.PropertyChangeListener createPActionChangeListener(PButton button)
Creates a new listener for the action.
Parameters:
button - The targeted button.
Returns:
The associated property change listener.