DockableBar (Chart FX for Java 8.0 API Specification)

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

Direct Known Subclasses:

DataGrid, DockableToolBar, LegendBox, LegendBox
```
public class DockableBar
extends java.lang.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 method.
Using the setDock method, you can dock the bar in different areas of the Chart.
You must make the bar isVisible in order to see any of the visual attributes configured using the methods of the class.
The border of the bar can the set by using a pre-defined object such as SimpleBorder, or ImageBorderusing the method setChartBorder.
The following methods of the Chartreturn objects inheriting from DockableBar: setLegendBox, setToolBar, setMenuBar, and setDataGrid.
Dragging the legend box (end user) is not supported but may be positioned in the chart area using the setDock method. 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 attached to a logical position that will change as the chart size changes.

Constructor Summary

Constructors
Constructor and Description

DockableBar()

Constructors
Constructor and Description
`DockableBar()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addVisibleChangedListener(EventListener value)` Adds a VisibleChangedListener to the listener list.
`java.awt.Color`	`getBackColor()` Gets or sets a value for the background color of a dockable bar.
`DockBorder`	`getBorder()` Allows the developer to specify the border style.
`DockArea`	`getDock()` Sets the position of the data grid.
`int`	`getHeight()` Gets or sets the height of the dockable bar in pixels.
`int`	`getWidth()` Sets the height in pixels.
`int`	`getZOrder()` Gets or sets the z-order for a dockable bar.
`boolean`	`isAutoSize()` Allows Chart FX to calculate the best size according to the tool position.
`boolean`	`isVisible()` Gets or sets a value indicating the Dockablebar object should be shown or not.
`void`	`removeVisibleChangedListener(EventListener value)` Removes a VisibleChangedListener from the listener list.
`void`	`resetAutoSize()` Set the property AutoSize to its default value.
`void`	`resetBackColor()` Set the property BackColor to its default value.
`void`	`resetBorder()` Set the property Border to its default value.
`void`	`resetDock()` Set the property Dock to its default value.
`void`	`resetHeight()` Set the property Height to its default value.
`void`	`resetVisible()` Set the property Visible to its default value.
`void`	`resetWidth()` Set the property Width to its default value.
`void`	`resetZOrder()` Set the property ZOrder to its default value.
`void`	`setAutoSize(boolean value)` Allows Chart FX to calculate the best size according to the tool position.
`void`	`setBackColor(java.awt.Color value)` Gets or 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)` Gets or sets the height of the dockable bar in pixels.
`void`	`setVisible(boolean value)` Gets or 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)` Gets or 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
  - isAutoSize
```
public boolean isAutoSize()
```
    Allows Chart FX to calculate the best size according to the tool position.
    Java
    chart1.getDataGrid().setAutoSize(false);
    See Also:
    resetAutoSize
  - setAutoSize
```
public void setAutoSize(boolean value)
```
    Allows Chart FX to calculate the best size according to the tool position.
    Java
    chart1.getDataGrid().setAutoSize(false);
    Parameters:
    value -
    See Also:
    resetAutoSize
  - getBackColor
```
public java.awt.Color getBackColor()
```
    Gets or sets a value for the background color of a dockable bar.
    
    The effect of this method 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 Documentation.
    To change the background color of the data grid to red:
    Java
    chart1.getDataGrid().setBackColor(new java.awt.Color(255,0,0,255));
    See Also:
    resetBackColor
  - setBackColor
```
public void setBackColor(java.awt.Color value)
```
    Gets or sets a value for the background color of a dockable bar.
    
    The effect of this method 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 Documentation.
    To change the background color of the data grid to red:
    Java
    chart1.getDataGrid().setBackColor(new java.awt.Color(255,0,0,255));
    Parameters:
    value -
    See Also:
    resetBackColor
  - getBorder
```
public DockBorder getBorder()
```
    Allows the developer to specify the border style.
    Java
    chart1.getDataGrid().setChartBorder(DockBorder.EXTERNAL);
    See Also:
    resetBorder
  - setBorder
```
public void setBorder(DockBorder value)
```
    Allows the developer to specify the border style.
    Java
    chart1.getDataGrid().setChartBorder(DockBorder.EXTERNAL);
    Parameters:
    value -
    See Also:
    resetBorder
  - getDock
```
public DockArea getDock()
```
    Sets the position of the data grid.
    
    All tools in Chart FX are created (by default) with the isAutoSize method set to True. When this method is set to True and the end user moves a Dockable Bar to another position, Chart FX will calculate the appropriate width and height.
    To dock the DataGrid to the right margin:
    Java
    chart1.getDataGrid().setDock(DockArea.RIGHT);
    See Also:
    resetDock
  - setDock
```
public void setDock(DockArea value)
```
    Sets the position of the data grid.
    
    All tools in Chart FX are created (by default) with the isAutoSize method set to True. When this method is set to True and the end user moves a Dockable Bar to another position, Chart FX will calculate the appropriate width and height.
    To dock the DataGrid to the right margin:
    Java
    chart1.getDataGrid().setDock(DockArea.RIGHT);
    Parameters:
    value -
    See Also:
    resetDock
  - getHeight
```
public int getHeight()
```
    Gets or sets the height of the dockable bar in pixels.
    
    When you modify the height, the isAutoSize method will be set to False.
    Use the Height method to configure the height for the dockable bar object.
    To set the height for the data grid to 300 pixels:
    Java
    chart1.getDataGrid().setHeight(300);
    See Also:
    resetHeight
  - setHeight
```
public void setHeight(int value)
```
    Gets or sets the height of the dockable bar in pixels.
    
    When you modify the height, the isAutoSize method will be set to False.
    Use the Height method to configure the height for the dockable bar object.
    To set the height for the data grid to 300 pixels:
    Java
    chart1.getDataGrid().setHeight(300);
    Parameters:
    value -
    See Also:
    resetHeight
  - isVisible
```
public boolean isVisible()
```
    Gets or sets a value indicating the Dockablebar object should be shown or not.
    
    Hiding a DockableBar object not destroy or lose previous settings assigned by other methods.
    To hide the data grid:
    Java
    chart1.getDataGrid().setVisible(false);
    See Also:
    resetVisible
  - setVisible
```
public void setVisible(boolean value)
```
    Gets or sets a value indicating the Dockablebar object should be shown or not.
    
    Hiding a DockableBar object not destroy or lose previous settings assigned by other methods.
    To hide the data grid:
    Java
    chart1.getDataGrid().setVisible(false);
    Parameters:
    value -
    See Also:
    resetVisible
  - getWidth
```
public int getWidth()
```
    Sets the height in pixels.
    
    When you modify the width, the isAutoSize method will be set to False.
    To set the width for the data grid to 300 pixels:
    Java
    chart1.getDataGrid().setWidth((short)300);
    See Also:
    resetWidth
  - setWidth
```
public void setWidth(int value)
```
    Sets the height in pixels.
    
    When you modify the width, the isAutoSize method will be set to False.
    To set the width for the data grid to 300 pixels:
    Java
    chart1.getDataGrid().setWidth((short)300);
    Parameters:
    value -
    See Also:
    resetWidth
  - getZOrder
```
public int getZOrder()
```
    Gets or sets the z-order for a dockable bar.
    Java
    int zOrderDG; zOrderDG = chart1.getDataGrid().getZOrder();
    See Also:
    resetZOrder
  - setZOrder
```
public void setZOrder(int value)
```
    Gets or sets the z-order for a dockable bar.
    Java
    int zOrderDG; zOrderDG = chart1.getDataGrid().getZOrder();
    Parameters:
    value -
    See Also:
    resetZOrder
  - resetAutoSize
```
public void resetAutoSize()
```
    Set the property AutoSize to its default value.
    
    See Also:
    isAutoSize
  - resetBackColor
```
public void resetBackColor()
```
    Set the property BackColor to its default value.
    
    See Also:
    setBackColor
  - resetBorder
```
public void resetBorder()
```
    Set the property Border to its default value.
    
    See Also:
    setBorder
  - resetDock
```
public void resetDock()
```
    Set the property Dock to its default value.
    
    See Also:
    setDock
  - resetHeight
```
public void resetHeight()
```
    Set the property Height to its default value.
    
    See Also:
    setHeight
  - resetVisible
```
public void resetVisible()
```
    Set the property Visible to its default value.
    
    See Also:
    isVisible
  - resetWidth
```
public void resetWidth()
```
    Set the property Width to its default value.
    
    See Also:
    setWidth
  - resetZOrder
```
public void resetZOrder()
```
    Set the property ZOrder to its default value.
    
    See Also:
    setZOrder
  - addVisibleChangedListener
```
public void addVisibleChangedListener(EventListener value)
```
    Adds a VisibleChangedListener to the listener list.
    
    Parameters:
    value -
  - removeVisibleChangedListener
```
public void removeVisibleChangedListener(EventListener value)
```
    Removes a VisibleChangedListener from the listener list.
    
    Parameters:
    value -

Class DockableBar

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DockableBar

Method Detail

isAutoSize

setAutoSize

getBackColor

setBackColor

getBorder

setBorder

getDock

setDock

getHeight

setHeight

isVisible

setVisible

getWidth

setWidth

getZOrder

setZOrder

resetAutoSize

resetBackColor

resetBorder

resetDock

resetHeight

resetVisible

resetWidth

resetZOrder

addVisibleChangedListener

removeVisibleChangedListener