java.lang.Objectorg.objectweb.telosys.common.TelosysObject
org.objectweb.telosys.uil.screenmap.ScreenDefinition
Each instance of this class represents a screen definition loaded from the "screens.xml" file
or defined by convention (since v 1.1.0 )
One instance for each screen.
Constructor Summary | |
protected |
ScreenDefinition(java.lang.String screenName,
org.objectweb.telosys.uil.screenmap.ScreenDefLocation screenLoc,
java.lang.String sContextId,
java.lang.String sContextName,
java.lang.String sContextAction)
Creates a new screen definition with the attributes located at the "screen" tag level |
Method Summary | |
protected void |
addElement(ScreenMapElement elem)
Adds a screen element This method is used by the loader when a subtag "screen/element" is encountered |
int |
getElemCount()
Returns the number of elements |
java.util.HashMap |
getElements()
Returns all the elements defined |
boolean |
getFlagScreenBodyParsed()
Returns true if the Screen Body file has been parsed |
java.lang.String |
getScreenBody(java.lang.String sType)
Returns the "screen body" file part for the given type ( without the "root dir" part ) |
java.lang.String |
getScreenContextAction()
Returns the default screen context action for this ScreenMap, or null if none |
int |
getScreenContextId()
Returns the id of the screen context associated with this ScreenMap The expected values are : . |
java.lang.String |
getScreenContextName()
Returns the name of the screen context associated with this ScreenMap or null if none |
java.lang.String |
getScreenCss(java.lang.String sType)
Returns the CSS to use |
protected org.objectweb.telosys.uil.screenmap.ScreenDefLocation |
getScreenDefLocation()
Returns the common screen location (used for both "html" and "xml" types) |
protected org.objectweb.telosys.uil.screenmap.ScreenDefLocation |
getScreenDefLocation(java.lang.String sScreenTypeParam)
Returns the screen definition associated with the given type, or null if no specific definition has been defined |
java.lang.String |
getScreenName()
Returns the ScreenMap name |
java.lang.String |
getScreenScript(java.lang.String sType)
Returns the Javascript to use |
java.lang.String |
getScreenTarget(java.lang.String sType)
Returns the screen target ( template, simpe page or URL ) |
Translator |
getTranslator()
Returns the translator to use |
boolean |
isBodyTarget(java.lang.String sType)
Returns true if the screen is composed of a template and a screen body |
boolean |
isPageTarget(java.lang.String sType)
Returns true if the screen is a single resource ( just one JSP, no template + body ) |
protected void |
setElements(java.util.HashMap hm)
Set the elements |
protected void |
setFlagScreenBodyParsed(boolean v)
Set the flag saying if the Screen Body file has been parsed |
protected void |
setScreenContextAction(java.lang.String v)
Set the default screen context action for this ScreenMap |
protected void |
setScreenContextId(java.lang.String v)
Set the id of the screen context associated with this ScreenMap |
protected void |
setScreenContextName(java.lang.String v)
Set the name of the screen context associated with this ScreenMap |
protected void |
setScreenDefLocation(org.objectweb.telosys.uil.screenmap.ScreenDefLocation screenLoc)
Set a specific "html" or "xul" definition This method is used by the loader when a subtag "screen/html" or "screen/xul" is encountered |
protected void |
setTranslator(Translator t)
Set the translator to use |
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 |
protected ScreenDefinition(java.lang.String screenName, org.objectweb.telosys.uil.screenmap.ScreenDefLocation screenLoc, java.lang.String sContextId, java.lang.String sContextName, java.lang.String sContextAction)
screenName
- the screen name (cannot be null)screenLoc
- the common Screen Def Location (cannot be null)sContextId
- can be null or voidsContextName
- can be null or voidsContextAction
- can be null or voidMethod Detail |
public final java.lang.String getScreenName()
public final boolean getFlagScreenBodyParsed()
protected final void setFlagScreenBodyParsed(boolean v)
v
- public final int getScreenContextId()
protected final void setScreenContextId(java.lang.String v)
v
- public final java.lang.String getScreenContextName()
protected final void setScreenContextName(java.lang.String v)
v
- public final java.lang.String getScreenContextAction()
protected final void setScreenContextAction(java.lang.String v)
v
- protected void setScreenDefLocation(org.objectweb.telosys.uil.screenmap.ScreenDefLocation screenLoc)
screenLoc
- protected final org.objectweb.telosys.uil.screenmap.ScreenDefLocation getScreenDefLocation()
protected final org.objectweb.telosys.uil.screenmap.ScreenDefLocation getScreenDefLocation(java.lang.String sScreenTypeParam)
sScreenTypeParam
- "html" or "xul" ( not case sensitive )
protected void addElement(ScreenMapElement elem)
elem
- protected void setElements(java.util.HashMap hm)
hm
- public java.util.HashMap getElements()
public int getElemCount()
protected void setTranslator(Translator t)
t
- public Translator getTranslator()
public boolean isBodyTarget(java.lang.String sType)
sType
-
public boolean isPageTarget(java.lang.String sType)
sType
-
public java.lang.String getScreenTarget(java.lang.String sType)
sType
-
public java.lang.String getScreenBody(java.lang.String sType)
sType
-
public java.lang.String getScreenCss(java.lang.String sType)
sType
-
public java.lang.String getScreenScript(java.lang.String sType)
sType
-