bibliothek.gui.dock.common.event

Class CDockableLocationEvent

java.lang.Object

bibliothek.gui.dock.common.event.CDockableLocationEvent

public class CDockableLocationEvent
extends Object

This event object is given to a CDockableLocationListener if the location or the visibility to the user of a CDockable changed.
Please note that any location can be null.

Author:

Benjamin Sigg

Constructor Summary

Constructors

Constructor and Description
CDockableLocationEvent(CDockable dockable, boolean oldShowing, boolean newShowing, CLocation oldLocation, CLocation newLocation) Creates a new event.

Method Summary

Modifier and Type	Method and Description
CDockable	getDockable() Gets the dockable whose state changed.
CLocation	getNewLocation() Gets the location of the dockable after this event
boolean	getNewShowing() Tells whether the user can see the dockable after this event
boolean	getNewVisible() Deprecated. replaced by getNewShowing()
CLocation	getOldLocation() Gets the location of the dockable before this event
boolean	getOldShowing() Tells whether the user could see the dockable before this event
boolean	getOldVisible() Deprecated. replaced by getOldShowing()
boolean	isLocationChanged() Tells whether the location of the dockable changed.
boolean	isShowingChanged() Tells whether the showing state of the dockable changed
boolean	isVisibleChanged() Deprecated. this method gets replaced by isShowingChanged()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CDockableLocationEvent

public CDockableLocationEvent(CDockable dockable,
                              boolean oldShowing,
                              boolean newShowing,
                              CLocation oldLocation,
                              CLocation newLocation)

Creates a new event.

Parameters:

dockable - the source of the event

oldShowing - the old visibility state

newShowing - the new visibility state

oldLocation - the old location, may be null

newLocation - the new location, may be null

Method Detail

getDockable

public CDockable getDockable()

Gets the dockable whose state changed.

Returns:

the element whose state changed

isLocationChanged

public boolean isLocationChanged()

Tells whether the location of the dockable changed.

Returns:

whether the location changed

getOldLocation

public CLocation getOldLocation()

Gets the location of the dockable before this event

Returns:

the old location, can be null

getNewLocation

public CLocation getNewLocation()

Gets the location of the dockable after this event

Returns:

the new location, can be null

isVisibleChanged

@Deprecated
 @Todo(compatibility=BREAK_MAJOR,
      priority=ENHANCEMENT,
      target=VERSION_1_1_3,
      description="remove this method")
public boolean isVisibleChanged()

Deprecated. this method gets replaced by isShowingChanged()

Tells whether the visibility state of the dockable changed

Returns:

whether the visibility state changed

isShowingChanged

public boolean isShowingChanged()

Tells whether the showing state of the dockable changed

Returns:

whether the showing state changed

getOldVisible

@Deprecated
 @Todo(compatibility=BREAK_MAJOR,
      priority=ENHANCEMENT,
      target=VERSION_1_1_3,
      description="remove this method")
public boolean getOldVisible()

Deprecated. replaced by getOldShowing()

Tells whether the user could see the dockable before this event

Returns:

the old visibility state

getOldShowing

public boolean getOldShowing()

Tells whether the user could see the dockable before this event

Returns:

the old visibility state

getNewVisible

@Todo(compatibility=BREAK_MAJOR,
      priority=ENHANCEMENT,
      target=VERSION_1_1_3,
      description="remove this method")
 @Deprecated
public boolean getNewVisible()

Deprecated. replaced by getNewShowing()

Tells whether the user can see the dockable after this event

Returns:

the new visibility state

getNewShowing

public boolean getNewShowing()

Tells whether the user can see the dockable after this event

Returns:

the new visibility state

toString

public String toString()

Overrides:

toString in class Object