Class idx.mobile.Login
Extends
dojox.mobile.SimpleDialog.
The Login widget is a dialog enabling the user to log in to an
IBM One UI application in a standard way. It extends dojox/mobile/SimpleDialog
to perform initialisation and configuration.
To create the dialog, initialise the widget with the required properties. The appropriate HTML and CSS is created immediately, and subsidiary dijit components may be created and marshalled, but the dialog is initially hidden. When the dialog is to be shown, call the show() method. If the dialog includes a cancel button, this will automatically hide the dialog when selected. The application may also hide the dialog if required by calling the hide() method.
When the user has entered credentials and presses the "Log In" button, the "login" event is triggered. The application can connect to the "onLogin" method which receives an object containing two fields:
- name: the user name entered
- password: the password entered
Defined in: <idx\mobile\Login.js>.
Constructor Summary
Constructor Attributes | Constructor Name and Description |
---|---|
Creates a new "Login" dialog
|
Field Summary
Field Attributes | Field Name and Description |
---|---|
If true, the dialog will include a cancel button enabling the user to
abandon the login attempt.
|
|
The copyright year or years that should be inserted into the legal information.
|
|
The copyright or other legal information that should be displayed.
|
|
The product name (required), to a maximum of 90 characters.
|
Method Summary
Method Attributes | Method Name and Description |
---|---|
create()
|
|
hide()
|
|
onLogin(args)
Handle the user pressing the "Log In" button.
|
|
showMessage(message)
Display a message to the user on the login panel.
|
Constructor Detail
idx.mobile.Login()
var logindialog = new idx.mobile.Login({ name: "My product", onLogin: function(args){ this.hide(); } });
Field Detail
cancelable
copyright
{string} legal
{string} name
Method Detail
buildRendering()
create()
hide()
onLogin(args)
- Parameters:
- args
postMixInProperties()
showMessage(message)
- Parameters:
- message