qnx.fuse.ui.dialog.LoginDialog

LoginDialog

Properties | Methods | Events


Packageqnx.fuse.ui.dialog
Classpublic class LoginDialog
InheritanceLoginDialog Inheritance AlertDialog Inheritance DialogBase Inheritance qnx.fuse.ui.window.WindowedComponent
Subclasses PasswordChangeDialog

The LoginDialog class consists of the inherited elements of the AlertDialog along with a username TextInput, a password TextInput, a show password CheckBox and a remember me CheckBox. You must set usernamePlaceholder and/or passwordPlaceholder to show the username and/or password fields.

Class information:
BlackBerry 10 Version:   10.0.0



Public Properties

 PropertyDefined By
 InheritedallowEmptyResponse : Boolean
Determines whether the dialog enables the default button when input fields are empty or not.
DialogBase
 InheritedbuttonCount : int
[read-only] Read-only property reflecting the number of buttons in the dialog.
DialogBase
 InheritedbuttonLimit : int
Sets the limit for the number of buttons that can appear in the footer on the dialog.
DialogBase
 InheritedcancelRequired : Boolean
DialogBase
 InheritedcheckboxLabel : String
The text for the checkbox label on the dialog.
AlertDialog
 InheritedcontentSelectable : Boolean
Gets or Sets flag indicating the main content container is selectable.
DialogBase
 InheriteddefaultButtonIndex : int
Gets or sets the default button index value used to determine what button to automatically select in the event that the user hits the return key.
DialogBase
  errorText : String
Sets the text for the error field on the dialog.
LoginDialog
 Inheritedicon : String
Sets the icon based on absolute path
AlertDialog
 InheritedisBusy : Boolean
Determines whether the dialog should allow the activity indicator to the user or not.
DialogBase
 Inheritedmessage : String
Sets the message text for the dialog.
AlertDialog
 InheritedmessageHasEmoticons : Boolean
[write-only] Indicates whether the message text has emoticons or not.
AlertDialog
  password : String
Sets the text for the password field on the dialog.
LoginDialog
  passwordKeyboard : String
LoginDialog
  passwordPrompt : String
Makes password field visible and sets the prompt text for the field on the dialog.
LoginDialog
  rememberMe : Boolean
Sets the remember me state on the dialog.
LoginDialog
  rememberMeLabel : String
Sets the text for the remember me checkbox on the dialog.
LoginDialog
 InheritedreturnKeyType : String
Sets the return key type for input fields on the dialog.
DialogBase
 InheritedselectedIndex : int
[read-only] Read-only property which defines the index of the button selected to close the dialog, or -1 of no button was selected.
DialogBase
  showPassword : Boolean
Deprecated: showPassword has been deprecated. The show password checkbox feature has been replaced by explicit mask/unmask controls in the individual password fields. The showPassword property can no longer be set and will always return false.
Sets the show password state on the dialog.
LoginDialog
  showPasswordLabel : String
Deprecated: showPasswordLabel has been deprecated. The show password checkbox feature has been replaced by explicit mask/unmask controls in the individual password fields. The showPasswordLabel property can no longer be set and will always return "".
Sets the text for the show password checkbox on the dialog.
LoginDialog
 InheritedtextInputOptions : int
Sets the text input options for input fields on the dialog.
DialogBase
 Inheritedtitle : String
Sets the text for the dialog title.
DialogBase
  username : String
Sets the text for the username field on the dialog.
LoginDialog
  usernameKeyboard : String
LoginDialog
  usernamePrompt : String
Makes username field visible and sets the prompt text for the field on the dialog.
LoginDialog

Protected Properties

 PropertyDefined By
 Inheritedcheckbox : CheckBox
AlertDialog
 InheritedcheckboxContainer : Container
The always show this message (or whatever) checkbox.
AlertDialog
 Inheritedcontent : Container
The container for the dialog content area
DialogBase
 InheritedcssID : String
[override] [read-only] Returns the CSS ID of the component.
DialogBase
 InheriteddialogContainer : Container
The outer-most container for the dialog
DialogBase
  errorLabel : Label
The error Label.
LoginDialog
 Inheritedfooter : Container
The container for the dialog footer area
DialogBase
 Inheritedheader : Container
The container for the dialog header area
DialogBase
 InheritediconAndMessageLabelContainer : Container
AlertDialog
 InheritediconImage : Image
The icon.
AlertDialog
 InheritediconPath : String
AlertDialog
 InheritedmasterContent : Container
The container for the master content area
DialogBase
 InheritedmessageHTML : String
AlertDialog
 InheritedmessageLabel : Label
The message Label.
AlertDialog
  passwordInput : TextInput
The password TextInput field.
LoginDialog
 InheritedtitleHTML : String
DialogBase
  usernameInput : TextInput
The username TextInput field.
LoginDialog

Public Methods

 MethodDefined By
  
Constructor for the LoginDialog class.
LoginDialog
 Inherited
addButton(label:String):int
Adds a button to the dialog.
DialogBase
 Inherited
cancel():void
[override] Cancels the on-screen dialog.
DialogBase
 Inherited
