org.noos.xing.mydoggy
Interface ContentUI

All Superinterfaces:

DockableUI, Observable

All Known Subinterfaces:

DesktopContentUI, MultiSplitContentUI, TabbedContentUI

public interface ContentUI
extends DockableUI

This interface is used to modify the ui behaviours of a single content.

Since:

1.1.0

Author:

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

See Also:

TabbedContentUI, DesktopContentUI

Method Summary

Content	getContent() Returns the Content contropart of this ContentUI.
Rectangle	getDetachedBounds() Returns the bounds of the detached window from the last detached session.
int	getTransparentDelay() Returns the transparent delay.
float	getTransparentRatio() Returns the transparent ratio.
boolean	isAddToTaskBarWhenDetached() Returns the property value of "addToTaskBarWhenDetached".
boolean	isAlwaysOnTop() Returns the value of the alwaysOnTop property.
boolean	isCloseable() Returns whether this content could be close using the ui.
boolean	isDetachable() Returns whether this content could be detach using the ui.
boolean	isMaximizable() Returns whether this content could be maximized using the ui.
boolean	isMinimizable() Returns whether this content could be minimized using the ui.
boolean	isTransparentMode() Returns the transparent mode.
void	setAddToTaskBarWhenDetached(boolean addToTaskBarWhenDetached) When it sets to true then when the content is detached a button is added to the task bar of your operating system.
void	setAlwaysOnTop(boolean alwaysOnTop) Changes the alwaysOnTop property value used for the window associated to the detache content.
void	setCloseable(boolean closeable) Sets the closeable property of this content.
void	setConstraints(Object... contraints) Set up contraints for the content.
void	setDetachable(boolean detachable) Sets the detachable property of this content.
void	setDetachedBounds(Rectangle detachedBounds) Sets the bounds for the next detached session.
void	setMaximizable(boolean maximizable) Sets the maximizable property of this content.
void	setMinimizable(boolean minimizable) Sets the minimizable property of this content.
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.Observable

addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Method Detail

getContent

Content getContent()

Returns the Content contropart of this ContentUI.

Returns:

the Content contropart.

Since:

1.2.0

isCloseable

boolean isCloseable()

Returns whether this content could be close using the ui.

Returns:

true if this content can be closed using the ui, false otherwise.

Since:

1.1.0

See Also:

setCloseable(boolean)

setCloseable

void setCloseable(boolean closeable)

Sets the closeable property of this content.

Parameters:

closeable - true if this content can be closed using the ui, false otherwise.

Since:

1.1.0

See Also:

isCloseable()

isDetachable

boolean isDetachable()

Returns whether this content could be detach using the ui.

Returns:

true if this content can be detached using the ui, false otherwise.

Since:

1.1.0

setDetachable

void setDetachable(boolean detachable)

Sets the detachable property of this content.

Parameters:

detachable - true if this content can be detached using the ui, false otherwise.

Since:

1.1.0

See Also:

isDetachable()

isMinimizable

boolean isMinimizable()

Returns whether this content could be minimized using the ui.

Returns:

true if this content can be minimized using the ui, false otherwise.

Since:

1.4.2

setMinimizable

void setMinimizable(boolean minimizable)

Sets the minimizable property of this content.

Parameters:

minimizable - true if this content can be minimized using the ui, false otherwise.

Since:

1.4.2

See Also:

()

isMaximizable

boolean isMaximizable()

Returns whether this content could be maximized using the ui.

Returns:

true if this content can be maximized using the ui, false otherwise.

Since:

1.5.0

setMaximizable

void setMaximizable(boolean maximizable)

Sets the maximizable property of this content.

Parameters:

maximizable - true if this content can be maximized using the ui, false otherwise.

Since:

1.5.0

See Also:

isMaximizable()

setTransparentMode

void setTransparentMode(boolean transparentMode)

Sets the transparent mode. If the transparent mode is enabled then when the content is detached and the window containing the content losts the focus then the window becomes transparent. This facility is os-dependent.

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

setConstraints

void setConstraints(Object... contraints)

Set up contraints for the content. This dependes on the spcific ContentManagerUI mounted.

Parameters:

contraints - the constraint to bound the content into the ui.

Since:

1.4.0

getDetachedBounds

Rectangle getDetachedBounds()

Returns the bounds of the detached window from the last detached session.

Returns:

the bounds.

Since:

1.4.1

setDetachedBounds

void setDetachedBounds(Rectangle detachedBounds)

Sets the bounds for the next detached session.

Parameters:

detachedBounds - bounds to be setted.

Since:

1.4.1

setAddToTaskBarWhenDetached

void setAddToTaskBarWhenDetached(boolean addToTaskBarWhenDetached)

When it sets to true then when the content is detached a button is added to the task bar of your operating system.

Parameters:

addToTaskBarWhenDetached - true if to the content is associated a button into the task bar when it is detached, false otherwise.

Since:

1.4.2

isAddToTaskBarWhenDetached

boolean isAddToTaskBarWhenDetached()

Returns the property value of "addToTaskBarWhenDetached".

Returns:

true if to the content is associated a button into the task bar when it is detached, false otherwise.

Since:

1.4.2

setAlwaysOnTop

void setAlwaysOnTop(boolean alwaysOnTop)

Changes the alwaysOnTop property value used for the window associated to the detache content.

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 content window is in always-on-top state, false otherwise

Since:

1.5

See Also:

setAlwaysOnTop(boolean)