org.objectweb.telosys.uil.screenmap
Class ScreenMap

java.lang.Object
  extended byorg.objectweb.telosys.common.TelosysObject
      extended byorg.objectweb.telosys.uil.screenmap.ScreenMap

public class ScreenMap
extends TelosysObject


Constructor Summary
ScreenMap(ScreenDefRootDir rootDir, org.objectweb.telosys.uil.screenmap.ScreenDefinition def, java.lang.String sScreenType, int iScreenId)
           
ScreenMap(ScreenDefRootDir rootDir, org.objectweb.telosys.uil.screenmap.ScreenDefinition def, java.lang.String sScreenType, int iScreenContextId, java.lang.String sScreenContextName)
           
 
Method Summary
 java.lang.String describe()
           
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()
           
 ScreenMapElement getElement(java.lang.String sName)
           
 java.lang.String getImagesRootDir()
           
 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
 int getScreenContextId()
           
 java.lang.String getScreenContextName()
           
 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()
           
 boolean isHtmlType()
           
 boolean isXulType()
           
 
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

ScreenMap

public ScreenMap(ScreenDefRootDir rootDir,
                 org.objectweb.telosys.uil.screenmap.ScreenDefinition def,
                 java.lang.String sScreenType,
                 int iScreenId)

ScreenMap

public ScreenMap(ScreenDefRootDir rootDir,
                 org.objectweb.telosys.uil.screenmap.ScreenDefinition def,
                 java.lang.String sScreenType,
                 int iScreenContextId,
                 java.lang.String sScreenContextName)
Method Detail

getTargetPath

public java.lang.String getTargetPath()
Returns the path to target the Screen

Returns:
the path to the Screen Template ( if ScreenBody ) or the Screen Page

getScreenBodyPath

public java.lang.String getScreenBodyPath()
Returns the path to the ScreenBody if any

Returns:

getScreenBody

public java.lang.String getScreenBody()
Returns the ScreenBody if any

Returns:

getCssPath

public java.lang.String getCssPath()
Returns the path to the CSS file if any

Returns:

getCss

public java.lang.String getCss()
Returns the CSS file if any

Returns:

getScriptPath

public java.lang.String getScriptPath()
Returns the path to the JS script file if any

Returns:

getScript

public java.lang.String getScript()
Returns the JS script file if any

Returns:

getType

public java.lang.String getType()
Returns:
the type of the Screen ( i.e. : "html" or "xul" )

getScreenContextId

public int getScreenContextId()
Returns:
the ID of the ScreenContext managed by the ScreenMap

getScreenContextName

public java.lang.String getScreenContextName()
Returns:
the name of ScreenContext managed by the ScreenMap ( the name defined in the ScreenContext registry )

isHtmlType

public boolean isHtmlType()

isXulType

public boolean isXulType()

getImagesRootDir

public java.lang.String getImagesRootDir()

getName

public java.lang.String getName()
Returns:
the name of the ScreenMap ( name defined in the "screens.xml" file )

getElement

public ScreenMapElement getElement(java.lang.String sName)

getElemCount

public int getElemCount()

getTranslator

public Translator getTranslator()
Returns the screen map translator (if any)

Returns:

describe

public java.lang.String describe()

getContextURI

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)
Build a Web App context URI with the given ScreenMap parts
( e.g. : "/screenmap/name-type/id-ctx:action?params" )

Parameters:
sScreenName - : the ScreenMap name
sScreenType - : the ScreenMap type ( e.g. "html" or "xul" ) null = default type
sContextId - : the context id to use ( e.g. "1", "2", ... ) null = default context-id
sContextName - : the name of the ScreenContext to use, or null = ScreenMap name
sContextAction - : the action to apply on the ScreenContext ( "open", "use", "none" ) or null
sParams - : the standard URL parameters ( e.g. "param1=aaa¶m2=bbb" ) or null
Returns:
: the relative URI in the current Web App ( e.g. "/screenmap/SCREEN01-html/1-MYCONTEXT:use" )