|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.vlsolutions.swing.docking.event.DockingActionEvent
public abstract class DockingActionEvent
An abstract event class describing a docking action.
This event is used to explain a dockable action : it doesn't contain any information about the current state of a dockable, but describes precisely what we want to do with it (for example, detach it, or left-split another dockable).
The DockingActionDockableEvent abstract subclass is used as a superclass for all events associated to a single dockable.
Concrete sub classes are used for every type of docking action (split, tab...)
Field Summary | |
---|---|
static int |
ACTION_ADD_DOCKABLE
Field associated to an addDockable action |
static int |
ACTION_CLOSE
Field associated to a closing action |
static int |
ACTION_CREATE_TAB
Field associated to a createTab action |
static int |
ACTION_SPLIT_COMPONENT
Field associated to a split component action |
static int |
ACTION_SPLIT_DOCKABLE
Field associated to a split dockable action |
static int |
ACTION_SPLIT_DOCKABLE_CONTAINER
Field associated to a multipurpose (API internals) splut container action |
static int |
ACTION_STATE_CHANGE
A multipurpose action used to describe maximize, hide and detach actions |
Constructor Summary | |
---|---|
DockingActionEvent(DockingDesktop targetDesktop,
int initialState,
int nextState,
int actionType)
Constructs a new DockingActionEvent |
Method Summary | |
---|---|
java.lang.Object |
clone()
Overriden clone method |
int |
getActionType()
Returns a field describing the action (ACTION_CLOSE...). |
DockingDesktop |
getDesktop()
Returns the desktop used as a receiver (target) of the docking action. |
int |
getInitialDockableState()
Returns one of the DockableState states reflecting the state of the dockable before the action |
int |
getNextDockableState()
Returns one of the DockableState states reflecting the state of the dockable after the action |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int ACTION_CLOSE
public static final int ACTION_ADD_DOCKABLE
public static final int ACTION_SPLIT_DOCKABLE
public static final int ACTION_SPLIT_COMPONENT
public static final int ACTION_SPLIT_DOCKABLE_CONTAINER
public static final int ACTION_CREATE_TAB
public static final int ACTION_STATE_CHANGE
Constructor Detail |
---|
public DockingActionEvent(DockingDesktop targetDesktop, int initialState, int nextState, int actionType)
targetDesktop
- the desktop that will receive the action .initialState
- the initial (before action) DockableState (DockableState.STATE_FLOATING...)nextState
- the next (after action) DockableState (DockableState.STATE_DOCKED...)actionType
- a field defining the type of action used (ACTION_CLOSE...)Method Detail |
---|
public int getInitialDockableState()
public int getNextDockableState()
public int getActionType()
public DockingDesktop getDesktop()
The desktop used as a source (on multi-desktop applications) can be retrieved by asking for the current dockable state (to the DockingContext).
public java.lang.Object clone()
clone
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |