|
HATS 7.5.1 Web API ReferencePublicly accessible methods not documented here are for IBM internal use only and may change in a future release of the product. |
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.ibm.hats.common.BaseInfo
public class BaseInfo
Parent class for all Info objects. BaseInfo provides common functionality for accessing locales, text replacement, global variables, screen orientation, the host screen, session IDs, and rendering properties.
| Field Summary |
|---|
| Fields inherited from interface com.ibm.hats.common.IBaseInfo |
|---|
CLASSNAME |
| Method Summary | |
|---|---|
protected void |
calcClientLocale(IRequest req)
Uses the class properties of this object to figure out which Locale is desired for use in client rendering. |
String |
getArabicOrientation()
Gets the Arabic Shaping orientation. |
String |
getAutoFldRev()
Gets the auto field reverse. |
Hashtable |
getClassProperties()
Gets the rendering properties hashtable. |
Locale |
getClientLocale()
Returns the Locale to be used for rendering client displays (browser button labels, for example). |
Hashtable |
getDefaultRendering()
Gets the default rendering properties hashtable. |
IGlobalVariable |
getGlobalVariable(String name)
Gets the named global variable. |
IGlobalVariable |
getGlobalVariable(String name,
boolean createIfNotExist)
Gets the named global variable, optionally creating it if it doesn't already exist. |
IGlobalVariable |
getGlobalVariable(String name,
boolean createIfNotExist,
boolean bidiImplicit)
Gets the named global variable, optionally creating it if it doesn't already exist. |
Hashtable |
getGlobalVariables()
Returns the hashtable of global variables. |
String |
getGlobalVariableValueForField(String name,
boolean isOppositeToScreen)
Gets the named global variable that supposed to be shown in Visual input field, optionally creating it if it doesn't already exist. |
HostScreen |
getHostScreen()
Gets the current host screen. |
boolean |
getIsRtlCustomisation()
Returns the customization screen orientation. |
String |
getScreenOrientation()
Returns the screen's orientation. |
String |
getSessionNumber()
Returns the session number for this session. |
IGlobalVariable |
getSharedGlobalVariable(String name)
Gets the named shared global variable. |
IGlobalVariable |
getSharedGlobalVariable(String name,
boolean createIfNotExist)
Gets the named shared global variable, optionally creating it if it doesn't already exist |
IGlobalVariable |
getSharedGlobalVariable(String name,
boolean createIfNotExist,
boolean bidiImplicit)
Gets the named shared global variable, optionally creating it if it doesn't already exist |
Hashtable |
getSharedGlobalVariables()
Gets the hashtable of shared global variables. |
TextReplacementList |
getTextReplacement()
Returns the list of text replacements. |
boolean |
hasScrRevButton()
Gets whether or not there is a screen reverse button. |
boolean |
isNewWindows()
This method could be called while in HATS studio or in HATS runtime |
void |
setArabicOrientation(String Orientation)
Sets the Arabic Shaping orientation. |
void |
setAutoFldRev(String autoFldRev)
|
void |
setClassProperties(Hashtable render)
Sets the rendering properties hashtable. |
void |
setClientLocale(Locale l)
Sets the Locale to be used for rendering client displays. |
void |
setDefaultRendering(Hashtable defaultRendering)
Sets the default rendering properties hashtable. |
void |
setGlobalVariables(Hashtable globalVar)
Sets the hashtable of global variables. |
void |
setHostScreen(HostScreen presentation)
Sets the current host screen. |
void |
setIsRtlCustomisation(boolean isRtlCustomisation)
Sets the customization screen orientation. |
void |
setScreenOrientation(String screenOrientation)
Sets the screen's orientation. |
void |
setScrRevButton(boolean hasScrRevButton)
Sets whether or not there is a screen reverse button. |
void |
setSessionNumber(String sessionNum)
Sets the session number for this session. |
void |
setSharedGlobalVariables(Hashtable globalVar)
Sets the hashtable of global variables. |
void |
setTextReplacement(TextReplacementList textReplace)
Sets the list of text replacements. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Method Detail |
|---|
protected void calcClientLocale(IRequest req)
public final Locale getClientLocale()
getClientLocale in interface IBaseInfopublic final void setClientLocale(Locale l)
public final void setTextReplacement(TextReplacementList textReplace)
public final TextReplacementList getTextReplacement()
getTextReplacement in interface IBaseInfopublic final void setGlobalVariables(Hashtable globalVar)
public final Hashtable getGlobalVariables()
getGlobalVariables in interface IBaseInfopublic IGlobalVariable getGlobalVariable(String name)
getGlobalVariable in interface IBaseInfoname - The name of the global variable to be retrieved.
public IGlobalVariable getGlobalVariable(String name,
boolean createIfNotExist)
getGlobalVariable in interface IBaseInfocreateIfNotExist - whether or not it should create a non-existent global variablename - The name of the global variable to be retrieved.
public String getGlobalVariableValueForField(String name,
boolean isOppositeToScreen)
isOppositeToScreen - whether input field will be oriented opposite to screen
public IGlobalVariable getGlobalVariable(String name,
boolean createIfNotExist,
boolean bidiImplicit)
getGlobalVariable in interface IBaseInfocreateIfNotExist - whether or not it should create a non-existent global variablebidiImplicit - if (bidiImplicit = true) display Implicit, if (bidiImplicit = false) display Visual.name - The name of the global variable to be retrieved.
public final void setSharedGlobalVariables(Hashtable globalVar)
public final Hashtable getSharedGlobalVariables()
getSharedGlobalVariables in interface IBaseInfopublic IGlobalVariable getSharedGlobalVariable(String name)
getSharedGlobalVariable in interface IBaseInfoname - The name of the shared global variable to be retrieved.
public IGlobalVariable getSharedGlobalVariable(String name,
boolean createIfNotExist)
getSharedGlobalVariable in interface IBaseInfocreateIfNotExist - whether or not it should create a non-existent global variablename - The name of the shared global variable to be retrieved.
public IGlobalVariable getSharedGlobalVariable(String name,
boolean createIfNotExist,
boolean bidiImplicit)
getSharedGlobalVariable in interface IBaseInfocreateIfNotExist - whether or not it should create a non-existent global variablebidiImplicit - if (bidiImplicit = true) display Implicit if (bidiImplicit = false) display Visual.name - The name of the shared global variable to be retrieved.
public boolean getIsRtlCustomisation()
public void setIsRtlCustomisation(boolean isRtlCustomisation)
public final void setScreenOrientation(String screenOrientation)
public final String getScreenOrientation()
getScreenOrientation in interface IBaseInfopublic final void setArabicOrientation(String Orientation)
public final String getArabicOrientation()
getArabicOrientation in interface IBaseInfopublic final void setAutoFldRev(String autoFldRev)
public final String getAutoFldRev()
IBaseInfo
getAutoFldRev in interface IBaseInfopublic final boolean hasScrRevButton()
hasScrRevButton in interface IBaseInfopublic final void setScrRevButton(boolean hasScrRevButton)
public final void setSessionNumber(String sessionNum)
public final String getSessionNumber()
getSessionNumber in interface IBaseInfopublic final void setHostScreen(HostScreen presentation)
public final HostScreen getHostScreen()
getHostScreen in interface IBaseInfopublic final void setClassProperties(Hashtable render)
public final Hashtable getClassProperties()
getClassProperties in interface IBaseInfopublic final void setDefaultRendering(Hashtable defaultRendering)
public final Hashtable getDefaultRendering()
getDefaultRendering in interface IBaseInfopublic boolean isNewWindows()
|
HATS 7.5.1 (201005110649) | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||