public class DocumentNameModule extends Object implements TreeLabelProvider, DynamicTreeModule
Document
name for display in a FlexibleTree
.
This module does *not* supply a label! If you're looking for labels, see
DocumentStateModule
.DynamicTreeModule.TreeCallback
Constructor and Description |
---|
DocumentNameModule() |
Modifier and Type | Method and Description |
---|---|
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. |
void |
updateLabel(TreePath treePath,
StyledDocument doc) |
public void updateLabel(TreePath treePath, StyledDocument doc) throws BadLocationException
updateLabel
in interface TreeLabelProvider
BadLocationException
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
.registerTreeCallback
in interface DynamicTreeModule
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.