Apache Flex (FlexJS) 0.7.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
Alert

Package | org.apache.flex.html
Class | public class Alert
Inheritance | Alert UIBase HTMLElementWrapper flash.display.Sprite
Implements | IPopUp

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

The Alert class is a component that displays a message and one or more buttons in a view that pops up over all other controls and views. The Alert component uses the AlertView bead to display a modal dialog with a title and a variety of buttons configured through the flag property of its show() static function. The Alert component uses the following beads: org.apache.flex.core.IBeadModel: the data model for the Alert. org.apache.flex.core.IBeadView: the bead used to create the parts of the Alert. org.apache.flex.core.IBeadController: the bead used to handle input events. org.apache.flex.core.IBorderBead: if present, draws a border around the Alert. org.apache.flex.core.IBackgroundBead: if present, places a solid color background below the Alert.

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | $height : Number [read-only] Retrieve the low-level bounding box height. | UIBase
|  | $width : Number [read-only] Retrieve the low-level bounding box width. | UIBase
|  | beads : Array The array property that is used to add additional beads to an MXML tag. | UIBase
|  | className : String The classname. | UIBase
|  | element : IFlexJSElement [read-only] Each IUIBase has an element that is actually added to the platform's display list DOM. | UIBase
|  | explicitHeight : Number The explicitly set width (as opposed to measured width or percentage width). | UIBase
|  | explicitWidth : Number The explicitly set width (as opposed to measured width or percentage width). | UIBase
|  | flags : uint The buttons to display on the Alert as bit-mask values. | Alert
|  | height : Number [override] The height of the component. | UIBase
|  | id : String An id property for MXML documents. | UIBase
|  | measurementBead : IMeasurementBead [read-only] A measurement bead, if one exists. | UIBase
|  | message : String The message to display in the Alert body. | Alert
|  | model : Object An IBeadModel that serves as the data model for the component. | UIBase
|  | numElements : int [read-only] The number of elements in the parent. | UIBase
|  | percentHeight : Number The requested percentage height this component should have in the parent container. | UIBase
|  | percentWidth : Number The requested percentage width this component should have in the parent container. | UIBase
|  | style : Object The object that contains "styles" and other associated name-value pairs. | UIBase
|  | title : String The tile of the Alert. | Alert
|  | topMostEventDispatcher : IEventDispatcher [read-only] The top most event dispatcher. | UIBase
|  | typeNames : String A list of type names. | UIBase
|  | view : IBeadView An IBeadView that serves as the view for the component. | UIBase
|  | width : Number [override] The width of the component. | UIBase

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | Alert() constructor. | Alert
|  | addBead(bead:IBead):void [override] Add a bead to the strand. | UIBase
|  | addedToParent():void The method called when added to a parent. | UIBase
|  | addElement(c:Object, dispatchEvent:Boolean = true):void Add a component to the parent. | UIBase
|  | addElementAt(c:Object, index:int, dispatchEvent:Boolean = true):void Add a component to the parent. | UIBase
|  | getBeadByType(classOrInterface:Class):IBead Find a bead on the strand. | UIBase
|  | getElementAt(index:int):Object Get a component from the parent. | UIBase
|  | getElementIndex(c:Object):int Gets the index of this subcomponent. | UIBase
|  | isHeightSizedToContent():Boolean | UIBase
|  | isWidthSizedToContent():Boolean | UIBase
|  | removeBead(value:IBead):IBead Remove a bead from the strand. | UIBase
|  | removeElement(c:Object, dispatchEvent:Boolean = true):void Remove a component from the parent. | UIBase
|  | setHeight(value:Number, noEvent:Boolean = false):void | UIBase
|  | setWidth(value:Number, noEvent:Boolean = false):void | UIBase
|  | setWidthAndHeight(newWidth:Number, newHeight:Number, noEvent:Boolean = false):void | UIBase
|  | setX(value:Number):void | UIBase
|  | setY(value:Number):void | UIBase
|  | show(parent:Object):void Shows the Alert anchored to the given parent object which is usally a root component such as a UIView.. | Alert
|  | show(text:String, parent:Object, title:String, flags:uint):void [static] This static method is a convenience function to quickly create and display an Alert. | Alert

