bibliothek.gui.dock.title

Class DockTitleEvent

java.lang.Object

bibliothek.gui.dock.title.DockTitleEvent

Direct Known Subclasses:

ActionsDockTitleEvent, ActivityDockTitleEvent

public class DockTitleEvent
extends Object

These events are used for DockTitles, to transfer information between station and title. See the method DockTitle.changed(DockTitleEvent) for more details.

Author:

Benjamin Sigg

Constructor Summary

Constructors

Constructor and Description
DockTitleEvent(Dockable dockable) Constructs a new event.
DockTitleEvent(DockStation station, Dockable dockable) Constructs a new event.

Method Summary

Modifier and Type	Method and Description
Dockable	getDockable() Gets the Dockable for which the target-title is used.
DockStation	getStation() Gets the station which created the event, and on which the target-title is displayed.

Methods inherited from class java.lang.Object

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

Constructor Detail

DockTitleEvent

public DockTitleEvent(Dockable dockable)

Constructs a new event.

Parameters:

dockable - the Dockable for which the target-title is rendered

DockTitleEvent

public DockTitleEvent(DockStation station,
                      Dockable dockable)

Constructs a new event. This constructor should only be called if a DockStation itself sends the event. Other components should use DockTitleEvent(Dockable).

Parameters:

station - the station on which the target-title is displayed

dockable - the Dockable for which the target-title is rendered

Method Detail

getStation

public DockStation getStation()

Gets the station which created the event, and on which the target-title is displayed.

Returns:

the station, null if the event was not sent by the station

getDockable

public Dockable getDockable()

Gets the Dockable for which the target-title is used.

Returns:

the owner of the title