FOM Reference > Application > Toolbars > fToolbar interface
  
fToolbar interface
An individual toolbar within the application.
DisplayType enumeration
Options for the toolbar display.
The DisplayType enumeration has the following constants of type int.
DISPLAY_TEXT = 1
Text.
DISPLAY_ICONS = 2
Icons.
DISPLAY_TEXT_ICONS = 3
Text and Icons.
LocationType enumeration
Options for the toolbar location.
The LocationType enumeration has the following constants of type int.
LOCATION_TOP = 1
Top.
LOCATION_BOTTOM = 2
Bottom.
LOCATION_LEFT = 3
Left.
LOCATION_RIGHT = 4
Right.
action attribute
The default action for any of the items on the toolbar.
action
Access
read-write
Returns
String
display attribute
The type of display to show for the toolbar. Value is one of fToolbar.DisplayType.
display
Access
read-write
Returns
int
gap attribute
The gap for the toolbar in pixels.
gap
Access
read-write
Returns
int
items attribute
This is a read only array of all items that appear on the toolbar.
items
Access
read-only
Returns
fToolbarItem[]
location attribute
The side on which the toolbar is to be displayed. Value is one of fToolbar.LocationType.
location
Access
read-write
Returns
int
margin attribute
The margin for the toolbar in pixels.
margin
Access
read-write
Returns
int
name attribute
The name for the toolbar.
name
Access
read-only
Returns
String
wrap attribute
If true, the items on the toolbar will wrap when required.
wrap
Access
read-write
Returns
boolean
addItem method
Adds an item to the toolbar.
addItemitem
Parameters
fToolbarItemitem
The fToolbarItem object to add to the toolbar.
Returns
void. None.
clear method
Remove all items from the toolbar.
clear
Parameters
None
Returns
void. None.
removeItem method
Removes an item from the toolbar.
removeItemitem
Parameters
fToolbarItemitem
The fToolbarItem object to remove from the toolbar.
Returns
void. None.