HATS 7.5.1 Web API Reference

Publicly accessible methods not documented here are for IBM internal use only and may change in a future release of the product.

com.ibm.hats.transform.context
Class ContextAttributes

java.lang.Object
  extended by java.util.Dictionary
      extended by java.util.Hashtable
          extended by com.ibm.hats.transform.context.ContextAttributes
All Implemented Interfaces:
Serializable, Cloneable, Map
Direct Known Subclasses:
WebContextAttributes

public class ContextAttributes
extends Hashtable

Context attributes are a collection of attributes regarding the environment that the HSR component is running in. These attributes are required by the HSR component, but must be provided by the consumer because they are attributes that the HSR component is unable to calculate independently. The reason HSR is unable to calculate the attributes is because the attributes are implementation-specific. That is, if a consumer is deploying HSR in Java Servlet environment, then getting context attributes about the environment requires using Servlet-specific code. The same applies if the consumer is deploying HSR in Eclipse Studio. Getting context attributes about the Studio requires using Studio-specific code. Therefore, to keep HSR from being tied to certain implementations (such as to Java Servlets or Eclipse Studio), the responsibility of providing context attributes necessary to HSR is the responsibility of its consumer.

See Also:
Serialized Form

Field Summary
static String ATTR_APP_DEFAULT_LOCALE
          Flag indicating the application-default locale
static String ATTR_APPLY_RENDERING_RULES
          Flag to indicate whether rendering rules (global rules) are to be applied in this screen transformation
static String ATTR_APPLY_TEXT_REPLACEMENT
          Flag to indicate whther text replacements are to be applied in this screen transformation
static String ATTR_CLASS_LOADER
          Flag to store an optional class loader in the context attributes
static String ATTR_CLIENT_LOCALE
          Flag to indicate the client locale
static String ATTR_CODEPAGE
          Internal constant related to code page (primarily used for Bidi-processing)
static String ATTR_DBCS_SETTINGS
          Flag for storing an IDBCSSettings object in the context attributes
static String ATTR_FORM_ID
          Form ID (primarily applicable in a Portal environment)
static String ATTR_GLOBAL_VARIABLES
          Flag for storing the Global variables Hashtable in the context attributes
static String ATTR_HSR_BIDI_SERVICES
          Flag for storing an HsrBidiServices object in the context attributes
static String ATTR_IN_COMPACT_RENDERING
          Flag indicating whether screen transformation is being performed via compact rendering (default rendering for a smaller screen)
static String ATTR_IN_DEFAULT_RENDERING
          Flag indicating whether screen transformation is being performed via default rendering
static String ATTR_IN_GLOBAL_RULES
          Flag indicating whether component selection is in the Global Rules wizard
static String ATTR_IN_LINUX_OS
          Flag indicating whether the transformation recipient is running on a Linux operating system
static String ATTR_IN_SCREEN_COMBINATION
          Flag indicating whether component selection is in Screen Combination editor or wizard
static String ATTR_IN_VCT_CONTEXT
          Flag indicating whether the transformation is being performed inside VCT context (that is, using JSP "visual custom tags")
static String ATTR_IN_VISTA_OS
          Flag indicating whether the transformation recipient is running on a Vista operating system
static String ATTR_IN_WIN08_OS
           
static String ATTR_IN_WINDOWS_CE_OS
          Flag indicating whether the transformation recipient is running on Windows CE
static String ATTR_PARMS_IN_TRANSFORM_HTML
          Flag for storing a the paramters of a transformed HTML (most likely from an HttpServletRequest)
static String ATTR_PATH_INFO_OBJECT
          Flag for storing an IPathInfo object, which contains file path information of image and other files for certain widgets
static String ATTR_RENDERING_RULES_ENGINE
          Reference to the RenderingRulesEngine object associated with the current screen transformation
static String ATTR_RUNTIME_RTL
          Flag to indicate if screen text orientation in the end-user runtime is intentionally set right-to-left or left-to-right (Bidi-only)
static String ATTR_SCRIPT_LANGUAGE
          Name of the scripting language to generate scripts in (see the individual com.ibm.hats.transform.actions.ScriptAction classes)
static String ATTR_SCRIPTING_DISABLED
          Flag to indicate whether scripting (normally Javascript generation) is disabled
static String ATTR_SHARED_GLOBAL_VARIABLES
          Flag for storing a shared global variables Hashtable
static String ATTR_TEXT_REPLACEMENTS
          Flag for storing a text replacement list
static String LEFT_TO_RIGHT_TEXT
          Bidirectional text orientation setting representing left-to-right text
static String RIGHT_TO_LEFT_TEXT
          Bidirectional text orientation setting representing right-to-left text
 
Constructor Summary
ContextAttributes()
           Creates a new ContextAttributes object with required HSR context attributes prefilled with default values.
 
Method Summary
 Locale getApplicationDefaultLocale()
          Gets the default locale for the application.
 ClassLoader getClassLoader()
          Gets an optional ClassLoader object (used primarily in the Studio environment) for loading components and widgets, if already set in the context attributes.
 Locale getClientLocale()
          Gets the client locale, if already set in the context attributes.
 int getCodePage()
          Gets the code page of the original host screen that is being transformed, if already set in the context attributes.
 com.ibm.hats.common.IDBCSSettings getDBCSSettings()
          Gets the DBCS Settings object that is necessary for DBCS data processing in a DBCS environment, if already set in the context attributes.
 String getFormID()
          Gets the name of the HTML form to which transformation output will be encapsulated in, if already set in the context attributes.
 Hashtable getGlobalVariables()
          Gets the hashtable of optional Global Variables, if already set in the context attributes.
 HsrBidiServices getHsrBidiServices()
          Gets an HsrBidiServices object that is required only when processing Bidirectional data in HSR.
 com.ibm.hats.transform.IPathInfo getPathInfo()
          Gets an IPathInfo object, which contains path information required for HSR widgets, like Calendar, which load files from the file system.
 IRenderingRulesEngine getRenderingRulesEngine()
          Gets an optional engine for Global Rules processing, which is only intended to be used in the IBM HATS environment.
 String getRuntimeTextOrientation()
          Gets the text orientation configured in a runtime environment (such as an end-user's Web browser), which is to also be applied to the screen text by HSR, if already set in the context attributes.
 String getScriptLanguage()
          Gets the name of the scripting language to generate scripts in (see the individual com.ibm.hats.transform.actions.ScriptAction classes), if already set in the context attributes.
 Hashtable getSharedGlobalVariables()
          Gets an optional hashtable of Shared Global Variables, if already set in the context attributes.
 TextReplacementList getTextReplacements()
          Gets an optional TextReplacementList object used in Text Replacement functionality, if already set in the context attributes.
 Map getTransformationHTMLParameters()
          Gets a Map object representing the HTML parameters from the result of a transformation request, if already set in the context attributes.
 boolean isApplyRenderingRules()
          Gets a boolean value representing whether optional Global Rules should be applied (this concept only applies to the IBM HATS product), if already set in the context attributes.
 boolean isApplyTextReplacement()
          Gets a boolean value representing whether option Text Replacements should be applied, if already set in the context attributes.
 boolean isInCompactRendering()
          Gets the optional value of the "is in compact rendering" attribute from the context attributes table, if already set in the context attributes.
 boolean isInDefaultRendering()
          Gets the optional value of the "is in default rendering" attribute from the context attributes table, if already set in the context attributes.
 boolean isInGlobalRules()
          Gets a boolean value representing whether or not global rules are being processed.
 boolean isInLinuxOS()
          Gets whether the transformation request is targeted for a Linux operating system, if already set in the context attributes.
 boolean isInScreenCombination()
          Gets a boolean value representing whether caller is in Screen Combination wizard/ editor if already set in the context attributes.
 boolean isInVCTContext()
          Gets whether the transformation is performed in the VCT context (that is, using JSP "visual custom tags"), if already set in the context attributes.
 boolean isInVistaOS()
          Gets whether the transformation request is targeted for a Windows Vista operating system, if already set in the context attributes.
 boolean isInWin08OS()
          Gets whether the transformation request is targeted for a Windows Server 2008 operating system, if already set in the context attributes.
 boolean isInWindowsCEOS()
          Gets whether the transformation request is targeted for Windows CE operating and its variants, if already set in the context attributes.
 boolean isScriptingDisabled()
          Gets whether scripting is disabled or not, if already set in the context attributes.
 boolean isVista()
           
 boolean isWin08()
           
static ContextAttributes makeContextAttributes(Hashtable contextAttributes)
          Deprecated.  
 Object put(Object key, Object value)
           
 void setApplicationDefaultLocale(Locale defaultLocale)
          Sets the default locale for the application.
 void setApplyRenderingRules(boolean applyRules)
          Sets an optional boolean value representing whether Global Rules should be applied (and only applies to the IBM HATS product).
 void setApplyTextReplacement(boolean applyTextReplacement)
          Sets an optional boolean value representing whether Text Replacement should be applied to protected text of a host screen representation during a transformation.
 void setClassLoader(ClassLoader classLoader)
          Sets an optional class loader for loading component and widget classes.
 void setClientLocale(Locale clientLocale)
          Sets the client locale for the application.
 void setCodePage(int codepage)
          Sets the code page of the original host screen that is being transformed.
 void setDBCSSettings(com.ibm.hats.common.IDBCSSettings dbcsSettings)
          Sets the DBCS Settings object that is typically used in a DBCS environment.
 void setFormID(String formID)
          Sets the name of the HTML form to which transformation output will be encapsulated in.
 void setGlobalVariables(Hashtable globalVars)
          Sets the optional hashtable of Global Variables.
 void setHsrBidiServices(HsrBidiServices hsrBidi)
          Sets an HsrBidiServices object that is required for processing Bidirectional data in HSR.
 void setIsInCompactRendering(boolean isCompactRendering)
          Sets the optional value of the "is in compact rendering" attribute from the context attributes table.
 void setIsInDefaultRendering(boolean isDefaultRender)
          Sets the optional value of the "is in default rendering" attribute from the context attributes table.
 void setIsInVCTContext(boolean inVCT)
          Sets the optional flag of whether the transformation is performed in the VCT context.
 void setIsLinuxOS(boolean isLinux)
          Sets whether the transformation request is targeted for a Linux operating system.
 void setIsVistaOS(boolean isVista)
          Sets whether the transformation request is targeted for a Vista operating system.
 void setIsWindowsCEOS(boolean isWindowsCE)
          Sets whether the transformation request is targeted for Widnows CE and its variants.
 void setPathInfo(com.ibm.hats.transform.IPathInfo pathInfo)
          Sets an IPathInfo object, which contains path information necessary for HSR widgets, like Calendar, which load files from the file system.
 void setRenderingRulesEngine(IRenderingRulesEngine renderingRulesEngine)
          Sets an engine for Global Rules processing, which is only intended to be used in the IBM HATS environment.
 void setRuntimeTextOrientation(String orientation)
          Sets the text orientation configured in a runtime environment (such as an end-user's Web browser), which is to also be applied to the screen text by HSR.
 void setScriptingDisabled(boolean disabled)
          Set whether scripting is disabled or not.
 void setScriptLanguage(String scriptLanguage)
          Sets the name of the scripting language to generate scripts in (see the individual com.ibm.hats.transform.actions.ScriptAction classes).
 void setSharedGlobalVariables(Hashtable sharedGlobalVars)
          Sets the optional hashtable of Shared Global Variables.
 void setTextReplacements(TextReplacementList replacementList)
          Sets an optional TextReplacementList object used in Text Replacement functionality.
 void setTransformationHTMLParameters(Map htmlParmMap)
          Sets a Map object representing the HTML parameters from the result of a transformation request.
 
Methods inherited from class java.util.Hashtable
clear, clone, contains, containsKey, containsValue, elements, entrySet, equals, get, hashCode, isEmpty, keys, keySet, putAll, rehash, remove, size, toString, values
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

ATTR_APP_DEFAULT_LOCALE

public static final String ATTR_APP_DEFAULT_LOCALE
Flag indicating the application-default locale

See Also:
Constant Field Values

ATTR_APPLY_RENDERING_RULES

public static final String ATTR_APPLY_RENDERING_RULES
Flag to indicate whether rendering rules (global rules) are to be applied in this screen transformation

See Also:
Constant Field Values

ATTR_APPLY_TEXT_REPLACEMENT

public static final String ATTR_APPLY_TEXT_REPLACEMENT
Flag to indicate whther text replacements are to be applied in this screen transformation

See Also:
Constant Field Values

ATTR_CLASS_LOADER

public static final String ATTR_CLASS_LOADER
Flag to store an optional class loader in the context attributes

See Also:
Constant Field Values

ATTR_CLIENT_LOCALE

public static final String ATTR_CLIENT_LOCALE
Flag to indicate the client locale

See Also:
Constant Field Values

ATTR_CODEPAGE

public static final String ATTR_CODEPAGE
Internal constant related to code page (primarily used for Bidi-processing)

See Also:
Constant Field Values

ATTR_DBCS_SETTINGS

public static final String ATTR_DBCS_SETTINGS
Flag for storing an IDBCSSettings object in the context attributes

See Also:
Constant Field Values

ATTR_FORM_ID

public static final String ATTR_FORM_ID
Form ID (primarily applicable in a Portal environment)

See Also:
Constant Field Values

ATTR_GLOBAL_VARIABLES

public static final String ATTR_GLOBAL_VARIABLES
Flag for storing the Global variables Hashtable in the context attributes

See Also:
Constant Field Values

ATTR_HSR_BIDI_SERVICES

public static final String ATTR_HSR_BIDI_SERVICES
Flag for storing an HsrBidiServices object in the context attributes

See Also:
Constant Field Values

ATTR_IN_DEFAULT_RENDERING

public static final String ATTR_IN_DEFAULT_RENDERING
Flag indicating whether screen transformation is being performed via default rendering

See Also:
Constant Field Values

ATTR_IN_COMPACT_RENDERING

public static final String ATTR_IN_COMPACT_RENDERING
Flag indicating whether screen transformation is being performed via compact rendering (default rendering for a smaller screen)

See Also:
Constant Field Values

ATTR_IN_SCREEN_COMBINATION

public static final String ATTR_IN_SCREEN_COMBINATION
Flag indicating whether component selection is in Screen Combination editor or wizard

See Also:
Constant Field Values

ATTR_IN_GLOBAL_RULES

public static final String ATTR_IN_GLOBAL_RULES
Flag indicating whether component selection is in the Global Rules wizard

See Also:
Constant Field Values

ATTR_IN_LINUX_OS

public static final String ATTR_IN_LINUX_OS
Flag indicating whether the transformation recipient is running on a Linux operating system

See Also:
Constant Field Values

ATTR_IN_VISTA_OS

public static final String ATTR_IN_VISTA_OS
Flag indicating whether the transformation recipient is running on a Vista operating system

See Also:
Constant Field Values

ATTR_IN_WIN08_OS

public static final String ATTR_IN_WIN08_OS
See Also:
Constant Field Values

ATTR_IN_WINDOWS_CE_OS

public static final String ATTR_IN_WINDOWS_CE_OS
Flag indicating whether the transformation recipient is running on Windows CE

See Also:
Constant Field Values

ATTR_IN_VCT_CONTEXT

public static final String ATTR_IN_VCT_CONTEXT
Flag indicating whether the transformation is being performed inside VCT context (that is, using JSP "visual custom tags")

See Also:
Constant Field Values

ATTR_PARMS_IN_TRANSFORM_HTML

public static final String ATTR_PARMS_IN_TRANSFORM_HTML
Flag for storing a the paramters of a transformed HTML (most likely from an HttpServletRequest)

See Also:
Constant Field Values

ATTR_PATH_INFO_OBJECT

public static final String ATTR_PATH_INFO_OBJECT
Flag for storing an IPathInfo object, which contains file path information of image and other files for certain widgets

See Also:
Constant Field Values

ATTR_RENDERING_RULES_ENGINE

public static final String ATTR_RENDERING_RULES_ENGINE
Reference to the RenderingRulesEngine object associated with the current screen transformation

See Also:
Constant Field Values

ATTR_RUNTIME_RTL

public static final String ATTR_RUNTIME_RTL
Flag to indicate if screen text orientation in the end-user runtime is intentionally set right-to-left or left-to-right (Bidi-only)

See Also:
Constant Field Values

ATTR_SCRIPT_LANGUAGE

public static final String ATTR_SCRIPT_LANGUAGE
Name of the scripting language to generate scripts in (see the individual com.ibm.hats.transform.actions.ScriptAction classes)

See Also:
Constant Field Values

ATTR_SCRIPTING_DISABLED

public static final String ATTR_SCRIPTING_DISABLED
Flag to indicate whether scripting (normally Javascript generation) is disabled

See Also:
Constant Field Values

ATTR_SHARED_GLOBAL_VARIABLES

public static final String ATTR_SHARED_GLOBAL_VARIABLES
Flag for storing a shared global variables Hashtable

See Also:
Constant Field Values

ATTR_TEXT_REPLACEMENTS

public static final String ATTR_TEXT_REPLACEMENTS
Flag for storing a text replacement list

See Also:
Constant Field Values

LEFT_TO_RIGHT_TEXT

public static final String LEFT_TO_RIGHT_TEXT
Bidirectional text orientation setting representing left-to-right text

See Also:
Constant Field Values

RIGHT_TO_LEFT_TEXT

public static final String RIGHT_TO_LEFT_TEXT
Bidirectional text orientation setting representing right-to-left text

See Also:
Constant Field Values
Constructor Detail

ContextAttributes

public ContextAttributes()

Creates a new ContextAttributes object with required HSR context attributes prefilled with default values. The default values are listed immediately below. If the default values are not satisfactory, then they should be overridden with the appropriate set() method.

Following are examples of attributes that are not prefilled but must be provided by the consumer for HSR to function properly. A consumer should ideally examine each "getter" function of the context attributes and provide the attributes with the attribute's corresponding set() method.

Method Detail

getApplicationDefaultLocale

public Locale getApplicationDefaultLocale()
Gets the default locale for the application. If a default locale has not been stored in the context attributes, this function attempts to get the system default locale and return it. If that is not available, the locale Locale.ENGLISH is returned.

Returns:
Locale - the default application locale if set, else the system default, else Locale.ENGLISH

getClassLoader

public ClassLoader getClassLoader()
Gets an optional ClassLoader object (used primarily in the Studio environment) for loading components and widgets, if already set in the context attributes. If not set, a null value is returned.

Returns:
ClassLoader - a ClassLoader

getClientLocale

public Locale getClientLocale()
Gets the client locale, if already set in the context attributes. If not set, a null value is returned. The consumer is solely responsible for setting this attribute.

Returns:
Locale - the client locale if set, else null

getCodePage

public int getCodePage()
Gets the code page of the original host screen that is being transformed, if already set in the context attributes. If not set, a default value of 37 (United States English) is returned.

Returns:
int - integer value of the codepage if set, else 37

getDBCSSettings

public com.ibm.hats.common.IDBCSSettings getDBCSSettings()
Gets the DBCS Settings object that is necessary for DBCS data processing in a DBCS environment, if already set in the context attributes. If not set, a null value is returned. The consumer is solely responsible for setting this attribute.

Returns:
IDBCSSettings - a class representing DBCSSettings commonly used in a DBCS environment, else null if not already set

getFormID

public String getFormID()
Gets the name of the HTML form to which transformation output will be encapsulated in, if already set in the context attributes. If not set, a default value of "HSRForm" will be returned.

Returns:
String - name of the HTML form to encapsulate HSR output, else "HSRForm" if not already set

getGlobalVariables

public Hashtable getGlobalVariables()
Gets the hashtable of optional Global Variables, if already set in the context attributes. If not set, a null value is returned.

Returns:
Hashtable - hashtable of Global Variables or else null if not already set

getHsrBidiServices

public HsrBidiServices getHsrBidiServices()
Gets an HsrBidiServices object that is required only when processing Bidirectional data in HSR. If an HsrBidiServices object has not already been set in the context attributes, a value of null is returned. The consumer is solely responsible for setting this attribute.

Returns:
HsrBidiServices - a class used for Bidirectional data processing, else null if not already set

getPathInfo

public com.ibm.hats.transform.IPathInfo getPathInfo()
Gets an IPathInfo object, which contains path information required for HSR widgets, like Calendar, which load files from the file system. If an IPathInfo object has not already been set in the context attributes, a value of null is returned. The consumer is solely responsible for setting this attribute.

Returns:
IPathInfo - a class containing path information for file access, else null if not already set

getRenderingRulesEngine

public IRenderingRulesEngine getRenderingRulesEngine()
Gets an optional engine for Global Rules processing, which is only intended to be used in the IBM HATS environment. If an IRenderingRulesEngine object has not already been set in the context attributes, a value of null is returned.

Returns:
IRenderingRulesEngine - an engine for HATS Global Rules processing, else null if not already set

getRuntimeTextOrientation

public String getRuntimeTextOrientation()
Gets the text orientation configured in a runtime environment (such as an end-user's Web browser), which is to also be applied to the screen text by HSR, if already set in the context attributes. This attribute only applies to HSR if it is running in a Bidirectional environment. The text orientation is either LEFT_TO_RIGHT (default) or RIGHT_TO_LEFT.

Returns:
String text orientation (LEFT_TO_RIGHT or RIGHT_TO_LEFT)

getScriptLanguage

public String getScriptLanguage()
Gets the name of the scripting language to generate scripts in (see the individual com.ibm.hats.transform.actions.ScriptAction classes), if already set in the context attributes. If not set, a default value of "javascript" is returned.

Returns:
String - the script language to generate HSR scripts, else default "javascript"

getSharedGlobalVariables

public Hashtable getSharedGlobalVariables()
Gets an optional hashtable of Shared Global Variables, if already set in the context attributes. If not set, a null value is returned.

Returns:
Hashtable - hashtable of Shared Global Variables or else null if not already set

getTextReplacements

public TextReplacementList getTextReplacements()
Gets an optional TextReplacementList object used in Text Replacement functionality, if already set in the context attributes. If not set, a null value is returned.

Returns:
TextReplacementList - a list for use in Text Replacement functionality, else null if not already set

getTransformationHTMLParameters

public Map getTransformationHTMLParameters()
Gets a Map object representing the HTML parameters from the result of a transformation request, if already set in the context attributes. The Map will typically come from an HttpServletRequest, using its function "getParameterMap." If not set, a null value is returned. The consumer is solely responsible for setting this attribute. This attribute is not required, but it is preferred that the attribute be stored if convenient.

Returns:
Map - a map of HTML parameters from the ouptut of a transformation request, else null if not already set

isApplyRenderingRules

public boolean isApplyRenderingRules()
Gets a boolean value representing whether optional Global Rules should be applied (this concept only applies to the IBM HATS product), if already set in the context attributes. If not set, a default value of false is returned.

Returns:
boolean - whether Global Rules should be applied, else false if not already set

isApplyTextReplacement

public boolean isApplyTextReplacement()
Gets a boolean value representing whether option Text Replacements should be applied, if already set in the context attributes. If not set, a default value of false is returned.

Returns:
boolean - whether Text Replacements should be applied, else false if not already set

isInDefaultRendering

public boolean isInDefaultRendering()
Gets the optional value of the "is in default rendering" attribute from the context attributes table, if already set in the context attributes. If not set, a default value of false is returned.

Returns:
boolean - whether in default rendering or not, else false if not already set

isInCompactRendering

public boolean isInCompactRendering()
Gets the optional value of the "is in compact rendering" attribute from the context attributes table, if already set in the context attributes. If not set, a default value of false is returned.

Returns:
boolean - whether in compact rendering or not, else false if not already set

isInScreenCombination

public boolean isInScreenCombination()
Gets a boolean value representing whether caller is in Screen Combination wizard/ editor if already set in the context attributes. If not set, a default value of false is returned.

Returns:
boolean - whether call is from Screen Combination context

isInGlobalRules

public boolean isInGlobalRules()
Gets a boolean value representing whether or not global rules are being processed. If the value is set in the context attributes then that value is returned. If the value is not set in the context attributes then false is returned.

Returns:
boolean - whether or not global rules are being processed.

isInLinuxOS

public boolean isInLinuxOS()
Gets whether the transformation request is targeted for a Linux operating system, if already set in the context attributes. If not set, a default value of false is returned. The consumer is solely responsible for setting this attribute. This parameter is required if end-users are on a Linux operating system.

Returns:
boolean - whether the target operating system is Linux, else false if not already set

isInVistaOS

public boolean isInVistaOS()
Gets whether the transformation request is targeted for a Windows Vista operating system, if already set in the context attributes. If not set, a default value of false is returned. The consumer is solely responsible for setting this attribute. This parameter is required if end-users are on a Windows Vista operating system.

Returns:
boolean - whether the target operating system is Windows Vista, else false if not already set

isInWin08OS

public boolean isInWin08OS()
Gets whether the transformation request is targeted for a Windows Server 2008 operating system, if already set in the context attributes. If not set, a default value of false is returned. The consumer is solely responsible for setting this attribute. This parameter is required if end-users are on a Windows Server 2008 operating system.

Returns:
boolean - whether the target operating system is Windows Server 2008, else false if not already set

isInWindowsCEOS

public boolean isInWindowsCEOS()
Gets whether the transformation request is targeted for Windows CE operating and its variants, if already set in the context attributes. If not set, a default value of false is returned. The consumer is solely responsible for setting this attribute. This parameter is required if end-users are on Windows CE or its variants.

Returns:
boolean - whether the target operating system is Windows CE and its variants, else false if not already set

isInVCTContext

public boolean isInVCTContext()
Gets whether the transformation is performed in the VCT context (that is, using JSP "visual custom tags"), if already set in the context attributes. If not set, a default value of false is returned. This attribute is optional.

Returns:
boolean - whether in the VCT context or not, else false if not already set

isScriptingDisabled

public boolean isScriptingDisabled()
Gets whether scripting is disabled or not, if already set in the context attributes. If not set, a default value of false is returned. This attribute is optional.

Returns:
boolean - whether scripting is disabled or not, else false if not already set

setApplicationDefaultLocale

public void setApplicationDefaultLocale(Locale defaultLocale)
Sets the default locale for the application. The consumer must set this attribute if the default is not satisfactory.

Parameters:
defaultLocale - - the application default locale

setApplyRenderingRules

public void setApplyRenderingRules(boolean applyRules)
Sets an optional boolean value representing whether Global Rules should be applied (and only applies to the IBM HATS product).

Parameters:
applyRules - - boolean representing whether Global Rules are to be applied

setApplyTextReplacement

public void setApplyTextReplacement(boolean applyTextReplacement)
Sets an optional boolean value representing whether Text Replacement should be applied to protected text of a host screen representation during a transformation.

Parameters:
applyTextReplacement - - boolean representing whether Text Replacements are to be applied

setClassLoader

public void setClassLoader(ClassLoader classLoader)
Sets an optional class loader for loading component and widget classes.

Parameters:
classLoader -

setClientLocale

public void setClientLocale(Locale clientLocale)
Sets the client locale for the application.

Parameters:
clientLocale - - the client locale

setCodePage

public void setCodePage(int codepage)
Sets the code page of the original host screen that is being transformed.

Parameters:
codepage - - code page of the original host

setDBCSSettings

public void setDBCSSettings(com.ibm.hats.common.IDBCSSettings dbcsSettings)
Sets the DBCS Settings object that is typically used in a DBCS environment.

Parameters:
dbcsSettings - - DBCS Settings object to be used in a DBCS enviroment.

setFormID

public void setFormID(String formID)
Sets the name of the HTML form to which transformation output will be encapsulated in.

Parameters:
formID - - name of HTML form

setGlobalVariables

public void setGlobalVariables(Hashtable globalVars)
Sets the optional hashtable of Global Variables.

Parameters:
globalVars - - hashtable of global variables

setHsrBidiServices

public void setHsrBidiServices(HsrBidiServices hsrBidi)
Sets an HsrBidiServices object that is required for processing Bidirectional data in HSR.

Parameters:
hsrBidi - - the HsrBidiServices object to use in the Bidirectional environment

setIsInDefaultRendering

public void setIsInDefaultRendering(boolean isDefaultRender)
Sets the optional value of the "is in default rendering" attribute from the context attributes table.

Parameters:
isDefaultRender - - whether in default rendering or not

setIsInCompactRendering

public void setIsInCompactRendering(boolean isCompactRendering)
Sets the optional value of the "is in compact rendering" attribute from the context attributes table.

Parameters:
isCompactRendering - - whether in compact rendering or not

setIsInVCTContext

public void setIsInVCTContext(boolean inVCT)
Sets the optional flag of whether the transformation is performed in the VCT context.

Parameters:
inVCT - - whether in VCT context or not

setIsLinuxOS

public void setIsLinuxOS(boolean isLinux)
Sets whether the transformation request is targeted for a Linux operating system.

Parameters:
isLinux - - whether in LinuxOS or not

setIsVistaOS

public void setIsVistaOS(boolean isVista)
Sets whether the transformation request is targeted for a Vista operating system.

Parameters:
isVista - - whether in Vista or not.

setIsWindowsCEOS

public void setIsWindowsCEOS(boolean isWindowsCE)
Sets whether the transformation request is targeted for Widnows CE and its variants.

Parameters:
isWindowsCE - - whether in Windows CE or not

setPathInfo

public void setPathInfo(com.ibm.hats.transform.IPathInfo pathInfo)
Sets an IPathInfo object, which contains path information necessary for HSR widgets, like Calendar, which load files from the file system.

Parameters:
pathInfo - - object containing file system path info

setRenderingRulesEngine

public void setRenderingRulesEngine(IRenderingRulesEngine renderingRulesEngine)
Sets an engine for Global Rules processing, which is only intended to be used in the IBM HATS environment.

Parameters:
renderingRulesEngine - - object to process Global Rules

setRuntimeTextOrientation

public void setRuntimeTextOrientation(String orientation)
Sets the text orientation configured in a runtime environment (such as an end-user's Web browser), which is to also be applied to the screen text by HSR. This attribute only applies to HSR if it is running in a Bidirectional environment. The text orientation must either be set to LEFT_TO_RIGHT_TEXT (default) or RIGHT_TO_LEFT_TEXT. If the orientation is not either of those, then the orientation will be set LEFT_TO_RIGHT_TEXT.

Parameters:
orientation - - text orientation (LEFT_TO_RIGHT_TEXT or RIGHT_TO_LEFT_TEXT)

setScriptingDisabled

public void setScriptingDisabled(boolean disabled)
Set whether scripting is disabled or not.

Parameters:
disabled - - whether scripting is disabled or not

setScriptLanguage

public void setScriptLanguage(String scriptLanguage)
Sets the name of the scripting language to generate scripts in (see the individual com.ibm.hats.transform.actions.ScriptAction classes).

Parameters:
scriptLanguage - - name of language to set

setSharedGlobalVariables

public void setSharedGlobalVariables(Hashtable sharedGlobalVars)
Sets the optional hashtable of Shared Global Variables.

Parameters:
sharedGlobalVars - - hashtable of shared global variables

setTextReplacements

public void setTextReplacements(TextReplacementList replacementList)
Sets an optional TextReplacementList object used in Text Replacement functionality.

Parameters:
replacementList - - text replacement list to set

setTransformationHTMLParameters

public void setTransformationHTMLParameters(Map htmlParmMap)
Sets a Map object representing the HTML parameters from the result of a transformation request. The Map will typically come from an HttpServletRequest, using its function "getParameterMap."

Parameters:
htmlParmMap - - map of the transformation HTML parameters

makeContextAttributes

public static ContextAttributes makeContextAttributes(Hashtable contextAttributes)
Deprecated. 

Makes a ContextAttribute from a Hashtable. This method can help update V6 and earlier Hashtable uses for components and widgets to the new V7 APIs. Returns the same object if object is already a ContextAttribute.

Parameters:
contextAttributes - The context attributes.
Returns:
A ContextAttributes object.

put

public Object put(Object key,
                  Object value)
Specified by:
put in interface Map
Overrides:
put in class Hashtable

isVista

public boolean isVista()

isWin08

public boolean isWin08()

HATS 7.5.1 (201005110649)