com.borland.primetime.actions
Class ActionToolBar

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPanel
                          |
                          +--com.borland.primetime.actions.ActionToolBar
All Implemented Interfaces:
javax.accessibility.Accessible, ActionWidget, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

public class ActionToolBar
extends javax.swing.JPanel
implements ActionWidget

The ActionToolBar defines a toolbar that is dynamically built from the contents of the ActionGroup it is constructed with.d

ActionToolBars are constructed with a source Object and an ActionGroup to represent. The source Object will be passed as the source of the ActionEvent in the associated actions' actionPerformed methods. This allows an ActionToolBar to pass a particular source object (not the toolbar itself), so the associated Actions can have direct access to a specific Object. This source is determined by the code that instantiates the ActionToolBar.

In all cases, the SHORT_DESCRIPTION attribute is used for the text, the SMALL_ICON attribute is used for the icon (icons on/off with static 'showIcons' property), and the MNEMONIC attribute is used for the mnemonic.

See Also:
Action, ActionGroup, StateAction, UpdateableAction, Serialized Form

Inner Class Summary
protected  class ActionToolBar.ButtonPanel
           
 
Inner classes inherited from class javax.swing.JPanel
javax.swing.JPanel.AccessibleJPanel
 
Inner classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Inner classes inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Inner classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent
 
Field Summary
protected  ActionGroup aGroup
           
protected  ActionToolBar.ButtonPanel buttonPane
           
protected  ActionGroup contextGroup
           
protected  java.awt.Dimension fixedButtonSize
           
protected  boolean glowStyle
           
protected  boolean horizontal
           
protected static java.awt.Image IMAGE_DOWN
           
protected static java.awt.Image IMAGE_LEFT
           
protected static java.awt.Image IMAGE_RIGHT
           
protected static java.awt.Image IMAGE_UP
           
protected  ActionPopupMenu pop
           
protected static int SCROLL_BUTTON_SIZE
           
protected  int scrollIndex
           
protected  boolean scrolling
           
protected  boolean showBars
           
protected  boolean showIcons
           
protected  boolean showRips
           
protected  boolean showText
           
protected  java.lang.Object source
           
protected  boolean useSmallIcon
           
 
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
ActionToolBar(java.lang.Object source, ActionGroup group)
          Constructs an ActionToolBar with the specified source object and ActionGroup.
ActionToolBar(java.lang.Object source, ActionGroup group, java.awt.Dimension fixedButtonSize)
          Constructs an ActionToolBar with the specified source object, ActionGroup, and button size.
ActionToolBar(java.lang.Object source, ActionGroup group, java.awt.Dimension fixedButtonSize, boolean useSmallIcon)
          Constructs an ActionToolBar with the specified source object, ActionGroup, button size, and useSmallIcon state.
ActionToolBar(java.lang.Object source, ActionGroup group, java.awt.Dimension fixedButtonSize, boolean useSmallIcon, boolean horizontal)
          Constructs an ActionToolBar with the specified source object, ActionGroup, button size, useSmallIcon state, and horizontal setting.
 
Method Summary
protected  void expandGroup(ActionGroup group)
           
 javax.swing.Action getAction()
          Returns the Action object used by this ActionWidget
 ActionGroup getContextGroup()
          Returns the context pop-up ActionGroup.
 java.awt.Dimension getFixedButtonSize()
          Returns the toolbar button size.
 ActionGroup getGroup()
           
 java.awt.Dimension getMinimumSize()
           
 java.lang.Object getSource()
          Returns the source object used by this ActionWidget
 boolean isGlowStyle()
           
 boolean isHorizontal()
          Returns the horizontal property setting.
 boolean isShowIcons()
          Returns the state of the 'showIcons' property.
 boolean isShowRips()
           
 boolean isShowSeparators()
           
 boolean isShowText()
          Returns the state of the 'showText' property.
 boolean isUseSmallIcon()
          Returns the state of the useSmallIcon property.
protected  void rebuild()
           
 void scrollNext()
           
 void scrollPrevious()
           
 void scrollToVisible(javax.swing.Action action)
           
 void setContextGroup(ActionGroup group)
          Sets the context pop-up ActionGroup for this ActionToolBar.
 void setFixedButtonSize(java.awt.Dimension size)
          Sets the toolbar button size.
 void setGlowStyle(boolean glow)
           
 void setHorizontal(boolean horz)
          Sets the horizontal property for this ActionToolBar.
protected  void setScrollMode(boolean scroll)
           
 void setShowIcons(boolean show)
          Sets the 'showIcons' property to the passed value.
 void setShowRips(boolean rips)
           
 void setShowSeparators(boolean separators)
           
 void setShowText(boolean show)
          Sets the 'showText' property to the passed value.
 void setUseSmallIcon(boolean useSmall)
          Sets the useSmallIcon property.
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUIClassID, paramString, updateUI
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getVerifyInputWhenFocusTarget, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, hide, isDoubleBuffered, isFocusCycleRoot, isFocusTraversable, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processFocusEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setLayout, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, imageUpdate, inside, isDisplayable, isEnabled, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, 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, wait, wait, wait
 

Field Detail

SCROLL_BUTTON_SIZE

protected static final int SCROLL_BUTTON_SIZE

IMAGE_LEFT

protected static final java.awt.Image IMAGE_LEFT

IMAGE_RIGHT

protected static final java.awt.Image IMAGE_RIGHT

IMAGE_UP

protected static final java.awt.Image IMAGE_UP

IMAGE_DOWN

protected static final java.awt.Image IMAGE_DOWN

