org.noos.xing.mydoggy
Interface FloatingTypeDescriptor

All Superinterfaces:

Observable, ToolWindowTypeDescriptor

public interface FloatingTypeDescriptor
extends ToolWindowTypeDescriptor

This interface is used to modify the behaviours of FLOATING and FLOATING_FREE type.

Since:

1.1.0

Author:

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

See Also:

ToolWindowType.FLOATING, ToolWindowType.FLOATING_FREE

Method Summary

Point	getLocation() Gets the location of the window in the form of a point specifying the component's top-left corner.
Dimension	getSize() Returns the size of the window in the form of a Dimension object.
int	getTransparentDelay() Returns the transparent delay.
float	getTransparentRatio() Returns the transparent ratio.
boolean	isAddToTaskBar() Returns the property value of "addToTaskBarWhenDetached".
boolean	isAlwaysOnTop() Returns the value of the alwaysOnTop property.
boolean	isModal() Indicates whether the window used by FLOATING and FLOATING_FREE type is modal.
boolean	isOsDecorated() Returns true if the OS decoration is used, false otherwise.
boolean	isResizable() Returns whether the floatingwindow is resizable by user mouse actions.
boolean	isTransparentMode() Returns the transparent mode.
void	setAddToTaskBar(boolean addToTaskBar) When it sets to true then when the toolwindow is in flaoting mode a button is added to the task bar of your operating system.
void	setAlwaysOnTop(boolean alwaysOnTop) Changes the alwaysOnTop property value used for a floating toolwindow.
void	setLocation(int x, int y) Sets the window location.
void	setModal(boolean modal) Specifies whether the window used by FLOATING and FLOATING_FREE type should be modal.
void	setOsDecorated(boolean osDecorated) Enables or disable the OS decoration.
void	setResizable(boolean resizable) When true, the floating window is not resizable by user mouse actions.
void	setSize(int width, int height) Sets the window size.
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

setLocation

void setLocation(int x,
                 int y)

Sets the window location. This location is also used the first time the window becomes visible. The top-left corner of the new location is specified by the x and y parameters in the system coordinate space.

Parameters:

x - the x-coordinate of the new location's top-left corner in the system's coordinate space

y - the y-coordinate of the new location's top-left corner in the system's coordinate space

Since:

1.1.0

See Also:

getLocation()

getLocation

Point getLocation()

Gets the location of the window in the form of a point specifying the component's top-left corner. The location will be relative to the system coordinate space.

Returns:

an instance of Point representing the top-left corner of the component's bounds in the system coordinate space.

Since:

1.1.0

See Also:

setLocation(int, int)

setSize

void setSize(int width,
             int height)

Sets the window size. This size is also used the first time the window becomes visible.

Parameters:

width - the new width of this component in pixels

height - the new height of this component in pixels

Since:

1.1.0

See Also:

getSize()

getSize

Dimension getSize()

Returns the size of the window in the form of a Dimension object. The height field of the Dimension object contains this window's height, and the width field of the Dimension object contains this window's width.

Returns:

a Dimension object that indicates the size of this window.

Since:

1.1.0

See Also:

setSize(int, int)

setModal

void setModal(boolean modal)

Specifies whether the window used by FLOATING and FLOATING_FREE type should be modal.

Parameters:

modal - true to make the window modal; false otherwise.

Since:

1.1.0

See Also:

isModal()

isModal

boolean isModal()

Indicates whether the window used by FLOATING and FLOATING_FREE type is modal. When a modal window is made visible, user input will be blocked to the other windows in the application.

Returns:

true if this window is modal; false otherwise.

Since:

1.1.0

See Also:

setModal(boolean)

setTransparentMode

void setTransparentMode(boolean transparentMode)

Sets the transparent mode. If the transparent mode is enabled then when the window used by FLOATING and FLOATING_FREE type losts the focus it becomes transparent. This facility is os-dependent.

Parameters:

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

Since:

1.1.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.1.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.1.0

getTransparentRatio

float getTransparentRatio()

Returns the transparent ratio.

Returns:

ratio value used to describe the opacity of the window.

Since:

1.1.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.1.0

getTransparentDelay

int getTransparentDelay()

Returns the transparent delay.

Returns:

delay in milliseconds.

Since:

1.1.0

setAddToTaskBar

void setAddToTaskBar(boolean addToTaskBar)

When it sets to true then when the toolwindow is in flaoting mode a button is added to the task bar of your operating system.

Parameters:

addToTaskBar - true if to the toolwindow is associated a button into the task bar when it is in floating mode, false otherwise.

Since:

1.4.2

isAddToTaskBar

boolean isAddToTaskBar()

Returns the property value of "addToTaskBarWhenDetached".

Returns:

true if to the toolwindow is associated a button into the task bar when it is in floating mode, false otherwise.

Since:

1.4.2

setAlwaysOnTop

void setAlwaysOnTop(boolean alwaysOnTop)

Changes the alwaysOnTop property value used for a floating toolwindow.

Parameters:

alwaysOnTop - new value of always-on-top state of the window.

Since:

1.5.0

isAlwaysOnTop

boolean isAlwaysOnTop()

Returns the value of the alwaysOnTop property.

Returns:

true, if the floating toolwindow is in always-on-top state, false otherwise

Since:

1.5

See Also:

setAlwaysOnTop(boolean)

setOsDecorated

void setOsDecorated(boolean osDecorated)

Enables or disable the OS decoration.

Parameters:

osDecorated - true to enabled the OS decoration, false otherwise.

Since:

1.5.0

isOsDecorated

boolean isOsDecorated()

Returns true if the OS decoration is used, false otherwise.

Returns:

true if the OS decoration is used, false otherwise.

Since:

1.5.0

setResizable

void setResizable(boolean resizable)

When true, the floating window is not resizable by user mouse actions.

Parameters:

resizable - whether user resize is allowed

Since:

1.5.0

isResizable

boolean isResizable()

Returns whether the floatingwindow is resizable by user mouse actions.

Returns:

true if user resize allowed.

Since:

1.5.0