Protected Methods
Show Inherited Protected Methods
Show Inherited Protected Methods

| Method | Defined By
--- | --- | ---
|  | repeaterListener(event:Event):void Rebroadcast an event from a sub component from the component. | UIBase

Events
Hide Inherited Events
Show Inherited Events

| Event | Summary | Defined By
--- | --- | --- | ---
|  | click | Set a different class for click events so that there aren't dependencies on the flash classes on the JS side. | UIBase
|  | mouseDown | Set a different class for mouseDown events so that there aren't dependencies on the flash classes on the JS side. | UIBase
|  | mouseMove | Set a different class for mouseMove events so that there aren't dependencies on the flash classes on the JS side. | UIBase
|  | mouseOut | Set a different class for mouseOut events so that there aren't dependencies on the flash classes on the JS side. | UIBase
|  | mouseOver | Set a different class for mouseOver events so that there aren't dependencies on the flash classes on the JS side. | UIBase
|  | mouseUp | Set a different class for mouseUp events so that there aren't dependencies on the flash classes on the JS side. | UIBase
|  | rollOut | Set a different class for rollOut events so that there aren't dependencies on the flash classes on the JS side. | UIBase
|  | rollOver | Set a different class for rollOver events so that there aren't dependencies on the flash classes on the JS side. | UIBase

Public Constants

| Constant | Defined By
--- | --- | ---
|  | CANCEL : uint = 0x000008 [static] The bitmask button flag to show the Cancel button. | Alert
|  | NO : uint = 0x000002 [static] The bitmask button flag to show the NO button. | Alert
|  | OK : uint = 0x000004 [static] The bitmask button flag to show the OK button. | Alert
|  | YES : uint = 0x000001 [static] The bitmask button flag to show the YES button. | Alert

Property Detail

flags | property

`flags:uint`

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

The buttons to display on the Alert as bit-mask values.

Implementation
`public function get flags():uint`
`public function set flags(value:uint):void`

message | property |

`message:String`

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

The message to display in the Alert body.

Implementation
`public function get message():String`
`public function set message(value:String):void`

title | property |

`title:String`

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

The tile of the Alert.

Implementation
`public function get title():String`
`public function set title(value:String):void`
Constructor Detail

Alert | () | Constructor

`public function Alert()`

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

constructor.

Method Detail

show | () | method

`public function show(parent:Object):void`

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

Shows the Alert anchored to the given parent object which is usally a root component such as a UIView..

Parameters

| `parent:Object` — parent The object that hosts the pop-up.

show | () | method |

`public static function show(text:String, parent:Object, title:String, flags:uint):void`

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

This static method is a convenience function to quickly create and display an Alert. The text and parent paramters are required, the others will default.

Parameters

| `text:String` — text The message content of the Alert.
| `parent:Object` — parent The object that hosts the pop-up.
| `title:String` — title An optional title for the Alert.
| `flags:uint` (default = `NaN`)`` — flags Identifies which buttons to display in the alert.

Constant Detail

CANCEL | Constant

`public static const CANCEL:uint = 0x000008`

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

The bitmask button flag to show the Cancel button.

NO | Constant |

`public static const NO:uint = 0x000002`

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

The bitmask button flag to show the NO button.

OK | Constant |

`public static const OK:uint = 0x000004`

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

The bitmask button flag to show the OK button.

YES | Constant |

`public static const YES:uint = 0x000001`

Language Version : | ActionScript 3.0

Product Version : | FlexJS 0.0

Runtime Versions : | Flash Player 10.2, AIR 2.6

The bitmask button flag to show the YES button.

Mon Sep 5 2016, 07:19 AM -07:00