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 RenderingItem

java.lang.Object
  extended by com.ibm.hats.transform.RenderingItem
All Implemented Interfaces:
Cloneable

public class RenderingItem
extends Object
implements Cloneable


Field Summary
static String ATTR_ALTERNATE
           
static String ATTR_ALTERNATE_RENDERING_SET
           
static String ATTR_APPLY_TEXT_REPLACEMENT
           
static String ATTR_ASSOCIATED_SCREEN
           
static String ATTR_CASE_SENSITIVE
           
static String ATTR_COMPONENT_CLASS
           
static String ATTR_DESCRIPTION
           
static String ATTR_DYNAMIC_REGION
           
static String ATTR_ENABLED
           
static String ATTR_END_COL
           
static String ATTR_END_ROW
           
static String ATTR_FROM
           
static String ATTR_IDENTIFIER
           
static String ATTR_KEEP_OUTPUT_TOGETHER
           
static String ATTR_KEEP_SCREEN_REGION_SIZE
           
static String ATTR_MATCH_LTR
           
static String ATTR_MATCH_REVERSE
           
static String ATTR_MATCH_RTL
           
static String ATTR_NAME
           
static String ATTR_REGULAR_EXPRESSION
           
static String ATTR_START_COL
           
static String ATTR_START_ROW
           
static String ATTR_TO
           
static String ATTR_TO_IMAGE
           
static String ATTR_VALUE
           
static String ATTR_WIDGET_CLASS
           
static String BIDI_OPP_COMP
           
 ComponentElement[] cearray
           
 Component component
           
 String componentClassName
           
 String componentIdentifier
           
 Properties componentSettings
           
 ScreenRegion consumedRegion
           
 ContextAttributes contextAttributes
           
 String dynamicRegionName
           
 ScreenRegion searchRegion
           
static String TAG_COMPONENT_SETTINGS
           
static String TAG_RENDERING_ITEM
           
static String TAG_REPLACE
           
static String TAG_SETTING
           
static String TAG_TEXT_REPLACEMENT_LIST
           
static String TAG_WIDGET_SETTINGS
           
 TextReplacementList textReplacementList
           
 Widget widget
           
 StringBuffer widgetbuffer
           
 String widgetClassName
           
 Properties widgetSettings
           
 
Constructor Summary
RenderingItem(Element item)
          Constructor for RenderingItem
RenderingItem(String componentClassName, String widgetClassName, int startRow, int startCol, int endRow, int endCol, int maxCols, boolean linear, Properties componentSettings, Properties widgetSettings, TextReplacementList textReplacementList)
           
RenderingItem(String componentClassName, String widgetClassName, int startRow, int startCol, int endRow, int endCol, int maxCols, boolean linear, Properties componentSettings, Properties widgetSettings, TextReplacementList textReplacementList, HsrScreen hs)
           
RenderingItem(String componentClassName, String widgetClassName, int startRow, int startCol, int endRow, int endCol, Properties componentSettings, Properties widgetSettings, TextReplacementList textReplacementList)
           
RenderingItem(String componentClassName, String widgetClassName, int startRow, int startCol, int endRow, int endCol, Properties componentSettings, Properties widgetSettings, TextReplacementList textReplacementList, HsrScreen hs)
           
RenderingItem(String componentClassName, String widgetClassName, ScreenRegion region, Properties componentSettings, Properties widgetSettings, TextReplacementList textReplacementList)
          Constructor for RenderingItem.
RenderingItem(String componentClassName, String widgetClassName, ScreenRegion region, Properties componentSettings, Properties widgetSettings, TextReplacementList textReplacementList, HsrScreen hs)
           
RenderingItem(String componentClassName, String widgetClassName, String dynamicRegionName, Properties componentSettings, Properties widgetSettings, TextReplacementList textReplacementList)
           
 
Method Summary
 Object clone()
           
 void createClasses(HsrScreen hs)
           
 void createComponent(HsrScreen hs)
           
 void createWidget(HsrScreen hs)
           
 boolean equals(Object obj)
           
 String getAlternate()
           
 String getAlternateRenderingSet()
           
 String getAssociatedScreen()
          Returns the associated screen for studio editor.
 String getBIDIOpposite()
           
 String getComponentClassName()
          Returns the componentClassName.
 String getComponentIdentifier()
           
 Properties getComponentSettings()
          Returns the componentSettings.
 ScreenRegion getConsumedRegion()
           
 ContextAttributes getContextAttributes()
           
 String getDescription()
           
 String getDynamicRegionName()
          Returns the dynamicRegion name
 String getName()
           
 Properties getPreCombinedComponentSettings()
           
 Properties getPreCombinedWidgetSettings()
           
 ScreenRegion getRegion()
          Returns the region.
 TextReplacementList getTextReplacementList()
          Returns the textReplacementList.
 String getWidgetClassName()
          Returns the widgetClassName.
 Properties getWidgetSettings()
          Returns the widgetSettings.
 void init(HsrScreen hs, ContextAttributes contextAttrib, Hashtable classSettings)
           
 void init(HsrScreen hs, ContextAttributes contextAttrib, Hashtable classSettings, Properties BIDIWidgetSettings)
           
 void init(HsrScreen hs, Hashtable contextAttrib, Hashtable classSettings)
          Deprecated.  
 void init(HsrScreen hs, Hashtable contextAttrib, Hashtable classSettings, Properties BIDIWidgetSettings)
          Deprecated.  
 boolean isApplyTextReplacement()
          Returns is textReplacements are enabled
 boolean isEnabled()
          Returns the enabled.
 boolean isFromCombScreen()
           
 ComponentElement[] runComponent()
           
 ComponentElement[] runComponent(ScreenRegion tempRegion)
           
 StringBuffer runWidget(ComponentElement[] ce_array)
           
 StringBuffer runWidget(ComponentElement[] ce_array, StringBuffer sb)
           
 void setAlternate(String string)
           
 void setAlternateRenderingSet(String string)
           
 void setApplyTextReplacement(boolean applyFlag)
           
 void setAssociatedScreen(String associatedScreen)
           
 void setBIDIOpposite(String newBIDIOpposite)
           
 void setComponentClassName(String componentClassName)
          Sets the componentClassName.
 void setComponentIdentifier(String string)
           
 void setComponentSettings(Properties componentSettings)
          Sets the componentSettings.
 void setConsumedRegion(ScreenRegion region)
           
 void setContextAttributes(ContextAttributes contextAttrib)
           
 void setContextAttributes(Hashtable contextAttrib)
          Deprecated.  
 void setDescription(String string)
           
 void setDynamicRegionName(String name)
          Sets the dynamicRegion name
 void setEnabled(boolean enabled)
          Sets the enabled.
 void setFromCombScreen(boolean fromCombScreen)
           
 void setName(String string)
           
 void setPreCombinedComponentSettings(Properties settings)
           
 void setPreCombinedWidgetSettings(Properties settings)
           
 void setRegion(ScreenRegion region)
          Sets the region.
 void setTextReplacementList(TextReplacementList textReplacementList)
          Sets the textReplacementList.
 void setUseComponentElementArrayTogether(boolean useComponentElementArrayTogether)
           
 void setUseSearchRegionForConsumedRegion(boolean useSearchRegionForConsumedRegion)
           
 void setWidgetClassName(String widgetClassName)
          Sets the widgetClassName.
 void setWidgetSettings(Properties widgetSettings)
          Sets the widgetSettings.
 Element toElement(Document doc)
           
 Element toElement(Document doc, boolean enptuiSupported)
           
 Element toElement(Document doc, boolean enptuiSupported, boolean subfileSupported)
           
 Element toElement(Document doc, boolean enptuiSupported, boolean subfileSupported, boolean lightPenSupported)
           
 String toString()
           
 boolean useComponentElementArrayTogether()
           
 boolean useSearchRegionForConsumedRegion()
           
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

TAG_RENDERING_ITEM

public static final String TAG_RENDERING_ITEM
See Also:
Constant Field Values

TAG_COMPONENT_SETTINGS

public static final String TAG_COMPONENT_SETTINGS
See Also:
Constant Field Values

TAG_WIDGET_SETTINGS

public static final String TAG_WIDGET_SETTINGS
See Also:
Constant Field Values

TAG_SETTING

public static final String TAG_SETTING
See Also:
Constant Field Values

TAG_TEXT_REPLACEMENT_LIST

public static final String TAG_TEXT_REPLACEMENT_LIST
See Also:
Constant Field Values

TAG_REPLACE

public static final String TAG_REPLACE
See Also:
Constant Field Values

ATTR_FROM

public static final String ATTR_FROM
See Also:
Constant Field Values

ATTR_TO

public static final String ATTR_TO
See Also:
Constant Field Values

ATTR_TO_IMAGE

public static final String ATTR_TO_IMAGE
See Also:
Constant Field Values

ATTR_CASE_SENSITIVE

public static final String ATTR_CASE_SENSITIVE
See Also:
Constant Field Values

ATTR_REGULAR_EXPRESSION

public static final String ATTR_REGULAR_EXPRESSION
See Also:
Constant Field Values

ATTR_MATCH_LTR

public static final String ATTR_MATCH_LTR
See Also:
Constant Field Values

ATTR_MATCH_RTL

public static final String ATTR_MATCH_RTL
See Also:
Constant Field Values

ATTR_MATCH_REVERSE

public static final String ATTR_MATCH_REVERSE
See Also:
Constant Field Values

ATTR_DESCRIPTION

public static final String ATTR_DESCRIPTION
See Also:
Constant Field Values

ATTR_ENABLED

public static final String ATTR_ENABLED
See Also:
Constant Field Values

ATTR_COMPONENT_CLASS

public static final String ATTR_COMPONENT_CLASS
See Also:
Constant Field Values

ATTR_WIDGET_CLASS

public static final String ATTR_WIDGET_CLASS
See Also:
Constant Field Values

ATTR_START_ROW

public static final String ATTR_START_ROW
See Also:
Constant Field Values

ATTR_START_COL

public static final String ATTR_START_COL
See Also:
Constant Field Values

ATTR_END_ROW

public static final String ATTR_END_ROW
See Also:
Constant Field Values

ATTR_END_COL

public static final String ATTR_END_COL
See Also:
Constant Field Values

ATTR_DYNAMIC_REGION

public static final String ATTR_DYNAMIC_REGION
See Also:
Constant Field Values

ATTR_ASSOCIATED_SCREEN

public static final String ATTR_ASSOCIATED_SCREEN
See Also:
Constant Field Values

ATTR_ALTERNATE

public static final String ATTR_ALTERNATE
See Also:
Constant Field Values

ATTR_ALTERNATE_RENDERING_SET

public static final String ATTR_ALTERNATE_RENDERING_SET
See Also:
Constant Field Values

BIDI_OPP_COMP

public static final String BIDI_OPP_COMP
See Also:
Constant Field Values

ATTR_NAME

public static final String ATTR_NAME
See Also:
Constant Field Values

ATTR_VALUE

public static final String ATTR_VALUE
See Also:
Constant Field Values

ATTR_APPLY_TEXT_REPLACEMENT

public static final String ATTR_APPLY_TEXT_REPLACEMENT
See Also:
Constant Field Values

ATTR_KEEP_OUTPUT_TOGETHER

public static final String ATTR_KEEP_OUTPUT_TOGETHER
See Also:
Constant Field Values

ATTR_KEEP_SCREEN_REGION_SIZE

public static final String ATTR_KEEP_SCREEN_REGION_SIZE
See Also:
Constant Field Values

ATTR_IDENTIFIER

public static final String ATTR_IDENTIFIER
See Also:
Constant Field Values

componentIdentifier

public String componentIdentifier

componentClassName

public String componentClassName

widgetClassName

public String widgetClassName

componentSettings

public Properties componentSettings

widgetSettings

public Properties widgetSettings

textReplacementList

public TextReplacementList textReplacementList

component

public Component component

widget

public Widget widget

cearray

public ComponentElement[] cearray

widgetbuffer

public StringBuffer widgetbuffer

searchRegion

public ScreenRegion searchRegion

consumedRegion

public ScreenRegion consumedRegion

dynamicRegionName

public String dynamicRegionName

contextAttributes

public ContextAttributes contextAttributes
Constructor Detail

RenderingItem

public RenderingItem(String componentClassName,
                     String widgetClassName,
                     ScreenRegion region,
                     Properties componentSettings,
                     Properties widgetSettings,
                     TextReplacementList textReplacementList)
