| Package | Top Level |
| Class | public class OptionButton |
This class dispatches the following events:
| Name | Type | Dispatched... |
|---|---|---|
click | Click | when the button is clicked |
See also
| Method | Defined by | ||
|---|---|---|---|
|
Constructor.
| OptionButton | ||
|
This method lets you register event listener functions with the specified control or object.
| OptionButton | ||
|
getIconFile():String
Gets the icon file associated with the button.
| OptionButton | ||
|
getName():String
Gets the control name.
| OptionButton | ||
|
getToolTip():String
Gets the tooltip associated with this control.
| OptionButton | ||
|
Pops up a menu below the button.
| OptionButton | ||
|
setIconFile(iconFile:String):void
Sets the icon associated with the button.
| OptionButton | ||
|
setName(name:String):void
Sets the control name.
| OptionButton | ||
|
setToolTip(tooltip:String):void
Sets the tooltip that shows up when the user moves the mouse over the control.
| OptionButton | ||
| OptionButton | () | constructor |
public function OptionButton()Constructor.
| addEventListener | () | method |
public function addEventListener(eventName:String, callback:String):void
This method lets you register event listener functions with the specified control or object.
The event listener functions always receive an event object as a parameter. This
event has, among other, a sender property which is a reference to the object that has
dispatched the event. This object may also have additional properties which depend on the
the event.
eventName:String — The event you wish to listen to.
|
|
callback:String — The Lua function to call when the event is triggered.
|
See also
| getIconFile | () | method |
public function getIconFile():StringGets the icon file associated with the button.
ReturnsString — The icon file path.
|
| getName | () | method |
public function getName():StringGets the control name.
ReturnsString — The control name.
|
| getToolTip | () | method |
public function getToolTip():StringGets the tooltip associated with this control.
ReturnsString — The tooltip.
|
| popupMenu | () | method |
public function popupMenu(menu:Menu):voidPops up a menu below the button. This can be used to allow the user to choose between multiple options when the button is clicked.
Parametersmenu:Menu — The menu to display.
|
See also
| setIconFile | () | method |
public function setIconFile(iconFile:String):voidSets the icon associated with the button. Set it to an empty string to use the default icon.
ParametersiconFile:String — The icon file path.
|
| setName | () | method |
public function setName(name:String):voidSets the control name.
Parametersname:String — The control name.
|
| setToolTip | () | method |
public function setToolTip(tooltip:String):voidSets the tooltip that shows up when the user moves the mouse over the control.
Parameterstooltip:String — The tooltip.
|