bibliothek.gui.dock.station.toolbar

Class ToolbarContainerDropInfo

java.lang.Object

bibliothek.gui.dock.station.toolbar.ToolbarContainerDropInfo

All Implemented Interfaces:

StationDropOperation

public abstract class ToolbarContainerDropInfo
extends Object
implements StationDropOperation

This class contains and computes information about a drag and drop action. Especially, where the Dockable should be inserted into which ToolbarContainerDockStation

Author:

Herve Guillaume

Constructor Summary

Constructors

Constructor and Description
ToolbarContainerDropInfo(Dockable dockable, ToolbarContainerDockStation stationHost, DockablePlaceholderList<StationChildHandle> associateToolbars, int mouseX, int mouseY) Constructs a new info to know where drop a dockable

Method Summary

Modifier and Type	Method and Description
CombinerTarget	getCombination()
DisplayerCombinerTarget	getDisplayerCombination()
Dockable	getDockableBeneathMouse() Gets the index of the component beneath the mouse
abstract int	getIndex() Gets the index of getDockableBeneathMouse() in the parent DockStation.
Dockable	getItem()
Position	getItemPositionVSBeneathDockable() Gets the relative position of drag dockable with the closest dockable above the mouse.
Position	getSideDockableBeneathMouse() Gets the closest side of the component beneath the mouse.
DockStation	getTarget()
boolean	isMove()
String	toString()
String	toSummaryString() Return a string describing field values

Methods inherited from class java.lang.Object

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

Methods inherited from interface bibliothek.gui.dock.station.StationDropOperation

destroy, draw, execute

Constructor Detail

ToolbarContainerDropInfo

public ToolbarContainerDropInfo(Dockable dockable,
                                ToolbarContainerDockStation stationHost,
                                DockablePlaceholderList<StationChildHandle> associateToolbars,
                                int mouseX,
                                int mouseY)

Constructs a new info to know where drop a dockable

Parameters:

dockable - the dockable to drop

stationHost - the station where drop the dockable

associateToolbars - the other dockables in the station

mouseX - the mouse position on X axis

mouseY - the mouse position on Y axis

Method Detail

getItem

public Dockable getItem()

Specified by:

getItem in interface StationDropOperation

getTarget

public DockStation getTarget()

Specified by:

getTarget in interface StationDropOperation

getCombination

public CombinerTarget getCombination()

Specified by:

getCombination in interface StationDropOperation

getDisplayerCombination

public DisplayerCombinerTarget getDisplayerCombination()

Specified by:

getDisplayerCombination in interface StationDropOperation

isMove

public boolean isMove()

Specified by:

isMove in interface StationDropOperation

getIndex

public abstract int getIndex()

Gets the index of getDockableBeneathMouse() in the parent DockStation.

Returns:

the index or -1 if not available

getDockableBeneathMouse

public Dockable getDockableBeneathMouse()

Gets the index of the component beneath the mouse

Returns:

the index

getSideDockableBeneathMouse

public Position getSideDockableBeneathMouse()

Gets the closest side of the component beneath the mouse. Example: if the mouse is over a button, near the top of the button, this return NORTH position

Returns:

the side

getItemPositionVSBeneathDockable

public Position getItemPositionVSBeneathDockable()

Gets the relative position of drag dockable with the closest dockable above the mouse.

Returns:

the position

toString

public String toString()

Overrides:

toString in class Object

toSummaryString

public String toSummaryString()

Return a string describing field values

Returns:

string describing fields