java.lang.Objectorg.objectweb.telosys.common.TelosysObject
org.objectweb.telosys.uil.screenmap.ScreenMap
ScreenMap informations for specific screenmap request
An instance of this class is created each time a screenmap request occurs
Constructor Summary | |
ScreenMap(ScreenDefRootDir rootDir,
ScreenDefinition def,
java.lang.String sScreenType,
int iScreenContextId,
java.lang.String sScreenContextName,
java.lang.String sScreenContextAction)
Constructor |
Method Summary | |
java.lang.String |
describe()
Returns a string describing the ScreenMap |
static java.lang.String |
getContextURI(java.lang.String sScreenName,
java.lang.String sScreenType,
java.lang.String sContextId,
java.lang.String sContextName,
java.lang.String sContextAction,
java.lang.String sParams)
Build a Web App context URI with the given ScreenMap parts ( e.g. : "/screenmap/name-type/id-ctx:action? |
java.lang.String |
getCss()
Returns the CSS file if any |
java.lang.String |
getCssPath()
Returns the path to the CSS file if any |
int |
getElemCount()
Returns the number of elements |
ScreenMapElement |
getElement(java.lang.String sName)
Returns the element corresponding to the given name |
java.lang.String |
getImagesRootDir()
Returns the images root dir |
java.lang.String |
getName()
|
java.lang.String |
getScreenBody()
Returns the ScreenBody if any |
java.lang.String |
getScreenBodyPath()
Returns the path to the ScreenBody if any |
java.lang.String |
getScreenContextAction()
Returns the ScreenContext action required for this ScreenMap (can be null) |
int |
getScreenContextId()
Returns the ID of the ScreenContext managed by this ScreenMap ( never UNDEFINED_CONTEXT_ID ) |
java.lang.String |
getScreenContextName()
Returns the name of ScreenContext managed by this ScreenMap ( never null ) |
java.lang.String |
getScript()
Returns the JS script file if any |
java.lang.String |
getScriptPath()
Returns the path to the JS script file if any |
java.lang.String |
getTargetPath()
Returns the path to target the Screen |
Translator |
getTranslator()
Returns the screen map translator (if any) |
java.lang.String |
getType()
Returns the ScreenMap type |
boolean |
isHtmlType()
Returns true if the ScreenMap produces HTML output |
boolean |
isXulType()
Returns true if the ScreenMap produces XUL output |
Methods inherited from class org.objectweb.telosys.common.TelosysObject |
error, error, error, getFlagTrace, info, setFlagTrace, trace, warn |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public ScreenMap(ScreenDefRootDir rootDir, ScreenDefinition def, java.lang.String sScreenType, int iScreenContextId, java.lang.String sScreenContextName, java.lang.String sScreenContextAction)
rootDir
- def
- sScreenType
- "html" or "xul" ( can be null )iScreenContextId
- 0..N or UNDEFINED_CONTEXT_ID or DYNAMIC_CONTEXT_ID ( use UNDEFINED_CONTEXT_ID for "null" )sScreenContextName
- can be nullMethod Detail |
public java.lang.String getTargetPath()
public java.lang.String getScreenBodyPath()
public java.lang.String getScreenBody()
public java.lang.String getCssPath()
public java.lang.String getCss()
public java.lang.String getScriptPath()
public java.lang.String getScript()
public java.lang.String getType()
public int getScreenContextId()
public java.lang.String getScreenContextName()
public java.lang.String getScreenContextAction()
public boolean isHtmlType()
public boolean isXulType()
public java.lang.String getImagesRootDir()
public java.lang.String getName()
public ScreenMapElement getElement(java.lang.String sName)
sName
-
public int getElemCount()
public Translator getTranslator()
public java.lang.String describe()
public static java.lang.String getContextURI(java.lang.String sScreenName, java.lang.String sScreenType, java.lang.String sContextId, java.lang.String sContextName, java.lang.String sContextAction, java.lang.String sParams)
sScreenName
- : the ScreenMap namesScreenType
- : the ScreenMap type ( e.g. "html" or "xul" ) null = default typesContextId
- : the context id to use ( e.g. "1", "2", ... ) null = default context-idsContextName
- : the name of the ScreenContext to use, or null = ScreenMap namesContextAction
- : the action to apply on the ScreenContext ( "open", "use", "none" ) or nullsParams
- : the standard URL parameters ( e.g. "param1=aaa¶m2=bbb" ) or null