Developer Resources
ToolBarItem
Overview
The ToolBarItem represents an item on a toolbar.
Constructor
- ToolBarItem()
- ToolBarItem(enabled_bitmap : Bitmap, disabled_bitmap : Bitmap, label : String, help : String)
Arguments
- enabled_bitmap
- The bitmap that shows when the toolbar item is enabled.
- disabled_bitmap
- The bitmap that shows when the toolbar item is disabled.
- label
- The toolbar label.
- help
- The toolbar help text.
Events
- ToolBarItem.click
- Fired when the tool bar item is clicked.
Methods
- ToolBarItem.getHelpString
- Returns the help string associated with the toolbar item.
- ToolBarItem.getLabel
- Returns the text of the toolbar item.
- ToolBarItem.getTooltip
- Returns the tooltip text for the toolbar item.
- ToolBarItem.setBitmap
- Sets a bitmap for the toolbar item.
- ToolBarItem.setDisabledBitmap
- Sets a bitmap for the toolbar item.
- ToolBarItem.setEnabled
- Enables or disables a toolbar item.
- ToolBarItem.setHelpString
- Sets the help string for the toolbar item.
- ToolBarItem.setLabel
- Sets the label for a toolbar item.
- ToolBarItem.setTooltip
- Sets the tooltip text for the toolbar item.
ToolBarItem.getHelpString
- function ToolBarItem.getHelpString() : String
Returns
The help string associated with the toolbar item.
Description
Returns the help string associated with the toolbar item.
ToolBarItem.getLabel
- function ToolBarItem.getLabel() : String
Returns
The text of the toolbar item.
Description
Returns the text of the toolbar item.
ToolBarItem.getTooltip
- function ToolBarItem.getTooltip() : String
Returns
The tooltip text for the toolbar item.
Description
Returns the tooltip text for the toolbar item.
ToolBarItem.setBitmap
- function ToolBarItem.setBitmap(bitmap : Bitmap)
Arguments
- bitmap
- The bitmap to show on the toolbar when the toolbar is enabled.
Description
Sets the toolbar item's bitmap, specified by bitmap, that will be shown when the toolbar item is enabled.
ToolBarItem.setDisabledBitmap
- function ToolBarItem.setDisabledBitmap(bitmap : Bitmap)
Arguments
- bitmap
- The bitmap to show on the toolbar when the toolbar is disabled.
Description
Sets the toolbar item's, specified by bitmap, that will be shown when the toolbar item is disabled.
ToolBarItem.setEnabled
- function ToolBarItem.setEnabled()
- function ToolBarItem.setEnabled(enabled : Boolean)
Arguments
- enabled
- A flag which determines whether a toolbar item is enabled or not.
Description
Enables or disables a toolbar item. If enabled isn't specified, the toolbar item is enabled; otherwise the toolbar item is enabled if enabled is true and disabled if enabled is false.
ToolBarItem.setHelpString
- function ToolBarItem.setHelpString(help : String)
Arguments
- help
- The help string associated with the toolbar item.
Description
Sets the toolbar item help string, specified by help.
ToolBarItem.setLabel
- function ToolBarItem.setLabel(label : String)
Arguments
- label
- The new text for the toolbar item.
Description
Sets the toolbar item text specified by label.
ToolBarItem.setTooltip
- function ToolBarItem.setTooltip(tooltip : String)
Arguments
- tooltip
- The text to use when the tooltip shows.
Description
Sets the tooltip text, specified by tooltip, for the toolbar item.