You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
jitsi/src/net/java/sip/communicator/service/gui/ConfigurationWindow.java

50 lines
2.0 KiB

/*
* SIP Communicator, the OpenSource Java VoIP and Instant Messaging client.
*
* Distributable under LGPL license.
* See terms of license at gnu.org.
*/
package net.java.sip.communicator.service.gui;
/**
* The <tt>ConfigurationWindow</tt> is a contianer contianing
* <tt>ConfigurationForm</tt>s. It is meant to be implemented by the
* UIService implementation to provide a mechanism for adding and removing
* configuration forms in the GUI.
* <p>
* A bundle could have its own specific configurations that should be configured
* by the user. By implementing the <tt>ConfigurationForm</tt> interface
* each bundle is able to provide its own configuration form in the UI by adding
* it through this interface.
* <p>
* The <tt>ConfigurationWindow</tt> for the current ui implementation could
* be obtained by invoking <code>UIService.getConfigurationWindow</code> method.
*
* @author Yana Stamcheva
*/
public interface ConfigurationWindow extends ApplicationWindow {
/**
* Adds the given <tt>ConfigurationForm</tt> in this
* <tt>ConfigurationWindow</tt>. Meant to be used by bundles that want to
* add to the UI their own specific configuration forms.
* @param configForm The <tt>ConfigurationForm</tt> to add.
* @throws ClassCastException if the contained form object in the given
* <tt>ConfigurationForm</tt> is not an instance of a class supported by
* the service implementation.
*/
public void addConfigurationForm(ConfigurationForm configForm)
throws ClassCastException;
/**
* Removes the given <tt>ConfigurationForm</tt> from this
* <tt>ConfigurationWindow</tt>.
*
* @param configForm The <tt>ConfigurationForm</tt> to remove.
* @throws IllegalArgumentException if the given <tt>ConfigurationForm</tt>
* is not contained in this <tt>ConfigurationWindow</tt>.
*/
public void removeConfigurationForm(ConfigurationForm configForm)
throws IllegalArgumentException;
}