Package | com.adobe.solutions.rca.presentation.util |
Class | public class AlertFormatter |
Inheritance | AlertFormatter Object |
Language Version: | ActionScript 3.0 |
Product Version: | Review, Commenting, and Approval Building Block 10.0 |
Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
Public Properties
Property | Defined By | ||
---|---|---|---|
constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | ||
ERROR_ICON : Class
This property refers to error icon. | AlertFormatter | ||
INFO_ICON : Class
This property refers to information icon. | AlertFormatter | ||
OK_ICON : Class
This property refers to OK icon. | AlertFormatter | ||
prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | ||
WARNING_ICON : Class
This property refers to warning icon. | AlertFormatter |
Public Methods
Method | Defined By | ||
---|---|---|---|
AlertFormatter(alertParent:UIComponent = null)
The constructor for AlertFormatter class. | AlertFormatter | ||
Indicates whether an object has a specified property defined. | Object | ||
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | ||
Indicates whether the specified property exists and is enumerable. | Object | ||
Sets the availability of a dynamic property for loop operations. | Object | ||
showAlert(message:String, title:String, icon:Class, buttons:uint, closer:Function = null, minHeight:Number = NaN, minWidth:Number = NaN):void
This method displays a generic dialog. | AlertFormatter | ||
showAlertWithNoButtonsAndReturn(message:String, title:String, icon:Class, buttons:uint, closer:Function = null, minHeight:Number = NaN, minWidth:Number = NaN):Alert
This method displays a generic dialog without any buttons. | AlertFormatter | ||
This method displays an error dialog. | AlertFormatter | ||
This method displays an information dialog. | AlertFormatter | ||
This method displays a notification dialog. | AlertFormatter | ||
This method displays a warning dialog. | AlertFormatter | ||
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | ||
Returns the string representation of the specified object. | Object | ||
Returns the primitive value of the specified object. | Object |
Property Detail
ERROR_ICON | property |
public var ERROR_ICON:Class
Language Version: | ActionScript 3.0 |
Product Version: | Review, Commenting, and Approval Building Block 10.0 |
Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
This property refers to error icon.
INFO_ICON | property |
public var INFO_ICON:Class
Language Version: | ActionScript 3.0 |
Product Version: | Review, Commenting, and Approval Building Block 10.0 |
Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
This property refers to information icon.
OK_ICON | property |
public var OK_ICON:Class
Language Version: | ActionScript 3.0 |
Product Version: | Review, Commenting, and Approval Building Block 10.0 |
Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
This property refers to OK icon.
WARNING_ICON | property |
public var WARNING_ICON:Class
Language Version: | ActionScript 3.0 |
Product Version: | Review, Commenting, and Approval Building Block 10.0 |
Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
This property refers to warning icon.
Constructor Detail
AlertFormatter | () | Constructor |
public function AlertFormatter(alertParent:UIComponent = null)
Language Version: | ActionScript 3.0 |
Product Version: | Review, Commenting, and Approval Building Block 10.0 |
Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
The constructor for AlertFormatter
class.
alertParent:UIComponent (default = null ) — UI component that acts as the parent of the alert dialog.
|
Method Detail
showAlert | () | method |
public function showAlert(message:String, title:String, icon:Class, buttons:uint, closer:Function = null, minHeight:Number = NaN, minWidth:Number = NaN):void
Language Version: | ActionScript 3.0 |
Product Version: | Review, Commenting, and Approval Building Block 10.0 |
Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
This method displays a generic dialog.
Parameters
message:String — Message displayed in the alert dialog.
| |
title:String — Title of the alert dialog.
| |
icon:Class — Icon displayed on the dialog.
| |
buttons:uint (default = NaN ) — Buttons that are displayed on the dialog.
| |
closer:Function (default = null ) — Function invoked when the buttons on the alert are clicked.
| |
minHeight:Number (default = NaN ) — Minimum height of the alert dialog.
| |
minWidth:Number (default = NaN ) — Minimum width of the alert dialog.
|
showAlertWithNoButtonsAndReturn | () | method |
public function showAlertWithNoButtonsAndReturn(message:String, title:String, icon:Class, buttons:uint, closer:Function = null, minHeight:Number = NaN, minWidth:Number = NaN):Alert
Language Version: | ActionScript 3.0 |
Product Version: | Review, Commenting, and Approval Building Block 10.0 |
Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
This method displays a generic dialog without any buttons.
Parameters
message:String — Message displayed in the alert dialog.
| |
title:String — Title of the alert dialog.
| |
icon:Class — Icon to be displayed in dialog.
| |
buttons:uint (default = NaN ) — The buttons that will be displayed on dialog. These buttons will not be visible.
| |
closer:Function (default = null ) — Function to be invoked when the buttons on alert are clicked.
| |
minHeight:Number (default = NaN ) — Minimum height of the alert dialog.
| |
minWidth:Number (default = NaN ) — Minimum width of the alert dialog.
|
Alert — It returns the alert dialog that is created by this method.
|
showError | () | method |
public function showError(message:String, title:String, minHeight:Number = NaN, minWidth:Number = NaN):void
Language Version: | ActionScript 3.0 |
Product Version: | Review, Commenting, and Approval Building Block 10.0 |
Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
This method displays an error dialog.
Parameters
message:String — Message displayed in the alert dialog.
| |
title:String — Title of the alert dialog.
| |
minHeight:Number (default = NaN ) — Minimum height of the alert dialog.
| |
minWidth:Number (default = NaN ) — Minimum width of the alert dialog.
|
showInfo | () | method |
public function showInfo(message:String, title:String, minHeight:Number = NaN, minWidth:Number = NaN):void
Language Version: | ActionScript 3.0 |
Product Version: | Review, Commenting, and Approval Building Block 10.0 |
Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
This method displays an information dialog.
Parameters
message:String — Message displayed in the alert dialog.
| |
title:String — Title of the alert dialog.
| |
minHeight:Number (default = NaN ) — Minimum height of the alert dialog.
| |
minWidth:Number (default = NaN ) — Minimum width of the alert dialog.
|
showNotification | () | method |
public function showNotification(message:String, title:String, minHeight:Number = NaN, minWidth:Number = NaN):void
Language Version: | ActionScript 3.0 |
Product Version: | Review, Commenting, and Approval Building Block 10.0 |
Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
This method displays a notification dialog.
Parameters
message:String — Message displayed in the alert dialog.
| |
title:String — Title of the alert dialog.
| |
minHeight:Number (default = NaN ) — Minimum height of the alert dialog.
| |
minWidth:Number (default = NaN ) — Minimum width of the alert dialog.
|
showWarning | () | method |
public function showWarning(message:String, title:String, minHeight:Number = NaN, minWidth:Number = NaN):void
Language Version: | ActionScript 3.0 |
Product Version: | Review, Commenting, and Approval Building Block 10.0 |
Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
This method displays a warning dialog.
Parameters
message:String — Message displayed in the alert dialog.
| |
title:String — Title of the alert dialog.
| |
minHeight:Number (default = NaN ) — Minimum height of the alert dialog.
| |
minWidth:Number (default = NaN ) — Minimum width of the alert dialog.
|
Mon Nov 28 2011, 06:48 AM -08:00