|
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.transform.BaseTransformationFunctions
com.ibm.hats.transform.TransformationFunctions
public class TransformationFunctions
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 |
|---|
protected static final String Copyright
| Constructor Detail |
|---|
public TransformationFunctions()
| Method Detail |
|---|
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)
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.
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)
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.
public static String getPreview(String componentClassName,
String widgetClassName,
ClassLoader classLoader,
HostScreen hostScreen,
ScreenRegion region,
Properties componentSettings,
Properties widgetSettings,
boolean isBidi,
ContextAttributes contextAttributes)
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.
public static String getPreview(String componentClassName,
String widgetClassName,
ClassLoader classLoader,
HostScreen hostScreen,
ScreenRegion region,
Properties componentSettings,
Properties widgetSettings,
boolean isBidi,
ContextAttributes contextAttributes,
TextReplacementList trl)
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.
public static String getDefaultRenderingPreview(RenderingSet renderingSet,
HostScreen hostScreen,
BlockScreenRegion region,
boolean applyGlobalRules,
Hashtable classSettings,
ClassLoader classLoader)
public static String getDefaultRenderingPreview(RenderingSet renderingSet,
HostScreen hostScreen,
BlockScreenRegion region,
boolean applyGlobalRules,
Hashtable classSettings,
ClassLoader classLoader,
Properties BIDISettings)
public static String getDefaultRenderingPreview(RenderingSet renderingSet,
HostScreen hostScreen,
BlockScreenRegion region,
boolean applyGlobalRules,
Hashtable classSettings,
ContextAttributes contextAttributes)
public static String getDefaultRenderingPreview(RenderingSet renderingSet,
HostScreen hostScreen,
BlockScreenRegion region,
boolean applyGlobalRules,
Hashtable classSettings,
ContextAttributes contextAttributes,
Properties BIDISettings)
public static String getDefaultRenderingTagsOutput(RenderingSet renderingSet,
HostScreen hostScreen,
BlockScreenRegion region,
boolean applyGlobalRules,
Hashtable classSettings,
ClassLoader classLoader,
boolean createFLMTable)
public static String getDefaultRenderingTagsOutput(RenderingSet renderingSet,
HostScreen hostScreen,
BlockScreenRegion region,
boolean applyGlobalRules,
Hashtable classSettings,
ClassLoader classLoader,
boolean createFLMTable,
Properties BIDIWidgetSettings)
public static String getDefaultRenderingTagsOutput(RenderingSet renderingSet,
HostScreen hostScreen,
BlockScreenRegion region,
boolean applyGlobalRules,
Hashtable classSettings,
ClassLoader classLoader,
boolean createFLMTable,
Properties BIDIWidgetSettings,
boolean includeEmptyProtectedFields)
public static String generateDefaultRenderingTag(BlockScreenRegion region,
String renderingSetName,
boolean applyGlobalRules,
boolean applyTextReplacement,
Properties settings)
region - The region.renderingSetName - The name of the rendering set.applyGlobalRules - A boolean specifying the value of the applyGlobalRules tag attributeapplyTextReplacement - A boolean specifying the value of the applyTextReplacement tag attributesettings - Any extra settings.
public static String generateComponentTag(RenderingItem item)
public static String generateComponentTag(RenderingItem item,
boolean outputTagInDefaultRendering)
item - The rendering item.outputTagInDefaultRendering - The output tag in the default rendering.
public static boolean isCustomComponent(String componentClassName,
ClassLoader classLoader)
componentClassName - The fully qualified component class name.classLoader - The class loader.
public static boolean isCustomWidget(String widgetClassName,
ClassLoader classLoader)
widgetClassName - The fully qualified widget class name.classLoader - The class loader.
public static com.ibm.hats.transform.PathInfo getPathInfo(ContextAttributes contextAttributes)
public static String[] getMultipleValues(String value)
value specified (using the "|" pipe character as the delimiter).
value - The concatenated String.
value specified
(using the "|" pipe character as the delimiter).public static String buildMuliValueString(String[] values)
public static boolean isScriptingDisabled(ContextAttributes contextAttributes)
contextAttributes - The context attributes.
public static boolean isInStudio(ContextAttributes contextAttributes)
contextAttributes - The context attributes.
public static boolean isInDefaultRendering(ContextAttributes contextAttributes)
contextAttributes - The context attributes.
public static boolean isInWidgetPreview(ContextAttributes contextAttributes)
contextAttributes - The context attributes.
public static boolean isInComponentPreview(ContextAttributes contextAttributes)
contextAttributes - The context attributes.
public static boolean isInWizard(ContextAttributes contextAttributes)
contextAttributes - The context attributes.
public static boolean isOutputTagInDefaultRendering(ContextAttributes contextAttributes)
public static boolean isFreeLayoutMode(ContextAttributes contextAttributes)
public static boolean isCreateFLMTable(ContextAttributes contextAttributes)
public static boolean isGenerateComponentTag(ComponentElement componentElement)
componentElement - The component element.
public static boolean isScriptingDisabled(Hashtable contextAttributes)
contextAttributes - The context attributes.
public static boolean isInStudio(Hashtable contextAttributes)
contextAttributes - The context attributes.
public static boolean isInDefaultRendering(Hashtable contextAttributes)
contextAttributes - The context attributes.
public static boolean isInWidgetPreview(Hashtable contextAttributes)
contextAttributes - The context attributes.
public static boolean isInComponentPreview(Hashtable contextAttributes)
contextAttributes - The context attributes.
public static boolean isInWizard(Hashtable contextAttributes)
contextAttributes - The context attributes.
public static boolean isOutputTagInDefaultRendering(Hashtable contextAttributes)
public static boolean isFreeLayoutMode(Hashtable contextAttributes)
public static boolean isCreateFLMTable(Hashtable contextAttributes)
public static ComponentElement[] doComponentRecognition(String componentClassName,
ClassLoader classLoader,
HsrScreen hs,
ScreenRegion region,
Properties settings,
Hashtable contextAttributes)
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.
public static String drawWidget(String widgetClassName,
ClassLoader classLoader,
ComponentElement[] cea,
Properties settings,
Hashtable contextAttributes)
widgetClassName - The fully qualified widget class name.classLoader - The class loader.cea - The component element array.settings - The properties.contextAttributes - The context attributes.
public static com.ibm.hats.transform.PathInfo getPathInfo(Hashtable contextAttributes)
public static String getDefaultRenderingPreview(RenderingSet renderingSet,
HostScreen hostScreen,
BlockScreenRegion region,
boolean applyGlobalRules,
Hashtable classSettings,
Hashtable contextAttributes,
Properties BIDISettings)
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)
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.
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)
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.
public static String getPreview(String componentClassName,
String widgetClassName,
ClassLoader classLoader,
HostScreen hostScreen,
ScreenRegion region,
Properties componentSettings,
Properties widgetSettings,
boolean isBidi,
Hashtable contextAttributes)
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.
public static String getPreview(String componentClassName,
String widgetClassName,
ClassLoader classLoader,
HostScreen hostScreen,
ScreenRegion region,
Properties componentSettings,
Properties widgetSettings,
boolean isBidi,
Hashtable contextAttributes,
TextReplacementList trl)
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.
|
HATS 7.5.1 (201005110649) | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||