public interface DockRelocator
DockRelocator
is responsible for executing and managing the basic drag and drop
operations.Modifier and Type | Method and Description |
---|---|
void |
addMode(DockRelocatorMode mode)
Adds a mode to this relocator, a mode can be activated or deactivated
when the user presses a button like "ctrl" or "shift" during a
drag and drop operation.
|
void |
addVetoableDockRelocatorListener(VetoableDockRelocatorListener listener)
Adds a listener to this manager.
|
void |
cancel()
Cancels the current drag and drop operation (if there is any).
|
DirectRemoteRelocator |
createDirectRemote(Dockable dockable)
Creates a device with which drag&drop operations concerning
dockable can be initiated and executed. |
DirectRemoteRelocator |
createDirectRemote(Dockable dockable,
boolean forceDrag)
Creates a device with which drag&drop operations concerning
dockable can be initiated and executed. |
RemoteRelocator |
createRemote(Dockable dockable)
Creates a device with which drag&drop operations concerning
dockable can be initiated and executed. |
RemoteRelocator |
createRemote(Dockable dockable,
boolean forceDrag)
Creates a device with which drag&drop operations concerning
dockable can be initiated and executed. |
int |
getDragDistance()
Gets the distance the user must move the mouse in order to begin a
drag operation.
|
Inserter |
getInserter()
Gets the algorithm used to override decisions of a
DockStation . |
Merger |
getMerger()
Gets an algorithm useful for merging two
DockStation s. |
boolean |
hasTarget()
Tells whether the current drag and drop operation has a target, i.e.
|
boolean |
isDragOnlyTitle()
Tells whether dockables can only be dragged through their title or not.
|
boolean |
isOnMove()
Tells whether the user has currently grabbed a dockable and moves
the dockable around.
|
boolean |
isOnPut()
Tells whether this relocator currently puts a Dockable.
|
void |
removeMode(DockRelocatorMode mode)
Removes a mode that has earlier been added to this relocator.
|
void |
removeVetoableDockRelocatorListener(VetoableDockRelocatorListener listener)
Removes a listener from this manager.
|
void |
setDragDistance(int dragDistance)
Sets the distance the user must move the mouse in order to begin a
drag operation.
|
void |
setDragOnlyTitle(boolean dragOnlyTitle)
Tells whether dockables can only be dragged through their title or not.
|
void |
setInserter(Inserter inserter)
Sets the algorithm which is used to override decisions of a
DockStation . |
void |
setMerger(Merger merger)
Sets an algorithm for merging two
DockStation s. |
void addVetoableDockRelocatorListener(VetoableDockRelocatorListener listener)
Dockable
is moved.listener
- the new listenervoid removeVetoableDockRelocatorListener(VetoableDockRelocatorListener listener)
listener
- the listener to removeboolean isDragOnlyTitle()
true
if a Dockable must be dragged through their
titles, false
if every part of the dockable can be
grabbed by the mouse.setDragOnlyTitle(boolean)
void setDragOnlyTitle(boolean dragOnlyTitle)
dragOnlyTitle
- true
if a Dockable must be dragged through its
title, false
if every part of the dockable can be
grabbed by the mouse.int getDragDistance()
void setDragDistance(int dragDistance)
dragDistance
- the distance in pixelMerger getMerger()
DockStation
s.null
void setMerger(Merger merger)
DockStation
s.merger
- the new algorithm, can be null
Inserter getInserter()
DockStation
.null
void setInserter(Inserter inserter)
DockStation
.inserter
- the algorithm, can be null
void addMode(DockRelocatorMode mode)
mode
- the new mode, not null
void removeMode(DockRelocatorMode mode)
mode
- the mode to removeboolean isOnMove()
true
if a Dockable is currently draggedboolean isOnPut()
true
if a Dockable is movedboolean hasTarget()
false
if there is no operation runningvoid cancel()
DirectRemoteRelocator createDirectRemote(Dockable dockable)
dockable
can be initiated and executed.dockable
- the dockable which might be movedDirectRemoteRelocator createDirectRemote(Dockable dockable, boolean forceDrag)
dockable
can be initiated and executed.dockable
- the dockable which might be movedforceDrag
- if this flag is set to true
, then dragging will always start even
if one of the usual conditions is not met. I.e. dragging will start even if dockable
does not have a parent of even if the parent does not allow dragging. This flag should be used
with caution.RemoteRelocator createRemote(Dockable dockable)
dockable
can be initiated and executed.dockable
- the dockable which might be movedRemoteRelocator createRemote(Dockable dockable, boolean forceDrag)
dockable
can be initiated and executed.dockable
- the dockable which might be movedforceDrag
- if this flag is set to true
, then dragging will always start even
if one of the usual conditions is not met. I.e. dragging will start even if dockable
does not have a parent of even if the parent does not allow dragging. This flag should be used
with caution.