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.components
Class HtmlDDSComponent

java.lang.Object
  extended by com.ibm.hats.transform.components.Component
      extended by com.ibm.hats.transform.components.HtmlDDSComponent
All Implemented Interfaces:
IContextDependent, ICustomPropertySupplier

public class HtmlDDSComponent
extends Component
implements IContextDependent

The EnptuiSelectionField component is responsible for recognizing, obviously, ENPTUI Selection Fields.

There are no customizable settings for this component.

The recognize() methods of this component return an array of ComponentElement objects all of type:

which contains elements of type:


Field Summary
static String BLACKLIST_VALUE
           
static String CLASS_NAME
           
static String DEFAULT_BLOCKTAGS
           
static String DEFAULT_FILTERTYPE
           
static String DEFAULT_IGNORETAGS
           
static String DEFAULT_KEEPTAGS
           
static String DEFAULT_USETAGS
           
static Properties defaults
           
static String PROPERTY_BLOCKTAGS
           
static String PROPERTY_FILTERTYPE
           
static String PROPERTY_IGNORETAGS
           
static String PROPERTY_KEEPTAGS
           
static String PROPERTY_USETAGS
           
static String WHITELIST_VALUE
           
 
Fields inherited from class com.ibm.hats.transform.components.Component
contextAttributes, flag, hostScreen
 
Fields inherited from interface com.ibm.hats.common.IContextDependent
COPYRIGHT
 
Fields inherited from interface com.ibm.hats.common.ICustomPropertySupplier
CLASSNAME
 
Constructor Summary
HtmlDDSComponent(HsrScreen hostScreen)
          Constructs a new FieldComponent object.
 
Method Summary
protected  void addToElementList(ComponentElement element)
           
 int convertPosToCol(int pos)
           
 int convertPosToRow(int pos)
           
 Vector getCustomProperties(int iPageNumber, Properties properties, ResourceBundle bundle)
          Returns a list of this object's custom properties.
 Properties getDefaultValues(int iPageNumber)
          Returns this object's default property values.
 int getPropertyPageCount()
          Returns the number of property pages associated with this object.
protected  void handleHTMLData(Integer htmlLocation, String htmlData, BlockScreenRegion region)
           
 boolean isAllowed(ContextAttributes contextAttributes)
          Gets whether or not this object should be visible in the studio given some context attributes.
 boolean isPropertyAllowed(String name, ContextAttributes contextAttributes)
          Gets whether or not the specified property should be visible in the component or widget settings.
protected  String parseTags(String htmlData)
           
 ComponentElement[] recognize(BlockScreenRegion region, Properties settings)
          Returns an array of FieldRowComponentElement objects, each representing an entire screen row of fields and field segments.
 ComponentElement[] recognize(com.ibm.hats.transform.regions.LinearScreenRegion region, Properties settings)
          Not currently implemented.
protected  void useHTMLDDSFields(Hashtable htmldds, BlockScreenRegion region)
           
 
Methods inherited from class com.ibm.hats.transform.components.Component
convertPosToCol, convertPosToRow, convertRowColToPos, findFirstDelimiterIndex, findFirstIndexOf, findFirstIndexOf, findFirstIndexOf, findFirstNonWhitespaceIndex, findFirstNonWhitespaceIndex, findFirstNonWhitespaceIndex, getContextAttribute, getContextAttributes, getCustomComposite, getHostScreen, getTrailingSpaceCount, newInstance, recognize, setContextAttribute, setContextAttributes, setHostScreen
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CLASS_NAME

public static final String CLASS_NAME
See Also:
Constant Field Values

PROPERTY_FILTERTYPE

public static final String PROPERTY_FILTERTYPE
See Also:
Constant Field Values

PROPERTY_IGNORETAGS

public static final String PROPERTY_IGNORETAGS
See Also:
Constant Field Values

PROPERTY_BLOCKTAGS

public static final String PROPERTY_BLOCKTAGS
See Also:
Constant Field Values

PROPERTY_USETAGS

public static final String PROPERTY_USETAGS
See Also:
Constant Field Values

PROPERTY_KEEPTAGS

public static final String PROPERTY_KEEPTAGS
See Also:
Constant Field Values

BLACKLIST_VALUE

public static final String BLACKLIST_VALUE
See Also:
Constant Field Values

WHITELIST_VALUE

public static final String WHITELIST_VALUE
See Also:
Constant Field Values

DEFAULT_FILTERTYPE

