|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object bibliothek.gui.dock.facile.mode.LocationModeEvent
public class LocationModeEvent
Information given to a LocationModeListener
.
Constructor Summary | |
---|---|
LocationModeEvent(LocationMode mode,
Location location,
Dockable dockable,
AffectedSet affected)
Creates a new event. |
Method Summary | |
---|---|
void |
done()
Marks the mode transition as over. |
AffectedSet |
getAffected()
The set of elements that is affected. |
java.lang.Object |
getClientObject(LocationModeListener key)
Gets some object that was stored earlier using key key . |
Dockable |
getDockable()
Gets the Dockable whose mode was, or is going to be, changed. |
Location |
getLocation()
Gets the location which dockable should have after
apply . |
LocationMode |
getMode()
Gets the source of the event, the mode whose apply method was called. |
boolean |
isDone()
Tells whether the mode transition has been done or not. |
void |
setClientObject(LocationModeListener key,
java.lang.Object value)
Stores object in a map using listener as key. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public LocationModeEvent(LocationMode mode, Location location, Dockable dockable, AffectedSet affected)
mode
- the source of the eventlocation
- the new location of dockable
, may be null
dockable
- the element with the new modeaffected
- the affected elementsMethod Detail |
---|
public void done()
apply
has finished its job.
LocationModeListener
s might however prematurely call this method. In this case
apply
is not executed, but all remaining events are sent anyway.
public boolean isDone()
true
if the transition is overpublic LocationMode getMode()
apply
method was called.
public Location getLocation()
dockable
should have after
apply
. Note: this might not be the actual location the element gets.
null
public Dockable getDockable()
Dockable
whose mode was, or is going to be, changed.
public AffectedSet getAffected()
public void setClientObject(LocationModeListener key, java.lang.Object value)
object
in a map using listener
as key. If this
method is called by LocationModeListener.applyStarting(LocationModeEvent)
,
then the object is available when LocationModeListener.applyDone(LocationModeEvent)
is called.
key
- the key, not null
value
- the value, may be null
public java.lang.Object getClientObject(LocationModeListener key)
key
.
key
- the key
null
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |