com.jidesoft.action.event
Class DockableBarsRearrangedEvent

java.lang.Object
  java.util.EventObject
      java.awt.AWTEvent
          com.jidesoft.action.event.DockableBarsRearrangedEvent

All Implemented Interfaces:

Serializable

public class DockableBarsRearrangedEvent
extends AWTEvent

An AWTEvent that adds support for DockableBarManager objects as the event source.

The event reflects that docked DockableBars have been rearranged. A DockableBar has:

- changed from floating to docked - changed from docked to floating - been added in docked mode - been removed from docked mode - been hidden from docked mode - moved from one DockableContainer to another - moved to a different row/column within the same DockableContainer - moved to a different index within the same row/column in the same DockableContainer - resized in the same row/column in the same DockableContainer.

The event indicates which component was moved and which of the above transitions happened to it.

The event lists its previous and current mode, (docked or floating), DockableContainer, (NORTH, SOUTH, EAST, or WEST), row/column index, item index within the row, and size. (length or height, depending upon its orientation)

When a DockableBar is rearranged, all of the DockableBars after it, in both its previous and current row/column, are also rearranged. Also, if the previous or current row/column contains no other DockableBars, a row/column must have been added or removed; so every DockableBar in every row/column after it is also rearranged.

Therefore, the event also includes a list of all other DockableBars which were rearranged; and each item also lists which transition happened to it along with its previous and current state values.

See Also:

DockableBar, DockableBarListener, Serialized Form

Field Summary

protected List<DockableBarStateTransition>	_otherRearrangedBarsStateTransitions
protected DockableBarStateTransition	_stateTransition
static int	DOCKABLE_BARS_REARRANGED_ADDED_DOCKED This event is delivered when the DockableBar is first added to DockableBarManager in docked mode.
static int	DOCKABLE_BARS_REARRANGED_CHANGED_CONTAINER This event is delivered when the docked DockableBar is moved to a different DockableContainer.
static int	DOCKABLE_BARS_REARRANGED_CHANGED_INDEX This event is delivered when the docked DockableBar is moved to a different index within the same row/column in the same DockableContainer.
static int	DOCKABLE_BARS_REARRANGED_CHANGED_ROW_OR_COLUMN This event is delivered when the docked DockableBar is moved to a different row within the same DockableContainer.
static int	DOCKABLE_BARS_REARRANGED_DOCKED_FLOATED This event is delivered when the docked DockableBar is floated.
static int	DOCKABLE_BARS_REARRANGED_DOCKED_REMOVED This event is delivered when the docked DockableBar is removed from DockableBarManager.
static int	DOCKABLE_BARS_REARRANGED_FIRST The first number in the range of IDs used for DockableBarsRearranged events.
static int	DOCKABLE_BARS_REARRANGED_FLOATING_DOCKED This event is delivered when the floating DockableBar is docked.
static int	DOCKABLE_BARS_REARRANGED_HIDDEN This event is delivered when the docked DockableBar is hidden.
static int	DOCKABLE_BARS_REARRANGED_LAST The last number in the range of IDs used for DockableBarsRearranged events.
static int	DOCKABLE_BARS_REARRANGED_MOVED This event is delivered when the docked DockableBar is moved when it is floating.
static int	DOCKABLE_BARS_REARRANGED_RESIZED This event is delivered when the docked DockableBar is resized at the same index within the same row/column in the same DockableContainer.

Fields inherited from class java.awt.AWTEvent

ACTION_EVENT_MASK, ADJUSTMENT_EVENT_MASK, COMPONENT_EVENT_MASK, consumed, CONTAINER_EVENT_MASK, FOCUS_EVENT_MASK, HIERARCHY_BOUNDS_EVENT_MASK, HIERARCHY_EVENT_MASK, id, INPUT_METHOD_EVENT_MASK, INVOCATION_EVENT_MASK, ITEM_EVENT_MASK, KEY_EVENT_MASK, MOUSE_EVENT_MASK, MOUSE_MOTION_EVENT_MASK, MOUSE_WHEEL_EVENT_MASK, PAINT_EVENT_MASK, RESERVED_ID_MAX, TEXT_EVENT_MASK, WINDOW_EVENT_MASK, WINDOW_FOCUS_EVENT_MASK, WINDOW_STATE_EVENT_MASK

Fields inherited from class java.util.EventObject

source

Constructor Summary

DockableBarsRearrangedEvent(Component source, int id)
Constructs an DockableBarEvent object.

Method Summary

void	addOtherRearrangedBar(DockableBarStateTransition stateTransition)
void	clear()
Component	getComponent() Returns the originator of the event.
List<DockableBarStateTransition>	getOtherRearrangedBarsStateTransitions()
DockableBarStateTransition	getStateTransition() Returns the state transition (ID and pre- and post-states) for the component that originated the event.
String	paramString() Returns a parameter string identifying this event.
void	setComponent(Component newValue)
void	setId(int newValue)
void	setStateTransition(DockableBarStateTransition newValue)

