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

All Superinterfaces:

Observable

All Known Subinterfaces:

Content, ToolWindow, ToolWindowTab

public interface Dockable<M extends DockableManager>
extends Observable

This interface represents the super interface for of all dockable object, i.e. ToolWindow, ToolWindowTab and Content.

Since:

1.4.0

Author:

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

See Also:

ToolWindow, ToolWindowTab, Content

Method Summary

void	ensureVisible() Used to ensure that the dockable is visible.
Component	getComponent() Returns the dockable component.
M	getDockableManager() Returns the DockableManager associated with this dockable.
Icon	getIcon() Returns the dockable icon.
String	getId() Returns the id used to register this dockable.
String	getTitle() Returns the dockable title.
boolean	isDetached() Returns whether or not the dockable is currently detached.
boolean	isFlashing() Returns whether flashing is currently enabled.
boolean	isMaximized() Returns whether this dockable is currently maximized.
boolean	isMinimized() Returns whether this dockable is currently minimized.
boolean	isSelected() Returns whether or not the dockable is currently selected.
boolean	isVisible() Returns true if the dockable is visible, false otherwise.
void	setDetached(boolean detached) This method is used to detach a dockable from its position.
void	setFlashing(boolean flash) Sets the flashing mode.
void	setFlashing(int duration) This method is used to enable flashing for a specific duration.
void	setIcon(Icon icon) This method is used to set the icon for this dockable.
void	setMaximized(boolean maximized) Maximizes this dockable.
void	setMinimized(boolean minimized) Minimizes this dockable.
void	setSelected(boolean selected) Sets whether or not the dockable is selected.
void	setTitle(String title) This method is used to set the title for this dockable.

Methods inherited from interface org.noos.xing.mydoggy.Observable

addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Method Detail

getDockableManager

M getDockableManager()

Returns the DockableManager associated with this dockable.

Returns:

the DockableManager associated with this dockable.

Since:

1.4.2

See Also:

ToolWindowManager, ToolWindow, ContentManager

getId

String getId()

Returns the id used to register this dockable.

Returns:

dockable id.

Since:

1.4.0

getTitle

String getTitle()

Returns the dockable title.

Returns:

the title for the this dockable.

Since:

1.4.0

See Also:

setTitle(String)

setTitle

void setTitle(String title)

This method is used to set the title for this dockable.

Parameters:

title - the new title.

Since:

1.4.0

See Also:

getTitle()

setIcon

void setIcon(Icon icon)

This method is used to set the icon for this dockable.

Parameters:

icon - the new icon.

Since:

1.4.0

See Also:

getIcon()

getIcon

Icon getIcon()

Returns the dockable icon.

Returns:

the icon of this dockable.

Since:

1.4.0

See Also:

setIcon(javax.swing.Icon)

getComponent

Component getComponent()

Returns the dockable component.

Returns:

the component of this dockable.

Since:

1.4.0

setFlashing

void setFlashing(boolean flash)

Sets the flashing mode. For toolwindows if the flashing mode is enabled then the toolwindow representative button will be flashing until the tool will be made visible. If the tool is visible but not active then the toolwindow title bar will be flashing until the tool will be made visible.

Parameters:

flash - true to enable flashing mode; false to disable flashing mode.

Since:

1.4.2

See Also:

isFlashing(), setFlashing(int)

setFlashing

void setFlashing(int duration)

This method is used to enable flashing for a specific duration.

Parameters:

duration - the duration of the flashing in millisiconds.

Since:

1.4.2

See Also:

setFlashing(boolean)

isFlashing

boolean isFlashing()

Returns whether flashing is currently enabled.

Returns:

true if the flashing is currently enabled, false otherwise.

Since:

1.4.2

setDetached

void setDetached(boolean detached)

This method is used to detach a dockable from its position.

Parameters:

detached - true to detach the dockable, false to reattach the dockable into the old position.

Since:

1.4.2

isDetached

boolean isDetached()

Returns whether or not the dockable is currently detached.

Returns:

true if the dockable is detached; false otherwise

Since:

1.4.2

See Also:

setDetached(boolean)

setSelected

void setSelected(boolean selected)

Sets whether or not the dockable is selected.

Parameters:

selected - whether or not the dockable should be selected.

Since:

1.4.2

See Also:

isSelected()

isSelected

boolean isSelected()

Returns whether or not the dockable is currently selected.

Returns:

true if the dockable is selected; false otherwise

Since:

1.4.2

See Also:

setSelected(boolean)

setMaximized

void setMaximized(boolean maximized)

Maximizes this dockable. A maximized dockable is resized to fully fit the related area.

Parameters:

maximized - a boolean, where true maximizes this dockable and false restores it.

Since:

1.4.2

isMaximized

boolean isMaximized()

Returns whether this dockable is currently maximized.

Returns:

true if this dockable is maximized, false otherwise.

Since:

1.4.2

setMinimized

void setMinimized(boolean minimized)

Minimizes this dockable. A minimized dockable is a dockable not visible but available.

Parameters:

minimized - a boolean, where true minimized this dockable and false restores it.

Since:

1.4.2

isMinimized

boolean isMinimized()

Returns whether this dockable is currently minimized.

Returns:

true if this dockable is minimized, false otherwise.

Since:

1.4.2

ensureVisible

void ensureVisible()

Used to ensure that the dockable is visible. The behaviour dependes on the specific dockable (ToolWindow, Content, ToolWindowTab).

Since:

1.4.2

isVisible

boolean isVisible()

Returns true if the dockable is visible, false otherwise.

Returns:

true if the dockable is visible, false otherwise.

Since:

1.4.0