FreeMindGroovyObjects: Difference between revisions

From FreeMind
Jump to navigationJump to search
Line 35: Line 35:
==== getAdditionalInfo() ====
==== getAdditionalInfo() ====
;Returns : String
;Returns : String
; Definition : Return the Additional Information for a MindMapNode.
;Definition : Return the Additional Information for a MindMapNode.
 
==== getAttribute(<String>) ====
;Returns : String
;Definition : Return the value of the specified MindMapNode Attribute.
;Parameters : <String> : The name of the Attribute to return.


==== getNodeLevel() ====
==== getNodeLevel() ====

Revision as of 00:00, 27 June 2009

This page is the starting point for a Groovy scripting reference. You will have to examine the FreeMind source code for operations on the interfaces. See the examples for a few operations such as setting the node text, node color and background color.

If you figure something out, document it here for the rest of us.


Objects

Available Operations

When the Groovy binding is created, two variables are set:

  • "c" is set to the MindMapController
  • "node" is set to the MindMapNode being evaluated


freemind.modes.MindMapNode

This is the generic object for a node, you navigate from node to node in a hierarchal manner.

Navigation

childrenFolded()

Returns
java.util.ListIterator

childrenUnfolded()

Returns
java.util.ListIterator

getChildren()

Returns
java.util.List

Information Retrieval

getAdditionalInfo()

Returns
String
Definition
Return the Additional Information for a MindMapNode.

getAttribute(<String>)

Returns
String
Definition
Return the value of the specified MindMapNode Attribute.
Parameters
<String> : The name of the Attribute to return.

getNodeLevel()

Returns
int
Definition
Returns the current level of the node.


getText()

Returns
string
Definition
Returns the text of the node.


Assignment

setColor(<color>)

Returns
?
Definition
Sets the text color of the node.
Parameters
<color> : accepts values in the form of java.awt.Color.RED


setBackgroundColor(<color>)

Returns
?
Definition
Sets the background color of the node.
Parameters
<color> : accepts values in the form of java.awt.Color.BLUE

setText(<string>)

Returns
?
Definition
Sets the text of the node.
Parameters
<string> : Next text value of the node.

c