org.noos.xing.mydoggy
Interface ToolWindowTypeDescriptor

All Superinterfaces:

Observable

All Known Subinterfaces:

DockedTypeDescriptor, FloatingLiveTypeDescriptor, FloatingTypeDescriptor, SlidingTypeDescriptor

public interface ToolWindowTypeDescriptor
extends Observable

This is a markup interface for all ToolWindowTypeDescriptor. A ToolWindowTypeDescriptor is an interface to modify the behaviours of a specific tool window type.

Since:

1.0.0

Author:

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

See Also:

ToolWindowType, DockedTypeDescriptor, FloatingTypeDescriptor

Method Summary

boolean	isAnimating() Returns whether the animations are enabled.
boolean	isAutoHide() Returns the autoHide property value of the tool.
boolean	isEnabled() Determines whether this mode is enabled.
boolean	isIdVisibleOnTitleBar() Returns the "idVisibleOnTitleBar" property value.
void	setAnimating(boolean animating) Enables or disables animations, depending on the value of the parameter animating.
void	setAutoHide(boolean autoHide) This method is used to set the autoHide property for the tool.
void	setEnabled(boolean enabled) Enables or disables this mode, depending on the value of the parameter enabled.
void	setIdVisibleOnTitleBar(boolean idVisibleOnTitleBar) Sets if the toolwindow id has to be showed on the title bar when the toolwindow is docked (that is type == DOCKED).

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

addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Method Detail

setAnimating

void setAnimating(boolean animating)

Enables or disables animations, depending on the value of the parameter animating.

Parameters:

animating - If true, animations are enabled; otherwise animations are disabled.

Since:

1.3.0

isAnimating

boolean isAnimating()

Returns whether the animations are enabled.

Returns:

true is the animations are enabled, false otherwise.

Since:

1.3.0

setIdVisibleOnTitleBar

void setIdVisibleOnTitleBar(boolean idVisibleOnTitleBar)

Sets if the toolwindow id has to be showed on the title bar when the toolwindow is docked (that is type == DOCKED).

Parameters:

idVisibleOnTitleBar - true if the toolwindow id has to be showed on the title bar. tool has type ToolWindowType.DOCKED.
false otherwise.

Since:

1.4.0

See Also:

isIdVisibleOnTitleBar()

isIdVisibleOnTitleBar

boolean isIdVisibleOnTitleBar()

Returns the "idVisibleOnTitleBar" property value.

Returns:

true if the toolwindow id has to be showed on the title bar. tool has type ToolWindowType.DOCKED.
false otherwise.

Since:

1.4.0

See Also:

setIdVisibleOnTitleBar(boolean)

setAutoHide

void setAutoHide(boolean autoHide)

This method is used to set the autoHide property for the tool.

Parameters:

autoHide - true to hide the tool when the tool losts focus; false to make inactive the tool when the tool losts focus.

Since:

1.4.2

See Also:

()

isAutoHide

boolean isAutoHide()

Returns the autoHide property value of the tool.

Returns:

autoHide property value.

Since:

1.4.2

See Also:

setAutoHide(boolean)

setEnabled

void setEnabled(boolean enabled)

Enables or disables this mode, depending on the value of the parameter enabled. An enabled mode can used by user.

Parameters:

enabled - If true, this mode is enabled; otherwise this mode is disabled

Since:

1.4.2

See Also:

isEnabled()

isEnabled

boolean isEnabled()

Determines whether this mode is enabled.

Returns:

true if the mode is enabled, false otherwise

Since:

1.4.2

See Also:

setEnabled(boolean)