public abstract class AccountRegistrationWizard
extends java.lang.Object
Note that the AccountRegistrationWizard is NOT a real wizard, it doesn't handle wizard events. Each UI Service implementation should provide its own wizard UI control, which should manage all the events, panels and buttons, etc.
It depends on the wizard implementation in the UI for whether or not a summary will be shown to the user before "Finish".
Constructor and Description |
---|
AccountRegistrationWizard() |
Modifier and Type | Method and Description |
---|---|
void |
accountRemoved(ProtocolProviderService protocolProvider)
Indicates that the account corresponding to the given
protocolProvider has been removed.
|
abstract java.lang.Object |
getFirstPageIdentifier()
Returns the identifier of the first account registration wizard page.
|
java.lang.String |
getForgotPasswordLink()
Returns the forgot password link if one exists.
|
java.lang.String |
getForgotPasswordLinkName()
Returns the forgot password link name.
|
abstract byte[] |
getIcon()
Returns the protocol icon that will be shown on the left of the protocol
name in the list, where user will choose the protocol to register to.
|
abstract java.lang.Object |
getLastPageIdentifier()
Returns the identifier of the last account registration wizard page.
|
abstract byte[] |
getPageImage()
Returns the image that will be shown on the left of the wizard pages.
|
abstract java.util.Iterator<WizardPage> |
getPages()
Returns the set of WizardPage-s for this
wizard.
|
abstract java.lang.String |
getProtocolDescription()
Returns a short description of the protocol that will be shown on the
right of the protocol name in the list, where user will choose the
protocol to register to.
|
abstract java.lang.String |
getProtocolName()
Returns the protocol display name that will be shown in the list,
where user will choose the protocol to register to.
|
abstract java.lang.Object |
getSimpleForm(boolean isCreateAccount)
Returns a simple account registration form that would be the first form
shown to the user.
|
abstract java.util.Iterator<java.util.Map.Entry<java.lang.String,java.lang.String>> |
getSummary()
Returns a set of key-value pairs that will represent the summary for
this wizard.
|
abstract java.lang.String |
getUserNameExample()
Returns an example string, which should indicate to the user how the
user name should look like.
|
WizardContainer |
getWizardContainer()
Returns the wizard container, where all pages are added.
|
boolean |
isAdvancedConfigurationEnabled()
Whether the advanced configuration is enabled.
|
boolean |
isHidden()
Indicates if a wizard is hidden.
|
boolean |
isModification()
Indicates if this wizard is modifying an existing account or is creating
a new one.
|
boolean |
isPreferredProtocol()
Indicates if this wizard is for the preferred protocol.
|
boolean |
isSimpleFormEnabled()
Indicates whether this wizard enables the simple "sign in" form shown
when the user opens the application for the first time.
|
boolean |
isWebSignupSupported()
Returns
true if the web sign up is supported by the current
implementation, false - otherwise. |
abstract void |
loadAccount(ProtocolProviderService protocolProvider)
Loads all data concerning the given ProtocolProviderService.
|
void |
setModification(boolean isModification)
Sets the modification property to indicate if this wizard is opened for
a modification.
|
protected void |
setWizardContainer(WizardContainer wizardContainer)
Sets the wizard container, where all pages are added.
|
abstract ProtocolProviderService |
signin()
Defines the operations that will be executed when the user clicks on
the wizard "Signin" button.
|
abstract ProtocolProviderService |
signin(java.lang.String userName,
java.lang.String password)
Defines the operations that will be executed when the user clicks on
the wizard "Signin" button.
|
void |
webSignup()
Defines the operation that will be executed when user clicks on the
"Sign up" link.
|
public abstract byte[] getIcon()
public abstract byte[] getPageImage()
public abstract java.lang.String getProtocolName()
public abstract java.lang.String getProtocolDescription()
public abstract java.lang.String getUserNameExample()
public abstract void loadAccount(ProtocolProviderService protocolProvider)
protocolProvider
- The ProtocolProviderService to
load data from.public abstract java.util.Iterator<WizardPage> getPages()
public abstract java.lang.Object getFirstPageIdentifier()
public abstract java.lang.Object getLastPageIdentifier()
public abstract java.util.Iterator<java.util.Map.Entry<java.lang.String,java.lang.String>> getSummary()
public abstract ProtocolProviderService signin() throws OperationFailedException
OperationFailedException
- if the operation didn't succeedpublic abstract ProtocolProviderService signin(java.lang.String userName, java.lang.String password) throws OperationFailedException
userName
- the user name to sign in withpassword
- the password to sign in withOperationFailedException
- if the operation didn't succeedpublic void accountRemoved(ProtocolProviderService protocolProvider)
protocolProvider
- the protocol provider that has been removedpublic boolean isWebSignupSupported()
true
if the web sign up is supported by the current
implementation, false
- otherwise.true
if the web sign up is supported by the current
implementation, false
- otherwisepublic void webSignup() throws java.lang.UnsupportedOperationException
java.lang.UnsupportedOperationException
- if the web sign up operation is
not supported by the current implementation.public java.lang.String getForgotPasswordLinkName()
public java.lang.String getForgotPasswordLink()
public abstract java.lang.Object getSimpleForm(boolean isCreateAccount)
isCreateAccount
- indicates if the simple form should be opened as
a create account form or as a login formpublic void setModification(boolean isModification)
isModification
- indicates if this wizard is opened for modification
or for creating a new account.public boolean isModification()
true
to indicate that this wizard is currently in
modification mode, false
- otherwise.public boolean isSimpleFormEnabled()
true
if the simple "Sign in" form is enabled or
false
otherwise.public boolean isAdvancedConfigurationEnabled()
public WizardContainer getWizardContainer()
protected void setWizardContainer(WizardContainer wizardContainer)
wizardContainer
- the wizard container, where all pages are addedpublic boolean isPreferredProtocol()
public boolean isHidden()
Jitsi, the OpenSource Java VoIP and Instant Messaging client.
Distributable under Apache license.