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
Class TransformationFunctions

java.lang.Object
  extended by com.ibm.hats.transform.BaseTransformationFunctions
      extended by com.ibm.hats.transform.TransformationFunctions

public class TransformationFunctions
extends com.ibm.hats.transform.BaseTransformationFunctions

This class contains miscellaneous methods related to host screen transformation.


Field Summary
protected static String Copyright
           
 
Fields inherited from class com.ibm.hats.transform.BaseTransformationFunctions
CLASS_NAME
 
Constructor Summary
TransformationFunctions()
           
 
Method Summary
static String buildMuliValueString(String[] values)
           
static ComponentElement[] doComponentRecognition(String componentClassName, ClassLoader classLoader, HsrScreen hs, ScreenRegion region, Properties settings, Hashtable contextAttributes)
          Deprecated.  
static String drawWidget(String widgetClassName, ClassLoader classLoader, ComponentElement[] cea, Properties settings, Hashtable contextAttributes)
          Deprecated.  
static String generateComponentTag(RenderingItem item)
           
static String generateComponentTag(RenderingItem item, boolean outputTagInDefaultRendering)
          Method to generate a <HATS:Component /> tag.
static String generateDefaultRenderingTag(BlockScreenRegion region, String renderingSetName, boolean applyGlobalRules, boolean applyTextReplacement, Properties settings)
          Method to generate a <HATS:DefaultRendering ...
static String getDefaultRenderingPreview(RenderingSet renderingSet, HostScreen hostScreen, BlockScreenRegion region, boolean applyGlobalRules, Hashtable classSettings, ClassLoader classLoader)
           
static String getDefaultRenderingPreview(RenderingSet renderingSet, HostScreen hostScreen, BlockScreenRegion region, boolean applyGlobalRules, Hashtable classSettings, ClassLoader classLoader, Properties BIDISettings)
           
static String getDefaultRenderingPreview(RenderingSet renderingSet, HostScreen hostScreen, BlockScreenRegion region, boolean applyGlobalRules, Hashtable classSettings, ContextAttributes contextAttributes)
           
static String getDefaultRenderingPreview(RenderingSet renderingSet, HostScreen hostScreen, BlockScreenRegion region, boolean applyGlobalRules, Hashtable classSettings, ContextAttributes contextAttributes, Properties BIDISettings)
           
static String getDefaultRenderingPreview(RenderingSet renderingSet, HostScreen hostScreen, BlockScreenRegion region, boolean applyGlobalRules, Hashtable classSettings, Hashtable contextAttributes, Properties BIDISettings)
          Deprecated.  
static String getDefaultRenderingTagsOutput(RenderingSet renderingSet, HostScreen hostScreen, BlockScreenRegion region, boolean applyGlobalRules, Hashtable classSettings, ClassLoader classLoader, boolean createFLMTable)
           
static String getDefaultRenderingTagsOutput(RenderingSet renderingSet, HostScreen hostScreen, BlockScreenRegion region, boolean applyGlobalRules, Hashtable classSettings, ClassLoader classLoader, boolean createFLMTable, Properties BIDIWidgetSettings)
           
static String getDefaultRenderingTagsOutput(RenderingSet renderingSet, HostScreen hostScreen, BlockScreenRegion region, boolean applyGlobalRules, Hashtable classSettings, ClassLoader classLoader, boolean createFLMTable, Properties BIDIWidgetSettings, boolean includeEmptyProtectedFields)
           
static String[] getMultipleValues(String value)
          Returns an array of String, each representing a segment of the value specified (using the "|" pipe character as the delimiter).
static com.ibm.hats.transform.PathInfo getPathInfo(ContextAttributes contextAttributes)
           
static com.ibm.hats.transform.PathInfo getPathInfo(Hashtable contextAttributes)
          Deprecated.  
static String getPreview(String componentClassName, String widgetClassName, ClassLoader classLoader, HostScreen hostScreen, int startRow, int startCol, int endRow, int endCol, Properties componentSettings, Properties widgetSettings, boolean isBidi, ContextAttributes contextAttributes)
          Performs component recognition and widget rendering using the specified parameters.
static String getPreview(String componentClassName, String widgetClassName, ClassLoader classLoader, HostScreen hostScreen, int startRow, int startCol, int endRow, int endCol, Properties componentSettings, Properties widgetSettings, boolean isBidi, ContextAttributes contextAttributes, TextReplacementList trl)
          Performs component recognition and widget rendering using the specified parameters.
static String getPreview(String componentClassName, String widgetClassName, ClassLoader classLoader, HostScreen hostScreen, int startRow, int startCol, int endRow, int endCol, Properties componentSettings, Properties widgetSettings, boolean isBidi, Hashtable contextAttributes)
          Deprecated.  
static String getPreview(String componentClassName, String widgetClassName, ClassLoader classLoader, HostScreen hostScreen, int startRow, int startCol, int endRow, int endCol, Properties componentSettings, Properties widgetSettings, boolean isBidi, Hashtable contextAttributes, TextReplacementList trl)
          Deprecated.  
static String getPreview(String componentClassName, String widgetClassName, ClassLoader classLoader, HostScreen hostScreen, ScreenRegion region, Properties componentSettings, Properties widgetSettings, boolean isBidi, ContextAttributes contextAttributes)
          Performs component recognition and widget rendering using the specified parameters.
static String getPreview(String componentClassName, String widgetClassName, ClassLoader classLoader, HostScreen hostScreen, ScreenRegion region, Properties componentSettings, Properties widgetSettings, boolean isBidi, ContextAttributes contextAttributes, TextReplacementList trl)
          Performs component recognition and widget rendering using the specified parameters.
static String getPreview(String componentClassName, String widgetClassName, ClassLoader classLoader, HostScreen hostScreen, ScreenRegion region, Properties componentSettings, Properties widgetSettings, boolean isBidi, Hashtable contextAttributes)
          Deprecated.  
static String getPreview(String componentClassName, String widgetClassName, ClassLoader classLoader, HostScreen hostScreen, ScreenRegion region, Properties componentSettings, Properties widgetSettings, boolean isBidi, Hashtable contextAttributes, TextReplacementList trl)
          Deprecated.  
static boolean isCreateFLMTable(ContextAttributes contextAttributes)
           
static boolean isCreateFLMTable(Hashtable contextAttributes)
          Deprecated.  
static boolean isCustomComponent(String componentClassName, ClassLoader classLoader)
          Return a boolean specifying whether the supplied component class name is a custom (non HATS) component.
static boolean isCustomWidget(String widgetClassName, ClassLoader classLoader)
          Return a boolean specifying whether the supplied widget class name is a custom (non HATS) widget.
static boolean isFreeLayoutMode(ContextAttributes contextAttributes)
           
static boolean isFreeLayoutMode(Hashtable contextAttributes)
          Deprecated.  
static boolean isGenerateComponentTag(ComponentElement componentElement)
          This is only used in Free Layout Mode (in Studio only).
static boolean isInComponentPreview(ContextAttributes contextAttributes)
          Returns the value of the "is in component preview" attribute from the context attributes table (if it exists, else this method returns false).
static boolean isInComponentPreview(Hashtable contextAttributes)
          Deprecated.  
static boolean isInDefaultRendering(ContextAttributes contextAttributes)
          Returns the value of the "is in default rendering" attribute from the context attributes table (if it exists, else this method returns false).
static boolean isInDefaultRendering(Hashtable contextAttributes)
          Deprecated.  
static boolean isInStudio(ContextAttributes contextAttributes)
          Returns the value of the "is in studio" attribute from the context attributes table (if it exists, else this method returns false).
static boolean isInStudio(Hashtable contextAttributes)
          Deprecated.  
static boolean isInWidgetPreview(ContextAttributes contextAttributes)
          Returns the value of the "is in widget preview" attribute from the context attributes table (if it exists, else this method returns false).
