org.openide.awt
Class Toolbar

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JToolBar
                          |
                          +--org.openide.awt.Toolbar

All Implemented Interfaces:

Accessible, ImageObserver, MenuContainer, Serializable, SwingConstants

public class Toolbar

extends JToolBar

Toolbar provides a component which is useful for displaying commonly used actions. It can be dragged inside its ToolbarPanel to customize its location.

See Also:

Serialized Form

Inner Class Summary

static class	Toolbar.DnDEvent DnDEvent is Toolbar's drag and drop event.
static interface	Toolbar.DnDListener DnDListener is Drag and Drop listener for Toolbar motion events.

Inner classes inherited from class javax.swing.JToolBar

JToolBar.AccessibleJToolBar, JToolBar.Separator

Inner classes inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Inner classes inherited from class java.awt.Container

Container.AccessibleAWTContainer

Inner classes inherited from class java.awt.Component

Component.AccessibleAWTComponent

Field Summary

static int

BASIC_HEIGHT Basic toolbar height.

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 javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NORTH, NORTH_EAST, NORTH_WEST, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Toolbar()
Create a new Toolbar with empty name.

Toolbar(String name)
Create a new not floatable Toolbar with programmatic name.

Toolbar(String name, boolean f)
Create a new Toolbar.

Toolbar(String name, String displayName)
Create a new not floatable Toolbar with specified programmatic name and display name

Toolbar(String name, String displayName, boolean f)
Create a new Toolbar.

Method Summary

void	addNotify()
protected void	fireDragToolbar(int dx, int dy, int type) Fire drag of Toolbar
protected void	fireDropToolbar(int dx, int dy, int type) Fire drop of Toolbar
String	getDisplayName()
void	removeAll() Removes all ACTION components.
static int	rowCount(int height) Compute with HEIGHT_TOLERANCE number of rows for specific toolbar height.
void	setDisplayName(String displayName) Sets new display name of this toolbar.
void	setDnDListener(Toolbar.DnDListener l) Set DnDListener to Toolbar.
void	setVisible(boolean b)

Methods inherited from class javax.swing.JToolBar

add, addImpl, addSeparator, addSeparator, createActionChangeListener, createActionComponent, getAccessibleContext, getComponentAtIndex, getComponentIndex, getMargin, getOrientation, getUI, getUIClassID, isBorderPainted, isFloatable, paintBorder, paramString, setBorderPainted, setFloatable, setMargin, setOrientation, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, 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, getMinimumSize, 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, 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, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, 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, 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

BASIC_HEIGHT

public static final int BASIC_HEIGHT

Basic toolbar height.

Constructor Detail

Toolbar

public Toolbar()

Create a new Toolbar with empty name.

Toolbar

public Toolbar(String name)

Create a new not floatable Toolbar with programmatic name. Display name is set to be the same as name

Toolbar

public Toolbar(String name,
               String displayName)

Create a new not floatable Toolbar with specified programmatic name and display name

Toolbar

public Toolbar(String name,
               boolean f)

Create a new Toolbar.

Parameters:

name - a String containing the associated name

f - specified if Toolbar is floatable Display name of the toolbar is set equal to the name.

Toolbar

public Toolbar(String name,
               String displayName,
               boolean f)

Create a new Toolbar.

Parameters:

name - a String containing the associated name

f - specified if Toolbar is floatable

Method Detail

addNotify

public void addNotify()

Overrides:

addNotify in class JComponent

setVisible

public void setVisible(boolean b)

Overrides:

setVisible in class JComponent

removeAll

public void removeAll()

Removes all ACTION components.

Overrides:

removeAll in class Container

rowCount

public static int rowCount(int height)

Compute with HEIGHT_TOLERANCE number of rows for specific toolbar height.

Parameters:

height - of some toolbar

Returns:

number of rows

setDnDListener

public void setDnDListener(Toolbar.DnDListener l)

Set DnDListener to Toolbar.

Parameters:

DndListener - for toolbar

getDisplayName

public String getDisplayName()

Returns:

Display name of this toolbar. Display name is localizable, on the contrary to the programmatic name

setDisplayName

public void setDisplayName(String displayName)

Sets new display name of this toolbar. Display name is localizable, on the contrary to the programmatic name

fireDragToolbar

protected void fireDragToolbar(int dx,
                               int dy,
                               int type)

Fire drag of Toolbar

Parameters:

dx - distance of horizontal dragging

dy - distance of vertical dragging

type - type of toolbar dragging

fireDropToolbar

protected void fireDropToolbar(int dx,
                               int dy,
                               int type)

Fire drop of Toolbar

Parameters:

dx - distance of horizontal dropping

dy - distance of vertical dropping

type - type of toolbar dropping