com.vlsolutions.swing.docking.event

Class DockingActionEvent

Implemented Interfaces:
Cloneable
Known Direct Subclasses:
DockingActionDockableEvent, DockingActionSplitDockableContainerEvent

public abstract class DockingActionEvent
extends java.lang.Object
implements Cloneable

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...)

Since:
2.1

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

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

Field Details

ACTION_ADD_DOCKABLE

public static final int ACTION_ADD_DOCKABLE
Field associated to an addDockable action
Field Value:
1

ACTION_CLOSE

public static final int ACTION_CLOSE
Field associated to a closing action
Field Value:
0

ACTION_CREATE_TAB

public static final int ACTION_CREATE_TAB
Field associated to a createTab action
Field Value:
5

ACTION_SPLIT_COMPONENT

public static final int ACTION_SPLIT_COMPONENT
Field associated to a split component action
Field Value:
3

ACTION_SPLIT_DOCKABLE

public static final int ACTION_SPLIT_DOCKABLE
Field associated to a split dockable action
Field Value:
2

ACTION_SPLIT_DOCKABLE_CONTAINER

public static final int ACTION_SPLIT_DOCKABLE_CONTAINER
Field associated to a multipurpose (API internals) splut container action
Field Value:
4

ACTION_STATE_CHANGE

public static final int ACTION_STATE_CHANGE
A multipurpose action used to describe maximize, hide and detach actions
Field Value:
6

Constructor Details

DockingActionEvent

public DockingActionEvent(DockingDesktop targetDesktop,
                          int initialState,
                          int nextState,
                          int actionType)
Constructs a new DockingActionEvent
Parameters:
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 Details

clone

public Object clone()
Overriden clone method

getActionType

public int getActionType()
Returns a field describing the action (ACTION_CLOSE...).

getDesktop

public DockingDesktop getDesktop()
Returns the desktop used as a receiver (target) of the docking action.

The desktop used as a source (on multi-desktop applications) can be retrieved by asking for the current dockable state (to the DockingContext).


getInitialDockableState

public int getInitialDockableState()
Returns one of the DockableState states reflecting the state of the dockable before the action

getNextDockableState

public int getNextDockableState()
Returns one of the DockableState states reflecting the state of the dockable after the action

© Copyright 2004-2006 VLSolutions. All Rights Reserved.
www.vlsolutions.com : Java Components - Smart Client Applications