|
||||||||||
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,
Dockable[] implicit,
DockStation target,
Point mouse,
boolean move)
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. |
Dockable[] |
getImplicitDockables()
Gets a set of Dockable s that will also change their parent due to this
event. |
Point |
getMouseLocation()
Gets the location of the mouse on the screen. |
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.Please note that this field does not take into consideration, that the dockable may
be forced onto another parent. |
void |
ignore()
The DockRelocator is to behave as if this event never happened. |
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. |
boolean |
isIgnored()
Tells whether the DockRelocator behaves as if an event did not happen. |
boolean |
isMove()
Tells whether the event really is a move event (the parent of the Dockable does not change). |
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, Dockable[] implicit, DockStation target, Point mouse, boolean move)
controller
- the controller in whose realm the event happensdockable
- the element that is moved aroundimplicit
- the elements that change their position tootarget
- the potential parent of dockable
mouse
- the location of the mouse on the screen or null
move
- whether the event does not change the 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 Dockable[] getImplicitDockables()
DockRelocatorEvent
Dockable
s that will also change their parent due to this
event. This list contains only the set of Dockable
s that are directly affected by this event.
Elements that are affected indirectly, e.g. because a DockStation
remains that has only one child and
thus gets removed, are not included.
getImplicitDockables
in interface DockRelocatorEvent
null
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.dockable
may
be forced onto another parent. Clients should always ask the Dockable
directly for its
real parent.
getTarget
in interface DockRelocatorEvent
null
if either the drag and drop operation is
not yet started or if there is no target selectedpublic Point getMouseLocation()
DockRelocatorEvent
DirectRemoteRelocator
or a RemoteRelocator
. The property may not be
set if either the location of the mouse is not important for the current event, or simply
if the location of the mouse is not known.
getMouseLocation
in interface DockRelocatorEvent
null
public 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()
public void ignore()
DockRelocatorEvent
DockRelocator
is to behave as if this event never happened. Usually this means that
the MouseEvent
is not consumed
and that no action takes place.
Note however that some events cannot be ignored, for example if the operation is
canceled
.
ignore
in interface DockRelocatorEvent
public boolean isIgnored()
DockRelocatorEvent
DockRelocator
behaves as if an event did not happen.
isIgnored
in interface DockRelocatorEvent
public boolean isMove()
DockRelocatorEvent
Dockable
does not change).
isMove
in interface DockRelocatorEvent
true
if the event describes a move event, false
if not or if the event
does not describe a drop operation.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |