Difference between revisions of "Scripting: API Changes"
From Freeplane - free mind mapping and knowledge management software
Irajawapys (talk | contribs) |
m (Reverted edits by Irajawapys (Talk) to last version by DimitryPolivaev) |
||
| Line 1: | Line 1: | ||
| − | + | The [[Scripting_API|Scripting API]], which is defined by the <groovy>org.freeplane.plugin.script.proxy.Proxy</groovy> interface, will evolve over time but Freeplane's developers will do whatever possible to keep new API versions downward compatible. On the other hand there might be changes in parts of the Freeplane code that are not part of the official API but on which some scripts might depend nevertheless. This mostly applies to the [[Scripting:_Freeplane_Utility_Classes|utility classes]]. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | The [[Scripting_API|Scripting API]], which is defined by the | ||
This page lists changes in Freeplane that you might want or sometimes have to care about when changing to new Freeplane versions. | This page lists changes in Freeplane that you might want or sometimes have to care about when changing to new Freeplane versions. | ||
| Line 16: | Line 8: | ||
Attributes: | Attributes: | ||
| − | + | <groovy> | |
| − | List | + | List<String> getAll(String) |
| − | public List | + | public List<String> getAttributeNames() |
String get(final int index) | String get(final int index) | ||
void set(final int index, final String value) | void set(final int index, final String value) | ||
| Line 26: | Line 18: | ||
void add(final String name, final String value) | void add(final String name, final String value) | ||
int size() | int size() | ||
| − | + | </groovy> | |
===1.43 rc=== | ===1.43 rc=== | ||
| − | + | <groovy> | |
File Map.getFile() | File Map.getFile() | ||
| − | + | </groovy> | |
== After Release 1.1== | == After Release 1.1== | ||
| Line 37: | Line 29: | ||
===Refactoring of utility classes=== | ===Refactoring of utility classes=== | ||
| − | In package | + | In package <tt>org.freeplane.core.util</tt>: |
| − | * | + | * <tt>ResUtil</tt> => <tt>FileUtils</tt> |
| − | * | + | * <tt>HtmlTools</tt> => <tt>HtmlUtils</tt> |
| − | * | + | * <tt>LogTool</tt> => <tt>LogUtils</tt> |
| − | * | + | * <tt>MenuTools</tt> => <tt>MenuUtils</tt> |
| − | * | + | * <tt>SysUtil</tt> => <tt>SysUtils</tt> |
| − | * | + | * <tt>XmlTool</tt> => <tt>XmlUtils</tt> |
Other: | Other: | ||
| − | * | + | * <tt>org.freeplane.core.resources.FpStringUtils</tt> => <tt>org.freeplane.core.util.TextUtil</tt> |
| − | * | + | * <tt>org.freeplane.core.util.MultipleValueMap</tt> => <tt>org.freeplane.core.util.collection.MultipleValueMap</tt> |
| − | The following Perl script will adjust all scripts in the current directory with a | + | The following Perl script will adjust all scripts in the current directory with a ".groovy" suffix. The original file will be saved with a ".bak" suffix. |
| − | + | <groovy> | |
perl -i.bak -pe 's,\b(Res|Sys)Util\b,$1Utils,g; | perl -i.bak -pe 's,\b(Res|Sys)Util\b,$1Utils,g; | ||
s,\b(Html|Log|Menu|Xml)Tools?\b,$1Utils,g; | s,\b(Html|Log|Menu|Xml)Tools?\b,$1Utils,g; | ||
| Line 57: | Line 49: | ||
s,\bFpStringUtils\b,TextUtils,g; | s,\bFpStringUtils\b,TextUtils,g; | ||
s,(util).(MultipleValueMap)\b,$1.collection.$2,g' *.groovy | s,(util).(MultipleValueMap)\b,$1.collection.$2,g' *.groovy | ||
| − | + | </groovy> | |
[[Category:Scripting]] | [[Category:Scripting]] | ||
Revision as of 18:31, 24 November 2010
The Scripting API, which is defined by the <groovy>org.freeplane.plugin.script.proxy.Proxy</groovy> interface, will evolve over time but Freeplane's developers will do whatever possible to keep new API versions downward compatible. On the other hand there might be changes in parts of the Freeplane code that are not part of the official API but on which some scripts might depend nevertheless. This mostly applies to the utility classes.
This page lists changes in Freeplane that you might want or sometimes have to care about when changing to new Freeplane versions.
Contents
Before Release 1.1
1.41 beta
Attributes: <groovy> List<String> getAll(String) public List<String> getAttributeNames() String get(final int index) void set(final int index, final String value) void set(final int index, final String name, final String value) boolean removeAll(final String name) void remove(final int index) void add(final String name, final String value) int size() </groovy>
1.43 rc
<groovy>
File Map.getFile()
</groovy>
After Release 1.1
Refactoring of utility classes
In package org.freeplane.core.util:
- ResUtil => FileUtils
- HtmlTools => HtmlUtils
- LogTool => LogUtils
- MenuTools => MenuUtils
- SysUtil => SysUtils
- XmlTool => XmlUtils
Other:
- org.freeplane.core.resources.FpStringUtils => org.freeplane.core.util.TextUtil
- org.freeplane.core.util.MultipleValueMap => org.freeplane.core.util.collection.MultipleValueMap
The following Perl script will adjust all scripts in the current directory with a ".groovy" suffix. The original file will be saved with a ".bak" suffix. <groovy> perl -i.bak -pe 's,\b(Res|Sys)Util\b,$1Utils,g;
s,\b(Html|Log|Menu|Xml)Tools?\b,$1Utils,g; s,resources\.FpStringUtils\b,util\.FpStringUtils,g; s,\bFpStringUtils\b,TextUtils,g; s,(util).(MultipleValueMap)\b,$1.collection.$2,g' *.groovy
</groovy>
