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

All Known Implementing Classes:

AdvancedConfigurationPanel, CertConfigPanel, GoogleContactsConfigForm, LazyConfigurationForm, LdapConfigForm

public interface ConfigurationForm

The ConfigurationForm interface is meant to be implemented by all bundles that want to add their own specific configuration forms in the UI. Each ConfigurationForm implementation could be added to the UI by invoking the ConfigurationDialog.addConfigurationForm method.

The ConfigurationDialog for the current ui implementation could be obtained by invoking UIService.getConfigurationDialog method.

Author:

Yana Stamcheva

Field Summary

static String	ADVANCED_TYPE The advanced configuration form type.
static String	CONTACT_SOURCE_TYPE The advanced contact source form type.
static String	FORM_TYPE The name of a property representing the type of the configuration form.
static String	GENERAL_TYPE The general configuration form type.
static String	SECURITY_TYPE The security configuration form type.

Method Summary

Object	getForm() Returns the containing form.
byte[]	getIcon() Returns the icon of this configuration form.
int	getIndex() Returns the index of this configuration form in the configuration window.
String	getTitle() Returns the title of this configuration form.
boolean	isAdvanced() Indicates if this is an advanced configuration form.

Field Detail

FORM_TYPE

static final String FORM_TYPE

The name of a property representing the type of the configuration form.

See Also:

Constant Field Values

SECURITY_TYPE

static final String SECURITY_TYPE

The security configuration form type.

See Also:

Constant Field Values

GENERAL_TYPE

static final String GENERAL_TYPE

The general configuration form type.

See Also:

Constant Field Values

ADVANCED_TYPE

static final String ADVANCED_TYPE

The advanced configuration form type.

See Also:

Constant Field Values

CONTACT_SOURCE_TYPE

static final String CONTACT_SOURCE_TYPE

The advanced contact source form type.

See Also:

Constant Field Values

Method Detail

getTitle

String getTitle()

Returns the title of this configuration form.

Returns:

the title of this configuration form

getIcon

byte[] getIcon()

Returns the icon of this configuration form. It depends on the UI implementation, how this icon will be used and where it will be placed.

Returns:

the icon of this configuration form

getForm

Object getForm()

Returns the containing form. This should be a container with all the fields, buttons, etc.

Note that it's very important to return here an object that is compatible with the current UI implementation library.

Returns:

the containing form

getIndex

int getIndex()

Returns the index of this configuration form in the configuration window. This index is used to put configuration forms in the desired order.

0 is the first position -1 means that the form will be put at the end

Returns:

the index of this configuration form in the configuration window.

isAdvanced

boolean isAdvanced()

Indicates if this is an advanced configuration form.

Returns:

true if this is an advanced configuration form, otherwise it returns false