static boolean isInWidgetPreview(Hashtable contextAttributes)
          Deprecated.  
static boolean isInWizard(ContextAttributes contextAttributes)
          Returns the value of the "is in wizard" attribute from the context attributes table (if it exists, else this method returns false).
static boolean isInWizard(Hashtable contextAttributes)
          Deprecated.  
static boolean isOutputTagInDefaultRendering(ContextAttributes contextAttributes)
           
static boolean isOutputTagInDefaultRendering(Hashtable contextAttributes)
          Deprecated.  
static boolean isScriptingDisabled(ContextAttributes contextAttributes)
          Returns the value of the "scripting disabled" attribute from the context attributes table (if it exists, else this method returns false).
static boolean isScriptingDisabled(Hashtable contextAttributes)
          Deprecated.  
 
Methods inherited from class com.ibm.hats.transform.BaseTransformationFunctions
createEmptyString, doComponentRecognition, drawWidget, evaluateFieldAttributeList, evaluateFieldAttributeWithModifier, evaluateFieldText, evaluateMatchOfFieldAttributes, evaluateProtectedField, leftTrimString, leftTrimStringDBCS, normalizeRegion, rightTrimString, rightTrimStringDBCS
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

Copyright

protected static final String Copyright
See Also:
Constant Field Values
Constructor Detail

TransformationFunctions

public TransformationFunctions()
Method Detail

getPreview

public static String getPreview(String componentClassName,
                                String widgetClassName,
                                ClassLoader classLoader,
                                HostScreen hostScreen,
                                int startRow,
                                int startCol,
                                int endRow,
                                int endCol,
                                Properties componentSettings,
                                Properties widgetSettings,
                                boolean isBidi,
                                ContextAttributes contextAttributes)
Performs component recognition and widget rendering using the specified parameters.

Parameters:
componentClassName - The fully qualified component class name.
widgetClassName - The fully qualified widget class name.
classLoader - The class loader.
hostScreen - The host screen.
startRow - The row to begin recognition.
startCol - The column to being recognition.
endRow - The row to end recognition.
endCol - The column to end recognition.
componentSettings - The set of component settings.
widgetSettings - The set of widget settings.
isBidi - Boolean value indicating Bidi state.
contextAttributes - The context attributes.
Returns:
The preview.

getPreview

public static String getPreview(String componentClassName,
                                String widgetClassName,
                                ClassLoader classLoader,
                                HostScreen hostScreen,
                                int startRow,
                                int startCol,
                                int endRow,
                                int endCol,
                                Properties componentSettings,
                                Properties widgetSettings,
                                boolean isBidi,
                                ContextAttributes contextAttributes,
                                TextReplacementList trl)
Performs component recognition and widget rendering using the specified parameters.

Parameters:
componentClassName - The fully qualified component class name.
widgetClassName - The fully qualified widget class name.
classLoader - The class loader.
hostScreen - The host screen.
startRow - The row to begin recognition.
startCol - The column to being recognition.
endRow - The row to end recognition.
endCol - The column to end recognition.
componentSettings - The set of component settings.
widgetSettings - The set of widget settings.
isBidi - Boolean value indicating Bidi state.
contextAttributes - The context attributes.
trl - The text replacement list.
Returns:
The preview.

getPreview

public static String getPreview(String componentClassName,
                                String widgetClassName,
                                ClassLoader classLoader,
                                HostScreen hostScreen,
                                ScreenRegion region,
                                Properties componentSettings,
                                Properties widgetSettings,
                                boolean isBidi,
                                ContextAttributes contextAttributes)
Performs component recognition and widget rendering using the specified parameters.

Parameters:
componentClassName - The fully qualified component class name.
widgetClassName - The fully qualified widget class name.
classLoader - The class loader.
hostScreen - The host screen.
region - The region to recognize.
componentSettings - The set of component settings.
widgetSettings - The set of widget settings.
isBidi - Boolean value indicating Bidi state.
contextAttributes - The context attributes.
Returns:
The preview.

getPreview

public static String getPreview(String componentClassName,
                                String widgetClassName,
                                ClassLoader classLoader,
                                HostScreen hostScreen,
                                ScreenRegion region,
                                Properties componentSettings,
                                Properties widgetSettings,
                                boolean isBidi,
                                ContextAttributes contextAttributes,
                                TextReplacementList trl)
Performs component recognition and widget rendering using the specified parameters.

Parameters:
componentClassName - The fully qualified component class name.
widgetClassName - The fully qualified widget class name.
classLoader - The class loader.
hostScreen - The host screen.
region - The region to recognize.
componentSettings - The set of component settings.
widgetSettings - The set of widget settings.
isBidi - Boolean value indicating Bidi state.
contextAttributes - The context attributes.
trl - The text replacement list.
Returns:
The preview.

getDefaultRenderingPreview

public static String getDefaultRenderingPreview(RenderingSet renderingSet,
                                                HostScreen hostScreen,
                                                BlockScreenRegion region,
                                                boolean applyGlobalRules,
                                                Hashtable classSettings,
                                                ClassLoader classLoader)

getDefaultRenderingPreview

public static String getDefaultRenderingPreview(RenderingSet renderingSet,
                                                HostScreen hostScreen,
                                                BlockScreenRegion region,
                                                boolean applyGlobalRules,
                                                Hashtable classSettings,
                                                ClassLoader classLoader,
                                                Properties BIDISettings)

getDefaultRenderingPreview

public static String getDefaultRenderingPreview(RenderingSet renderingSet,
                                                HostScreen hostScreen,
                                                BlockScreenRegion region,
                                                boolean applyGlobalRules,
                                                Hashtable classSettings,
                                                ContextAttributes contextAttributes)

getDefaultRenderingPreview

public static String getDefaultRenderingPreview(RenderingSet renderingSet,
                                                HostScreen hostScreen,
                                                BlockScreenRegion region,
                                                boolean applyGlobalRules,
                                                Hashtable classSettings,
                                                ContextAttributes contextAttributes,
                                                Properties BIDISettings)

getDefaultRenderingTagsOutput

public static String getDefaultRenderingTagsOutput(RenderingSet renderingSet,
                                                   HostScreen hostScreen,
                                                   BlockScreenRegion region,
                                                   boolean applyGlobalRules,
                                                   Hashtable classSettings,
                                                   ClassLoader classLoader,
                                                   boolean createFLMTable)

getDefaultRenderingTagsOutput

public static String getDefaultRenderingTagsOutput(RenderingSet renderingSet,
                                                   HostScreen hostScreen,
                                                   BlockScreenRegion region,
                                                   boolean applyGlobalRules,
                                                   Hashtable classSettings,
                                                   ClassLoader classLoader,
                                                   boolean createFLMTable,
                                                   Properties BIDIWidgetSettings)

getDefaultRenderingTagsOutput

public static String getDefaultRenderingTagsOutput(RenderingSet renderingSet,
                                                   HostScreen hostScreen,
                                                   BlockScreenRegion region,
                                                   boolean applyGlobalRules,
                                                   Hashtable classSettings,
                                                   ClassLoader classLoader,
                                                   boolean createFLMTable,
                                                   Properties BIDIWidgetSettings,
                                                   boolean includeEmptyProtectedFields)

generateDefaultRenderingTag

public static String generateDefaultRenderingTag(BlockScreenRegion region,
                                                 String renderingSetName,
                                                 boolean applyGlobalRules,
                                                 boolean applyTextReplacement,
                                                 Properties settings)
Method to generate a <HATS:DefaultRendering ... /> tag.

Parameters:
region - The region.
renderingSetName - The name of the rendering set.
applyGlobalRules - A boolean specifying the value of the applyGlobalRules tag attribute
applyTextReplacement - A boolean specifying the value of the applyTextReplacement tag attribute
settings - Any extra settings.
Returns:
The generated tag.

