| Package | ardisia.components.popUpButton |
| Class | public class PopUpButton |
| Inheritance | PopUpButton  spark.components.SkinnableContainer |
| Implements | mx.managers.IFocusManagerComponent |
Only the primary main button dispatches "click" events.
A Halo Menu cannot be added as PopUp content because the Menu class handles closing itself, which creates memory leaks when used in this component.
View the technical documentation on the Ardisia Labs website for more information.
Default MXML PropertypopUp
| Property | Defined By | ||
|---|---|---|---|
| closeOnActivity : Boolean = true
If true, the popup will be closed when mouse/resize activity occurs
that is not related to the popup. | PopUpButton | ||
| label : String
Text to appear on the main button skin part. | PopUpButton | ||
| openAlways : Boolean = true
If true, will pop up the popup content when the openButtonPart is
clicked or the control has focus and the spacebar is depressed. | PopUpButton | ||
| popUp : UIComponent
Specifies the content to popup when open() is called. | PopUpButton | ||
| Method | Defined By | ||
|---|---|---|---|
close():void
Closes the popup. | PopUpButton | ||
open():void
Opens the popup. | PopUpButton | ||
| Method | Defined By | ||
|---|---|---|---|
eventHandler(event:Event):void
Handles events for the component. | PopUpButton | ||
openButtonPartHandler(event:Event):void
Handles events for the open button skin part. | PopUpButton | ||
systemManagerHandler(event:Event):void
Handles events on the systemManager. | PopUpButton | ||
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when the popup is closed. | PopUpButton | |||
| Dispatched when the popup opens and is visible. | PopUpButton | |||
This component uses skins made up of skin parts. Do not set the skin parts directly. The component's skin sets the skin parts.
To skin the component, implement a skin that defines the following states. Although you must implement all skin states, a skin state can be empty. An empty skin state specifies no changes to the default skin state.
| Skin State | Description | Defined By | ||
|---|---|---|---|---|
open | State when the popup content is displayed and visible. | PopUpButton | ||
| closeOnActivity | property |
public var closeOnActivity:Boolean = trueIf true, the popup will be closed when mouse/resize activity occurs that is not related to the popup.
If false, close() must be called manually to remove the popup content.
The default value is true.
| label | property |
label:StringText to appear on the main button skin part.
The default value is "".
public function get label():String public function set label(value:String):void| openAlways | property |
public var openAlways:Boolean = trueIf true, will pop up the popup content when the openButtonPart is clicked or the control has focus and the spacebar is depressed.
If false, open() must be called manually to display the popup content.
The default value is true.
| popUp | property |
popUp:UIComponentSpecifies the content to popup when open() is called.
Cannot be a Halo Menu.
This property is bindable.
The default value is null.
This property can be used as the source for data binding.
public function get popUp():UIComponent public function set popUp(value:UIComponent):void| close | () | method |
public function close():voidCloses the popup.
| eventHandler | () | method |
protected function eventHandler(event:Event):voidHandles events for the component.
Parameters
event:Event — the Event that triggered the handler
|
| open | () | method |
public function open():voidOpens the popup.
| openButtonPartHandler | () | method |
protected function openButtonPartHandler(event:Event):voidHandles events for the open button skin part.
Parameters
event:Event — the Event that triggered the handler
|
| systemManagerHandler | () | method |
protected function systemManagerHandler(event:Event):voidHandles events on the systemManager.
Parameters
event:Event — the Event that triggered the handler
|
| close | Event |
ardisia.components.popUpButton.events.PopUpButtonEventardisia.components.popUpButton.events.PopUpButtonEventDispatched when the popup is closed.
| open | Event |
ardisia.components.popUpButton.events.PopUpButtonEventardisia.components.popUpButton.events.PopUpButtonEventDispatched when the popup opens and is visible.