|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IssuesListConfigurator
A interface for classes that can configuring an IssuesList. Each Configurator is defined in the same extension as the IssuesList it can configure. Some IIssuesLists don't require a configurator. An example of an issues list that requires a configuration is one that is backed onto a database. The username/password and connection information need to be set; it is the job of the IssuesListConfigurator to do this.
The configuration appears in the preference pages of the application.
Method Summary | |
---|---|
void |
getConfiguration(IMemento memento)
Fills the memento object with the configuration data. |
Control |
getControl(Composite parent,
IIssuesPreferencePage page)
Returns a control that will configure the issues list. |
java.lang.String |
getError()
This method is called after isConfigured() is called. |
void |
initConfiguration(IIssuesList list,
IMemento memento)
Initializes the IssuesListConfigurator AND the IssuesList. |
boolean |
isConfigured()
Returns true if the IIssuesList can be used. |
Method Detail |
---|
void initConfiguration(IIssuesList list, IMemento memento)
list
- the list that the configurator will configure.memento
- a memento that contains the previous configuration. Maybe null if the list has never been configured.void getConfiguration(IMemento memento)
Note: The control may be disposed by this point so ensure that the method does not need to access any widgets in the control.
Control getControl(Composite parent, IIssuesPreferencePage page)
Warning: the memento may be null
parent
- the composite that will be used to create the control. The Layout of the parent is a FillLayout.
boolean isConfigured()
java.lang.String getError()
isConfigured()
is called. If isConfigured()
returns false this method is called to obtain a
human readable error message.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |