bibliothek.gui.dock.event
Interface DockableListener

All Known Implementing Classes:
AbstractButtonContentCondition, CloseableDockableMenuPiece.Item, DockableAdapter, StationChildrenActionSource.FocusAction

public interface DockableListener

A listener which is added to a Dockable. These listeners are manly used to update the titles of a Dockable whenever necessary.

Author:
Benjamin Sigg

Method Summary
 void titleBound(Dockable dockable, DockTitle title)
          Will be invoked when a DockTitle was bound to a Dockable.
 void titleExchanged(Dockable dockable, DockTitle title)
          Invoked when the properties of a Dockable have a so dramatically changed, that the DockTitle title is no longer considered a good title and should be replaced.
 void titleIconChanged(Dockable dockable, javax.swing.Icon oldIcon, javax.swing.Icon newIcon)
          Invoked when the title-icon of a Dockable has changed
 void titleTextChanged(Dockable dockable, java.lang.String oldTitle, java.lang.String newTitle)
          Invoked when the title of a Dockable has changed.
 void titleToolTipChanged(Dockable dockable, java.lang.String oldToolTip, java.lang.String newToolTip)
          Called when the tooltip of a Dockable changed.
 void titleUnbound(Dockable dockable, DockTitle title)
          Will be invoked when a DockTitle was unbound from a Dockable.
 

Method Detail

titleBound

void titleBound(Dockable dockable,
                DockTitle title)
Will be invoked when a DockTitle was bound to a Dockable.

Parameters:
dockable - the Dockable whose title is set
title - the new title

titleUnbound

void titleUnbound(Dockable dockable,
                  DockTitle title)
Will be invoked when a DockTitle was unbound from a Dockable.

Parameters:
dockable - the Dockable whose title was removed
title - the remove title

titleTextChanged

void titleTextChanged(Dockable dockable,
                      java.lang.String oldTitle,
                      java.lang.String newTitle)
Invoked when the title of a Dockable has changed.

Parameters:
dockable - the Dockable whose title is changed
oldTitle - the title before the change
newTitle - the title after the change

titleIconChanged

void titleIconChanged(Dockable dockable,
                      javax.swing.Icon oldIcon,
                      javax.swing.Icon newIcon)
Invoked when the title-icon of a Dockable has changed

Parameters:
dockable - the Dockable whose title is changed
oldIcon - the old icon, may be null
newIcon - the new icon, may be null

titleToolTipChanged

void titleToolTipChanged(Dockable dockable,
                         java.lang.String oldToolTip,
                         java.lang.String newToolTip)
Called when the tooltip of a Dockable changed.

Parameters:
dockable - the dockable whose tooltip changed
oldToolTip - the old value
newToolTip - the new value

titleExchanged

void titleExchanged(Dockable dockable,
                    DockTitle title)
Invoked when the properties of a Dockable have a so dramatically changed, that the DockTitle title is no longer considered a good title and should be replaced. The one element which shows title should unbind it, and request a new title.

Parameters:
dockable - the source of the event
title - the title that should be discarded, can be null to alert elements which do show the null-title