public abstract class DatabaseServiceListener extends Object
DatabaseService can get notified of special events by registering this listener
via addDatabaseServiceListener.
Any implementation of a database service which supports the type of changes handled here should call
those callbacs to insure proper handling of the service UI on Geneious side.| Constructor and Description |
|---|
DatabaseServiceListener() |
| Modifier and Type | Method and Description |
|---|---|
void |
actionsChanged()
Notify the program that the actions returned by
GeneiousService.getActionsAlwaysEnabled()
or GeneiousService.getActionsEnabledWhenServiceSelected() have changed since the service
was initialized or this was last called. |
void |
browsableContentsChanged()
Gets called when the browse contents of this Database Service have been changed.
|
void |
documentCopyAboutToBeAdded(AnnotatedPluginDocument document)
Called when a document is about to be added to a
WritableDatabaseService. |
void |
documentMoved(AnnotatedPluginDocument document,
DatabaseService source)
Called when a document is moved using
WritableDatabaseService.moveDocument(com.biomatters.geneious.publicapi.documents.AnnotatedPluginDocument, jebl.util.ProgressListener). |
void |
extendedSearchOptionsChanged()
Notify the code using this database that this database's extended options have
changed.
|
void |
fieldsChanged()
Notify using code about a change in search fields.
|
void |
hiddenElementsChanged()
Called when one or more hidden elements have been updated, added or removed from a
WritableDatabaseService. |
void |
searchableStatusChanged(boolean isSearchable,
String message)
Notify using code about a change in status of searchability.
|
public void browsableContentsChanged()
browasable database).
This typically results in the using code retrieving the document list again from the database.public void searchableStatusChanged(boolean isSearchable,
String message)
isSearchable - false to disable the search button/panel in the interfacemessage - to display to the user if isSearchable == false. Ignored if isSearchable == truepublic void documentCopyAboutToBeAdded(AnnotatedPluginDocument document)
WritableDatabaseService. Only called for changes
in the service this listener was added to, not any child services.
This method is only called if the listener is on a WritableDatabaseService.document - the document that is about to be added. NOTE: This is not the actual document that will be stored in the
database, a copy of this document will be added.public void documentMoved(AnnotatedPluginDocument document, DatabaseService source)
WritableDatabaseService.moveDocument(com.biomatters.geneious.publicapi.documents.AnnotatedPluginDocument, jebl.util.ProgressListener).
Only called when a document is moved to the service this listener was added to, not any child services.
This method is only called if the listener is on a WritableDatabaseService.document - the document that has been movedsource - the DatabaseService that the document was moved frompublic void hiddenElementsChanged()
WritableDatabaseService. Only called for changes
in the service this listener was added to, not any child services.
This method is only called if the listener is on a WritableDatabaseService.public void fieldsChanged()
search fields again
and update the search UI etc.public void extendedSearchOptionsChanged()
DatabaseService.getExtendedSearchOptions(boolean)
being called again so the UI can be updated for example.public void actionsChanged()
GeneiousService.getActionsAlwaysEnabled()
or GeneiousService.getActionsEnabledWhenServiceSelected() have changed since the service
was initialized or this was last called. The actions in the menu will be updated.