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 EnptuiWindowComponent

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

public class EnptuiWindowComponent
extends DialogComponent

The EnptuiWindow component is responsible for recognizing, obviously, ENPTUI Windows.

There are no customizable settings for this component.

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


Field Summary
static String CLASS_NAME
           
static Properties defaults
           
 
Fields inherited from class com.ibm.hats.transform.components.DialogComponent
BOTTOM_BORDER, BOTTOMLEFTCORNER_BORDER, BOTTOMRIGHTCORNER_BORDER, CLASS, LEFT_BORDER, PROPERTY_ALLOW_EXTERNAL_INTERACTION, PROPERTY_CURSOR_AT_ORIGIN, PROPERTY_CURSORLOGIC, PROPERTY_HORIZONTAL_CHARS, PROPERTY_MATCH_SIDES, PROPERTY_MINIMUM_COLS, PROPERTY_MINIMUM_ROWS, PROPERTY_MINIMUM_TOP_HEADER_CHARS, PROPERTY_SEARCHMORE, PROPERTY_TAKE_FIRST_MATCH, PROPERTY_VALIDATE_CURSOR, PROPERTY_VERTICAL_CHARS, RIGHT_BORDER, TOP_BORDER, TOPLEFTCORNER_BORDER, TOPRIGHTCORNER_BORDER, VALUE_HALF_LENGTH
 
Fields inherited from class com.ibm.hats.transform.components.Component
contextAttributes, flag, hostScreen
 
Fields inherited from interface com.ibm.hats.common.ICustomPropertySupplier
CLASSNAME
 
Constructor Summary
EnptuiWindowComponent(HsrScreen hostScreen)
          Constructs a new FieldComponent object.
 
Method Summary
 void addBorderToElementsList(BlockScreenRegion consume, BlockScreenRegion region, int type, Properties settings, boolean isDefaultRendering)
           
 void addBorderToElementsList(BlockScreenRegion consume, BlockScreenRegion region, int type, Properties settings, boolean isDefaultRendering, String windowTitle)
           
protected  void addToElementList(ComponentElement element)
           
 int convertPosToCol(int pos)
           
 int convertPosToRow(int pos)
           
 int fieldLookup(int spot)
          Returns which field is at the given location.
protected  BlockScreenRegion getBlockRegion(com.ibm.hats.common.HostScreenEnptuiWindow hsew)
           
 Properties getDefaultValues(int iPageNumber)
          Returns this object's default property values.
 int getPropertyPageCount()
          Returns the number of property pages associated with this object.
 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.
 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 useENPTUIWindows(com.ibm.hats.common.HostScreenEnptuiWindow[] hsewArray, BlockScreenRegion region, Properties settings)
           
protected  BlockScreenRegion validateWindowArea(BlockScreenRegion[] windowArray, int i, BlockScreenRegion region)
           
 
Methods inherited from class com.ibm.hats.transform.components.DialogComponent
getCustomProperties
 
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

defaults

public static Properties defaults
Constructor Detail

EnptuiWindowComponent

public EnptuiWindowComponent(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.

Overrides:
recognize in class DialogComponent
Parameters:
region - rectangular region to search in
settings - recognition settings (not applicable)
Returns:
array of FieldRowComponentElement objects.
See Also:
Component.recognize(BlockScreenRegion, Properties), DialogRowComponentElement, DisabledAreaComponentElement, FieldComponent, FieldRowComponentElement

recognize

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

Overrides:
recognize in class DialogComponent
See Also:
Component.recognize(LinearScreenRegion, Properties)

useENPTUIWindows

protected void useENPTUIWindows(com.ibm.hats.common.HostScreenEnptuiWindow[] hsewArray,
                                BlockScreenRegion region,
                                Properties settings)

getBlockRegion

protected BlockScreenRegion getBlockRegion(com.ibm.hats.common.HostScreenEnptuiWindow hsew)

validateWindowArea

protected BlockScreenRegion validateWindowArea(BlockScreenRegion[] windowArray,
                                               int i,
                                               BlockScreenRegion region)

addBorderToElementsList

public void addBorderToElementsList(BlockScreenRegion consume,
                                    BlockScreenRegion region,
                                    int type,
                                    Properties settings,
                                    boolean isDefaultRendering)

addBorderToElementsList

public void addBorderToElementsList(BlockScreenRegion consume,
                                    BlockScreenRegion region,
                                    int type,
                                    Properties settings,
                                    boolean isDefaultRendering,
                                    String windowTitle)

addToElementList

protected void addToElementList(ComponentElement element)

fieldLookup

public int fieldLookup(int spot)
Returns which field is at the given location.

Parameters:
spot - The position to look for the field at.
Returns:
Returns field by field order (0 for first field) or -1 of no field is at that location.

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
Overrides:
isPropertyAllowed in class DialogComponent
Parameters:
name - property name
Returns:
whether or not this property is allowed in the specified context

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
Overrides:
isAllowed in class DialogComponent
Returns:
whether or not this Component or Widget is allowed in the specified context

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 DialogComponent
Returns:
the number of defined property pages used to configure this object, or 0 if there are none

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 DialogComponent
Parameters:
iPageNumber - page for which to retrieve default properties
Returns:
object's default properties

HATS 7.5.1 (201005110649)