|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectes.unex.sextante.gui.help.HelpIO
public class HelpIO
Constructor Summary | |
---|---|
HelpIO()
|
Method Summary | |
---|---|
static boolean |
containsStringInHelpFile(GeoAlgorithm alg,
java.lang.String string)
Returns true if the help file associated with an algorithm contains a given search string |
static java.util.HashMap |
createMap(java.util.ArrayList list)
|
static java.lang.String |
getHelpAsHTMLCode(GeoAlgorithm alg)
Returns the help associated with a given geoalgorithm as a html-formatted string |
static java.lang.String |
getHelpFilename(GeoAlgorithm alg)
Returns the help filename for a given algorithm |
static java.lang.String |
getHelpPath(GeoAlgorithm alg,
boolean bForceLocale)
Returns the path where help files for a given algorithm are found |
static java.util.ArrayList |
open(java.lang.String sFilename)
|
static void |
save(java.util.ArrayList elements,
java.lang.String sFilename)
|
static void |
saveHelpToHTML(GeoAlgorithm alg,
java.lang.String sBaseFolder)
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public HelpIO()
Method Detail |
---|
public static void save(java.util.ArrayList elements, java.lang.String sFilename)
public static java.util.ArrayList open(java.lang.String sFilename)
public static java.lang.String getHelpAsHTMLCode(GeoAlgorithm alg)
alg
- the geoalgorithm
public static java.util.HashMap createMap(java.util.ArrayList list)
public static boolean containsStringInHelpFile(GeoAlgorithm alg, java.lang.String string)
alg
- the GeoAlgorithmstring
- a string to search
public static java.lang.String getHelpFilename(GeoAlgorithm alg)
alg
- the GeoAlgorithm
public static java.lang.String getHelpPath(GeoAlgorithm alg, boolean bForceLocale)
alg
- the GeoAlgorithmbForceCurrentLocale
- if true, returns the path to the current
locale, even if it does not exist. If false, it will return the path
corresponding to the default locale (english) in case the one corresponding
to the current locale does not exist.
public static void saveHelpToHTML(GeoAlgorithm alg, java.lang.String sBaseFolder)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |