|
LEONARDI Application Composer - 8.9.0.40 by W4 S.A. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectleon.misc.LyHelpFiles
public class LyHelpFiles
This class is used to manage access to application help files. Programs attempts to find in help directory : help/lang/classId/actionId.html then help/lang/classId/rootActionId.html then help/lang/actionId.html then help/lang/rootActionId_XX.html which is the default leonardi file. If file could not be found, file are searched with no lang information.
Field Summary | |
---|---|
static java.lang.String |
__VERSION
|
static java.lang.String |
FILE_DOES_NOT_EXIST
Dummy String which indicates that Help file could not be found. |
static java.lang.String |
HELP_DIR
Dummy String which indicates the help dir hashkey. |
static java.lang.String |
HELP_EXTENSION
Default help files extension. |
Constructor Summary | |
---|---|
LyHelpFiles(LyEnvironment environment)
Constructor with a given environment. |
Method Summary | |
---|---|
java.lang.String |
getHelpFile(java.lang.String actionId,
java.lang.String rootActionId,
java.lang.String classId)
Gets the help file for the specified context, or null if help file could not be found. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String __VERSION
public static final java.lang.String FILE_DOES_NOT_EXIST
public static final java.lang.String HELP_DIR
public static java.lang.String HELP_EXTENSION
Constructor Detail |
---|
public LyHelpFiles(LyEnvironment environment)
_helpFiles
and sets the
environment with the given value.
environment
- Current environment.Method Detail |
---|
public java.lang.String getHelpFile(java.lang.String actionId, java.lang.String rootActionId, java.lang.String classId)
actionId
- Current action identifier (attempt to get help for the specific action)rootActionId
- Root action identifierclassId
- Class id identifier.
|
(c) January 2013 - W4 S.A. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |