bibliothek.gui.dock.facile.mode
Class AbstractLocationMode.DockableHandle

java.lang.Object
  bibliothek.gui.dock.facile.mode.AbstractLocationMode.DockableHandle

Enclosing class:

AbstractLocationMode<A extends ModeArea>

protected class AbstractLocationMode.DockableHandle
extends Object

Meta information about a currently registered Dockable.

Author:

Benjamin Sigg

Constructor Summary

AbstractLocationMode.DockableHandle(Dockable dockable)
Creates a new handle.

Method Summary

void	destroy() Called when this handle is no longer of any use
DockActionSource	getActions(Mode<Location> mode) Called by AbstractLocationMode.getActionsFor(Dockable, Mode) to the actions related to this dockable.
Dockable	getDockable() Gets the element of this handle.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractLocationMode.DockableHandle

public AbstractLocationMode.DockableHandle(Dockable dockable)

Creates a new handle.

Parameters:

dockable - the new element, not null

Method Detail

getDockable

public Dockable getDockable()

Gets the element of this handle.

Returns:

the element, not null

destroy

public void destroy()

Called when this handle is no longer of any use

getActions

public DockActionSource getActions(Mode<Location> mode)

Called by AbstractLocationMode.getActionsFor(Dockable, Mode) to the actions related to this dockable. The default implementation is to return a source returned by the current LocationModeActionProvider.

Parameters:

mode - the current mode of this element

Returns:

the actions or null