ilog.views.appframe.swing

Interface IlvDockingBarArea.DockingBarInfo

Enclosing class:

IlvDockingBarArea

public static interface IlvDockingBarArea.DockingBarInfo

Provides docking information for a bar managed by a docking bar area.

Method Summary

Modifier and Type	Method and Description
int	getDockingSide() Returns the side of the docking bar area panel in which the bar is placed when the bar is docked.
Point	getFloatingLocation() Returns the location of the floating window containing the bar when it is undocked.
String	getName() Returns the name of the bar that this object provides information for.
boolean	isDocked() Determines whether the bar is docked.
boolean	isUndocked() Determines whether the bar is undocked.
boolean	isVisible() Determines whether the bar is visible.

Method Detail

getName

String getName()

Returns the name of the bar that this object provides information for.

isVisible

boolean isVisible()

Determines whether the bar is visible.

Returns:

true if the bar is visible; false otherwise.

isDocked

boolean isDocked()

Determines whether the bar is docked.

Returns:

true if the bar is docked; false otherwise.

isUndocked

boolean isUndocked()

Determines whether the bar is undocked.

Returns:

true if the bar is undocked; false otherwise.

getDockingSide

int getDockingSide()

Returns the side of the docking bar area panel in which the bar is placed when the bar is docked.

Returns:

the docking side. The returned value is one of the following values:

• SwingConstants.LEFT
• SwingConstants.TOP
• SwingConstants.RIGHT
• SwingConstants.BOTTOM

getFloatingLocation

Point getFloatingLocation()

Returns the location of the floating window containing the bar when it is undocked.

Returns:

the bounds of the floating window - can be null if the bar has never been undocked and if no undocking position were specified for the bar in the settings of the docking bar area.