org.openbp.cockpit.plugins.toolbox
Class ToolBoxItem

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  org.openbp.cockpit.plugins.toolbox.ToolBoxItem

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, BreakoutBoxEntry, DragOrigin

public class ToolBoxItem
extends javax.swing.JPanel
implements DragOrigin, BreakoutBoxEntry

This is a ToolBoxItem which is displayed in a ToolBoxPlugin. The Item implements starts Drag and Drop with the given TransferHandler.

Author:

Jens Ferchland

See Also:

Serialized Form

Nested Class Summary

class

ToolBoxItem.TBMouseListener MouseListener to intercept popup requests and doubleclicks.

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.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

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

ToolBoxItem(java.lang.String title, javax.swing.Icon icon, java.lang.String description, java.awt.datatransfer.Transferable transferable)
Constructor.

ToolBoxItem(java.lang.String title, java.lang.String iconModelKey, java.lang.String description, java.awt.datatransfer.Transferable transferable)
Constructor.

Method Summary

boolean	canDrag() If this returns false, no dragging is permitted.
void	draw(java.awt.Graphics g) Draws the entry.
void	dropAccepted(java.awt.datatransfer.Transferable t) Called when the drag has been accepted by a InteractionClient, but before it is actually imported.
void	dropCanceled(java.awt.datatransfer.Transferable t) Called when the drag action has been aborted, either by dropping upon a non- qualifying target or because the target reported an unsuccessful drop.
void	dropPerformed(java.awt.datatransfer.Transferable t) Called when the drop has been performed and the object has been inserted.
java.lang.String	getDescription() Gets the description of this entry.
MultiIcon	getDragImage() Gets the image for the construction of the drag cursor.
MultiIcon	getIcon() Gets the icon of this entry.
java.lang.String	getIconModelKey() Gets the key for retrieval of the icon from the icon model (in case of skin changes).
Importer	getImporter() Gets the importer of the entry.
java.awt.Rectangle	getLocationOnGlassPanel() Gets the location and dimension of the entry.
java.lang.String	getTitle() Gets the title of this entry.
ToolBoxPlugin	getToolbox() Gets the toolbox this item belongs to.
java.awt.datatransfer.Transferable	getTranferableAt(java.awt.Point p) Returns the Transferable for a drag Operation starting at .
java.awt.datatransfer.Transferable	getTransferable() Gets the transfer object of the tool bar item.
boolean	importData(java.awt.Point dropPoint) Imports the data at the drop point.
void	initComponent() Initializes the component with the icon and text.
boolean	reactsOn(int x, int y) Checks if the given point is inside the region of the entry.
void	setIconModelKey(java.lang.String iconModelKey) Sets the key for retrieval of the icon from the icon model (in case of skin changes).
void	setImporter(Importer importer) Sets the Importer of this BreakoutBoxEntry
void	setLocationOnGlassPanel(java.awt.Rectangle r) Sets the location and dimension of the entry.
void	setToolbox(ToolBoxPlugin toolbox) Sets the toolbox this item belongs to.
java.lang.String	toString() Returns a string representation of this object.
void	updateModelIcon(java.lang.String skinName) Updates the icon of the toolbox item if it has been retrieved from the icon model in the case of skin changes.

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, 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, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, 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, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.openbp.jaspira.gui.interaction.BreakoutBoxEntry

getToolTipText

Constructor Detail

ToolBoxItem

public ToolBoxItem(java.lang.String title,
                   java.lang.String iconModelKey,
                   java.lang.String description,
                   java.awt.datatransfer.Transferable transferable)

Constructor.

Parameters:

title - Item title

iconModelKey - Key for retrieval of the icon from the icon model (in case of skin changes)

description - Description text of the item

transferable - Transfer object of the tool bar item

ToolBoxItem

public ToolBoxItem(java.lang.String title,
                   javax.swing.Icon icon,
                   java.lang.String description,
                   java.awt.datatransfer.Transferable transferable)

Constructor.

Parameters:

title - Item title

icon - Icon representing the item

description - Description text of the item

transferable - Transfer object of the tool bar item

Method Detail

toString

public java.lang.String toString()

Returns a string representation of this object.

Overrides:

toString in class java.awt.Component

initComponent

public void initComponent()

Initializes the component with the icon and text.

updateModelIcon

public void updateModelIcon(java.lang.String skinName)

Updates the icon of the toolbox item if it has been retrieved from the icon model in the case of skin changes.

Parameters:

skinName - Skin name

getTransferable

public java.awt.datatransfer.Transferable getTransferable()

Gets the transfer object of the tool bar item.

Specified by:

getTransferable in interface BreakoutBoxEntry

getToolbox

public ToolBoxPlugin getToolbox()

Gets the toolbox this item belongs to.

setToolbox

public void setToolbox(ToolBoxPlugin toolbox)

Sets the toolbox this item belongs to.

getIconModelKey

public java.lang.String getIconModelKey()

Gets the key for retrieval of the icon from the icon model (in case of skin changes).

setIconModelKey

