com.lamatek.swingextras
Class JInternalToolBar

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  com.lamatek.swingextras.JInternalToolBar

All Implemented Interfaces:

java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible

public class JInternalToolBar
extends javax.swing.JPanel
implements java.awt.event.MouseListener, java.awt.event.MouseMotionListener

A toolbar to be used in MDI interfaces. This toolbar is floatable and when floated, creates a new javax.swing.JInternalFrame with the toolbar enclosed. This toolbar provides a draggable 'thumb' component that the user drags into the desktop pane to float the toolbar. When the JInternalFrame is closed or is dragged back to the original docked location, the toolbar is docked and the JInternalFrame is disposed.

A JInternalToolBar can be either vertically or horizontally oriented.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

protected javax.swing.JDesktopPane	desktop
protected boolean	docked
protected boolean	floatable
static int	HORIZONTAL Variable used to declare horizontal (left to right) orientation.
protected int	orientation
static int	VERTICAL Variable used to declare vertical (top to bottom) orientation.

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

JInternalToolBar(java.lang.String title, int orientation, javax.swing.JDesktopPane desktop)
Creates a new floatable, dockable JInternalToolBar.

Method Summary

javax.swing.JButton	add(javax.swing.JButton button) Adds a javax.swing.JButton to the toolbar.
void	addSeparator(int size) Adds a separator of the given size to the toolbar.
protected void	dock()
void	mouseClicked(java.awt.event.MouseEvent e) Used by the Thumb object.
void	mouseDragged(java.awt.event.MouseEvent e) Used by the Thumb object.
void	mouseEntered(java.awt.event.MouseEvent e) Used by the Thumb object.
void	mouseExited(java.awt.event.MouseEvent e) Used by the Thumb object.
void	mouseMoved(java.awt.event.MouseEvent e) Used by the Thumb object.
void	mousePressed(java.awt.event.MouseEvent e) Used by the Thumb object.
void	mouseReleased(java.awt.event.MouseEvent e) Used by the Thumb object.
void	setFrameIcon(javax.swing.ImageIcon icon) Sets the frame icon when the toolbar is floating.
void	setToolBarBorder(javax.swing.border.Border b) Sets the border for the toolbar when docked.
void	setToolBarIcon(javax.swing.ImageIcon icon) Sets the frame icon when the toolbar is floating.
protected void	unDock()

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

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, 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, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, 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

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

VERTICAL

public static final int VERTICAL

Variable used to declare vertical (top to bottom) orientation.

See Also:

Constant Field Values

HORIZONTAL

public static final int HORIZONTAL

Variable used to declare horizontal (left to right) orientation.

See Also:

Constant Field Values

orientation

protected int orientation

floatable

protected boolean floatable

docked

protected boolean docked

desktop

protected javax.swing.JDesktopPane desktop

Constructor Detail

JInternalToolBar

public JInternalToolBar(java.lang.String title,
                        int orientation,
                        javax.swing.JDesktopPane desktop)

Creates a new floatable, dockable JInternalToolBar.

Parameters:

title - The text label for the JInternalFrame when floating.

orientation - Denotes whether the JInternalToolBar should be vertically or horizontally oriented. Use the VERTICAL or HORIZONTAL static variables.

desktop - The JDesktopPane to contain the Toolbar when floating.

Method Detail

mouseDragged

public void mouseDragged(java.awt.event.MouseEvent e)

Used by the Thumb object.

Specified by:

mouseDragged in interface java.awt.event.MouseMotionListener

mouseMoved

public void mouseMoved(java.awt.event.MouseEvent e)

Used by the Thumb object.

Specified by:

mouseMoved in interface java.awt.event.MouseMotionListener

mouseClicked

public void mouseClicked(java.awt.event.MouseEvent e)

Used by the Thumb object.

Specified by:

mouseClicked in interface java.awt.event.MouseListener

mouseEntered

public void mouseEntered(java.awt.event.MouseEvent e)

Used by the Thumb object.

Specified by:

mouseEntered in interface java.awt.event.MouseListener

mouseExited

public void mouseExited(java.awt.event.MouseEvent e)

Used by the Thumb object.

Specified by:

mouseExited in interface java.awt.event.MouseListener

mousePressed

public void mousePressed(java.awt.event.MouseEvent e)

Used by the Thumb object.

Specified by:

mousePressed in interface java.awt.event.MouseListener

mouseReleased

public void mouseReleased(java.awt.event.MouseEvent e)

Used by the Thumb object.

Specified by:

mouseReleased in interface java.awt.event.MouseListener

setToolBarIcon

public void setToolBarIcon(javax.swing.ImageIcon icon)

Sets the frame icon when the toolbar is floating.

Parameters:

icon - The icon for the frame when the toolbar is floating.

addSeparator

public void addSeparator(int size)

Adds a separator of the given size to the toolbar.

Parameters:

size - The size of the separator to be added.

add

public javax.swing.JButton add(javax.swing.JButton button)

Adds a javax.swing.JButton to the toolbar.

Parameters:

button - The next JButton to add to the toolbar.

Returns:

The button added to the toolbar.

setToolBarBorder

public void setToolBarBorder(javax.swing.border.Border b)

Sets the border for the toolbar when docked.

Parameters:

b - The border to be used when the toolbar is docked.

unDock

protected void unDock()

dock

protected void dock()

setFrameIcon

public void setFrameIcon(javax.swing.ImageIcon icon)

Sets the frame icon when the toolbar is floating.

Parameters:

icon - The icon to use when the toolbar is floating.

See Also:

setToolBarIcon