Class ecm.widget.dialog.LoginDialog
Extends
ecm.widget.dialog.BaseDialog.
Provides a dialog box that is used to log in to a content server.
Defined in: <ecm\widget\dialog\LoginDialog.js>.
Constructor Summary
| Constructor Attributes | Constructor Name and Description |
|---|---|
Field Summary
| Field Attributes | Field Name and Description |
|---|---|
|
The repository to be connected.
|
- Fields borrowed from class ecm.widget.dialog.BaseDialog:
- fitContentArea, lockFullscreen
Method Summary
| Method Attributes | Method Name and Description |
|---|---|
|
connectToRepository(repository, callback, onCancel, foreground)
Logs in to the specified repository.
|
|
|
hide()
Hides the dialog.
|
|
| <static> |
ecm.widget.dialog.LoginDialog.LoginDialog.checkLogin(repository, callback, onCancel, foreground)
Static method that displays a login dialog if required to login to a specified repository.
|
| <static> |
ecm.widget.dialog.LoginDialog.LoginDialog.getLoginDialog()
Static method that returns a singleton global instance of the login dialog.
|
|
onCancel()
|
|
|
onConnected(repository)
An event invoked when the login is successful.
|
|
|
onLoginFailed(response, errors)
An event invoked when the login fails.
|
|
|
sessionExpiredHandler(request, error)
This method can be connected to listen to ecm.desktop.onSessionExpired to display the login dialog
for session expiration.
|
|
|
setDesktopId(desktopId)
Sets the desktop identifier to do the log in to.
|
|
|
setRepository(repository)
|
|
|
show(timeout, request, onCancel, onCancel, prepped)
Shows the dialog.
|
- Methods borrowed from class ecm.widget.dialog.BaseDialog:
- addButton, appendSecondaryMessage, buildRendering, clearMessage, clearSecondaryMessage, destroy, isMaximized, onDragOver, resize, setIntroText, setIntroTextRef, setMaximized, setMessage, setReferenceLink, setResizable, setSize, setSizeToViewportRatio, setTitle, setWidth, showActionBar
Field Detail
repository
The repository to be connected. An instance of
ecm.model.Repository.
Method Detail
cleanMessage()
connectToRepository(repository, callback, onCancel, foreground)
Logs in to the specified repository. This sets the repository field and invokes the show function.
- Parameters:
- repository
- An instance of ecm.model.Repository for the repository to be connected.
- callback
- A function invoked when the login is successful.
- onCancel
- A callback function that is called if the login action is cancelled
- foreground
- Pass true to display the status window when connecting to an SSO repository.
constructor()
hide()
Hides the dialog. This is normally automatically invoked when login is successful.
<static> ecm.widget.dialog.LoginDialog.LoginDialog.checkLogin(repository, callback, onCancel, foreground)
Static method that displays a login dialog if required to login to a specified repository.
- Parameters:
- repository
- An instance of ecm.model.Repository for the repository to be connected.
- callback
- A function invoked when the login is successful. If no login is required then this function is immediately invoked.
- onCancel
- A callback function that is called if the login action is cancelled
- foreground
- Pass true to display the status window when connecting to an SSO repository.
<static> ecm.widget.dialog.LoginDialog.LoginDialog.getLoginDialog()
Static method that returns a singleton global instance of the login dialog.
- Returns:
- Returns the global instance of the login dialog.
onCancel()
onConnected(repository)
An event invoked when the login is successful.
- Parameters:
- repository
onLoginFailed(response, errors)
An event invoked when the login fails.
- Parameters:
- response
- errors
- Since:
- 2.0.3.3
postCreate()
sessionExpiredHandler(request, error)
This method can be connected to listen to ecm.desktop.onSessionExpired to display the login dialog
for session expiration.
- Parameters:
- request
- error
setDesktopId(desktopId)
Sets the desktop identifier to do the log in to. This is used to log into a different desktop.
- Parameters:
- desktopId
- The id of the desktop to log in to.
setRepository(repository)
- Parameters:
- repository
- The repository to connect to.
show(timeout, request, onCancel, onCancel, prepped)
Shows the dialog.
- Parameters:
- timeout
- If true, the dialog is displayed for timeout purposes. Only password can be entered. User name field will be read-only.
- request
- The original request to retry after login completes. This is only needed for cases where login is for session expiration.
- onCancel
- A callback function that is called if the login action is cancelled
- onCancel
- prepped