public void setIconModelKey(java.lang.String iconModelKey)

Sets the key for retrieval of the icon from the icon model (in case of skin changes).

canDrag

public boolean canDrag()

Description copied from interface: DragOrigin

If this returns false, no dragging is permitted.

Specified by:

canDrag in interface DragOrigin

See Also:

DragOrigin.canDrag()

dropAccepted

public void dropAccepted(java.awt.datatransfer.Transferable t)

Description copied from interface: DragOrigin

Called when the drag has been accepted by a InteractionClient, but before it is actually imported.

Specified by:

dropAccepted in interface DragOrigin

Parameters:

t - Dragged transferable

See Also:

DragOrigin.dropAccepted(Transferable t)

dropCanceled

public void dropCanceled(java.awt.datatransfer.Transferable t)

Description copied from interface: DragOrigin

Called when the drag action has been aborted, either by dropping upon a non- qualifying target or because the target reported an unsuccessful drop.

Specified by:

dropCanceled in interface DragOrigin

Parameters:

t - Dragged transferable

See Also:

DragOrigin.dropCanceled(Transferable t)

dropPerformed

public void dropPerformed(java.awt.datatransfer.Transferable t)

Description copied from interface: DragOrigin

Called when the drop has been performed and the object has been inserted.

Specified by:

dropPerformed in interface DragOrigin

Parameters:

t - Dragged transferable

See Also:

DragOrigin.dropPerformed(Transferable t)

getTranferableAt

public java.awt.datatransfer.Transferable getTranferableAt(java.awt.Point p)

Description copied from interface: DragOrigin

Returns the Transferable for a drag Operation starting at .

Specified by:

getTranferableAt in interface DragOrigin

Parameters:

p - The location at which the drag started in component local coordinates

Returns:

The Transferable to drag

See Also:

DragOrigin.getTranferableAt(Point)

getDragImage

public MultiIcon getDragImage()

Description copied from interface: DragOrigin

Gets the image for the construction of the drag cursor.

Specified by:

getDragImage in interface DragOrigin

Returns:

The image or null if no special drag image is to be constructed

See Also:

DragOrigin.getDragImage()

draw

public void draw(java.awt.Graphics g)

Description copied from interface: BreakoutBoxEntry

Draws the entry.

Specified by:

draw in interface BreakoutBoxEntry

Parameters:

g - Graphics context

See Also:

BreakoutBoxEntry.draw(Graphics)

getDescription

public java.lang.String getDescription()

Description copied from interface: BreakoutBoxEntry

Gets the description of this entry.

Specified by:

getDescription in interface BreakoutBoxEntry

See Also:

BreakoutBoxEntry.getDescription()

getIcon

public MultiIcon getIcon()

Description copied from interface: BreakoutBoxEntry

Gets the icon of this entry.

Specified by:

getIcon in interface BreakoutBoxEntry

See Also:

BreakoutBoxEntry.getIcon()

getImporter

public Importer getImporter()

Description copied from interface: BreakoutBoxEntry

Gets the importer of the entry.

Specified by:

getImporter in interface BreakoutBoxEntry

See Also:

BreakoutBoxEntry.getImporter()

setImporter

public void setImporter(Importer importer)

Sets the Importer of this BreakoutBoxEntry

getTitle

public java.lang.String getTitle()

Description copied from interface: BreakoutBoxEntry

Gets the title of this entry.

Specified by:

getTitle in interface BreakoutBoxEntry

See Also:

BreakoutBoxEntry.getTitle()

importData

public boolean importData(java.awt.Point dropPoint)

Description copied from interface: BreakoutBoxEntry

Imports the data at the drop point.

Specified by:

importData in interface BreakoutBoxEntry

Parameters:

dropPoint - Import position in glass coordinates

Returns:

true The data was successfully imported.
false An error occured while importing the data.

See Also:

BreakoutBoxEntry.importData(Point)

reactsOn

public boolean reactsOn(int x,
                        int y)

Description copied from interface: BreakoutBoxEntry

Checks if the given point is inside the region of the entry.

Specified by:

reactsOn in interface BreakoutBoxEntry

Parameters:

x - Position in screen coordinates

y - Position in screen coordinates

See Also:

BreakoutBoxEntry.reactsOn(int, int)

setLocationOnGlassPanel

public void setLocationOnGlassPanel(java.awt.Rectangle r)

Description copied from interface: BreakoutBoxEntry

Sets the location and dimension of the entry.

Specified by:

setLocationOnGlassPanel in interface BreakoutBoxEntry

Parameters:

r - Bounds in screen coordinates

See Also:

BreakoutBoxEntry.setLocationOnGlassPanel(Rectangle)

getLocationOnGlassPanel

public java.awt.Rectangle getLocationOnGlassPanel()

Description copied from interface: BreakoutBoxEntry

Gets the location and dimension of the entry.

Specified by:

getLocationOnGlassPanel in interface BreakoutBoxEntry

Returns:

Bounds in screen coordinates

See Also:

BreakoutBoxEntry.setLocationOnGlassPanel(Rectangle)