org.noos.xing.mydoggy
Interface ToolWindowManagerDescriptor

All Superinterfaces:

Observable

public interface ToolWindowManagerDescriptor
extends Observable

This interface is used to modify the behaviours of the ToolWindowManager.

Since:

1.2.0

Author:

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

Nested Class Summary

static class

ToolWindowManagerDescriptor.Corner

Method Summary

PushAwayMode	getPushAwayMode() Returns the current push away mode.
PushAwayModeDescriptor	getPushAwayModeDescriptor(PushAwayMode pushAwayMode) Returns the PushAwayModeDescriptor for the passed push away mode if it is supported, null otherwise.
boolean	isNumberingEnabled() Returns the activation status of the toolwindow index shortcuts.
boolean	isPreviewEnabled() Returns true if previews are enabled, false otherwise.
boolean	isShowUnavailableTools() Returns the value of the property "showUnavailableTools"
void	setCornerComponent(ToolWindowManagerDescriptor.Corner corner, Component component) Adds the specified component at the given corner.
void	setNumberingEnabled(boolean numberingEnabled) Enable or disable toolwindow index shortcuts.
void	setPreviewEnabled(boolean previewEnabled) Enables or disables tool window previews.
void	setPushAwayMode(PushAwayMode pushAwayMode) Sets the push away mode to pushAwayMode
void	setShowUnavailableTools(boolean showUnavailableTools) Sets whether or not the representative anchor buttons for unavailable tools are to be shown.

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

addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Method Detail

setPushAwayMode

void setPushAwayMode(PushAwayMode pushAwayMode)

Sets the push away mode to pushAwayMode

Parameters:

pushAwayMode - the new push away mode

Since:

1.2.0

See Also:

PushAwayMode

getPushAwayMode

PushAwayMode getPushAwayMode()

Returns the current push away mode.

Returns:

the current push away mode.

Since:

1.2.0

getPushAwayModeDescriptor

PushAwayModeDescriptor getPushAwayModeDescriptor(PushAwayMode pushAwayMode)

Returns the PushAwayModeDescriptor for the passed push away mode if it is supported, null otherwise.

Parameters:

pushAwayMode - mode whose descriptor is to be returned.

Returns:

the PushAwayModeDescriptor for the passed push away mode if it is supported, null otherwise.

Since:

1.3.0

See Also:

PushAwayModeDescriptor, PushAwayMode

setCornerComponent

void setCornerComponent(ToolWindowManagerDescriptor.Corner corner,
                        Component component)

Adds the specified component at the given corner.

Parameters:

corner - the corner at which to insert the component.

component - the component to be added.

Since:

1.3.0

See Also:

ToolWindowManagerDescriptor.Corner

setNumberingEnabled

void setNumberingEnabled(boolean numberingEnabled)

Enable or disable toolwindow index shortcuts.

Parameters:

numberingEnabled - true to enabled toolwindow index shortcuts, false to disable..

Since:

1.3.1

See Also:

ToolWindow.setIndex(int), isNumberingEnabled()

isNumberingEnabled

boolean isNumberingEnabled()

Returns the activation status of the toolwindow index shortcuts.

Returns:

true is the toolwindow index shortcuts are enabled, false otherwise.

Since:

1.3.1

See Also:

setNumberingEnabled(boolean)

setPreviewEnabled

void setPreviewEnabled(boolean previewEnabled)

Enables or disables tool window previews.

Parameters:

previewEnabled - true to enable previews, false otherwise.

Since:

1.4.0

isPreviewEnabled

boolean isPreviewEnabled()

Returns true if previews are enabled, false otherwise.

Returns:

true if previews are enabled, false otherwise.

Since:

1.4.0

setShowUnavailableTools

void setShowUnavailableTools(boolean showUnavailableTools)

Sets whether or not the representative anchor buttons for unavailable tools are to be shown.

Parameters:

showUnavailableTools - true if you want to show the representative anchor buttons for unavailable tools, false otherwise.

Since:

1.4.1

See Also:

isShowUnavailableTools()

isShowUnavailableTools

boolean isShowUnavailableTools()

Returns the value of the property "showUnavailableTools"

Returns:

true if the representative anchor buttons for unavailable tools are shown, false otherwise.

Since:

1.4.1

See Also:

setShowUnavailableTools(boolean)