org.objectweb.telosys.uil
Class TelosysUIL

java.lang.Object
  extended byorg.objectweb.telosys.uil.TelosysUIL

public final class TelosysUIL
extends java.lang.Object

Telosys User Interface Layer constants and static methods


Field Summary
static java.lang.String ACTION_NONE
           
static java.lang.String ACTION_OPEN
           
static java.lang.String ACTION_USE
           
static java.lang.String TELOSYS_CSS_FILE
           
 
Constructor Summary
TelosysUIL()
           
 
Method Summary
static java.lang.String getDefaultScreenContextAction()
          Returns the default screen context action : "open", "use" or "none" ( never null )
static int getDefaultScreenId()
          Returns the default screen id
static java.lang.String getDefaultScreenType()
          Returns the default screen type ( "html", "xul", ... )
static ScreenDefConfig getScreenDefConfig()
          Returns the Screens Definitions Configuration
( the "config" part of the screens.xml file )
static ScreenDefinitions getScreenDefinitions()
          Returns the screen definitions
static java.lang.String getScreenMapServletPath()
          Returns the "server side" screen map servlet path
defined in the "config" tag of the screens XML file
( e.g. : "/screenmap" )
static java.lang.String getScreensConfigFileName()
          Returns the file name (or resource name) of the screens XML file ( screens.xml )
static java.lang.String getTagsConfigFileName()
          Returns the tags configuration file name
static Translator getTranslator(javax.servlet.ServletContext servletContext, java.lang.String sFile, java.lang.String[] languages)
          Uses the current TranslatorLoader to return the Translator associated with the given file and languages
static ITranslatorLoader getTranslatorLoader()
          Returns the translator loader to use
static boolean init(javax.servlet.ServletContext servletContext)
          UIL initialization
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TELOSYS_CSS_FILE

public static final java.lang.String TELOSYS_CSS_FILE
See Also:
Constant Field Values

ACTION_NONE

public static final java.lang.String ACTION_NONE
See Also:
Constant Field Values

ACTION_OPEN

public static final java.lang.String ACTION_OPEN
See Also:
Constant Field Values

ACTION_USE

public static final java.lang.String ACTION_USE
See Also:
Constant Field Values
Constructor Detail

TelosysUIL

public TelosysUIL()
Method Detail

init

public static boolean init(javax.servlet.ServletContext servletContext)
UIL initialization

Parameters:
servletContext -
Returns:

getScreensConfigFileName

public static java.lang.String getScreensConfigFileName()
Returns the file name (or resource name) of the screens XML file ( screens.xml )

Returns:

getTagsConfigFileName

public static java.lang.String getTagsConfigFileName()
Returns the tags configuration file name

Returns:

getScreenDefinitions

public static ScreenDefinitions getScreenDefinitions()
Returns the screen definitions

Returns:

getTranslatorLoader

public static ITranslatorLoader getTranslatorLoader()
Returns the translator loader to use

Returns:

getTranslator

public static Translator getTranslator(javax.servlet.ServletContext servletContext,
                                       java.lang.String sFile,
                                       java.lang.String[] languages)
Uses the current TranslatorLoader to return the Translator associated with the given file and languages

Parameters:
servletContext -
sFile -
languages -
Returns:
the Translator, or null if none

getScreenDefConfig

public static ScreenDefConfig getScreenDefConfig()
Returns the Screens Definitions Configuration
( the "config" part of the screens.xml file )

Returns:

getDefaultScreenType

public static java.lang.String getDefaultScreenType()
Returns the default screen type ( "html", "xul", ... )

Returns:

getDefaultScreenContextAction

public static java.lang.String getDefaultScreenContextAction()
Returns the default screen context action : "open", "use" or "none" ( never null )

Returns:

getDefaultScreenId

public static int getDefaultScreenId()
Returns the default screen id

Returns:

getScreenMapServletPath

public static java.lang.String getScreenMapServletPath()
Returns the "server side" screen map servlet path
defined in the "config" tag of the screens XML file
( e.g. : "/screenmap" )

Returns: