bibliothek.gui.dock.station

Class OrientingDockStationEvent

java.lang.Object

bibliothek.gui.dock.station.OrientingDockStationEvent

public class OrientingDockStationEvent
extends Object

An event fired by an OrientedDockStation if one or many children changed their orientation.

Author:

Benjamin Sigg

Constructor Summary

Constructors

Constructor and Description
OrientingDockStationEvent(OrientingDockStation station) Creates a new event, this is equivalent of calling OrientingDockStationEvent(OrientingDockStation, Dockable[]) with the children array set to null
OrientingDockStationEvent(OrientingDockStation station, Dockable[] children) Creates a new event.

Method Summary

Modifier and Type	Method and Description
Collection<Dockable>	getChildren() Gets all affected children, the collection is not modifiable.
OrientingDockStation	getStation() Gets the source of the event.
boolean	isAffected(Dockable dockable) Tells whether dockable was affected by the event.

Methods inherited from class java.lang.Object

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

Constructor Detail

OrientingDockStationEvent

public OrientingDockStationEvent(OrientingDockStation station)

Creates a new event, this is equivalent of calling OrientingDockStationEvent(OrientingDockStation, Dockable[]) with the children array set to null

Parameters:

station - the source of the event

OrientingDockStationEvent

public OrientingDockStationEvent(OrientingDockStation station,
                                 Dockable[] children)

Creates a new event.

Parameters:

station - the source of the event

children - the affected children or null, if null then all children of station are affected

Method Detail

getStation

public OrientingDockStation getStation()

Gets the source of the event.

Returns:

the source

isAffected

public boolean isAffected(Dockable dockable)

Tells whether dockable was affected by the event.

Parameters:

dockable - some dockable which may or may not be affected

Returns:

true if dockable may have changed its orientation

getChildren

public Collection<Dockable> getChildren()

Gets all affected children, the collection is not modifiable.

Returns:

all affected Dockables