com.softwarefx.chartfx.server
Class DockableBar

java.lang.Object
  com.softwarefx.chartfx.server.DockableBar

Direct Known Subclasses:

DataGrid, LegendBox, LegendBox, ToolBar

public abstract class DockableBar
extends Object

Provides access to the DockableBar object, which is the parent class of objects such as the LegendBox, the ToolBar, and the DataGrid.

The background color may be modified using the setBackColor(java.awt.Color) property.

Using the setDock(com.softwarefx.chartfx.server.DockArea) property, you can dock the bar in different areas of the Chart.

You must make the bar setVisible(boolean) in order to see any of the visual attributes configured using the properties of the Class .

The following properties of the Chartreturn objects inheriting from DockableBar: Chart.getLegendBox(), Chart.getToolBar(), Chart.getMenuBar(), and Chart.getDataGrid().

Dragging the legend box (end user) is not supported but may be positioned in the chart area using the setDock(com.softwarefx.chartfx.server.DockArea) property. Functionality has been added to the legends to enhance the appearance in a docked position (left, right, top or bottom). For example, you can include borders around a legend or leave them in the default compacted view. By modifying visual attributes, the legend box appears to be floating but it is attach to a logical position that will change as the chart size changes.

Constructor Summary

DockableBar()

Method Summary

Color	getBackColor() Gets the BackColor.
DockBorder	getBorder() Gets the Border.
DockArea	getDock() Gets the Dock.
int	getHeight() Gets the Height.
int	getWidth() Gets the Width.
int	getZOrder() Gets the ZOrder.
boolean	isAutoSize() Gets the AutoSize.
boolean	isVisible() Gets the Visible.
void	resetBackColor() Resets the BackColor of DockableBar to the default.
void	setAutoSize(boolean value) Allows Chart FX for Java to calculate the best size according to the tool position.
void	setBackColor(Color value) Sets a value for the background color of a dockable bar.
void	setBorder(DockBorder value) Allows the developer to specify the border style.
void	setDock(DockArea value) Sets the position of the data grid.
void	setHeight(int value) Sets the height of the dockable bar in pixels.
void	setVisible(boolean value) Sets a value indicating the Dockablebar object should be shown or not.
void	setWidth(int value) Sets the height in pixels.
void	setZOrder(int value) Sets the z-order for a dockable bar.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DockableBar

public DockableBar()

Method Detail

getBackColor

public Color getBackColor()

Gets the BackColor. For more detail see setBackColor(java.awt.Color).

getBorder

public DockBorder getBorder()

Gets the Border. For more detail see setBorder(com.softwarefx.chartfx.server.DockBorder).

getDock

public DockArea getDock()

Gets the Dock. For more detail see setDock(com.softwarefx.chartfx.server.DockArea).

getHeight

public int getHeight()

Gets the Height. For more detail see setHeight(int).

getWidth

public int getWidth()

Gets the Width. For more detail see setWidth(int).

getZOrder

public int getZOrder()

Gets the ZOrder. For more detail see setZOrder(int).

isAutoSize

public boolean isAutoSize()

Gets the AutoSize. For more detail see setAutoSize(boolean).

isVisible

public boolean isVisible()

Gets the Visible. For more detail see setVisible(boolean).

resetBackColor

public void resetBackColor()

Resets the BackColor of DockableBar to the default.

setAutoSize

public void setAutoSize(boolean value)

Allows Chart FX for Java to calculate the best size according to the tool position.

Remarks:

When the user moves a dockable bar from one docked position to another (e.g. Docked-Right to Docked-Top), the object must be resized accordingly to fit. When this method is set to True, you will not need to set the Width or Height as Chart FX for Java will calculate those values for you.

The setWidth(int) and setHeight(int) properties may be used to manually control the size of a DockableBar, however they should only be used when the AutoSize is configured to False.

The setDock(com.softwarefx.chartfx.server.DockArea) property may be used to position a DockableBar object in a chart.

See Also:

setWidth(int), setHeight(int), setDock(com.softwarefx.chartfx.server.DockArea), LegendBox

setBackColor

public void setBackColor(Color value)

Sets a value for the background color of a dockable bar.

Remarks:

The effect of this property is to change the background behind any dockable bar object such as the DataGrid.

Named color are supported (e.g. Red), to use Hex notation you have to use quotes (e.g. "#FF00FF").

For more information regarding the Color type, please refer to the Java API Documentation.

See Also:

setBorder(com.softwarefx.chartfx.server.DockBorder), setWidth(int), setHeight(int), setDock(com.softwarefx.chartfx.server.DockArea)

setBorder

public void setBorder(DockBorder value)

Allows the developer to specify the border style.

Remarks:

Allows you to specify the border for any DockableBar to be External, Internal or None.

See Also:

Chart.setBorder(com.softwarefx.chartfx.server.adornments.IBorderAdornment), setDock(com.softwarefx.chartfx.server.DockArea)

setDock

public void setDock(DockArea value)

Sets the position of the data grid.

Remarks:

All tools in Chart FX for Java are created (by default) with the setAutoSize(boolean) property set to True. When this method is set to True and the end user moves a Dockable Bar to another position, Chart FX for Java will calculate the appropriate width and height.

See Also:

setAutoSize(boolean), setWidth(int), setHeight(int)

setHeight

public void setHeight(int value)

Sets the height of the dockable bar in pixels.

Remarks:

When you modify the height, the setAutoSize(boolean) property will be set to False.

Use the Height property to configure the height for the dockable bar object.

See Also:

setDock(com.softwarefx.chartfx.server.DockArea), setAutoSize(boolean), setWidth(int), LegendBox

setVisible

public void setVisible(boolean value)

Sets a value indicating the Dockablebar object should be shown or not.

Remarks:

Hiding a DockableBar object not destroy or lose previous settings assigned by other properties.

See Also:

Chart.getDataGrid(), Chart.getToolBar(), Chart.getMenuBar(), Chart.getLegendBox(), Chart, ToolBar

setWidth

public void setWidth(int value)

Sets the height in pixels.

Remarks:

When you modify the width, the setAutoSize(boolean) property will be set to False.

See Also:

setHeight(int), setDock(com.softwarefx.chartfx.server.DockArea), setAutoSize(boolean)

setZOrder

public void setZOrder(int value)

Sets the z-order for a dockable bar.

Remarks:

Using this property, developers can control the order of Dockable bar objects in a chart.