FreeMindGroovyObjects: Difference between revisions

From FreeMind
Jump to navigationJump to search
No edit summary
(Started documenting methods)
Line 20: Line 20:
This is the generic object for a node, you navigate from node to node in a hierarchal manner.  
This is the generic object for a node, you navigate from node to node in a hierarchal manner.  


=== getNodeLevel() ===
=== Navigation ===
 
==== childrenUnfolded() ====
;Returns : collection?
 
 
=== Information Retrieval ===
 
==== getNodeLevel() ====
;Returns : int
;Returns : int
;Definition : Returns the current level of the node.
;Definition : Returns the current level of the node.




=== getText() ===
==== getText() ====
;Returns : string
;Returns : string
;Definition : Returns the text of the node.
;Definition : Returns the text of the node.




=== setColor(<color>) ===
=== Assignment ===
 
==== setColor(<color>) ====
;Returns : ?
;Returns : ?
;Definition : Sets the text color of the node.
;Definition : Sets the text color of the node.
Line 36: Line 46:




=== setBackgroundColor(<color>) ===
==== setBackgroundColor(<color>) ====
;Returns : ?
;Returns : ?
;Definition : Sets the background color of the node.
;Definition : Sets the background color of the node.
;Parameters : <color> : accepts values in the form of java.awt.Color.BLUE
;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 ==
== c ==

Revision as of 22:48, 21 May 2008

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


node

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

Navigation

childrenUnfolded()

Returns
collection?


Information Retrieval

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