org.objectweb.telosys.uil.screenmap
Class ScreenDefinitions

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

public class ScreenDefinitions
extends TelosysObject

An instance of this class contains all the screen definitions loaded from the "screens.xml" file.
It's the ScreenMap provider.
The screens definitions (and the default configuration values) are used to build
all the elements composing a ScreenMap ( body, script, css, template, and so on )


Constructor Summary
ScreenDefinitions()
          Constructor
 
Method Summary
 ScreenDefConfig getConfig()
          Returns the instance containing the attributes of the tag
 ScreenDefRootDir getHtmlRootDir()
          Returns the attributes for "HTML" screen type
 ScreenDefRootDir getRootDir(java.lang.String sScreenTypeParam)
          Returns the attributes for the given screen type ( "HTML" or "XUL" )
 ScreenConventions getScreenConventions()
          Returns the instance containing the attributes of the tag
 int getScreenDefCount()
          Returns the current number of screen definitions
it can evolve if the Convention over Configuration is used ( see )
 ScreenDefinition getScreenDefinition(java.lang.String sScreenName)
          Returns the screen definition for the given screen name, or null if none
 ScreenMap getScreenMap(javax.servlet.ServletContext servletContext, java.lang.String sScreenName, java.lang.String sScreenType, int iScreenContextId, java.lang.String sScreenContextName, java.lang.String sScreenContextAction)
          Creates a ScreenMap instance for the given screen informations ( name, type, context id, context name )
 java.util.Iterator getScreenNames()
          Returns an iterator for all the screen names currently defined
 java.lang.String[] getScreenNamesArray()
          Returns an array of all the screen names currently defined
 ScreenDefRootDir getXulRootDir()
          Returns the attributes for "XUL" screen type
 
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

ScreenDefinitions

public ScreenDefinitions()
Constructor

Method Detail

getConfig

public ScreenDefConfig getConfig()
Returns the instance containing the attributes of the tag

Returns:

getScreenConventions

public ScreenConventions getScreenConventions()
Returns the instance containing the attributes of the tag

Returns:

getHtmlRootDir

public ScreenDefRootDir getHtmlRootDir()
Returns the attributes for "HTML" screen type

Returns:

getXulRootDir

public ScreenDefRootDir getXulRootDir()
Returns the attributes for "XUL" screen type

Returns:

getRootDir

public ScreenDefRootDir getRootDir(java.lang.String sScreenTypeParam)
Returns the attributes for the given screen type ( "HTML" or "XUL" )

Parameters:
sScreenTypeParam - "html" or "xul" ( not case sensitive )
Returns:

getScreenMap

public ScreenMap getScreenMap(javax.servlet.ServletContext servletContext,
                              java.lang.String sScreenName,
                              java.lang.String sScreenType,
                              int iScreenContextId,
                              java.lang.String sScreenContextName,
                              java.lang.String sScreenContextAction)
Creates a ScreenMap instance for the given screen informations ( name, type, context id, context name )

Parameters:
servletContext -
sScreenName - cannot be null
sScreenType - can be null
iScreenContextId - can be UNDEFINED_CONTEXT_ID ( same as null )
sScreenContextName - can be null (if null the screen name is used)
sScreenContextAction - can be null (if null the default action is used)
Returns:

getScreenDefinition

public ScreenDefinition getScreenDefinition(java.lang.String sScreenName)
Returns the screen definition for the given screen name, or null if none

Parameters:
sScreenName -
Returns:

getScreenNames

public java.util.Iterator getScreenNames()
Returns an iterator for all the screen names currently defined

Returns:

getScreenNamesArray

public java.lang.String[] getScreenNamesArray()
Returns an array of all the screen names currently defined

Returns:

getScreenDefCount

public int getScreenDefCount()
Returns the current number of screen definitions
it can evolve if the Convention over Configuration is used ( see )

Returns: