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 WebContextAttributes

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

public class WebContextAttributes
extends ContextAttributes

This class extends the class ContextAttributes and contains additional attributes that only apply to a Web-based context. A consumer should use an instance this class with HSR (versus using the base class ContextAttributes) if they are deploying HSR in the Web environment.

See Also:
Serialized Form

Field Summary
static String ATTR_IN_IE_BROWSER
           
static String ATTR_IN_SAFARI_BROWSER
           
 
Fields inherited from class com.ibm.hats.transform.context.ContextAttributes
ATTR_APP_DEFAULT_LOCALE, ATTR_APPLY_RENDERING_RULES, ATTR_APPLY_TEXT_REPLACEMENT, ATTR_CLASS_LOADER, ATTR_CLIENT_LOCALE, ATTR_CODEPAGE, ATTR_DBCS_SETTINGS, ATTR_FORM_ID, ATTR_GLOBAL_VARIABLES, ATTR_HSR_BIDI_SERVICES, ATTR_IN_COMPACT_RENDERING, ATTR_IN_DEFAULT_RENDERING, ATTR_IN_GLOBAL_RULES, ATTR_IN_LINUX_OS, ATTR_IN_SCREEN_COMBINATION, ATTR_IN_VCT_CONTEXT, ATTR_IN_VISTA_OS, ATTR_IN_WIN08_OS, ATTR_IN_WINDOWS_CE_OS, ATTR_PARMS_IN_TRANSFORM_HTML, ATTR_PATH_INFO_OBJECT, ATTR_RENDERING_RULES_ENGINE, ATTR_RUNTIME_RTL, ATTR_SCRIPT_LANGUAGE, ATTR_SCRIPTING_DISABLED, ATTR_SHARED_GLOBAL_VARIABLES, ATTR_TEXT_REPLACEMENTS, LEFT_TO_RIGHT_TEXT, RIGHT_TO_LEFT_TEXT
 
Constructor Summary
WebContextAttributes()
           Creates a new WebContextAttributes object, which should be used by the consumer if running HSR in a Web-specific context, such as a Web Browser.
 
Method Summary
 boolean isInIEViewer()
          Gets whether the transformation request is intended to be viewed with the Internet Explorer Web browser, if already set in the context attributes.
 boolean isInPocketIEViewer()
          Gets whether the transformation request is intended to be viewed with the Pocket Internet Explorer Web browser.
 boolean isInSafariViewer()
          Gets whether the transformation request is intended to be viewed with the Safari Web browser, if already set in the context attributes.
 void setIsInIEViewer(boolean isInIE)
          Sets whether the transformation request is intended to be viewed with the Internet Explorer Web browser.
 void setIsInSafariViewer(boolean isInSafari)
          Sets whether the transformation request is intended to be viewed with the Safari Web browser.
 
Methods inherited from class com.ibm.hats.transform.context.ContextAttributes
getApplicationDefaultLocale, getClassLoader, getClientLocale, getCodePage, getDBCSSettings, getFormID, getGlobalVariables, getHsrBidiServices, getPathInfo, getRenderingRulesEngine, getRuntimeTextOrientation, getScriptLanguage, getSharedGlobalVariables, getTextReplacements, getTransformationHTMLParameters, isApplyRenderingRules, isApplyTextReplacement, isInCompactRendering, isInDefaultRendering, isInGlobalRules, isInLinuxOS, isInScreenCombination, isInVCTContext, isInVistaOS, isInWin08OS, isInWindowsCEOS, isScriptingDisabled, isVista, isWin08, makeContextAttributes, put, setApplicationDefaultLocale, setApplyRenderingRules, setApplyTextReplacement, setClassLoader, setClientLocale, setCodePage, setDBCSSettings, setFormID, setGlobalVariables, setHsrBidiServices, setIsInCompactRendering, setIsInDefaultRendering, setIsInVCTContext, setIsLinuxOS, setIsVistaOS, setIsWindowsCEOS, setPathInfo, setRenderingRulesEngine, setRuntimeTextOrientation, setScriptingDisabled, setScriptLanguage, setSharedGlobalVariables, setTextReplacements, setTransformationHTMLParameters
 
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_IN_IE_BROWSER

public static final String ATTR_IN_IE_BROWSER
See Also:
Constant Field Values

ATTR_IN_SAFARI_BROWSER

public static final String ATTR_IN_SAFARI_BROWSER
See Also:
Constant Field Values
Constructor Detail

WebContextAttributes

public WebContextAttributes()

Creates a new WebContextAttributes object, which should be used by the consumer if running HSR in a Web-specific context, such as a Web Browser. With this constructor, some of the required HSR context attributes are 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

isInIEViewer

public boolean isInIEViewer()
Gets whether the transformation request is intended to be viewed with the Internet Explorer Web browser, if already set in the context attributes. If not set, the default value of false is returned. The consumer is solely responsible for setting this attribute.

Returns:
boolean telling whether in IE browser or not. false if not set.

isInPocketIEViewer

public boolean isInPocketIEViewer()
Gets whether the transformation request is intended to be viewed with the Pocket Internet Explorer Web browser.

Returns:
boolean telling whether in Pocket IE browser or not. false if not set.

isInSafariViewer

public boolean isInSafariViewer()
Gets whether the transformation request is intended to be viewed with the Safari Web browser, if already set in the context attributes. If not set, the default value of false is returned. The consumer is solely responsible for setting this attribute.

Returns:
boolean telling whether in Safari browser or not. false if not set.

setIsInIEViewer

public void setIsInIEViewer(boolean isInIE)
Sets whether the transformation request is intended to be viewed with the Internet Explorer Web browser.

Parameters:
isInIE - - whether in IE browser or not

setIsInSafariViewer

public void setIsInSafariViewer(boolean isInSafari)
Sets whether the transformation request is intended to be viewed with the Safari Web browser.

Parameters:
isInSafari - - whether in Safari browser or not

HATS 7.5.1 (201005110649)