|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object bibliothek.gui.dock.control.relocator.DefaultDockRelocatorEvent
public class DefaultDockRelocatorEvent
A default implementation of DockRelocatorEvent
.
Constructor Summary | |
---|---|
DefaultDockRelocatorEvent(DockController controller,
Dockable dockable,
DockStation target)
Creates a new event. |
Method Summary | |
---|---|
void |
cancel()
Cancels the entire operation, the Dockable remains at its current place and
all visible indicators are removed. |
void |
drop()
Advices to complete the drag and drop operation right now, this operation at least requires DockRelocatorEvent.getTarget() to be not null , otherwise this operation
is equal to calling DockRelocatorEvent.cancel() . |
void |
forbid()
Forbids the current event to complete, depending on the state of the operation this is equivalent to calling DockRelocatorEvent.cancel() . |
DockController |
getController()
Gets the controller in whose realm this event was created. |
Dockable |
getDockable()
Gets the Dockable which is or will be dragged. |
DockRelocator |
getSource()
Gets the DockRelocator which created this event. |
DockStation |
getTarget()
Gets the current target of the drag and drop operation, if the operation would finish now, the dockable would be dropped onto this station. |
boolean |
isCanceled()
Tells whether this event is already canceled. |
boolean |
isDropping()
Tells whether this event will result in a drop operation. |
boolean |
isForbidden()
Tells whether this event is forbidden. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DefaultDockRelocatorEvent(DockController controller, Dockable dockable, DockStation target)
controller
- the controller in whose realm the event happensdockable
- the element that is moved aroundtarget
- the potential parent of dockable
Method Detail |
---|
public void cancel()
DockRelocatorEvent
Dockable
remains at its current place and
all visible indicators are removed.
cancel
in interface DockRelocatorEvent
public void drop()
DockRelocatorEvent
DockRelocatorEvent.getTarget()
to be not null
, otherwise this operation
is equal to calling DockRelocatorEvent.cancel()
.
drop
in interface DockRelocatorEvent
public void forbid()
DockRelocatorEvent
DockRelocatorEvent.cancel()
.
forbid
in interface DockRelocatorEvent
public DockController getController()
DockRelocatorEvent
getController
in interface DockRelocatorEvent
null
public Dockable getDockable()
DockRelocatorEvent
Dockable
which is or will be dragged.
getDockable
in interface DockRelocatorEvent
public DockRelocator getSource()
DockRelocatorEvent
DockRelocator
which created this event.
getSource
in interface DockRelocatorEvent
null
public DockStation getTarget()
DockRelocatorEvent
the dockable
would be dropped onto this station.
getTarget
in interface DockRelocatorEvent
null
if either the drag and drop operation is
not yet started or if there is no target selectedpublic boolean isCanceled()
DockRelocatorEvent
DockRelocatorEvent.cancel()
or because the DockRelocator
already decided that the
operation has to be canceled.
isCanceled
in interface DockRelocatorEvent
DockRelocatorEvent.cancel()
public boolean isDropping()
DockRelocatorEvent
DockRelocatorEvent.drop()
or because the DockRelocator
already decided that
a the operation has to finish.
isDropping
in interface DockRelocatorEvent
the dockable
will be droppedDockRelocatorEvent.drop()
public boolean isForbidden()
DockRelocatorEvent
DockRelocatorEvent.forbid()
or because the DockRelocator
already decided that this operation should not
have an effect.
isForbidden
in interface DockRelocatorEvent
DockRelocatorEvent.forbid()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |