net.java.sip.communicator.service.gui
Interface AccountRegistrationForm

All Known Implementing Classes:

EmptyAccountRegistrationForm

public interface AccountRegistrationForm

Author:

Yana Stamcheva

Method Summary

Component	getAdvancedForm() Returns the advanced registration form.
byte[]	getIcon() Returns the icon that will be shown on the left of the registration form.
byte[]	getListIcon() 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.
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.
String	getProtocolName() Returns the protocol name that will be shown in the list, where user will choose the protocol to register to.
Component	getSimpleForm() Returns a simple account registration form that would be the first form shown to the user.
String	getUserNameExample() Returns an example string, which should indicate to the user how the user name should look like.
boolean	isModification() Indicates if this wizard is modifying an existing account or is creating a new one.
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.
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.
ProtocolProviderService	signin() Defines the operations that will be executed when the user clicks on the wizard "Signin" button.
ProtocolProviderService	signin(String userName, 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.

Method Detail

getListIcon

byte[] getListIcon()

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.

Returns:

a short description of the protocol.

getIcon

byte[] getIcon()

Returns the icon that will be shown on the left of the registration form.

Returns:

the icon that will be shown on the left of the registration form

getProtocolName

String getProtocolName()

Returns the protocol name that will be shown in the list, where user will choose the protocol to register to.

Returns:

the protocol name.

getProtocolDescription

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.

Returns:

a short description of the protocol.

getUserNameExample

String getUserNameExample()

Returns an example string, which should indicate to the user how the user name should look like. For example: john@jabber.org.

Returns:

an example string, which should indicate to the user how the user name should look like.

loadAccount

void loadAccount(ProtocolProviderService protocolProvider)

Loads all data concerning the given ProtocolProviderService. This method is meant to be used when a modification in an already created account is needed.

Parameters:

protocolProvider - The ProtocolProviderService to load data from.

getAdvancedForm

Component getAdvancedForm()

Returns the advanced registration form.

Returns:

the advanced registration form

signin

ProtocolProviderService signin()
                               throws OperationFailedException

Defines the operations that will be executed when the user clicks on the wizard "Signin" button.

Returns:

the ProtocolProviderService that signed in

Throws:

OperationFailedException

signin

ProtocolProviderService signin(String userName,
                               String password)
                               throws OperationFailedException

Defines the operations that will be executed when the user clicks on the wizard "Signin" button.

Parameters:

userName - the user name to sign in with

password - the password to sign in with

Throws:

OperationFailedException

isWebSignupSupported

boolean isWebSignupSupported()

Returns true if the web sign up is supported by the current implementation, false - otherwise.

Returns:

true if the web sign up is supported by the current implementation, false - otherwise

webSignup

void webSignup()
               throws UnsupportedOperationException

Defines the operation that will be executed when user clicks on the "Sign up" link.

Throws:

UnsupportedOperationException - if the web sign up operation is not supported by the current implementation.

setModification

void setModification(boolean isModification)

Sets the modification property to indicate if this wizard is opened for a modification.

Parameters:

isModification - indicates if this wizard is opened for modification or for creating a new account.

isModification

boolean isModification()

Indicates if this wizard is modifying an existing account or is creating a new one.

Returns:

true to indicate that this wizard is currently in modification mode, false - otherwise.

isSimpleFormEnabled

boolean isSimpleFormEnabled()

Indicates whether this wizard enables the simple "sign in" form shown when the user opens the application for the first time. The simple "sign in" form allows user to configure her account in one click, just specifying her username and password and leaving any other configuration as by default.

Returns:

true if the simple "Sign in" form is enabled or false otherwise.

getSimpleForm

Component getSimpleForm()

Returns a simple account registration form that would be the first form shown to the user. Only if the user needs more settings she'll choose to open the advanced wizard, consisted by all pages.

Returns:

a simple account registration form