Eclipse RSE Development Guide (Galileo) - ISystemPasswordPromptDialog (RSE API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

RSE
Release 3.0

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.rse.ui.dialogs
Interface ISystemPasswordPromptDialog

All Known Implementing Classes:: SystemPasswordPromptDialog

public interface ISystemPasswordPromptDialog

Suggested interface for a dialog used to prompt user for a password.

Method Summary

boolean getForceToUpperCase ()
          Call this to query the force-to-uppercase setting

boolean getIsSavePassword ()
          Return true if the user elected to save the password

boolean getIsUserIdChanged ()
          Return true if the user changed the user id

boolean getIsUserIdChangePermanent ()
          Return true if the user elected to make the changed user Id a permanent change.

String getPassword ()
          Return the password entered by user

Shell getShell ()
          Return the shell for this dialog

String getUserId ()
          Return the userId entered by user

int open ()
          Open the dialog

void setBlockOnOpen (boolean block)
          Set modal vs modeless

void setForceToUpperCase (boolean force)
          Call this to force the userId and password to uppercase

void setPassword ( String password)
          Sets the password

void setPasswordValidator ( ISystemValidator v)
          Call this to specify a validator for the password.

void setSavePassword (boolean save)
          Preselect the save password checkbox.

void setSignonValidator ( ICredentialsValidator v)
          Call this to specify a validator for the signon.

void setSystemInput ( IConnectorService systemObject)
          Set the input System object in which the user is attempting to do a connect action.

void setUserIdValidator ( ISystemValidator v)
          Call this to specify a validator for the userId.

boolean wasCancelled ()
          Allow caller to determine if window was cancelled or not.

Method Detail

setBlockOnOpen

void setBlockOnOpen(boolean block)

Set modal vs modeless

open

int open()

Open the dialog

setSystemInput

void setSystemInput(
IConnectorService systemObject)

Set the input System object in which the user is attempting to do a connect action. This is used to query the system type, host name and userId to display to the user for contextual information.

This must be called right after instantiating this dialog.

wasCancelled

boolean wasCancelled()

Allow caller to determine if window was cancelled or not.

setUserIdValidator

void setUserIdValidator(
ISystemValidator v)

Call this to specify a validator for the userId. It will be called per keystroke.

setPasswordValidator

void setPasswordValidator(
ISystemValidator v)

Call this to specify a validator for the password. It will be called per keystroke.

setSignonValidator

void setSignonValidator(
ICredentialsValidator v)

Call this to specify a validator for the signon. It will be called when the OK button is pressed.

setForceToUpperCase

void setForceToUpperCase(boolean force)

Call this to force the userId and password to uppercase

getForceToUpperCase

boolean getForceToUpperCase()

Call this to query the force-to-uppercase setting

getUserId


String getUserId()

Return the userId entered by user

getPassword


String getPassword()

Return the password entered by user

setPassword

void setPassword(
String password)

Sets the password

setSavePassword

void setSavePassword(boolean save)

Preselect the save password checkbox. Default value is to not select the save password checkbox.

getIsUserIdChanged

boolean getIsUserIdChanged()

Return true if the user changed the user id

getIsUserIdChangePermanent

boolean getIsUserIdChangePermanent()

Return true if the user elected to make the changed user Id a permanent change.

getIsSavePassword

boolean getIsSavePassword()

Return true if the user elected to save the password

getShell


Shell getShell()

Return the shell for this dialog