Methods inherited from class java.awt.AWTEvent

consume, getID, isConsumed, setSource, toString

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DOCKABLE_BARS_REARRANGED_FIRST

public static final int DOCKABLE_BARS_REARRANGED_FIRST

The first number in the range of IDs used for DockableBarsRearranged events.

See Also:

Constant Field Values

DOCKABLE_BARS_REARRANGED_LAST

public static final int DOCKABLE_BARS_REARRANGED_LAST

The last number in the range of IDs used for DockableBarsRearranged events.

See Also:

Constant Field Values

DOCKABLE_BARS_REARRANGED_ADDED_DOCKED

public static final int DOCKABLE_BARS_REARRANGED_ADDED_DOCKED

This event is delivered when the DockableBar is first added to DockableBarManager in docked mode.

See Also:

Constant Field Values

DOCKABLE_BARS_REARRANGED_DOCKED_REMOVED

public static final int DOCKABLE_BARS_REARRANGED_DOCKED_REMOVED

This event is delivered when the docked DockableBar is removed from DockableBarManager.

See Also:

Constant Field Values

DOCKABLE_BARS_REARRANGED_DOCKED_FLOATED

public static final int DOCKABLE_BARS_REARRANGED_DOCKED_FLOATED

This event is delivered when the docked DockableBar is floated.

See Also:

Constant Field Values

DOCKABLE_BARS_REARRANGED_FLOATING_DOCKED

public static final int DOCKABLE_BARS_REARRANGED_FLOATING_DOCKED

This event is delivered when the floating DockableBar is docked.

See Also:

Constant Field Values

DOCKABLE_BARS_REARRANGED_HIDDEN

public static final int DOCKABLE_BARS_REARRANGED_HIDDEN

This event is delivered when the docked DockableBar is hidden.

See Also:

Constant Field Values

DOCKABLE_BARS_REARRANGED_CHANGED_CONTAINER

public static final int DOCKABLE_BARS_REARRANGED_CHANGED_CONTAINER

This event is delivered when the docked DockableBar is moved to a different DockableContainer.

See Also:

Constant Field Values

DOCKABLE_BARS_REARRANGED_CHANGED_ROW_OR_COLUMN

public static final int DOCKABLE_BARS_REARRANGED_CHANGED_ROW_OR_COLUMN

This event is delivered when the docked DockableBar is moved to a different row within the same DockableContainer.

See Also:

Constant Field Values

DOCKABLE_BARS_REARRANGED_CHANGED_INDEX

public static final int DOCKABLE_BARS_REARRANGED_CHANGED_INDEX

This event is delivered when the docked DockableBar is moved to a different index within the same row/column in the same DockableContainer.

See Also:

Constant Field Values

DOCKABLE_BARS_REARRANGED_RESIZED

public static final int DOCKABLE_BARS_REARRANGED_RESIZED

This event is delivered when the docked DockableBar is resized at the same index within the same row/column in the same DockableContainer.

See Also:

Constant Field Values

DOCKABLE_BARS_REARRANGED_MOVED

public static final int DOCKABLE_BARS_REARRANGED_MOVED

This event is delivered when the docked DockableBar is moved when it is floating.

See Also:

Constant Field Values

_stateTransition

protected DockableBarStateTransition _stateTransition

_otherRearrangedBarsStateTransitions

protected List<DockableBarStateTransition> _otherRearrangedBarsStateTransitions

Constructor Detail

DockableBarsRearrangedEvent

public DockableBarsRearrangedEvent(Component source,
                                   int id)

Constructs an DockableBarEvent object.

Parameters:

source - the Component object that originated the event (should be a DockableBar)

id - an integer indicating the type of event

Method Detail

paramString

public String paramString()

Returns a parameter string identifying this event. This method is useful for event logging and for debugging.

Overrides:

paramString in class AWTEvent

Returns:

a string identifying the event and its attributes

getComponent

public Component getComponent()

Returns the originator of the event.

Returns:

the Component (should be a DockableBar) object that originated the event

setComponent

public void setComponent(Component newValue)

setId

public void setId(int newValue)

getStateTransition

public DockableBarStateTransition getStateTransition()

Returns the state transition (ID and pre- and post-states) for the component that originated the event.

Returns:

the state transition for the component that originated the event

setStateTransition

public void setStateTransition(DockableBarStateTransition newValue)

addOtherRearrangedBar

public void addOtherRearrangedBar(DockableBarStateTransition stateTransition)

getOtherRearrangedBarsStateTransitions

public List<DockableBarStateTransition> getOtherRearrangedBarsStateTransitions()

clear

public void clear()