org.noos.xing.mydoggy
Interface ToolWindowBar

All Superinterfaces:

Observable

public interface ToolWindowBar
extends Observable

This interface is used to modify all toolwindow anchor related properties.

Since:

1.4.2

Author:

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

See Also:

ToolWindowAnchor, ToolWindowManager.getToolWindowBar(ToolWindowAnchor)

Method Summary

boolean	areToolsVisible() Returns the value of visible property.
ToolWindowAnchor	getAnchor() Returns the reference anchor.
int	getDividerSize() Returns the size of the border the separate a docked toolwindow from the contenManager for the specified anchor.
int	getLength() Returns the length in pixel of the bar.
JPopupMenu	getPopupMenu() Returns the popup menu.
ToolWindowManager	getToolWindowManager() Returns the toolwindow manager related to this bar.
ToolWindow[]	getToolWindows() Returns an array of the toolwindows attached on this bar.
boolean	isAggregateMode() Returns aggregate mode value for this anchor.
boolean	isVisible() TODO
void	setAggregateMode(boolean enable) Sets the aggregate mode for tools on the this anchor.
void	setDividerSize(int size) Sets the size of the border the separate a docked toolwindow from the contenManager for a specific anchor.
void	setLength(int length) Sets the length in pixel of the bar.
void	setPopupMenu(JPopupMenu popupMenu) Sets the popup menu to popupMenu.
void	setToolsVisible(boolean visible) This method is used to store and restore the toolwindows visible on this bar.
void	setVisible(boolean visible) TODO:

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

addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Method Detail

getToolWindowManager

ToolWindowManager getToolWindowManager()

Returns the toolwindow manager related to this bar.

Returns:

the toolwindow manager related to this bar.

getAnchor

ToolWindowAnchor getAnchor()

Returns the reference anchor.

Returns:

the reference anchor.

Since:

1.4.2

See Also:

ToolWindowAnchor

setDividerSize

void setDividerSize(int size)

Sets the size of the border the separate a docked toolwindow from the contenManager for a specific anchor.

Parameters:

size - an integer giving the size of the divider in pixels

Since:

1.4.2

See Also:

getDividerSize(), ToolWindowAnchor

getDividerSize

int getDividerSize()

Returns the size of the border the separate a docked toolwindow from the contenManager for the specified anchor.

Returns:

the size of the border

Since:

1.4.2

See Also:

setDividerSize(int)

setAggregateMode

void setAggregateMode(boolean enable)

Sets the aggregate mode for tools on the this anchor.

Parameters:

enable - aggregate mode value.

Since:

1.4.2

isAggregateMode

boolean isAggregateMode()

Returns aggregate mode value for this anchor.

Returns:

aggregate mode value.

Since:

1.4.2

setPopupMenu

void setPopupMenu(JPopupMenu popupMenu)

Sets the popup menu to popupMenu.

Parameters:

popupMenu - the popup menu for the bar.

Since:

1.4.2

See Also:

getPopupMenu()

getPopupMenu

JPopupMenu getPopupMenu()

Returns the popup menu.

Returns:

the popup menu.

Since:

1.4.2

See Also:

setPopupMenu(javax.swing.JPopupMenu)

setLength

void setLength(int length)

Sets the length in pixel of the bar.

Parameters:

length - length in pixel of the bar.

Since:

1.4.2

getLength

int getLength()

Returns the length in pixel of the bar.

Returns:

the length in pixel of the bar

Since:

1.4.2

getToolWindows

ToolWindow[] getToolWindows()

Returns an array of the toolwindows attached on this bar.

Returns:

an array of the toolwindows attached on this bar.

Since:

1.4.2

isVisible

boolean isVisible()

TODO

See Also:

setVisible(boolean)

setVisible

void setVisible(boolean visible)

TODO:

Since:

1.5.0

areToolsVisible

boolean areToolsVisible()

Returns the value of visible property.

Returns:

false if the last call to setVisible was with a false, true otherwise.

Since:

1.5.0

See Also:

setToolsVisible(boolean)

setToolsVisible

void setToolsVisible(boolean visible)

This method is used to store and restore the toolwindows visible on this bar. So when you call setVisible(false) the current state of the bar is stored and all docked toolwindows visible on this bar are hidden. When you after call setVisible(true) the state of the bar is restored to the previous saved state.

Parameters:

visible - false to store the state of the bar and hide all docked toolwindows. true to restore the previous saved state if any.

Since:

1.5.0

See Also:

areToolsVisible()