com.softwarefx.chartfx.server

Class DockableToolBar

java.lang.Object

com.softwarefx.chartfx.server.DockableBar

com.softwarefx.chartfx.server.DockableToolBar

public final class DockableToolBar
extends DockableBar

Provides access to the DockableToolBar object, which is the parent class of objects such as the Toolbar and MenuBar.

Constructor Summary

Constructors

Constructor and Description
DockableToolBar() Constructs a newly allocated DockableToolBar object

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Clears all items from the DockableToolBar object.
int	findCommand(int id) Returns the position of given command with a specific ID in the DockableToolBar.
int	findCommandId(CommandId id) Returns the position of given command with a specific CommandId in the DockableToolBar.
ToolBarItem	get(int n) Gets or sets a ToolBarItem for a selected index in the DockableToolBar object.
com.softwarefx.server.CommandCollection	getCommands() Returns the CommandCollection for the DockableToolBar object.
int	getLength() Gets the total number of ToolBarItems for a DockableToolBar object.
void	insert(int position, ToolBarItem item) Used to insert a ToolBarItem in the DockableToolBar at a selected position.
boolean	isShowImages() Gets or sets a value indicating whether to show or hide images for ToolBarItems.
java.util.Iterator<ToolBarItem>	iterator() Description goes here
void	removeAt(int position) Used to remove ToolBarItems from a DockableToolBar.
void	removeAt(int position, int count) Used to remove ToolBarItems from a DockableToolBar.
void	set(int n, ToolBarItem value) Gets or sets a ToolBarItem for a selected index in the DockableToolBar object.
void	setShowImages(boolean value) Gets or sets a value indicating whether to show or hide images for ToolBarItems.

Methods inherited from class com.softwarefx.chartfx.server.DockableBar

addVisibleChangedListener, getBackColor, getBorder, getDock, getHeight, getWidth, getZOrder, isAutoSize, isVisible, removeVisibleChangedListener, resetAutoSize, resetBackColor, resetBorder, resetDock, resetHeight, resetVisible, resetWidth, resetZOrder, setAutoSize, setBackColor, setBorder, setDock, setHeight, setVisible, setWidth, setZOrder

Methods inherited from class java.lang.Object

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

Constructor Detail

DockableToolBar

public DockableToolBar()

Constructs a newly allocated DockableToolBar object

Method Detail

getCommands

public com.softwarefx.server.CommandCollection getCommands()

Returns the CommandCollection for the DockableToolBar object.

• Java

• int CommandId_PointLabels;
  CommandId_PointLabels = CommandId.PointLabels;
  chart1.getToolBar().getCommands().get(CommandId_PointLabels).setEnabled(false);
  

get

public ToolBarItem get(int n)

Gets or sets a ToolBarItem for a selected index in the DockableToolBar object.

Developers may obtain the ToolBarItem object for a command in the DockableToolBar using this method. Using the supported DockableToolBar class members, developers configure attributes for a command.

To configure the 4th ToolBarItem as Print:

• Java

• chart1.getToolBar().get(4).setCommandId(CommandId.PRINT);
  

Parameters:

n -

set

public void set(int n,
       ToolBarItem value)

Gets or sets a ToolBarItem for a selected index in the DockableToolBar object.

Developers may obtain the ToolBarItem object for a command in the DockableToolBar using this method. Using the supported DockableToolBar class members, developers configure attributes for a command.

To configure the 4th ToolBarItem as Print:

• Java

• chart1.getToolBar().get(4).setCommandId(CommandId.PRINT);
  

Parameters:

n -

value -

getLength

public int getLength()

Gets the total number of ToolBarItems for a DockableToolBar object.

• Java

• int totalItems;
  totalItems = chart1.getToolBar().getLength();
  

isShowImages

public boolean isShowImages()

Gets or sets a value indicating whether to show or hide images for ToolBarItems.

• Java

• chart1.getToolBar().setShowImages(true);
  

setShowImages

public void setShowImages(boolean value)

Gets or sets a value indicating whether to show or hide images for ToolBarItems.

• Java

• chart1.getToolBar().setShowImages(true);
  

Parameters:

value -

clear

public void clear()

Clears all items from the DockableToolBar object.

You can use the textRemoveAt method to remove items from a selected DockableToolBar position.

To clear all the toolbar items:

• Java

• chart1.getToolBar().clear();
  

findCommand

public int findCommand(int id)

Returns the position of given command with a specific ID in the DockableToolBar.

This method is very useful when trying to remove an icon from a DockableToolBar object.

The CommandId Enum makes it simpler to specify which command you need to find the position of.

Parameters:

id - ID for the command to find.

findCommandId

public int findCommandId(CommandId id)

Returns the position of given command with a specific CommandId in the DockableToolBar.

This method is very useful when trying to remove an icon from a DockableToolBar object.

The CommandId Enum makes it simpler to specify which command you need to find the position of.

Parameters:

id - CommandId to find.

insert

public void insert(int position,
          ToolBarItem item)

Used to insert a ToolBarItem in the DockableToolBar at a selected position.

To Insert the Print ToolBarItem as the first item in the ToolBar:

• Java

• ToolBarItem command1;
  command1 = new ToolBarItem(CommandId.PRINT);
  chart1.getToolBar().Insert(0, command1);
  

Parameters:

position - Position in the DockableToolBar to insert the ToolBarItem.

item - ToolBarItem to insert.

iterator

public java.util.Iterator<ToolBarItem> iterator()

Description goes here

removeAt

public void removeAt(int position)

Used to remove ToolBarItems from a DockableToolBar.

To remove the 3rd and 4th ToolBarItems:

• Java

• chart1.getToolBar().removeAt(1, 2);
  

Parameters:

position - Position before the ToolBarItem to remove.

removeAt

public void removeAt(int position,
            int count)

Used to remove ToolBarItems from a DockableToolBar.

To remove the 3rd and 4th ToolBarItems:

• Java

• chart1.getToolBar().removeAt(1, 2);
  

Parameters:

position - Number of ToolBarItems to remove after the configured position.

count - Position of the ToolBarItem to begin removing.