org.noos.xing.mydoggy
Interface DockedTypeDescriptor

All Superinterfaces:

Observable, ToolWindowTypeDescriptor

public interface DockedTypeDescriptor
extends ToolWindowTypeDescriptor

This interface is used to modify the behaviours of DOCKED type.

Since:

1.0.0

Author:

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

See Also:

ToolWindowType.DOCKED

Method Summary

int	getDockLength() Returns the dock panel length.
int	getMinimumDockLength() Returns the minimum dock length used during toolwindow showing.
int	getPreviewDelay() Returns the preview delay.
float	getPreviewTransparentRatio() Returns the transparent ratio.
javax.swing.JMenu	getToolsMenu() The user can add customized menu items to the popup menu of the representative anchor button of this tool using the result of this method invocation.
ToolWindowActionHandler	getToolWindowActionHandler() Returns the ToolWindowActionHandler instance or null if it is not present.
boolean	isHideRepresentativeButtonOnVisible() Returns the "hideRepresentativeButtonOnVisible" property value.
boolean	isPopupMenuEnabled() Indicates whether the popup menu of the representative anchor button of the tool is enabled.
boolean	isPreviewEnabled() Returns the preview mode status.
void	setDockLength(int dockLength) Sets the width or heigth, based on anchor of tool window, of the dock panel.
void	setHideRepresentativeButtonOnVisible(boolean hideRepresentativeButtonOnVisible) Sets if mydoggy must hide the representative button when the tool become visible and the tool has type ToolWindowType.DOCKED.
void	setMinimumDockLength(int minimumDockLength) Sets the minimum dock length.
void	setPopupMenuEnabled(boolean enabled) Specifies whether the popup menu of the representative anchor button of the tool should be enabled.
void	setPreviewDelay(int delay) Sets the preview delay.
void	setPreviewEnabled(boolean enabled) Sets the preview mode.
void	setPreviewTransparentRatio(float transparentRatio) Sets the transparent ratio of the preview.
void	setToolWindowActionHandler(ToolWindowActionHandler toolWindowActionHandler) Sets the ToolWindowActionHandler to this descriptor.

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

isAnimating, isAutoHide, isEnabled, isIdVisibleOnTitleBar, setAnimating, setAutoHide, setEnabled, setIdVisibleOnTitleBar

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

addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Method Detail

setPopupMenuEnabled

void setPopupMenuEnabled(boolean enabled)

Specifies whether the popup menu of the representative anchor button of the tool should be enabled.

Parameters:

enabled - true to enable popup menu. false otherwise.

Since:

1.0.0

See Also:

ToolWindowType, isPopupMenuEnabled(), ToolWindowAnchor

isPopupMenuEnabled

boolean isPopupMenuEnabled()

Indicates whether the popup menu of the representative anchor button of the tool is enabled.

Returns:

true if the popup menu is enabled; false otherwise.

Since:

1.0.0

See Also:

setPopupMenuEnabled(boolean), ToolWindowAnchor

getToolsMenu

javax.swing.JMenu getToolsMenu()

The user can add customized menu items to the popup menu of the representative anchor button of this tool using the result of this method invocation.

Returns:

the menu where to add new menu items.

Since:

1.0.0

See Also:

ToolWindowAnchor

setDockLength

void setDockLength(int dockLength)

Sets the width or heigth, based on anchor of tool window, of the dock panel. This value is used by DOCKED and SLIDING tool window type.

Parameters:

dockLength -

Since:

1.0.0

See Also:

getDockLength()

getDockLength

int getDockLength()

Returns the dock panel length.

Returns:

the dock panel length.

Since:

1.0.0

See Also:

setDockLength(int)

setMinimumDockLength

void setMinimumDockLength(int minimumDockLength)

Sets the minimum dock length. This information is used every time a toolwindow (in docked or sliding mode) is showed.

Parameters:

minimumDockLength - the minimum dock length.

Since:

1.4.2

getMinimumDockLength

int getMinimumDockLength()

Returns the minimum dock length used during toolwindow showing.

Returns:

the minimum dock length.

Since:

1.4.2

getToolWindowActionHandler

ToolWindowActionHandler getToolWindowActionHandler()

Returns the ToolWindowActionHandler instance or null if it is not present.

Returns:

the ToolWindowActionHandler instance.

Since:

1.2.0

See Also:

ToolWindowActionHandler, setToolWindowActionHandler(ToolWindowActionHandler)

setToolWindowActionHandler

void setToolWindowActionHandler(ToolWindowActionHandler toolWindowActionHandler)

Sets the ToolWindowActionHandler to this descriptor.

Parameters:

toolWindowActionHandler - the handler.

Since:

1.2.0

See Also:

ToolWindowActionHandler, getToolWindowActionHandler(), getToolWindowActionHandler()

setPreviewEnabled

void setPreviewEnabled(boolean enabled)

Sets the preview mode. If the preview mode is enabled then when the mouse waits on the toolwindow representative button after a delay time the preview will become visible.

Parameters:

enabled - true to enable preview mode; false to disable preview mode.

Since:

1.3.0

See Also:

isPreviewEnabled()

isPreviewEnabled

boolean isPreviewEnabled()

Returns the preview mode status.

Returns:

true if the preview mode is enabled; false otherwise.

Since:

1.3.0

See Also:

setPreviewEnabled(boolean)

setPreviewDelay

void setPreviewDelay(int delay)

Sets the preview delay. When the mouse waits on the toolwindow representative button after a delay time the preview will become visible if the preview mode is enabled.

Parameters:

delay - the preview delay

Since:

1.3.0

See Also:

getPreviewDelay()

getPreviewDelay

int getPreviewDelay()

Returns the preview delay.

Returns:

preview delay in milliseconds.

Since:

1.3.0

See Also:

setPreviewDelay(int)

setPreviewTransparentRatio

void setPreviewTransparentRatio(float transparentRatio)

Sets the transparent ratio of the preview. Valid range is [0.0, 1.0]

Parameters:

transparentRatio - the transparent ratio.

Since:

1.3.0

See Also:

getPreviewTransparentRatio()

getPreviewTransparentRatio

float getPreviewTransparentRatio()

Returns the transparent ratio.

Returns:

ratio value used to describe the opacity of the preview.

Since:

1.3.0

See Also:

setPreviewTransparentRatio(float)

setHideRepresentativeButtonOnVisible

void setHideRepresentativeButtonOnVisible(boolean hideRepresentativeButtonOnVisible)

Sets if mydoggy must hide the representative button when the tool become visible and the tool has type ToolWindowType.DOCKED.

Parameters:

hideRepresentativeButtonOnVisible - true if mydoggy must hide the representative button when the tool become visible and the tool has type ToolWindowType.DOCKED.
false otherwise.

Since:

1.3.1

isHideRepresentativeButtonOnVisible

boolean isHideRepresentativeButtonOnVisible()

Returns the "hideRepresentativeButtonOnVisible" property value.

Returns:

true if mydoggy must hide the representative button when the tool become visible and the tool has type ToolWindowType.DOCKED.
false otherwise.

Since:

1.3.1