qnx.dialog.PromptDialog

PromptDialog

Properties | Methods | Events | Examples


Packageqnx.dialog
Classpublic class PromptDialog
InheritancePromptDialog Inheritance BaseDialog Inheritance flash.events.EventDispatcher

The PromptDialog class encapsulates the properties of a prompt dialog. The prompt dialog is used to prompt the user to complete an action.

Class information:
PlayBook Tablet OS Version:   1.0.6

View the examples

See also

AlertDialog



Public Properties

 PropertyDefined By
 Inheritedalign : String
[write-only] Sets the position of the dialog.
BaseDialog
 InheriteddefaultButtonIndex : int
Gets or sets the default button index value.
BaseDialog
 InheriteddialogSize : String
Gets or sets the size of the dialog.
BaseDialog
  displayAsPassword : Boolean
[write-only] Sets the value of displayAsPassword on the TextInput.
PromptDialog
 InheritedhideOnButtonClick : Boolean
Gets or sets the a value that determines if the dialog will close when the user clicks a button.
BaseDialog
 InheritedhideOnOutsideClick : Boolean
Gets or sets the a value that determines if the dialog will close when the user clicks outside the dialog ( perhaps on the modal ).
BaseDialog
 Inheritedid : String
The ID of the dialog, where each ID is unique to the client owner.
BaseDialog
 InheritedleaveFocus : Boolean
[write-only] Sets the leaveFocus property for the dialog.
BaseDialog
  message : String
[write-only] Sets the value of the message field.
PromptDialog
  messageHtml : String
[write-only] Sets the message TextField's html value.
PromptDialog
 InheritedmodalAlpha : Number
[write-only] Sets the background alpha value.
BaseDialog
  prompt : String
[write-only] Sets the value of the input placeholder text.
PromptDialog
 InheritedselectedIndex : int
[read-only] Returns the selected index of the button (that was clicked).
BaseDialog
  text : String
Gets or sets the value of the input TextField.
PromptDialog
 Inheritedtitle : String
[write-only] Sets the text for the dialog's title.
BaseDialog
 InheritedtitleHtml : String
[write-only] Sets the html text for the dialog's title.
BaseDialog

Public Methods

 MethodDefined By
  
Creates a PromptDialog instance.
PromptDialog
 Inherited
addButton(label:String):int
Adds a button to the dialog.
BaseDialog
 Inherited
cancel():void
Cancels or hides the dialog.
BaseDialog
 Inherited
Return the button count from the button array.
BaseDialog
 Inherited
getButtonPropertyAt(prop:String, index:int):Object
Gets the value of a property, given the property name and property object index.
BaseDialog
 Inherited
getItemAt(index:int):Object
Returns the button at the given index.
BaseDialog
 Inherited
removeButtonAt(index:int):void
Removes a button from the dialog, given an index.
BaseDialog
 Inherited
Gathers up and returns the description object for the dialog (client side).
BaseDialog
 Inherited
setButtonPropertyAt(prop:String, value:Object, index:int):void
Sets a button property given a property name, a property value, and the index of a button property object.
BaseDialog
 Inherited
show(groupId:String = null):void
Shows the dialog on the screen as a system or application dialog.
BaseDialog
 Inherited
update():void
Updates the dialog to reflect its current attributes.
BaseDialog

Events

 Event Summary Defined By
 InheritedDispatched when a button in the dialog has been clicked.BaseDialog

Property Detail

displayAsPassword


displayAsPassword:Boolean  [write-only]

Sets the value of displayAsPassword on the TextInput.


Implementation

public function set displayAsPassword(value:Boolean):void

message


message:String  [write-only]

Sets the value of the message field.


Implementation

public function set message(value:String):void

See also

messageHtml()

messageHtml


messageHtml:String  [write-only]

Sets the message TextField's html value.

In addition to providing HTML formatting to message text, the messageHtml method can be used to place images from the web within the message body of a dialog. In the following listing, an external image is placed in the body of a dialog and scaled using the width and height attributes.

         var dialog:PromptDialog = new PromptDialog();
         dialog.messageHtml = "<img src='http://www.somewebsite.com/somegraphic.jpg'" +
                     "width='500' height='350'/>";
         


Implementation

public function set messageHtml(value:String):void

prompt


prompt:String  [write-only]

Sets the value of the input placeholder text. The placeholder text appears in the text input field.


Implementation

public function set prompt(value:String):void

text


text:String

Gets or sets the value of the input TextField.


Implementation

public function get text():String
public function set text(value:String):void

Constructor Detail

PromptDialog()


public function PromptDialog()

Creates a PromptDialog instance.

Examples

The following code listing sets up a small prompt dialog with two buttons, a title, and a message:

        private function showPromptDialog():void
        {
            prompt = new PromptDialog();
            prompt.title = "WEP Key";
            prompt.message = "Please enter your 14 digit encryption key:";
            prompt.addButton("OK");
            prompt.addButton("Cancel");
            prompt.dialogSize= DialogSize.SIZE_SMALL;
            prompt.addEventListener(Event.SELECT, dButtonClicked); 
            prompt.show(IowWindow.getAirWindow().group);
        }
     

The code snippet above produces the following dialog:

Note: In the last line of the code snippet above, the window group ID is passed into the show method:

     .show(IowWindow.getAirWindow().group);
     
This ensures that the dialog will be modal for only this application. In other words, the application can still be minimized when this dialog is active.