public class DocumentAnnotationsModule extends AnnotationsModule<Document>
TreeModule
which exposes all annotations contained in the document as nodes. Depending
on the AnnotationsModule.PresentationMode
, the annotations are added in-line below the
node representing the Document
or below a separate grouping node.AnnotationsModule.AnnoSelectionMode, AnnotationsModule.AnnotationIcon, AnnotationsModule.DefaultLabelProvider, AnnotationsModule.PresentationMode
DynamicTreeModule.TreeCallback
annotationMatcher, annotationMatcherEditor, groupIcon, groupNodeToken
Constructor and Description |
---|
DocumentAnnotationsModule() |
DocumentAnnotationsModule(String groupNodeTitle) |
Modifier and Type | Method and Description |
---|---|
EventList<? extends Object> |
getChildren(TreePath treePath)
Returns a
EventList containing all the contents (children) for the last tree path
component of given tree path. |
Disposable |
registerTreeCallback(TreePath treePath,
DynamicTreeModule.TreeCallback callback)
This method is called in order to supply the tree module with a
DynamicTreeModule.TreeCallback for the
given treePath. |
contribute, createMatcherFilteredList, findDocumentForAnnotation, findPageForAnnotation, getAnnotationLabelProvider, getAnnotationLayer, getAnnotationMatcher, getGroupingNodeList, getIcon, getPageView, getPresentationMode, hasChildren, pathDeselected, pathSelected, setAnnotationLabelFilterator, setAnnotationLayer, setAnnotationMatcher, setPageView, setPresentationMode, updateLabel
public DocumentAnnotationsModule()
public DocumentAnnotationsModule(String groupNodeTitle)
public EventList<? extends Object> getChildren(TreePath treePath)
TreeContentProvider
EventList
containing all the contents (children) for the last tree path
component of given tree path. If no children should be contributed (neither now, nor in the
future) this method should return null
.treePath
- to supply children forEventList
of children or null
.public Disposable registerTreeCallback(TreePath treePath, DynamicTreeModule.TreeCallback callback)
DynamicTreeModule
DynamicTreeModule.TreeCallback
for the
given treePath. Using this callback the module can notify the FlexTree, that the object or
data, that the node for the given path represents, changed in some way, that makes it necessary
to update the node's derived properties.
This method may return an instance of Disposable
, called upon the disposal of the
representation node. This mechanism is used to properly shut down any listeners set up to
bridge changes from some domain object to the DynamicTreeModule.TreeCallback
. Supplying a
Disposable
isn't mandatory, however. If some other mechanism for de-registration is
applied (e.g. soft-references), implementors may return null
.treePath
- path to the domain object which this callback is supplied fornull
, if the disposal is implemented by other means (e.g. a soft
reference).Copyright © 2024 levigo holding gmbh. All rights reserved.