Packageqnx.dialog
Classpublic final class PasswordChangeDialog
InheritancePasswordChangeDialog Inheritance BaseDialog Inheritance flash.events.EventDispatcher

The PasswordChangeDialog class encapsulates the properties of a password set/change dialog. The password change dialog is used to provide password modification functionality for the device. The user name field is optional and is included to support use cases where the user name is implicit or there is no user name (for example, device password).

View the examples

See also

LoginDialog


Public Properties
 PropertyDefined By
 Inheritedalign : String
[write-only] Sets the position of the dialog.
BaseDialog
  confirmation : String
[read-only] Returns the new password confirmation entered by the user.
PasswordChangeDialog
  confirmationLabel : String
[write-only] Sets the confirmation label for the dialog.
PasswordChangeDialog
  confirmationPrompt : String
[write-only] Sets the confirmation placeholder text for the user.
PasswordChangeDialog
 InheriteddefaultButtonIndex : int
Gets or sets the default button index value.
BaseDialog
 InheriteddialogSize : String
Gets or sets the size of the dialog.
BaseDialog
 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
  message : String
[write-only] Sets the value of the message field.
PasswordChangeDialog
  messageHtml : String
[write-only] Sets the message TextField's html value.
PasswordChangeDialog
 InheritedmodalAlpha : Number
[write-only] Sets the background alpha value.
BaseDialog
  newPassword : String
[read-only] Gets and sets the new password entered by the user.
PasswordChangeDialog
  newPasswordLabel : String
[write-only] Sets the new password label for the dialog.
PasswordChangeDialog
  newPasswordPrompt : String
[write-only] Sets the new password placeholder text for the user.
PasswordChangeDialog
  password : String
Gets or sets the password entered by the user.
PasswordChangeDialog
  passwordLabel : String
[write-only] Sets the password label for the dialog.
PasswordChangeDialog
  passwordPrompt : String
[write-only] Sets the password placeholder text for the user.
PasswordChangeDialog
  rememberMe : Boolean
Gets or sets a value that determines the user's preference for remembering login credentials.
PasswordChangeDialog
  rememberMeLabel : String
[write-only] Sets the remember me label for the dialog check box.
PasswordChangeDialog
 InheritedselectedIndex : int
[read-only] Returns the selected index of the button (that was clicked).
BaseDialog
 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
  username : String
Gets or sets the username entered by the user.
PasswordChangeDialog
  usernameLabel : String
[write-only] Sets the user name label for the dialog.
PasswordChangeDialog
  usernamePrompt : String
[write-only] Sets the user name placeholder text for the dialog.
PasswordChangeDialog
Public Methods
 MethodDefined By
  
Constructor for the PasswordChangeDialog class.
PasswordChangeDialog
 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
confirmationproperty
confirmation:String  [read-only]

Returns the new password confirmation entered by the user.


Implementation
    public function get confirmation():String
confirmationLabelproperty 
confirmationLabel:String  [write-only]

Sets the confirmation label for the dialog.

If null, a default label is used since the confirmation field is not optional.


Implementation
    public function set confirmationLabel(value:String):void
confirmationPromptproperty 
confirmationPrompt:String  [write-only]

Sets the confirmation placeholder text for the user.


Implementation
    public function set confirmationPrompt(value:String):void
messageproperty 
message:String  [write-only]

Sets the value of the message field.


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

See also

messageHtmlproperty 
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:PasswordChangeDialog = new PasswordChangeDialog();
         dialog.messageHtml = "<img src='http://www.somewebsite.com/somegraphic.jpg'" +
                 "width='500' height='350'/>";
         


Implementation
    public function set messageHtml(value:String):void
newPasswordproperty 
newPassword:String  [read-only]

Gets and sets the new password entered by the user.


Implementation
    public function get newPassword():String
newPasswordLabelproperty 
newPasswordLabel:String  [write-only]

Sets the new password label for the dialog.

If null, a default label is used since the new password field is not optional.


Implementation
    public function set newPasswordLabel(value:String):void
newPasswordPromptproperty 
newPasswordPrompt:String  [write-only]

Sets the new password placeholder text for the user.


Implementation
    public function set newPasswordPrompt(value:String):void
passwordproperty 
password:String

Gets or sets the password entered by the user.


Implementation
    public function get password():String
    public function set password(value:String):void
passwordLabelproperty 
passwordLabel:String  [write-only]

Sets the password label for the dialog. If null, the password field is not shown.


Implementation
    public function set passwordLabel(value:String):void
passwordPromptproperty 
passwordPrompt:String  [write-only]

Sets the password placeholder text for the user.


Implementation
    public function set passwordPrompt(value:String):void
rememberMeproperty 
rememberMe:Boolean

Gets or sets a value that determines the user's preference for remembering login credentials.


Implementation
    public function get rememberMe():Boolean
    public function set rememberMe(value:Boolean):void
rememberMeLabelproperty 
rememberMeLabel:String  [write-only]

Sets the remember me label for the dialog check box. If null, the remember me check box is not shown.


Implementation
    public function set rememberMeLabel(value:String):void
usernameproperty 
username:String

Gets or sets the username entered by the user.


Implementation
    public function get username():String
    public function set username(value:String):void
usernameLabelproperty 
usernameLabel:String  [write-only]

Sets the user name label for the dialog. If null, the user name field is not shown.


Implementation
    public function set usernameLabel(value:String):void
usernamePromptproperty 
usernamePrompt:String  [write-only]

Sets the user name placeholder text for the dialog.


Implementation
    public function set usernamePrompt(value:String):void
Constructor Detail
PasswordChangeDialog()Constructor
public function PasswordChangeDialog()

Constructor for the PasswordChangeDialog class.

Examples

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

        private function showPwDialog():void
        {
            pw = new PasswordChangeDialog();
            pw.title = "Password change";
            pw.message = "Please enter your new password:";
            pw.addButton("OK");
            pw.addButton("Cancel");
            pw.dialogSize= DialogSize.SIZE_MEDIUM;
            pw.addEventListener(Event.SELECT, dButtonClicked); 
            pw.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.