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.
|
java.util.Collection<Proxy.Connector> |
getConnectorsIn() |
java.util.Collection<Proxy.Connector> |
getConnectorsOut() |
java.util.Date |
getCreatedAt() |
Convertible |
getDetails()
returns the text of the details as a Convertible like
getNote() for notes. |
java.lang.String |
getDetailsText()
returns the raw HTML text of the details if there is any or null otherwise.
|
java.lang.String |
getDisplayedText()
The visible text of this node.
|
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.
|
Proxy.Icons |
getIcons() |
java.lang.String |
getId() |
java.util.Date |
getLastModifiedAt() |
Proxy.Link |
getLink() |
Proxy.Map |
getMap()
the map this node belongs to.
|
Proxy.Node |
getNext()
returns the next node with respect to this node in breadth-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.
|
Convertible |
getNote()
Returns a Convertible object for the plain not text.
|
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.lang.String |
getPlainText()
use this method to remove all tags from an HTML node.
|
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 breadth-first order.
|
Proxy.Reminder |
getReminder()
use it to create and inspect
Proxy.Reminder s. |
java.lang.String |
getShortText() |
Proxy.NodeStyle |
getStyle()
The style attributes of a node can either be changed by assigning a named style like this:
|
java.lang.String |
getText()
The html text of this node.
|
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() |
Convertible |
getValue()
an alias for
getTo() . |
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() |
boolean |
isFree()
returns true if this node is freely positionable.
|
boolean |
isLeaf() |
boolean |
isLeft() |
boolean |
isMinimized() |
boolean |
isRoot() |
boolean |
isVisible() |
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")
org.freeplane.plugin.script.ExecuteScriptException
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.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 getPlainText()
java.lang.String getPlainTextContent()
java.lang.String getDisplayedText()
getPlainText()
to remove HTML.java.lang.String getTransformedText()
java.lang.String getShortText()
java.lang.String getText()
getPlainText()
to remove HTML.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.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()
boolean isMinimized()
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()
for subtrees
java.util.List<Proxy.Node> findAllDepthFirst()
for subtrees.
java.util.Date getLastModifiedAt()
java.util.Date getCreatedAt()