Constructor for RenderingItem.


RenderingItem

public RenderingItem(String componentClassName,
                     String widgetClassName,
                     int startRow,
                     int startCol,
                     int endRow,
                     int endCol,
                     Properties componentSettings,
                     Properties widgetSettings,
                     TextReplacementList textReplacementList)

RenderingItem

public RenderingItem(String componentClassName,
                     String widgetClassName,
                     int startRow,
                     int startCol,
                     int endRow,
                     int endCol,
                     int maxCols,
                     boolean linear,
                     Properties componentSettings,
                     Properties widgetSettings,
                     TextReplacementList textReplacementList)

RenderingItem

public RenderingItem(String componentClassName,
                     String widgetClassName,
                     int startRow,
                     int startCol,
                     int endRow,
                     int endCol,
                     int maxCols,
                     boolean linear,
                     Properties componentSettings,
                     Properties widgetSettings,
                     TextReplacementList textReplacementList,
                     HsrScreen hs)

RenderingItem

public RenderingItem(String componentClassName,
                     String widgetClassName,
                     int startRow,
                     int startCol,
                     int endRow,
                     int endCol,
                     Properties componentSettings,
                     Properties widgetSettings,
                     TextReplacementList textReplacementList,
                     HsrScreen hs)

RenderingItem

public RenderingItem(String componentClassName,
                     String widgetClassName,
                     ScreenRegion region,
                     Properties componentSettings,
                     Properties widgetSettings,
                     TextReplacementList textReplacementList,
                     HsrScreen hs)

RenderingItem

public RenderingItem(String componentClassName,
                     String widgetClassName,
                     String dynamicRegionName,
                     Properties componentSettings,
                     Properties widgetSettings,
                     TextReplacementList textReplacementList)

RenderingItem

public RenderingItem(Element item)
Constructor for RenderingItem

Parameters:
item - XML Element defining properties for item.
Method Detail

setBIDIOpposite

public void setBIDIOpposite(String newBIDIOpposite)
Parameters:
newBIDIOpposite - set the BIDIOpposite to newBIDIOpposite

getBIDIOpposite

public String getBIDIOpposite()
Returns:
the BIDIOpposite

getComponentClassName

public String getComponentClassName()
Returns the componentClassName.

Returns:
String

getComponentSettings

public Properties getComponentSettings()
Returns the componentSettings.

Returns:
Hashtable

isEnabled

public boolean isEnabled()
Returns the enabled.

Returns:
boolean

isApplyTextReplacement

public boolean isApplyTextReplacement()
Returns is textReplacements are enabled

Returns:
boolean

setApplyTextReplacement

public void setApplyTextReplacement(boolean applyFlag)

getRegion

public ScreenRegion getRegion()
Returns the region.

Returns:
BlockScreenRegion

getDynamicRegionName

public String getDynamicRegionName()
Returns the dynamicRegion name

Returns:
String

getWidgetClassName

public String getWidgetClassName()
Returns the widgetClassName.

Returns:
String

getWidgetSettings

public Properties getWidgetSettings()
Returns the widgetSettings.

Returns:
Hashtable

setComponentClassName

public void setComponentClassName(String componentClassName)
Sets the componentClassName.

Parameters:
componentClassName - The componentClassName to set

setComponentSettings

public void setComponentSettings(Properties componentSettings)
Sets the componentSettings.

Parameters:
componentSettings - The componentSettings to set

setEnabled

public void setEnabled(boolean enabled)
Sets the enabled.

Parameters:
enabled - The enabled to set

setRegion

public void setRegion(ScreenRegion region)
Sets the region.

Parameters:
region - The region to set

setDynamicRegionName

public void setDynamicRegionName(String name)
Sets the dynamicRegion name

Parameters:
name - The desired dynamicRegion request key

setWidgetClassName

public void setWidgetClassName(String widgetClassName)
Sets the widgetClassName.

Parameters:
widgetClassName - The widgetClassName to set

setWidgetSettings

public void setWidgetSettings(Properties widgetSettings)
Sets the widgetSettings.

Parameters:
widgetSettings - The widgetSettings to set

getTextReplacementList

