Package | com.vmware.widgets.util |
Class | public class Dialogs |
Inheritance | Dialogs ![]() |
Method | Defined By | ||
---|---|---|---|
showAlert(text:String, title:String, flags:uint = 0x4, parent:Sprite = null, closeHandler:Function = null, iconClass:Class = null, defaultButtonFlag:uint = 0x4, id:String):Alert [static]
Helper method to show a basic Alert. | Dialogs | ||
showAlertWithCheckbox(text:String, title:String, flags:uint = 0x4, parent:Sprite = null, closeHandler:Function = null, iconClass:Class = null, defaultButtonFlag:uint = 0x4, checkPrompt:String = null, defaultChecked:Boolean = false, id:String):void [static]
A static method which pops up an modal dialog alert. | Dialogs | ||
showError(text:String, title:String, parent:Sprite = null, closeHandler:Function = null, id:String, error:Error = null):void [static]
Helper method to show an error dialog. | Dialogs | ||
showOkCancelWarning(text:String, title:String, parent:Sprite = null, closeHandler:Function = null, defaultButtonFlag:uint = 0x0008, id:String):void [static]
Helper method to show an ok/cancel confirmation dialog. | Dialogs | ||
showPopUp(window:IFlexDisplayObject = null, parent:DisplayObject = null, modal:Boolean = false, childList:String = null, anchorDirection:String = center):void [static]
Displays a pop up window at the top level. | Dialogs | ||
showWarning(text:String, title:String, parent:Sprite = null, closeHandler:Function = null, id:String):void [static]
Helper method to show a warning dialog. | Dialogs | ||
showYesNoQuestion(text:String, title:String, parent:Sprite = null, closeHandler:Function = null, defaultButtonFlag:uint = 0x2, iconClass:Class = null, id:String, showCancelButton:Boolean = false):void [static]
Helper method to show a yes/no confirmation dialog. | Dialogs |
Constant | Defined By | ||
---|---|---|---|
BOTTOM_RIGHT : String = bottom_right [static]
Const used as a directional option for the AnchoredDialog. | Dialogs | ||
CENTER : String = center [static]
Const used as a directional option for the AnchoredDialog. | Dialogs | ||
CHECKED : uint = 0x0010 [static]
Result value for if the checkbox is selected. | Dialogs | ||
NO_ANCHOR : String = no_anchor [static]
Const used as a directional option for the AnchoredDialog. | Dialogs |
showAlert | () | method |
public static function showAlert(text:String, title:String, flags:uint = 0x4, parent:Sprite = null, closeHandler:Function = null, iconClass:Class = null, defaultButtonFlag:uint = 0x4, id:String):Alert
Helper method to show a basic Alert.
Parameters
text:String — Text string that appears in the Alert control. This text is centered
in the alert dialog box.
| |
title:String — Text string that appears in the title bar. This text is left justified.
| |
flags:uint (default = 0x4 ) — Which buttons to place in the Alert control.
| |
parent:Sprite (default = null ) — Object upon which the Alert control centers itself. If not set, Alert will
center in the screen.
| |
closeHandler:Function (default = null ) — Event handler that is called when any button on the Alert control is pressed.
The event object passed to this handler is an instance of CloseEvent;
the detail property of this object contains the value
Alert.OK , Alert.CANCEL ,
Alert.YES , or Alert.NO .
| |
iconClass:Class (default = null ) — Icon which is placed to the left of the text. If not provided, an 'info'
icon is displayed.
| |
defaultButtonFlag:uint (default = 0x4 ) — A bitflag that specifies the default button. You can specify one and only one of
Alert.YES , or Alert.NO . The default value is
Alert.NO . Pressing the Enter key triggers the default button
just as if you clicked it. Pressing Escape triggers the No button just
as if you selected it.
| |
id:String |
Alert —
The displayed Alert
|
showAlertWithCheckbox | () | method |
public static function showAlertWithCheckbox(text:String, title:String, flags:uint = 0x4, parent:Sprite = null, closeHandler:Function = null, iconClass:Class = null, defaultButtonFlag:uint = 0x4, checkPrompt:String = null, defaultChecked:Boolean = false, id:String):void
A static method which pops up an modal dialog alert. The dialog window will close when a button is selected in the control. A checkbox will be displayed for input below the message text.
Parameters
text:String — Text string that appears in the Alert control. This text is centered
in the alert dialog box.
| |
title:String — Text string that appears in the title bar. This text is left justified.
| |
flags:uint (default = 0x4 ) — Which buttons to place in the Alert control.
| |
parent:Sprite (default = null ) — Object upon which the Alert control centers itself. If not set, Alert will
center in the screen.
| |
closeHandler:Function (default = null ) — Event handler that is called when any button on the Alert control is pressed.
The event object passed to this handler is an instance of CloseEvent;
the detail property of this object contains the value
Alert.OK , Alert.CANCEL ,
Alert.YES , or Alert.NO .
| |
iconClass:Class (default = null ) — Icon which is placed to the left of the text. If not provided, an 'info'
icon is displayed.
| |
defaultButtonFlag:uint (default = 0x4 ) — A bitflag that specifies the default button. You can specify one and only one of
Alert.YES , or Alert.NO . The default value is
Alert.NO . Pressing the Enter key triggers the default button
just as if you clicked it. Pressing Escape triggers the No button just
as if you selected it.
| |
checkPrompt:String (default = null ) — Label for the checkbox. <null> to not display a checkbox.
| |
defaultChecked:Boolean (default = false ) — Default check state for the checkbox.
| |
id:String — Optional alert id.
|
showError | () | method |
public static function showError(text:String, title:String, parent:Sprite = null, closeHandler:Function = null, id:String, error:Error = null):void
Helper method to show an error dialog.
Parameters
text:String — Text string that appears in the Alert control. This text is centered
in the Alert dialog box. (Defaults to error.message if not specified)
| |
title:String — Text string that appears in the title bar. This text is left justified.
| |
parent:Sprite (default = null ) — Object upon which the Alert control centers itself. If not set, Alert will
center in the screen.
| |
closeHandler:Function (default = null ) — Event handler that is called when any button on the Alert control is pressed.
The event object passed to this handler is an instance of CloseEvent;
the detail property of this object contains the value
Alert.OK , Alert.CANCEL ,
Alert.YES , or Alert.NO .
| |
id:String — Flash error used for debugging.
| |
error:Error (default = null )
|
showOkCancelWarning | () | method |
public static function showOkCancelWarning(text:String, title:String, parent:Sprite = null, closeHandler:Function = null, defaultButtonFlag:uint = 0x0008, id:String):void
Helper method to show an ok/cancel confirmation dialog.
Parameters
text:String — Text string that appears in the Alert control. This text is centered
in the Alert dialog box.
| |
title:String — Text string that appears in the title bar. This text is left justified.
| |
parent:Sprite (default = null ) — Object upon which the Alert control centers itself. If not set, Alert will
center in the screen.
| |
closeHandler:Function (default = null ) — Event handler that is called when any button on the Alert control is pressed.
The event object passed to this handler is an instance of CloseEvent;
the detail property of this object contains the value
Alert.OK or Alert.CANCEL .
| |
defaultButtonFlag:uint (default = 0x0008 ) — A bitflag that specifies the default button. You can specify one and only one of
Alert.OK , or Alert.CANCEL . The default value is
Alert.CANCEL . Pressing the Enter key triggers the default button
just as if you clicked it. Pressing Escape triggers the Cancel button just
as if you selected it.
| |
id:String |
showPopUp | () | method |
public static function showPopUp(window:IFlexDisplayObject = null, parent:DisplayObject = null, modal:Boolean = false, childList:String = null, anchorDirection:String = center):void
Displays a pop up window at the top level. This should be used in place of PopUpManager.addPopUp if module-specific styling is required.
Parameters
window:IFlexDisplayObject (default = null ) — The display object to be popped up.
| |
parent:DisplayObject (default = null ) — Object upon which the Alert control centers itself. If not set, Alert will
center in the screen.
| |
modal:Boolean (default = false ) — If the user can interact with other objects in the background.
| |
childList:String (default = null ) — The child list in which to add the pop-up.
One of PopUpManagerChildList.APPLICATION ,
PopUpManagerChildList.POPUP ,
or PopUpManagerChildList.PARENT (default).
| |
anchorDirection:String (default = center ) — Where the pop up should be anchored in the parent.
You can specify one of:
Dialogs.NO_ANCHOR to prevent anchoring
Dialogs.CENTER to anchor the dialog to the center of the parent
Dialogs.BOTTOM_RIGHT to anchor the dialog in the bottom
right of the parent
|
showWarning | () | method |
public static function showWarning(text:String, title:String, parent:Sprite = null, closeHandler:Function = null, id:String):void
Helper method to show a warning dialog.
Parameters
text:String — Text string that appears in the Alert control. This text is centered
in the alert dialog box.
| |
title:String — Text string that appears in the title bar. This text is left justified.
| |
parent:Sprite (default = null ) — Object upon which the Alert control centers itself. If not set, Alert will
center in the screen.
| |
closeHandler:Function (default = null ) — Event handler that is called when any button on the Alert control is pressed.
The event object passed to this handler is an instance of CloseEvent;
the detail property of this object contains the value
Alert.OK , Alert.CANCEL ,
Alert.YES , or Alert.NO .
| |
id:String |
showYesNoQuestion | () | method |
public static function showYesNoQuestion(text:String, title:String, parent:Sprite = null, closeHandler:Function = null, defaultButtonFlag:uint = 0x2, iconClass:Class = null, id:String, showCancelButton:Boolean = false):void
Helper method to show a yes/no confirmation dialog.
Parameters
text:String — Text string that appears in the Alert control. This text is centered
in the Alert dialog box.
| |
title:String — Text string that appears in the title bar. This text is left justified.
| |
parent:Sprite (default = null ) — Object upon which the Alert control centers itself. If not set, Alert will
center in the screen.
| |
closeHandler:Function (default = null ) — Event handler that is called when any button on the Alert control is pressed.
The event object passed to this handler is an instance of CloseEvent;
the detail property of this object contains the value
Alert.OK , Alert.CANCEL ,
Alert.YES , or Alert.NO .
| |
defaultButtonFlag:uint (default = 0x2 ) — A bitflag that specifies the default button. You can specify one and only one of
Alert.YES , or Alert.NO . The default value is
Alert.NO . Pressing the Enter key triggers the default button
just as if you clicked it. Pressing Escape triggers the No button just
as if you selected it.
| |
iconClass:Class (default = null ) — Class of the icon that is placed to the left of the text in the Alert control.
Defaults to question icon if nothing is specified.
| |
id:String — Specifies if the 'Cancel' button should be shown as well. Defaults to false.
| |
showCancelButton:Boolean (default = false )
|
BOTTOM_RIGHT | Constant |
public static const BOTTOM_RIGHT:String = bottom_right
Const used as a directional option for the AnchoredDialog.
CENTER | Constant |
public static const CENTER:String = center
Const used as a directional option for the AnchoredDialog.
CHECKED | Constant |
public static const CHECKED:uint = 0x0010
Result value for if the checkbox is selected. Use an (&) to check value.
NO_ANCHOR | Constant |
public static const NO_ANCHOR:String = no_anchor
Const used as a directional option for the AnchoredDialog.