public interface DocumentNoteType
DocumentNoteFields
which specify the type of information that this note type represents.
ATTENTION: Plugin writers should not implement this interface.DocumentNoteUtilities to access the DocumentNoteTypes.
For an example of notes in use see documentation for DocumentNoteUtilities| Modifier and Type | Method and Description |
|---|---|
DocumentNote |
createDocumentNote()
Get an instance of
DocumentNote with this as its note type. |
String |
getCode() |
String |
getDescription() |
DocumentNoteField |
getField(String fieldCode) |
List<DocumentNoteField> |
getFields() |
long |
getModifiedDate()
Get the date that this note type was last modified (eg.
|
String |
getName() |
boolean |
isDefaultVisibleInTable()
Are the fields of this note type visible in the document table by default.
|
boolean |
isStoredInConnectedNonLocalDatbase()
If a note type is stored in a non-local database then the user should be notified when editing it because they may
effect other users.
|
boolean |
isVisible() |
void |
removeField(String fieldCode)
Remove a field.
|
void |
setDefaultVisibleInTable(boolean visible)
Set whether the fields of this note type are visible in the document table by default
|
void |
setDescription(String description) |
void |
setField(DocumentNoteField field)
Add or modify a field.
|
void |
setName(String name) |
void |
setVisible(boolean isVisible)
Setting this to false will mean the user can not edit the note type at all and can not add
new instances of the note type through the standard "Notes" user interface.
|
String getCode()
String getName()
String getDescription()
boolean isVisible()
setVisible(boolean)void setVisible(boolean isVisible)
isVisible - false to have this note type not visible in the user interface. true otherwiseboolean isDefaultVisibleInTable()
void setDefaultVisibleInTable(boolean visible)
visible - true if the fields of this note type should be visible in the document table by default, false otherwiseList<DocumentNoteField> getFields()
DocumentNoteField getField(String fieldCode)
fieldCode - of field to getcode or null if no field with this code.DocumentNoteField.getCode()void setDescription(String description)
description - to setgetDescription()void setField(DocumentNoteField field)
DocumentNoteField.createTextNoteField(String, String, String, java.util.List, boolean)
and the similar factory methods to get instances of DocumentNoteFields for adding.
This method should not be performed by a user interface if
DocumentNoteField.isUserModificationAllowed()
is false for the field with code fieldCodefield - to add (if a field with the same code does not already exist) or modify (if a field does
exist with the same code).void removeField(String fieldCode)
DocumentNoteField.isUserModificationAllowed()
is false for the field with code fieldCodefieldCode - of field to removeDocumentNote createDocumentNote()
DocumentNote with this as its note type. All values will
be empty. Use this to create a note for adding to an AnnotatedPluginDocument.AnnotatedPluginDocument.getDocumentNotes(boolean)long getModifiedDate()
System.currentTimeMillis()) that this note type was last modified. Will be 0
for note types that were last modified in Geneious 4.7 or earlier.boolean isStoredInConnectedNonLocalDatbase()