com.borland.primetime.actions
Class ActionPalettePage

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPanel
                          |
                          +--com.borland.primetime.actions.ActionPalettePage

public class ActionPalettePage
extends javax.swing.JPanel

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

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

Inner classes inherited from class javax.swing.JPanel
javax.swing.JPanel.AccessibleJPanel
 
Inner classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Field Summary
protected  ActionGroup aGroup
           
protected  java.awt.Dimension butSize
           
protected  ActionGroup contextGroup
           
protected  boolean horizontal
           
protected static javax.swing.Icon icon_blank
           
protected static javax.swing.Icon icon_marker
           
protected  ActionPopupMenu pop
           
protected  boolean showIcons
           
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
 
Constructor Summary
ActionPalettePage(java.lang.Object source, ActionGroup group)
          Constructs an ActionPalettePage with the specified source object and ActionGroup.
ActionPalettePage(java.lang.Object source, ActionGroup group, java.awt.Dimension butSize)
          Constructs an ActionPalettePage with the specified source object, ActionGroup, and button size.
ActionPalettePage(java.lang.Object source, ActionGroup group, java.awt.Dimension butSize, boolean useSmallIcon)
          Constructs an ActionPalettePage with the specified source object, ActionGroup, button size, and useSmallIcon state.
ActionPalettePage(java.lang.Object source, ActionGroup group, java.awt.Dimension butSize, boolean useSmallIcon, boolean horizontal)
          Constructs an ActionPalettePage with the specified source object, ActionGroup, button size, useSmallIcon state, and horizontal setting.
 
Method Summary
protected  void expandGroup(ActionGroup group)
           
 java.awt.Dimension getButtonSize()
          Returns the toolbar button size.
 ActionGroup getContextGroup()
          Returns the context pop-up ActionGroup.
 java.awt.Dimension getMinimumSize()
           
 int getSeparatorSize()
           
 boolean isHorizontal()
          Returns the horizontal property setting.
 boolean isShowIcons()
          Returns the state of the 'showIcons' property.
 boolean isShowText()
          Returns the state of the 'showText' property.
 boolean isUseSmallIcon()
          Returns the state of the useSmallIcon property.
 void setButtonSize(java.awt.Dimension size)
          Sets the toolbar button size.
 void setContextGroup(ActionGroup group)
          Sets the context pop-up ActionGroup for this ActionPalettePage.
 void setHorizontal(boolean horz)
          Sets the horizontal property for this ActionPalettePage.
 void setSeparatorSize(int pixels)
           
 void setShowIcons(boolean show)
          Sets the 'showIcons' property to the passed value.
 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, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInsets, getInsets, getLocation, getMaximumSize, 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, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, processComponentKeyEvent, processFocusEvent, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setEnabled, setFont, setForeground, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setUI, 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, setCursor, setLayout, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hide, 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, processInputMethodEvent, processMouseEvent, remove, removeComponentListener, removeFocusListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, 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

source

protected java.lang.Object source

aGroup

protected ActionGroup aGroup

butSize

protected java.awt.Dimension butSize

useSmallIcon

protected boolean useSmallIcon

horizontal

protected boolean horizontal

icon_blank

protected static javax.swing.Icon icon_blank

icon_marker

protected static javax.swing.Icon icon_marker

showIcons

protected boolean showIcons

showText

protected boolean showText

contextGroup

protected ActionGroup contextGroup

pop

protected ActionPopupMenu pop
Constructor Detail

ActionPalettePage

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

ActionPalettePage

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

ActionPalettePage

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

ActionPalettePage

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

setButtonSize

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

getButtonSize

public java.awt.Dimension getButtonSize()
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 ActionPalettePage. By default, the ActionPalettePage 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

setShowIcons

public void setShowIcons(boolean show)
Sets the 'showIcons' property to the passed value. If set to true, Actions displayed in the ActionPalettePage 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 ActionPalettePage 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.

setContextGroup

public void setContextGroup(ActionGroup group)
Sets the context pop-up ActionGroup for this ActionPalettePage. 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.

expandGroup

protected void expandGroup(ActionGroup group)

getMinimumSize

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

getSeparatorSize

public int getSeparatorSize()

setSeparatorSize

public void setSeparatorSize(int pixels)