org.noos.xing.mydoggy
Interface SlidingTypeDescriptor

All Superinterfaces:

Observable, ToolWindowTypeDescriptor

public interface SlidingTypeDescriptor
extends ToolWindowTypeDescriptor

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

Since:

1.2.0

Author:

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

See Also:

ToolWindowType.SLIDING

Method Summary

int	getTransparentDelay() Returns the transparent delay.
float	getTransparentRatio() Returns the transparent ratio.
boolean	isTransparentMode() Returns the transparent mode.
void	setTransparentDelay(int transparentDelay) Sets the transparent delay.
void	setTransparentMode(boolean transparentMode) Sets the transparent mode.
void	setTransparentRatio(float transparentRatio) Sets the transparent ratio.

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

addToolWindowAction, addToolWindowAction, getToolWindowAction, getToolWindowActions, getType, isAnimating, isAutoHide, isEnabled, isHideRepresentativeButtonOnVisible, isIdVisibleOnTitleBar, isTitleBarButtonsVisible, isTitleBarVisible, removeToolWindowAction, setAnimating, setAutoHide, setEnabled, setHideRepresentativeButtonOnVisible, setIdVisibleOnTitleBar, setTitleBarButtonsVisible, setTitleBarVisible

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

addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Method Detail

setTransparentMode

void setTransparentMode(boolean transparentMode)

Sets the transparent mode. If the transparent mode is enabled then when the toolwindow's content losts the focus it becomes transparent. This facility is os-independent.

Parameters:

transparentMode - true to enable trasparent mode; false to disable transparent mode.

Since:

1.2.0

See Also:

isTransparentMode(), setTransparentRatio(float)

isTransparentMode

boolean isTransparentMode()

Returns the transparent mode.

Returns:

true if the trasparent mode is enabled; false otherwise.

Since:

1.2.0

See Also:

setTransparentMode(boolean)

setTransparentRatio

void setTransparentRatio(float transparentRatio)

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

Parameters:

transparentRatio - the transparent ratio.

Since:

1.2.0

getTransparentRatio

float getTransparentRatio()

Returns the transparent ratio.

Returns:

ratio value used to describe the opacity of the window.

Since:

1.2.0

setTransparentDelay

void setTransparentDelay(int transparentDelay)

Sets the transparent delay. When the window losts focus, after delay time the window will become transparent.

Parameters:

transparentDelay - the transparent delay

Since:

1.2.0

getTransparentDelay

int getTransparentDelay()

Returns the transparent delay.

Returns:

delay in milliseconds.

Since:

1.2.0