public static interface Proxy.NodeRO
node
- read-only.Modifier and Type | Method and Description |
---|---|
java.util.List<Proxy.Node> |
find(groovy.lang.Closure<java.lang.Boolean> closure)
Starting from this node, recursively searches for nodes for which
closure.call(node)
returns true. |
java.util.List<Proxy.Node> |
find(org.freeplane.features.filter.condition.ICondition condition)
Deprecated.
since 1.2 use
find(Closure) instead. |
java.util.List<Proxy.Node> |
findAll()
Returns all nodes of the branch that starts with this node in breadth-first order.
|
java.util.List<Proxy.Node> |
findAllDepthFirst()
Returns all nodes of the branch that starts with this node in depth-first order.
|
Convertible |
getAt(java.lang.String attributeName)
allows to access attribute values like array elements.
|
Proxy.Attributes |
getAttributes() |
byte[] |
getBinary()
Returns a BASE64 encoded node text
(see
Proxy.Node.setBinary(byte[]) ) as a binary object. |
int |
getChildPosition(Proxy.Node childNode)
returns the index (0..) of this node in the (by Y coordinate sorted)
list of this node's children.
|
java.util.List<Proxy.Node> |
getChildren()
returns the children of this node ordered by Y coordinate.
|
Proxy.Cloud |
getCloud()
a reference to an accessor object for cloud properties of this node.
|
java.util.Collection<Proxy.Connector> |
getConnectorsIn() |
java.util.Collection<Proxy.Connector> |
getConnectorsOut() |
int |
getCountNodesSharingContent()
The count of node sharing their content with this node.
|
int |
getCountNodesSharingContentAndSubtree()
The count of nodes sharing their content and subtree with this node.
|
java.util.Date |
getCreatedAt() |
Convertible |
getDetails()
returns the text of the details as a Convertible like
getNote() for notes:
node.details.to.plain plain text of the node, possibly after formula evaluation
node.details.plain the same. |
java.lang.String |
getDetailsText()
returns the raw HTML text of the details if there is any or null otherwise.
|
java.lang.String |
getDisplayedText()
Plain or HTML text of this node after possible transformation (formula evaluation, formatting, ...)
and after text shortening.
|
Proxy.ExternalObject |
getExternalObject() |
java.lang.String |
getFormat()
returns the format string of the formatter if available and null otherwise.
|
boolean |
getHideDetails()
returns true if node details are hidden.
|
int |
getHorizontalShift() |
java.lang.String |
getHtmlText()
Plain text after removal of possible HTML markup.
|
Proxy.Icons |
getIcons()
a reference to an accessor object for icons of this node.
|
java.lang.String |
getId() |
java.util.Date |
getLastModifiedAt() |
Proxy.Link |
getLink()
a reference to an accessor object for link properties of this node.
|
Proxy.Map |
getMap()
the map this node belongs to.
|
int |
getMinimalDistanceBetweenChildren() |
Proxy.Node |
getNext()
returns the next node with respect to this node in depth-first order.
|
java.lang.String |
getNodeID()
Deprecated.
since 1.2 - use Node.getId() instead.
|
int |
getNodeLevel(boolean countHidden)
if countHidden is false then only nodes that are matched by the
current filter are counted.
|
java.util.List<Proxy.Node> |
getNodesSharingContent()
The count of nodes sharing their content with this node.
|
java.util.List<Proxy.Node> |
getNodesSharingContentAndSubtree()
The nodes sharing their content and subtree with this node.
|
Convertible |
getNote()
returns the text of the details as a Convertible.
|
java.lang.String |
getNoteText()
Returns the HTML text of the node.
|
java.lang.Object |
getObject()
The object that's displayed as the node text - normally the raw text of this node (then this method is
equivalent to
getText() ). |
Proxy.Node |
getParent() |
Proxy.Node |
getParentNode()
Deprecated.
since 1.2 - use
getParent() instead. |
java.util.List<Proxy.Node> |
getPathToRoot()
a list of all nodes starting from this node upto (and including) the root node.
|
java.lang.String |
getPlainText()
Plain text after removal of possible HTML markup.
|
java.lang.String |
getPlainTextContent()
Deprecated.
since 1.2 - use getPlainText() or getTo().getPlain() instead.
|
Proxy.Node |
getPrevious()
returns the previous node with respect to this node in depth-first order.
|
Proxy.Reminder |
getReminder()
use it to create and inspect
Proxy.Reminder s. |
java.lang.String |
getShortText()
Plain text of this node after possible transformation and forced text shortening.
|
Proxy.NodeStyle |
getStyle()
The style attributes of a node can either be changed by assigning a named style like this:
|
java.lang.String |
getText()
Raw text of this node which might be plain or HTML text.
|
Convertible |
getTo()
returns an object that performs conversions (method name is choosen to give descriptive code):
node.to.num Long or Double, see
Convertible.getDate() . |
java.lang.String |
getTransformedText()
Plain or HTML text of this node after possible transformation (formula evaluation, formatting, ...).
|
Convertible |
getValue()
an alias for
getTo() . |
int |
getVerticalShift() |
boolean |
hasStyle(java.lang.String styleName)
returns true if the node has the style of this name - either manually set or as a conditional style or it is
"default" which all nodes have.
|
boolean |
isDescendantOf(Proxy.Node p)
returns true if p is a parent, or grandparent, ...
|
boolean |
isFolded()
if this node is folded.
|
boolean |
isFree()
returns true if this node is freely positionable.
|
boolean |
isLeaf() |
boolean |
isLeft() |
boolean |
isMinimized()
if this node's text is shortened for display.
|
boolean |
isRoot() |
boolean |
isVisible()
if this node is visible or not (due to filtering).
|
Proxy.Attributes getAttributes()
Convertible getAt(java.lang.String attributeName)
Convertible
, not a String. Nevertheless it behaves like a String in almost all respects,
that is, in Groovy scripts it understands all String methods like lenght(), matches() etc.
// standard way node.attributes.set("attribute name", "12") // implicitely use getAt() def val = node["attribute name"] // use all conversions that Convertible provides (num, date, string, ...) assert val.num == new Long(12) // or use it just like a string assert val.startsWith("1") // check for availability of an attribute this way: if (node["unknown attribute"]) // surprise: the node has an attribute with key "unknown attribute"
org.freeplane.plugin.script.ExecuteScriptException
Proxy.Cloud getCloud()
int getChildPosition(Proxy.Node childNode)
java.util.List<Proxy.Node> getChildren()
java.util.Collection<Proxy.Connector> getConnectorsIn()
java.util.Collection<Proxy.Connector> getConnectorsOut()
java.lang.String getDetailsText()
Convertible getDetails()
getNote()
for notes:
boolean getHideDetails()
Proxy.ExternalObject getExternalObject()
Proxy.Icons getIcons()
Proxy.Link getLink()
Proxy.Reminder getReminder()
Proxy.Reminder
s. This property is never null.Proxy.Map getMap()
java.lang.String getNodeID()
java.lang.String getId()
int getNodeLevel(boolean countHidden)
Convertible getNote()
getNoteText()
to get the HTML text.org.freeplane.plugin.script.ExecuteScriptException
java.lang.String getNoteText()
org.freeplane.plugin.script.ExecuteScriptException
Proxy.Node getParent()
Proxy.Node getParentNode()
getParent()
instead.java.util.List<Proxy.Node> getPathToRoot()
def path = pathToRoot.collect{ it.plainText }.join('.')
Proxy.Node getNext()
Proxy.Node getPrevious()
Proxy.NodeStyle getStyle()
node.style.name = 'style.ok'or by changing attributes for this node individually like this:
node.style.textColorCode = '#FF0000'Conditional styles of a node can only be investigated by
hasStyle(String)
. Here a script that
creates an index of all nodes having the style 'todo':
def todos = node.map.root.createChild('To Do') c.find{ it.hasStyle('todo') }.each { def child = todos.createChild(it.text) child.link.node = it }
boolean hasStyle(java.lang.String styleName)
java.lang.String getText()
See
getPlainText()
for plain text or use HtmlUtils.htmlToPlain(String)
.
getHtmlText()
for HTML text or use HtmlUtils.plainToHTML(String)
.
getTransformedText()
or getValue()
for text after formula evaluation.
getObject()
for possible typed content.
getTo()
for text/object conversions.
java.lang.String getPlainText()
java.lang.String getPlainTextContent()
java.lang.String getHtmlText()
java.lang.String getTransformedText()
java.lang.String getDisplayedText()
isMinimized()
for node shortening.java.lang.String getShortText()
java.lang.Object getObject()
getText()
).
But in case of typed content (for numbers, dates and calendars) getObject()
returns
a proper IFormattedObject
. Use getPlainText()
to remove HTML.
See Proxy.Node.setObject(Object)
for details.java.lang.String getFormat()
Convertible getTo()
Convertible.getDate()
.
Convertible.getDate()
.
Convertible.getString()
.
Convertible.getText()
.
Convertible.getObject()
.
org.freeplane.plugin.script.ExecuteScriptException
- on formula evaluation errorsConversionException
- on parse errors, e.g. if to.date is invoked on "0.25"Convertible getValue()
getTo()
.org.freeplane.plugin.script.ExecuteScriptException
- on formula evaluation errorsbyte[] getBinary()
Proxy.Node.setBinary(byte[])
) as a binary object. Errors are signaled by a null return value.
Whitespace characters are ignored.boolean isDescendantOf(Proxy.Node p)
boolean isFolded()
boolean isFree()
boolean isLeaf()
boolean isLeft()
boolean isRoot()
boolean isVisible()
isFolded()
for folding state.boolean isMinimized()
int getCountNodesSharingContent()
if (node.countNodesSharingContent() > 0)
to check if a node has any clones.
getCountNodesSharingContent()
≥ getCountNodesSharingContentAndSubtree()
.getNodesSharingContent()
,
Proxy.Node.appendAsCloneWithSubtree(Proxy.NodeRO)
,
Proxy.Node.appendAsCloneWithoutSubtree(Proxy.NodeRO)
int getCountNodesSharingContentAndSubtree()
getCountNodesSharingContent()
≥ getCountNodesSharingContentAndSubtree()
.getNodesSharingContentAndSubtree()
,
Proxy.Node.appendAsCloneWithSubtree(Proxy.NodeRO)
,
Proxy.Node.appendAsCloneWithoutSubtree(Proxy.NodeRO)
java.util.List<Proxy.Node> getNodesSharingContent()
getCountNodesSharingContent()
≥ getCountNodesSharingContentAndSubtree()
.getCountNodesSharingContent()
,
Proxy.Node.appendAsCloneWithSubtree(Proxy.NodeRO)
,
Proxy.Node.appendAsCloneWithoutSubtree(Proxy.NodeRO)
java.util.List<Proxy.Node> getNodesSharingContentAndSubtree()
getCountNodesSharingContentAndSubtree()
,
Proxy.Node.appendAsCloneWithSubtree(Proxy.NodeRO)
,
Proxy.Node.appendAsCloneWithoutSubtree(Proxy.NodeRO)
java.util.List<Proxy.Node> find(org.freeplane.features.filter.condition.ICondition condition)
find(Closure)
instead.condition.checkNode(node)
returns true.java.util.List<Proxy.Node> find(groovy.lang.Closure<java.lang.Boolean> closure)
closure.call(node)
returns true. See Proxy.ControllerRO.find(Closure)
for details.java.util.List<Proxy.Node> findAll()
Proxy.ControllerRO.findAll()
for map-global searches.java.util.List<Proxy.Node> findAllDepthFirst()
Proxy.ControllerRO.findAllDepthFirst()
for map-global searches.java.util.Date getLastModifiedAt()
java.util.Date getCreatedAt()
int getHorizontalShift()
int getVerticalShift()
int getMinimalDistanceBetweenChildren()