Method Detail

• close

  boolean close​(boolean force,
                boolean allowInteraction)

  closes a map. Note that there is no undo for this method!

  Parameters:

  force - close map even if there are unsaved changes.

  allowInteraction - if (allowInteraction && ! force) a saveAs dialog will be opened if there are unsaved changes.

  Returns:

  false if the saveAs was cancelled by the user and true otherwise.

  Throws:

  RuntimeException - if the map contains changes and parameter force is false.

  Since:

  1.2

• save

  boolean save​(boolean allowInteraction)

  saves the map to disk. Note that there is no undo for this method.

  Parameters:

  allowInteraction - if a saveAs dialog should be opened if the map has no assigned URL so far.

  Returns:

  false if the saveAs was cancelled by the user and true otherwise.

  Throws:

  RuntimeException - if the map has no assigned URL and parameter allowInteraction is false.

  Since:

  1.2

• setSaved

  void setSaved​(boolean isSaved)

  Since:

  1.2

• setName

  void setName​(String title)

  Sets the map (frame/tab) title. Note that there is no undo for this method!

  Since:

  1.2

• setBackgroundColor

  void setBackgroundColor​(Color color)

  Since:

  1.2

• setBackgroundColorCode

  void setBackgroundColorCode​(String rgbString)

  Parameters:

  rgbString - a HTML color spec like #ff0000 (red) or #222222 (darkgray).

  Since:

  1.2

• filter

  void filter​(groovy.lang.Closure<Boolean> closure)

  install a Groovy closure as the current filter in this map. If closure is null then filtering will be disabled. The filter state of a node can be checked by Proxy.NodeRO.isVisible().
  To undo filtering use Tools → Undo. After execution of the following you have to use it seven times to return to the initial filter state.

   // show only matching nodes
   node.map.filter{ it.text.contains("todo") }
   // equivalent:
   node.map.filter = { it.text.contains("todo") }
   
   // show ancestors of matching nodes
   node.map.filter(true, false){ it.text.contains("todo") }
   // equivalent:
   node.map.setFilter(true, false, { it.text.contains("todo") })
   
   // show descendants of matching nodes
   node.map.filter(false, true){ it.text.contains("todo") }
   // equivalent:
   node.map.setFilter(false, true, { it.text.contains("todo") })
   
   // remove filter
   node.map.filter = null
   

  Since:

  1.2

• setFilter

  void setFilter​(groovy.lang.Closure<Boolean> closure)

  alias for filter(Closure). Enables assignment to the filter property.

  Since:

  1.2

• filter

  void filter​(boolean showAncestors,
              boolean showDescendants,
              groovy.lang.Closure<Boolean> closure)

  With filter(Closure) neither ancestors not descendants of the visible nodes are shown. Use this method to control these options.

  Since:

  1.2

  See Also:

  filter(Closure)

• setFilter

  void setFilter​(boolean showAncestors,
                 boolean showDescendants,
                 groovy.lang.Closure<Boolean> closure)

  alias for setFilter(boolean, boolean, Closure)

  Since:

  1.2

  See Also:

  filter(Closure)

• redoFilter

  void redoFilter()

  reinstalls the previously undone filter if there is any. Note: undo/redo for filters is separate to the undo/redo for other map state.

  Since:

  1.2

• undoFilter

  void undoFilter()

  removes the current filter and reinstalls the previous filter if there is any. Note: undo/redo for filters is separate to the undo/redo for other map state.

  Since:

  1.2

• getStorage

  Proxy.Properties getStorage()

  returns an accessor to the map specific storage. The value is never null

  Since:

  1.3.6