source

protected java.lang.Object source

aGroup

protected ActionGroup aGroup

fixedButtonSize

protected java.awt.Dimension fixedButtonSize

useSmallIcon

protected boolean useSmallIcon

horizontal

protected boolean horizontal

showIcons

protected boolean showIcons

showText

protected boolean showText

showBars

protected boolean showBars

showRips

protected boolean showRips

glowStyle

protected boolean glowStyle

scrollIndex

protected int scrollIndex

scrolling

protected boolean scrolling

contextGroup

protected ActionGroup contextGroup

pop

protected ActionPopupMenu pop

buttonPane

protected ActionToolBar.ButtonPanel buttonPane
Constructor Detail

ActionToolBar

public ActionToolBar(java.lang.Object source,
                     ActionGroup group)
Constructs an ActionToolBar with the specified source object and ActionGroup.
Parameters:
source - The source object
group - The action group

ActionToolBar

public ActionToolBar(java.lang.Object source,
                     ActionGroup group,
                     java.awt.Dimension fixedButtonSize)
Constructs an ActionToolBar with the specified source object, ActionGroup, and button size.
Parameters:
source - The source object
group - The action group
fixedButtonSize - The button size

ActionToolBar

public ActionToolBar(java.lang.Object source,
                     ActionGroup group,
                     java.awt.Dimension fixedButtonSize,
                     boolean useSmallIcon)
Constructs an ActionToolBar with the specified source object, ActionGroup, button size, and useSmallIcon state.
Parameters:
source - The source object
group - The action group
fixedButtonSize - The button size
useSmallIcon - Use the small icon (true) or the large icon (false)

ActionToolBar

public ActionToolBar(java.lang.Object source,
                     ActionGroup group,
                     java.awt.Dimension fixedButtonSize,
                     boolean useSmallIcon,
                     boolean horizontal)
Constructs an ActionToolBar with the specified source object, ActionGroup, button size, useSmallIcon state, and horizontal setting.
Parameters:
source - The source object
group - The action group
fixedButtonSize - The button size
useSmallIcon - Use the small icon (true) or the large icon (false)
horizontal - True for horizontal, false for vertical
Method Detail

getSource

public java.lang.Object getSource()
Description copied from interface: ActionWidget
Returns the source object used by this ActionWidget
Specified by:
getSource in interface ActionWidget

getAction

public javax.swing.Action getAction()
Description copied from interface: ActionWidget
Returns the Action object used by this ActionWidget
Specified by:
getAction in interface ActionWidget

getGroup

public ActionGroup getGroup()

setFixedButtonSize

public void setFixedButtonSize(java.awt.Dimension size)
Sets the toolbar button size.
Parameters:
size - The button size

getFixedButtonSize

public java.awt.Dimension getFixedButtonSize()
Returns the toolbar button size.
Returns:
The button size

setUseSmallIcon

public void setUseSmallIcon(boolean useSmall)
Sets the useSmallIcon property. When set to true, the SMALL_ICON attribute of the associated Action objects will be used.
Parameters:
useSmall - True to use small icons, false to use large icons

isUseSmallIcon

public boolean isUseSmallIcon()
Returns the state of the useSmallIcon property.
Returns:
The state of the useSmallIcon property

setHorizontal

public void setHorizontal(boolean horz)
Sets the horizontal property for this ActionToolBar. By default, the ActionToolBar is oriented horizontally.
Parameters:
horz - The horizontal property setting

isHorizontal

public boolean isHorizontal()
Returns the horizontal property setting.
Returns:
True if horizontal, false if vertical

setShowSeparators

public void setShowSeparators(boolean separators)

isShowSeparators

public boolean isShowSeparators()

setShowRips

public void setShowRips(boolean rips)

isShowRips

public boolean isShowRips()

scrollToVisible

public void scrollToVisible(javax.swing.Action action)

setShowIcons

public void setShowIcons(boolean show)
Sets the 'showIcons' property to the passed value. If set to true, Actions displayed in the ActionToolBar will show icons if the SMALL_ICON attribute is set on the passed Action. By default, icons do not show.
Parameters:
show - True for the icons to show, false if not.

isShowIcons

public boolean isShowIcons()
Returns the state of the 'showIcons' property.
Parameters:
return - The state of the 'showIcons' property.

setShowText

public void setShowText(boolean show)
Sets the 'showText' property to the passed value. If set to true, Actions displayed in the ActionToolBar will show text if the SHORT_DESCRIPTION attribute is set on the passed Action. By default, text is not shown.
Parameters:
show - True for the icons to show, false if not.

isShowText

public boolean isShowText()
Returns the state of the 'showText' property.
Parameters:
return - The state of the 'showText' property.

setGlowStyle

public void setGlowStyle(boolean glow)

isGlowStyle

public boolean isGlowStyle()

setContextGroup

public void setContextGroup(ActionGroup group)
Sets the context pop-up ActionGroup for this ActionToolBar. The context group defines the right-click menu contents.
Parameters:
group - The right-click context ActionGroup

getContextGroup

public ActionGroup getContextGroup()
Returns the context pop-up ActionGroup.
Returns:
The context pop-up ActionGroup.

rebuild

protected void rebuild()

expandGroup

protected void expandGroup(ActionGroup group)

getMinimumSize

public java.awt.Dimension getMinimumSize()
Overrides:
getMinimumSize in class javax.swing.JComponent

setScrollMode

protected void setScrollMode(boolean scroll)

scrollPrevious

public void scrollPrevious()

scrollNext

public void scrollNext()