[override] Called by the WindowManager class to request that the window control object immediately cancel the window.
DialogBase
 Inherited
getButtonPropertyAt(prop:String, index:int):Object
Gets the value of a property, given the property name and property object index.
DialogBase
 Inherited
getItemAt(index:int):Object
Returns the button at the given index, or null if the index is out of range.
DialogBase
 Inherited
onTransition(state:String):void
[override]
DialogBase
 Inherited
removeButtonAt(index:int):void
Removes the button from the dialog at the specified index.
DialogBase
 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.
DialogBase
 Inherited
show():void
[override] Shows the dialog on the screen.
DialogBase
 Inherited
update():void
[override] Updates the on-screen dialog to reflect its current attributes.
DialogBase
 Inherited
[override]
DialogBase

Protected Methods

 MethodDefined By
 Inherited
applyLocaleUpdates(data:Object, translate:Function):void
[override]
AlertDialog
 Inherited
This function is called whenever the textInputOptions have changed for the dialog.
DialogBase
 Inherited
createButton(position:String):LabelButton
Called to create a dialog button (must be derived from LabelButton)
DialogBase
  
createContent(container:Container):void
[override] Called to create the content area
LoginDialog
 Inherited
createDialog(container:Container):void
Called to create the dialog area
DialogBase
 Inherited
createFooter(container:Container):void
Called to create the footer area
DialogBase
 Inherited
createHeader(container:Container):void
Called to populate the header area
DialogBase
 Inherited
createIcon():void
AlertDialog
 Inherited
Called to create the content area
DialogBase
 Inherited
Called to create the button content area
DialogBase
 Inherited
Ensures the given component is properly destroyed.
DialogBase
 Inherited
The disableActionButton method disables the action button if there is more than one button, if it is not currently disabled and if defaultButtonIndex is set.
DialogBase
 Inherited
The enableActionButton method enables the action button if it was disabled.
DialogBase
  
init():void
[override]
LoginDialog
  
[override]
LoginDialog
 Inherited
onIconLoaded(e:Event):void
AlertDialog
 Inherited
onIconLoadFailed(e:IOErrorEvent):void
AlertDialog
 Inherited
removeIcon():void
AlertDialog

Events

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

Protected Constants

 ConstantDefined By
 InheritedCHECKBOX_CHECKED : String = checkboxChecked
[static]
AlertDialog
 InheritedCHECKBOX_ENABLED : String = checkboxEnabled
[static]
AlertDialog
 InheritedCHECKBOX_LABEL : String = checkboxLabel
[static]
AlertDialog
 InheritedCONTENT_SELECTED_INDEX : int = -2
[static] Selected index assigned when selectable content is pressed
DialogBase
 InheritedDIALOG_CHECKBOX : String = dialogCheckBox
[static]
DialogBase
 InheritedID_ALIGN_RIGHT : String = dialogAlignRight
[static] Id tag assigned to labels or text fields that want to inherit CSS right alignment formatting.
DialogBase

Property Detail

errorLabel


protected var errorLabel:Label

The error Label.

errorText


errorText:String

Sets the text for the error field on the dialog.


Implementation

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

password


password:String

Sets the text for the password field on the dialog.


Implementation

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

passwordInput


protected var passwordInput:TextInput

The password TextInput field.

passwordKeyboard


passwordKeyboard:String


Implementation

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

passwordPrompt


passwordPrompt:String

Makes password field visible and sets the prompt text for the field on the dialog.


Implementation

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

rememberMe


rememberMe:Boolean

Sets the remember me state on the dialog.


Implementation

public function get rememberMe():Boolean
public function set rememberMe(value:Boolean):void

rememberMeLabel


rememberMeLabel:String

Sets the text for the remember me checkbox on the dialog.


Implementation

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

showPassword


showPassword:Boolean
Deprecated: showPassword has been deprecated. The show password checkbox feature has been replaced by explicit mask/unmask controls in the individual password fields. The showPassword property can no longer be set and will always return false.

Sets the show password state on the dialog.


Implementation

public function get showPassword():Boolean
public function set showPassword(value:Boolean):void

showPasswordLabel


showPasswordLabel:String
Deprecated: showPasswordLabel has been deprecated. The show password checkbox feature has been replaced by explicit mask/unmask controls in the individual password fields. The showPasswordLabel property can no longer be set and will always return "".

Sets the text for the show password checkbox on the dialog.


Implementation

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

username


username:String

Sets the text for the username field on the dialog.


Implementation

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

usernameInput


protected var usernameInput:TextInput

The username TextInput field.

usernameKeyboard


usernameKeyboard:String


Implementation

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

usernamePrompt


usernamePrompt:String

Makes username field visible and sets the prompt text for the field on the dialog.


Implementation

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

Constructor Detail

LoginDialog()


public function LoginDialog()

Constructor for the LoginDialog class.

Method Detail

createContent()


override protected function createContent(container:Container):void

Called to create the content area

Parameters

container:Container

init()


override protected function init():void

onClearPasswords()


override protected function onClearPasswords():void





comments powered by Disqus