org.openide.loaders 5.9.22

org.openide.awt
Class ToolbarPool

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by org.openide.awt.ToolbarPool
All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, Accessible

public final class ToolbarPool
extends JComponent
implements Accessible

This class keeps track of the current toolbars and their names.

See Also:
Serialized Form

Nested Class Summary
static interface ToolbarPool.Configuration
          Abstract class for toolbar configuration
 
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.BltBufferStrategy, Component.FlipBufferStrategy
 
Field Summary
static String DEFAULT_CONFIGURATION
          Name of default toolbar configuration.
 
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
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
ToolbarPool(DataFolder df)
          Creates a new ToolbarPool.
 
Method Summary
 Toolbar findToolbar(String name)
          Returns a Toolbar to which this pool maps the given name.
 AccessibleContext getAccessibleContext()
          Read accessible context
 Border getBorder()
           
 String getConfiguration()
          Getter for the name of current configuration.
 String[] getConfigurations()
           
static ToolbarPool getDefault()
          Returns default toolbar pool.
 DataFolder getFolder()
           
 int getPreferredIconSize()
          Returns preferred size of icons used by toolbar buttons.
 Toolbar[] getToolbars()
          Returns the toolbars contained in this pool.
 void setConfiguration(String n)
          Switch to toolbar configuration by specific config name
 void setPreferredIconSize(int preferredIconSize)
          Sets preferred size of icons used by toolbar buttons.
 void setToolbarsListener(Toolbar.DnDListener l)
          Sets DnDListener to all Toolbars.
 void waitFinished()
          Allows to wait till the content of the pool is initialized.
 
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, 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, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, 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, updateUI
 
Methods inherited from class java.awt.Container
add, 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, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, 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, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

DEFAULT_CONFIGURATION

public static final String DEFAULT_CONFIGURATION
Name of default toolbar configuration.

See Also:
Constant Field Values
Constructor Detail

ToolbarPool

public ToolbarPool(DataFolder df)
Creates a new ToolbarPool. Useful for modules that need they own toolbars.

Parameters:
df - the data folder to read toolbar definitions and configurations from
Since:
1.5
Method Detail

getDefault

public static ToolbarPool getDefault()
Returns default toolbar pool.

Returns:
default system pool

getPreferredIconSize

public int getPreferredIconSize()
Returns preferred size of icons used by toolbar buttons. Default icons size is 16x16. Icon size 24x24 is also supported.

Returns:
preferred size of toolbar icons in pixels
Since:
4.15

setPreferredIconSize

public void setPreferredIconSize(int preferredIconSize)
                          throws IllegalArgumentException
Sets preferred size of icons used by toolbar buttons.

Parameters:
preferredIconSize - size of toolbar icons in pixels; currently one of 16 or 24
Throws:
IllegalArgumentException - if an unsupported size is given
Since:
4.15

getBorder

public Border getBorder()
Overrides:
getBorder in class JComponent

waitFinished

public final void waitFinished()
Allows to wait till the content of the pool is initialized.


setToolbarsListener

public void setToolbarsListener(Toolbar.DnDListener l)
Sets DnDListener to all Toolbars.


findToolbar

public final Toolbar findToolbar(String name)
Returns a Toolbar to which this pool maps the given name.

Parameters:
name - a String that is to be a toolbar's name
Returns:
a Toolbar to which this pool maps the name

getConfiguration

public final String getConfiguration()
Getter for the name of current configuration.

Returns:
the name of current configuration

setConfiguration

public final void setConfiguration(String n)
Switch to toolbar configuration by specific config name

Parameters:
n - toolbar configuration name

getFolder

public final DataFolder getFolder()
Returns:
the DataFolder from which the pool was created.

getToolbars

public final Toolbar[] getToolbars()
Returns the toolbars contained in this pool.

Returns:
the toolbars contained in this pool

getConfigurations

public final String[] getConfigurations()
Returns:
the names of toolbar configurations contained in this pool

getAccessibleContext

public AccessibleContext getAccessibleContext()
Read accessible context

Specified by:
getAccessibleContext in interface Accessible
Overrides:
getAccessibleContext in class JComponent
Returns:
- accessible context

org.openide.loaders 5.9.22

Built on July 11 2007.  |  Portions Copyright 1997-2005 Sun Microsystems, Inc. All rights reserved.