| Package | qnx.dialog |
| Class | public final class LoginDialog |
| Inheritance | LoginDialog  BaseDialog flash.events.EventDispatcher |
LoginDialog class encapsulates the properties of
a login dialog. The login dialog is used to provide password and identification
functionality for the device.
| Property | Defined By | ||
|---|---|---|---|
 | align : String [write-only]
Sets the position of the dialog. | BaseDialog | |
| defaultButtonIndex : int
Gets or sets the default button index value. | BaseDialog | |
| dialogSize : String
Gets or sets the size of the dialog. | BaseDialog | |
| hideOnButtonClick : Boolean
Gets or sets the a value that determines if the dialog will close
when the user clicks a button. | BaseDialog | |
| hideOnOutsideClick : 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 | |
| id : String
The ID of the dialog, where each ID is unique to the client owner. | BaseDialog | |
| leaveFocus : Boolean [write-only]
Sets the leaveFocus property for the dialog. | BaseDialog | |
| message : String [write-only]
Sets the value of the message field. | LoginDialog | ||
| messageHtml : String [write-only]
Sets the message TextField's html value. | LoginDialog | ||
| modalAlpha : Number [write-only]
Sets the background alpha value. | BaseDialog | |
| password : String
Gets and sets the password entered by the user. | LoginDialog | ||
| passwordLabel : String [write-only]
Sets the password label for the dialog. | LoginDialog | ||
| passwordPrompt : String [write-only]
Sets the password placeholder text for the user. | LoginDialog | ||
| rememberMe : Boolean
Gets or sets a value that determines the user's preference for remembering login credentials. | LoginDialog | ||
| rememberMeLabel : String [write-only]
Sets the remember me label for the dialog checkbox. | LoginDialog | ||
| selectedIndex : int [read-only]
Returns the selected index of the button (that was clicked). | BaseDialog | |
| title : String [write-only]
Sets the text for the dialog's title. | BaseDialog | |
| titleHtml : String [write-only]
Sets the html text for the dialog's title. | BaseDialog | |
| username : String
Gets and sets the username entered by the user. | LoginDialog | ||
| usernameLabel : String [write-only]
Sets the user name label for the dialog. | LoginDialog | ||
| usernamePrompt : String [write-only]
Sets the user name placeholder text for the dialog. | LoginDialog | ||
| Method | Defined By | ||
|---|---|---|---|
Constructor for the LoginDialog class. | LoginDialog | ||
| addButton(label:String):int
Adds a button to the dialog. | BaseDialog | |
| cancel():void
Cancels or hides the dialog. | BaseDialog | |
| getButtonCount():int
Return the button count from the button array. | BaseDialog | |
| getButtonPropertyAt(prop:String, index:int):Object
Gets the value of a property, given the property name and property object index. | BaseDialog | |
| getItemAt(index:int):Object
Returns the button at the given index. | BaseDialog | |
| removeButtonAt(index:int):void
Removes a button from the dialog, given an index. | BaseDialog | |
| sendDescription():Object
Gathers up and returns the description object for the dialog (client side). | BaseDialog | |
| 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 | |
| show(groupId:String = null):void
Shows the dialog on the screen as a system or application dialog. | BaseDialog | |
| update():void
Updates the dialog to reflect its current attributes. | BaseDialog | |
| message | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesmessage:String [write-only] Sets the value of the message field.
public function set message(value:String):voidSee also
| messageHtml | property |
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:LoginDialog = new LoginDialog();
dialog.messageHtml = "<img src='http://www.somewebsite.com/somegraphic.jpg'" +
"width='500' height='350'/>";
public function set messageHtml(value:String):void| password | property |
password:StringGets and sets the password entered by the user.
public function get password():String public function set password(value:String):void| passwordLabel | property |
passwordLabel:String [write-only] Sets the password label for the dialog. If null, the password field is not shown.
public function set passwordLabel(value:String):void| passwordPrompt | property |
passwordPrompt:String [write-only] Sets the password placeholder text for the user.
public function set passwordPrompt(value:String):void| rememberMe | property |
rememberMe:BooleanGets or sets a value that determines the user's preference for remembering login credentials.
public function get rememberMe():Boolean public function set rememberMe(value:Boolean):void| rememberMeLabel | property |
rememberMeLabel:String [write-only] Sets the remember me label for the dialog checkbox. If null, the remember me check box is not shown.
public function set rememberMeLabel(value:String):void| username | property |
username:StringGets and sets the username entered by the user.
public function get username():String public function set username(value:String):void| usernameLabel | property |
usernameLabel:String [write-only] Sets the user name label for the dialog. If null, the user name field is not shown.
public function set usernameLabel(value:String):void| usernamePrompt | property |
usernamePrompt:String [write-only] Sets the user name placeholder text for the dialog.
public function set usernamePrompt(value:String):void| LoginDialog | () | Constructor |
public function LoginDialog()
Constructor for the LoginDialog class.
The following code listing sets up a login dialog with two buttons, a title, and a message:
private function showLoginDialog():void
{
login = new LoginDialog();
login.title = "Device is locked";
login.message = "Please enter your username and password:";
login.addButton("OK");
login.addButton("Cancel");
login.passwordPrompt = "password";
login.rememberMeLabel = 'Remember me';
login.rememberMe = true;
login.dialogSize= DialogSize.SIZE_SMALL;
login.addEventListener(Event.SELECT, dButtonClicked);
login.show(IowWindow.getAirWindow().group);
}
The code above produces the following dialog:
The passwordPrompt and usernamePrompt properties allow you to add placeholder
text to the password and username fields. A user can click the rememberMe checkbox to store
user login information.
show method:
.show(IowWindow.getAirWindow().group);