Packagecom.adobe.portfolio.components
Classpublic class NavAlert
InheritanceNavAlert Inheritance NavSkinnableComponent Inheritance spark.components.supportClasses.SkinnableComponent
Subclasses BestExperienceAlert

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

The NavAlert class extends NavSkinnableComponent to display user alerts.



Public Properties
 PropertyDefined By
  message : String
The String to be displayed in the alert.
NavAlert
 InheritedskinState : String
The current skin state
NavSkinnableComponent
Protected Properties
 PropertyDefined By
 InheritedautoListen : AutoListen
NavSkinnableComponent
 InheritedautoWatch : AutoWatch
NavSkinnableComponent
Public Methods
 MethodDefined By
  
Constructor.
NavAlert
 Inherited
Creates autoListen and autoWatch for automatically tracking listeners and watchers.
NavSkinnableComponent
 Inherited
Uses autoListen and autoWatch to remove all listeners and watchers.
NavSkinnableComponent
 Inherited
setCurrentState(stateName:String, playTransition:Boolean = true):void
[override] Sets the current component state and skin state.
NavSkinnableComponent
  
show(container:IVisualElementContainer, msg:String = null):void
Shows the alert.
NavAlert
  
showPopup(parent:DisplayObject, message:String, modal:Boolean = true):NavAlert
[static] Creats an alert with the given message as a popup with the given parent.
NavAlert
Protected Methods
 MethodDefined By
 Inherited
addListener(listener:IEventDispatcher, type:String, handler:Function, useCapture:Boolean = false, priority:int = 0):void
NavSkinnableComponent
 Inherited
addWatcher(watcher:ChangeWatcher):void
NavSkinnableComponent
 Inherited
detachSkin():void
[override]
NavSkinnableComponent
 Inherited
[override]
NavSkinnableComponent
  
initStates():void
[override]
NavAlert
  
measure():void
[override]
NavAlert
  
onCloseButton(event:MouseEvent):void
NavAlert
  
partAdded(partName:String, instance:Object):void
[override]
NavAlert
 Inherited
partRemoved(partName:String, instance:Object):void
[override]
NavSkinnableComponent
Skin Parts

This component uses skins made up of skin parts. Do not set the skin parts directly. The component's skin sets the skin parts.


 Skin Part Description Defined By
  
closeButton:spark.components.Button
Required: true Part Type: Static
The close button for the Alert.
NavAlert
  
messageDisplay:spark.components.Label
Required: false Part Type: Static
An optional Label for displaying a message.
NavAlert
Skin States

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
  
disabled
NavAlert
  
normal
NavAlert
  
popup
NavAlert
Public Constants
 ConstantDefined By
 InheritedSTATE_DISABLED : String = disabled
[static]
NavSkinnableComponent
 InheritedSTATE_NORMAL : String = normal
[static]
NavSkinnableComponent
  STATE_POPUP : String = popup
[static]
NavAlert
Property Detail
messageproperty
message:String

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

The String to be displayed in the alert. This can also be set using the msg parameter of the show method.

This property can be used as the source for data binding.


Implementation
    public function get message():String
    public function set message(value:String):void
Constructor Detail
NavAlert()Constructor
public function NavAlert()

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Constructor.

Method Detail
initStates()method
override protected function initStates():void

measure()method 
override protected function measure():void

onCloseButton()method 
protected function onCloseButton(event:MouseEvent):void

Parameters

event:MouseEvent

partAdded()method 
override protected function partAdded(partName:String, instance:Object):void

Parameters

partName:String
 
instance:Object

show()method 
public function show(container:IVisualElementContainer, msg:String = null):void

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Shows the alert.

Parameters

container:IVisualElementContainer — The parent container
 
msg:String (default = null) — An optional String to be displayed in the alert

showPopup()method 
public static function showPopup(parent:DisplayObject, message:String, modal:Boolean = true):NavAlert

Creats an alert with the given message as a popup with the given parent.

Parameters

parent:DisplayObject
 
message:String
 
modal:Boolean (default = true)

Returns
NavAlert
Constant Detail
STATE_POPUPConstant
public static const STATE_POPUP:String = popup