public static final String DEFAULT_FILTERTYPE
See Also:
Constant Field Values

DEFAULT_IGNORETAGS

public static final String DEFAULT_IGNORETAGS
See Also:
Constant Field Values

DEFAULT_BLOCKTAGS

public static final String DEFAULT_BLOCKTAGS
See Also:
Constant Field Values

DEFAULT_USETAGS

public static final String DEFAULT_USETAGS
See Also:
Constant Field Values

DEFAULT_KEEPTAGS

public static final String DEFAULT_KEEPTAGS
See Also:
Constant Field Values

defaults

public static Properties defaults
Constructor Detail

HtmlDDSComponent

public HtmlDDSComponent(HsrScreen hostScreen)
Constructs a new FieldComponent object.

Parameters:
hostScreen -
Method Detail

convertPosToCol

public int convertPosToCol(int pos)

convertPosToRow

public int convertPosToRow(int pos)

recognize

public ComponentElement[] recognize(BlockScreenRegion region,
                                    Properties settings)
Returns an array of FieldRowComponentElement objects, each representing an entire screen row of fields and field segments.

The length of the returned array is equal to the number of rows in the specified region. Each FieldRowComponentElement is a set of FieldComponentElement objects.

Gaps between actual host screen fields are indicated as a protected, hidden FieldComponentElement objects.

Specified by:
recognize in class Component
Parameters:
region - rectangular region to search in
settings - recognition settings (not applicable)
Returns:
array of FieldRowComponentElement objects.

recognize

public ComponentElement[] recognize(com.ibm.hats.transform.regions.LinearScreenRegion region,
                                    Properties settings)
Not currently implemented.

Specified by:
recognize in class Component

useHTMLDDSFields

protected void useHTMLDDSFields(Hashtable htmldds,
                                BlockScreenRegion region)

addToElementList

protected void addToElementList(ComponentElement element)

handleHTMLData

protected void handleHTMLData(Integer htmlLocation,
                              String htmlData,
                              BlockScreenRegion region)

parseTags

protected String parseTags(String htmlData)

getPropertyPageCount

public int getPropertyPageCount()
Description copied from interface: ICustomPropertySupplier
Returns the number of property pages associated with this object.

Note: Currently only 0 or 1 pages are supported.

Specified by:
getPropertyPageCount in interface ICustomPropertySupplier
Overrides:
getPropertyPageCount in class Component
Returns:
the number of defined property pages used to configure this object, or 0 if there are none

getCustomProperties

public Vector getCustomProperties(int iPageNumber,
                                  Properties properties,
                                  ResourceBundle bundle)
Description copied from interface: ICustomPropertySupplier
Returns a list of this object's custom properties. Items must be of type com.ibm.hats.common.HCustomProperty.

Specified by:
getCustomProperties in interface ICustomPropertySupplier
Overrides:
getCustomProperties in class Component
Parameters:
iPageNumber - page number containing desired properties
properties - existing values for properties defined here
bundle - ResourceBundle containing NLS descriptions for the properties
Returns:
Vector containing all the custom properties for this object, or null if there are none
See Also:
HCustomProperty

getDefaultValues

public Properties getDefaultValues(int iPageNumber)
Description copied from interface: ICustomPropertySupplier
Returns this object's default property values.

Specified by:
getDefaultValues in interface ICustomPropertySupplier
Overrides:
getDefaultValues in class Component
Parameters:
iPageNumber - page for which to retrieve default properties
Returns:
object's default properties

isAllowed

public boolean isAllowed(ContextAttributes contextAttributes)
Description copied from interface: IContextDependent
Gets whether or not this object should be visible in the studio given some context attributes. The context attributes may contain the Component name when this is called on a Widget, or whether or not we are presenting this Component/Widget choice while configuring Default Rendering.

Specified by:
isAllowed in interface IContextDependent
Returns:
whether or not this Component or Widget is allowed in the specified context

isPropertyAllowed

public boolean isPropertyAllowed(String name,
                                 ContextAttributes contextAttributes)
Description copied from interface: IContextDependent
Gets whether or not the specified property should be visible in the component or widget settings. The context attributes may contain the Component name when this is called on a Widget, or whether or not we are presenting this Component/Widget choice while configuring Default Rendering.

Specified by:
isPropertyAllowed in interface IContextDependent
Parameters:
name - property name
Returns:
whether or not this property is allowed in the specified context

HATS 7.5.1 (201005110649)