generateComponentTag

public static String generateComponentTag(RenderingItem item)

generateComponentTag

public static String generateComponentTag(RenderingItem item,
                                          boolean outputTagInDefaultRendering)
Method to generate a <HATS:Component /> tag.

Parameters:
item - The rendering item.
outputTagInDefaultRendering - The output tag in the default rendering.
Returns:
The generated component tag.

isCustomComponent

public static boolean isCustomComponent(String componentClassName,
                                        ClassLoader classLoader)
Return a boolean specifying whether the supplied component class name is a custom (non HATS) component.

Parameters:
componentClassName - The fully qualified component class name.
classLoader - The class loader.
Returns:
Return true if the component is a custom component, false otherwise.

isCustomWidget

public static boolean isCustomWidget(String widgetClassName,
                                     ClassLoader classLoader)
Return a boolean specifying whether the supplied widget class name is a custom (non HATS) widget.

Parameters:
widgetClassName - The fully qualified widget class name.
classLoader - The class loader.
Returns:
Return true if the widget is a custom widget, false otherwise.

getPathInfo

public static com.ibm.hats.transform.PathInfo getPathInfo(ContextAttributes contextAttributes)

getMultipleValues

public static String[] getMultipleValues(String value)
Returns an array of String, each representing a segment of the value specified (using the "|" pipe character as the delimiter).

Parameters:
value - The concatenated String.
Returns:
Returns an array of the String contents with each element representing a segment of the value specified (using the "|" pipe character as the delimiter).

buildMuliValueString

public static String buildMuliValueString(String[] values)

isScriptingDisabled

public static boolean isScriptingDisabled(ContextAttributes contextAttributes)
Returns the value of the "scripting disabled" attribute from the context attributes table (if it exists, else this method returns false).

Parameters:
contextAttributes - The context attributes.
Returns:
Returns a boolean value indicating whether or not scripting is disabled.

isInStudio

public static boolean isInStudio(ContextAttributes contextAttributes)
Returns the value of the "is in studio" attribute from the context attributes table (if it exists, else this method returns false).

Parameters:
contextAttributes - The context attributes.
Returns:
Returns a boolean value indicating whether or not the "is in studio" attribute is set.

isInDefaultRendering

public static boolean isInDefaultRendering(ContextAttributes contextAttributes)
Returns the value of the "is in default rendering" attribute from the context attributes table (if it exists, else this method returns false).

Parameters:
contextAttributes - The context attributes.
Returns:
Returns a boolean value indicating whether or not the "is in default rendering" attribute is set.

isInWidgetPreview

public static boolean isInWidgetPreview(ContextAttributes contextAttributes)
Returns the value of the "is in widget preview" attribute from the context attributes table (if it exists, else this method returns false).

Parameters:
contextAttributes - The context attributes.
Returns:
Returns a boolean value indicating whether or not the "is in widget preview" attribute is set.

isInComponentPreview

public static boolean isInComponentPreview(ContextAttributes contextAttributes)
Returns the value of the "is in component preview" attribute from the context attributes table (if it exists, else this method returns false).

Parameters:
contextAttributes - The context attributes.
Returns:
Returns a boolean value indicating whether or not the "is in component preview" attribute is set.

isInWizard

public static boolean isInWizard(ContextAttributes contextAttributes)
Returns the value of the "is in wizard" attribute from the context attributes table (if it exists, else this method returns false).

Parameters:
contextAttributes - The context attributes.
Returns:
Returns a boolean value indicating whether or not the "is in wizard" attribute is set.

isOutputTagInDefaultRendering

public static boolean isOutputTagInDefaultRendering(ContextAttributes contextAttributes)

isFreeLayoutMode

public static boolean isFreeLayoutMode(ContextAttributes contextAttributes)

isCreateFLMTable

public static boolean isCreateFLMTable(ContextAttributes contextAttributes)

isGenerateComponentTag

