org.openide.awt

Class ToolbarPool

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

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

Nested Classes

Modifier and Type	Class and Description
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.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
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

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

Constructors

Constructor and Description
ToolbarPool(DataFolder df) Creates a new ToolbarPool.

Method Summary

Modifier and Type	Method and Description
Toolbar	findToolbar(String name) Returns a Toolbar to which this pool maps the given name.
AccessibleContext	getAccessibleContext() Read accessible context
String	getConfiguration() Getter for the name of current configuration.
String[]	getConfigurations()
static ToolbarPool	getDefault() Returns default toolbar pool.
DataFolder	getFolder()
int	getPreferredIconSize() Gets preferred size of icons used by toolbar buttons.
Toolbar[]	getToolbars() Returns the toolbars contained in this pool.
boolean	isFinished() Check whether all data needed for the toolbar are read from disk.
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) Deprecated.
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, 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, getUI, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, 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, 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, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, 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

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()

Gets preferred size of icons used by toolbar buttons. Default icon size is 24x24. Icon size 16x16 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

waitFinished

public final void waitFinished()

Allows to wait till the content of the pool is initialized.

isFinished

public final boolean isFinished()

Check whether all data needed for the toolbar are read from disk.

Returns:

true if ToolbarPool.waitFinished() and other getters will return immediately

Since:

7.30

setToolbarsListener

@Deprecated
public void setToolbarsListener(Toolbar.DnDListener l)

Deprecated.

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 Component

Returns:

- accessible context