public TextReplacementList getTextReplacementList()
Returns the textReplacementList.

Returns:
TextReplacementList

setTextReplacementList

public void setTextReplacementList(TextReplacementList textReplacementList)
Sets the textReplacementList.

Parameters:
textReplacementList - The textReplacementList to set

getContextAttributes

public ContextAttributes getContextAttributes()

setContextAttributes

public void setContextAttributes(ContextAttributes contextAttrib)

setContextAttributes

public void setContextAttributes(Hashtable contextAttrib)
Deprecated. 


getAssociatedScreen

public String getAssociatedScreen()
Returns the associated screen for studio editor.

Returns:
String

setAssociatedScreen

public void setAssociatedScreen(String associatedScreen)

toString

public String toString()
Overrides:
toString in class Object

toElement

public Element toElement(Document doc)

toElement

public Element toElement(Document doc,
                         boolean enptuiSupported)

toElement

public Element toElement(Document doc,
                         boolean enptuiSupported,
                         boolean subfileSupported)

toElement

public Element toElement(Document doc,
                         boolean enptuiSupported,
                         boolean subfileSupported,
                         boolean lightPenSupported)

init

public void init(HsrScreen hs,
                 Hashtable contextAttrib,
                 Hashtable classSettings)
Deprecated. 


init

public void init(HsrScreen hs,
                 Hashtable contextAttrib,
                 Hashtable classSettings,
                 Properties BIDIWidgetSettings)
Deprecated. 


init

public void init(HsrScreen hs,
                 ContextAttributes contextAttrib,
                 Hashtable classSettings)

init

public void init(HsrScreen hs,
                 ContextAttributes contextAttrib,
                 Hashtable classSettings,
                 Properties BIDIWidgetSettings)

createClasses

public void createClasses(HsrScreen hs)

createComponent

public void createComponent(HsrScreen hs)

createWidget

public void createWidget(HsrScreen hs)

runComponent

public ComponentElement[] runComponent()

runComponent

public ComponentElement[] runComponent(ScreenRegion tempRegion)

runWidget

public StringBuffer runWidget(ComponentElement[] ce_array,
                              StringBuffer sb)

runWidget

public StringBuffer runWidget(ComponentElement[] ce_array)

getName

public String getName()

setName

public void setName(String string)

getComponentIdentifier

public String getComponentIdentifier()

setComponentIdentifier

public void setComponentIdentifier(String string)

getDescription

public String getDescription()
Returns:
The description.

setDescription

public void setDescription(String string)
Parameters:
string -

setConsumedRegion

public void setConsumedRegion(ScreenRegion region)

getConsumedRegion

public ScreenRegion getConsumedRegion()

clone

public Object clone()
Overrides:
clone in class Object

setPreCombinedComponentSettings

public void setPreCombinedComponentSettings(Properties settings)

setPreCombinedWidgetSettings

public void setPreCombinedWidgetSettings(Properties settings)

getPreCombinedComponentSettings

public Properties getPreCombinedComponentSettings()

getPreCombinedWidgetSettings

public Properties getPreCombinedWidgetSettings()

getAlternate

public String getAlternate()

getAlternateRenderingSet

public String getAlternateRenderingSet()
Returns:
The alternate rendering set.

setAlternate

public void setAlternate(String string)
Parameters:
string -

setAlternateRenderingSet

public void setAlternateRenderingSet(String string)
Parameters:
string -

isFromCombScreen

public boolean isFromCombScreen()
Returns:
Returns the fromCombScreen.

setFromCombScreen

public void setFromCombScreen(boolean fromCombScreen)
Parameters:
fromCombScreen - The fromCombScreen to set.

setUseSearchRegionForConsumedRegion

public void setUseSearchRegionForConsumedRegion(boolean useSearchRegionForConsumedRegion)

useSearchRegionForConsumedRegion

public boolean useSearchRegionForConsumedRegion()

setUseComponentElementArrayTogether

public void setUseComponentElementArrayTogether(boolean useComponentElementArrayTogether)

useComponentElementArrayTogether

public boolean useComponentElementArrayTogether()

equals

public boolean equals(Object obj)
Overrides:
equals in class Object

HATS 7.5.1 (201005110649)