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

void	addToolWindowAction(ToolWindowAction toolWindowAction) Register or replace, if an action with the same id is already registered, a new action.
void	addToolWindowAction(ToolWindowAction toolWindowAction, int index) Register or replace, if an action with the same id is already registered, a new action.
ToolWindowAction	getToolWindowAction(String id) Returns the toolWindow action to which this descriptor maps the specified id.
ToolWindowAction[]	getToolWindowActions() Returns an array of the toolwindow actions registered into this descriptor.
ToolWindowType	getType() Returns the type whom this descriptor is for.
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	isHideRepresentativeButtonOnVisible() Returns the "hideRepresentativeButtonOnVisible" property value.
boolean	isIdVisibleOnTitleBar() Returns true if the toolwindow's id is visible, false otherwise.
boolean	isTitleBarButtonsVisible() Returns true if the toolwindow's action buttons are visible on the title bar, false otherwise.
boolean	isTitleBarVisible() Returns true if the toolwindow's title bar, false otherwise.
void	removeToolWindowAction(String id) Removes a toolwindow action by id from this descriptor if it is present.
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	setHideRepresentativeButtonOnVisible(boolean hideRepresentativeButtonOnVisible) Sets if mydoggy must hide the representative button when the tool become visible and the tool has type ToolWindowType.DOCKED.
void	setIdVisibleOnTitleBar(boolean idVisibleOnTitleBar) Shows of hides the toolwindow's id on the title bar..
void	setTitleBarButtonsVisible(boolean titleBarButtonsVisible) Shows or hides the toolwindow's action buttons on title bar.
void	setTitleBarVisible(boolean titleBarVisible) Shows or hides the toolwindow's title bar.

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

addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Method Detail

getType

ToolWindowType getType()

Returns the type whom this descriptor is for.

Returns:

the type whom this descriptor is for.

Since:

1.5.0

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)

Shows of hides the toolwindow's id on the title bar..

Parameters:

idVisibleOnTitleBar - true to show the id on the title bar, false to hide.

Since:

1.4.0

See Also:

isIdVisibleOnTitleBar()

isIdVisibleOnTitleBar

boolean isIdVisibleOnTitleBar()

Returns true if the toolwindow's id is visible, false otherwise.

Returns:

true if the toolwindow's id is visible, false otherwise.

Since:

1.4.0

See Also:

setIdVisibleOnTitleBar(boolean)

setTitleBarButtonsVisible

void setTitleBarButtonsVisible(boolean titleBarButtonsVisible)

Shows or hides the toolwindow's action buttons on title bar.

Parameters:

titleBarButtonsVisible - true to show the action buttons on the title bar, false to hide.

Since:

1.5.0

See Also:

isIdVisibleOnTitleBar()

isTitleBarButtonsVisible

boolean isTitleBarButtonsVisible()

Returns true if the toolwindow's action buttons are visible on the title bar, false otherwise.

Returns:

true if the toolwindow's action buttons are visible on the title bar, false otherwise.

Since:

1.5.0

See Also:

setIdVisibleOnTitleBar(boolean)

setTitleBarVisible

void setTitleBarVisible(boolean titleBarVisible)

Shows or hides the toolwindow's title bar.

Parameters:

titleBarVisible - true to show the title bar, false to hide.

Since:

1.5.0

See Also:

isIdVisibleOnTitleBar()

isTitleBarVisible

boolean isTitleBarVisible()

Returns true if the toolwindow's title bar, false otherwise.

Returns:

true if the toolwindow's title bar, false otherwise.

Since:

1.5.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()

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)

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.5.0

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.5.0

addToolWindowAction

void addToolWindowAction(ToolWindowAction toolWindowAction)

Register or replace, if an action with the same id is already registered, a new action.

Parameters:

toolWindowAction - the action to be registered or replaced.

Since:

1.5.0

See Also:

ToolWindowAction

addToolWindowAction

void addToolWindowAction(ToolWindowAction toolWindowAction,
                         int index)

Register or replace, if an action with the same id is already registered, a new action.

Parameters:

toolWindowAction - the action to be registered or replaced.

index - the index where to put the action.

Since:

1.5.0

See Also:

ToolWindowAction

getToolWindowAction

ToolWindowAction getToolWindowAction(String id)

Returns the toolWindow action to which this descriptor maps the specified id. Returns null if the descriptor contains no mapping for this id.

Parameters:

id - id whose associated toolWindow is to be returned.

Returns:

the toolWindow action to which this descriptor maps the specified id. Returns null if the descriptor contains no mapping for this id.

Since:

1.5.0

getToolWindowActions

ToolWindowAction[] getToolWindowActions()

Returns an array of the toolwindow actions registered into this descriptor.

Returns:

an array of the toolwindow actions registered into this descriptor

Since:

1.5.0

removeToolWindowAction

void removeToolWindowAction(String id)

Removes a toolwindow action by id from this descriptor if it is present.

Parameters:

id - the toolwindow action's id to be removed.

Since:

1.5.0