public static boolean isGenerateComponentTag(ComponentElement componentElement)
This is only used in Free Layout Mode (in Studio only). With FLM, if the table is filled up with the components it's hard to move components around because there's no more empty space. So the idea is to check to see if any fields need to be rendered.

Parameters:
componentElement - The component element.
Returns:
A boolean value indicating whether or not the "is generate component tag" indicates that a field needs to be rendered.

isScriptingDisabled

public static boolean isScriptingDisabled(Hashtable contextAttributes)
Deprecated. 

Returns the value of the "scripting disabled" attribute from the context attributes table (if it exists, else this method returns false).

Parameters:
contextAttributes - The context attributes.
Returns:
Return the value of the "scripting disabled" attribute from the context attributes table if it exists, false otherwise.

isInStudio

public static boolean isInStudio(Hashtable contextAttributes)
Deprecated. 

Returns the value of the "is in studio" attribute from the context attributes table (if it exists, else this method returns false).

Parameters:
contextAttributes - The context attributes.
Returns:
Returns a boolean value indicating whether or not the "is in studio" attribute is set.

isInDefaultRendering

public static boolean isInDefaultRendering(Hashtable contextAttributes)
Deprecated. 

Returns the value of the "is in default rendering" attribute from the context attributes table (if it exists, else this method returns false).

Parameters:
contextAttributes - The context attributes.
Returns:
Returns a boolean value indicating whether or not the "is in default rendering" attribute is set.

isInWidgetPreview

public static boolean isInWidgetPreview(Hashtable contextAttributes)
Deprecated. 

Returns the value of the "is in widget preview" attribute from the context attributes table (if it exists, else this method returns false).

Parameters:
contextAttributes - The context attributes.
Returns:
Returns a boolean value indicating whether or not the "is in widget preview" attribute is set.

isInComponentPreview

public static boolean isInComponentPreview(Hashtable contextAttributes)
Deprecated. 

Returns the value of the "is in component preview" attribute from the context attributes table (if it exists, else this method returns false).

Parameters:
contextAttributes - The context attributes.
Returns:
Returns a boolean value indicating whether or not the "is in component preview" attribute is set.

isInWizard

public static boolean isInWizard(Hashtable contextAttributes)
Deprecated. 

Returns the value of the "is in wizard" attribute from the context attributes table (if it exists, else this method returns false).

Parameters:
contextAttributes - The context attributes.
Returns:
Returns a boolean value indicating whether or not the "is in wizard" attribute is set.

isOutputTagInDefaultRendering

public static boolean isOutputTagInDefaultRendering(Hashtable contextAttributes)
Deprecated. 


isFreeLayoutMode

public static boolean isFreeLayoutMode(Hashtable contextAttributes)
Deprecated. 


isCreateFLMTable

public static boolean isCreateFLMTable(Hashtable contextAttributes)
Deprecated. 


doComponentRecognition

public static ComponentElement[] doComponentRecognition(String componentClassName,
                                                        ClassLoader classLoader,
                                                        HsrScreen hs,
                                                        ScreenRegion region,
                                                        Properties settings,
                                                        Hashtable contextAttributes)
Deprecated. 

Performs component recognition using the specified parameters.

Parameters:
componentClassName - The fully qualified component class name.
classLoader - The class loader.
hs - The host screen.
region - The region to recognize.
settings - The set of component settings.
contextAttributes - The context attributes.
Returns:
Returns the component element array.

drawWidget

public static String drawWidget(String widgetClassName,
                                ClassLoader classLoader,
                                ComponentElement[] cea,
                                Properties settings,
                                Hashtable contextAttributes)
Deprecated. 

Method to render the array of complement elements with the specified widget class name.

Parameters:
widgetClassName - The fully qualified widget class name.
classLoader - The class loader.
cea - The component element array.
settings - The properties.
contextAttributes - The context attributes.
Returns:
The drawn widget String.

getPathInfo

