org.noos.xing.mydoggy
Interface DockableManager<D extends Dockable>

All Known Subinterfaces:

ContentManager, ToolWindow, ToolWindowManager

public interface DockableManager<D extends Dockable>

This is a markup interface for all Dockable Manager.

Since:

1.4.2

Author:

Angelo De Caro (angelo.decaro@gmail.com)

Method Summary

void	addAlias(D d, Object alias) Associates the specified dockable with the specified alias in this manager.
void	addDockableManagerListener(DockableManagerListener listener) Registers listener so that it will receive events when a dockable is registered or removed.
Object[]	getAliases(D d) Returns all aliases associated to the passed dockable.
D	getDockableById(String id) Returns the dockable whose id is the passed value, null otherwise.
DockableManagerListener[]	getDockableManagerListeners() Returns an array of all the manager listeners registered on this manager.
D[]	getDockables() Returns an array of the dockables registered into this manager.
D	removeAlias(Object alias) Remove the alias from the manager.
void	removeDockableManagerListener(DockableManagerListener listener) Unregisters listener so that it will no longer receive events.

Method Detail

getDockables

D[] getDockables()

Returns an array of the dockables registered into this manager.

Returns:

an array of the dockables registered into this manager. If there is no tool registered then it returns an empty array.

Since:

1.5.0

getDockableById

D getDockableById(String id)

Returns the dockable whose id is the passed value, null otherwise.

Parameters:

id - the dockable id.

Returns:

the dockable whose id is the passed value, null otherwise.

Since:

1.5.0

addAlias

void addAlias(D d,
              Object alias)

Associates the specified dockable with the specified alias in this manager. If the manager previously contained a mapping for this alias, the old dockable is replaced by the specified dockable.

Parameters:

d - dockable to be associated with the specified alias.

alias - alias with which the specified dockable is to be associated.

Since:

1.5.0

getAliases

Object[] getAliases(D d)

Returns all aliases associated to the passed dockable.

Parameters:

d - dockable whose aliases are to be returned.

Returns:

all aliases associated to the passed dockable.

Since:

1.5.0

See Also:

addAlias(Dockable, Object)

removeAlias

D removeAlias(Object alias)

Remove the alias from the manager. If the manager previously contained a mapping for this alias, the dockable is returned.

Parameters:

alias - alias to be removed.

Returns:

If the manager previously contained a mapping for this alias, the dockable is returned.

Since:

1.5.0

addDockableManagerListener

void addDockableManagerListener(DockableManagerListener listener)

Registers listener so that it will receive events when a dockable is registered or removed. If listener listener is null, no exception is thrown and no action is performed.

Parameters:

listener - the ToolWindowManagerListener to register.

Since:

1.4.2

See Also:

ToolWindowManagerListener

removeDockableManagerListener

void removeDockableManagerListener(DockableManagerListener listener)

Unregisters listener so that it will no longer receive events. This method performs no function, nor does it throw an exception, if the listener specified by the argument was not previously added to this group. If listener listener is null, no exception is thrown and no action is performed.

Parameters:

listener - the DockableManagerListener to be removed

Since:

1.4.2

See Also:

addDockableManagerListener(DockableManagerListener)

getDockableManagerListeners

DockableManagerListener[] getDockableManagerListeners()

Returns an array of all the manager listeners registered on this manager.

Returns:

all of the group's DockableManagerListeners or an empty array if no tool window manager listeners are currently registered.

Since:

1.4.2

See Also:

addDockableManagerListener(DockableManagerListener), removeDockableManagerListener(DockableManagerListener)