org.objectweb.telosys.uil.screenmap
Class ScreenDefConfig

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

public class ScreenDefConfig
extends TelosysObject

This class provides the attributes loaded from the "" tag of the "screens.xml" file

Only one instance of this class ( held by ScreenDefinitions )


Constructor Summary
ScreenDefConfig()
          Constructor
 
Method Summary
 java.lang.String getAjaxRequestUrl()
          Returns the URL to use for AJAX calls ( for screen actions )
 java.lang.String getAllLanguages()
          Returns the languages string ( for i18n, languages supported by the translator )
 java.lang.String[] getAllLanguagesArray()
          Returns the languages array ( for i18n, languages supported by the translator )
 java.lang.String getBaseLanguage()
          Returns the "base language" ( for i18n )
 java.lang.String getDefaultAction()
          Returns the default action for the screen ( "open", "use", "none" )
 java.lang.String getFrameworkCSSDir()
          Returns the web context path of the framework CSS directory
 java.lang.String getFrameworkCSSFile()
          Returns the web context path of the framework CSS file
 java.lang.String getFrameworkCSSFile(java.lang.String sFileName)
          Returns the web context path of a given framework CSS file
 java.lang.String getFrameworkJavascriptFile()
          Returns the web context path of the javascript framework file
 java.lang.String getScreenMapUrl()
          Returns the URL to use to get a screenmap
 java.lang.String getTelosysJarFile()
          Returns the Telosys JAR file ( same as defined in the configuration file )
 
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

ScreenDefConfig

public ScreenDefConfig()
Constructor

Method Detail

getDefaultAction

public java.lang.String getDefaultAction()
Returns the default action for the screen ( "open", "use", "none" )

Returns:
the default action ( never null : "none" by default )

getFrameworkJavascriptFile

public java.lang.String getFrameworkJavascriptFile()
Returns the web context path of the javascript framework file

Returns:
the full path of the file ( ie: "/js/telosys.js" ), never null

getFrameworkCSSDir

public java.lang.String getFrameworkCSSDir()
Returns the web context path of the framework CSS directory

Returns:
the directory ( ie: "/css/telosys" ), never null

getFrameworkCSSFile

public java.lang.String getFrameworkCSSFile(java.lang.String sFileName)
Returns the web context path of a given framework CSS file

Parameters:
sFileName - ( ie : "image.png" )
Returns:
the full path with the directory ( ie: "/css/telosys/image.png" )

getFrameworkCSSFile

public java.lang.String getFrameworkCSSFile()
Returns the web context path of the framework CSS file

Returns:
the full path of the file ( ie: "/css/telosys/telosys.css" )

getTelosysJarFile

public java.lang.String getTelosysJarFile()
Returns the Telosys JAR file ( same as defined in the configuration file )

Returns:
the jar file ( e.g. "/WEB-INF/lib/telosys-1.0.0.jar" ), never null

getAjaxRequestUrl

public java.lang.String getAjaxRequestUrl()
Returns the URL to use for AJAX calls ( for screen actions )

Returns:
e.g. "/action" ( never null )

getScreenMapUrl

public java.lang.String getScreenMapUrl()
Returns the URL to use to get a screenmap

Returns:
e.g. "/screenmap" ( never null )

getBaseLanguage

public java.lang.String getBaseLanguage()
Returns the "base language" ( for i18n )

Returns:
the "base language" or null

getAllLanguages

public java.lang.String getAllLanguages()
Returns the languages string ( for i18n, languages supported by the translator )

Returns:
the string ( e.g. "fr,en,de" ), or null if not set

getAllLanguagesArray

public java.lang.String[] getAllLanguagesArray()
Returns the languages array ( for i18n, languages supported by the translator )

Returns:
the array ( e.g. { "fr","en","de" } ), or null if not set