public static com.ibm.hats.transform.PathInfo getPathInfo(Hashtable contextAttributes)
Deprecated. 


getDefaultRenderingPreview

public static String getDefaultRenderingPreview(RenderingSet renderingSet,
                                                HostScreen hostScreen,
                                                BlockScreenRegion region,
                                                boolean applyGlobalRules,
                                                Hashtable classSettings,
                                                Hashtable contextAttributes,
                                                Properties BIDISettings)
Deprecated. 


getPreview

public static String getPreview(String componentClassName,
                                String widgetClassName,
                                ClassLoader classLoader,
                                HostScreen hostScreen,
                                int startRow,
                                int startCol,
                                int endRow,
                                int endCol,
                                Properties componentSettings,
                                Properties widgetSettings,
                                boolean isBidi,
                                Hashtable contextAttributes)
Deprecated. 

Performs component recognition and widget rendering using the specified parameters.

Parameters:
componentClassName - The fully qualified component class name.
widgetClassName - The fully qualified widget class name.
classLoader - The class loader.
hostScreen - The host screen.
startRow - The row to begin recognition.
startCol - The column to being recognition.
endRow - The row to end recognition.
endCol - The column to end recognition.
componentSettings - The set of component settings.
widgetSettings - The set of widget settings.
isBidi - Boolean value indicating Bidi state.
contextAttributes - The context attributes.
Returns:
The preview.

getPreview

public static String getPreview(String componentClassName,
                                String widgetClassName,
                                ClassLoader classLoader,
                                HostScreen hostScreen,
                                int startRow,
                                int startCol,
                                int endRow,
                                int endCol,
                                Properties componentSettings,
                                Properties widgetSettings,
                                boolean isBidi,
                                Hashtable contextAttributes,
                                TextReplacementList trl)
Deprecated. 

Performs component recognition and widget rendering using the specified parameters.

Parameters:
componentClassName - The fully qualified component class name.
widgetClassName - The fully qualified widget class name.
classLoader - The class loader.
hostScreen - The host screen.
startRow - The row to begin recognition.
startCol - The column to being recognition.
endRow - The row to end recognition.
endCol - The column to end recognition.
componentSettings - The set of component settings.
widgetSettings - The set of widget settings.
isBidi - Boolean value indicating Bidi state.
contextAttributes - The context attributes.
trl - The text replacement list.
Returns:
The preview.

getPreview

public static String getPreview(String componentClassName,
                                String widgetClassName,
                                ClassLoader classLoader,
                                HostScreen hostScreen,
                                ScreenRegion region,
                                Properties componentSettings,
                                Properties widgetSettings,
                                boolean isBidi,
                                Hashtable contextAttributes)
Deprecated. 

Performs component recognition and widget rendering using the specified parameters.

Parameters:
componentClassName - The fully qualified component class name.
widgetClassName - The fully qualified widget class name.
classLoader - The class loader.
hostScreen - The host screen.
region - The region to recognize.
componentSettings - The set of component settings.
widgetSettings - The set of widget settings.
isBidi - Boolean value indicating Bidi state.
contextAttributes - The context attributes.
Returns:
The preview.

getPreview

public static String getPreview(String componentClassName,
                                String widgetClassName,
                                ClassLoader classLoader,
                                HostScreen hostScreen,
                                ScreenRegion region,
                                Properties componentSettings,
                                Properties widgetSettings,
                                boolean isBidi,
                                Hashtable contextAttributes,
                                TextReplacementList trl)
Deprecated. 

Performs component recognition and widget rendering using the specified parameters.

Parameters:
componentClassName - The fully qualified component class name.
widgetClassName - The fully qualified widget class name.
classLoader - The class loader.
hostScreen - The host screen.
region - The region to recognize.
componentSettings - The set of component settings.
widgetSettings - The set of widget settings.
isBidi - Boolean value indicating Bidi state.
contextAttributes - The context attributes.
trl - The text replacement list.
Returns:
The preview.

HATS 7.5.1 (201005110649)