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 EnptuiSelectionFieldComponent

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

public class EnptuiSelectionFieldComponent
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 CLASS_NAME
           
static Properties defaults
           
static int ENPTUI_SELECTION_TYPE_MENUBAR
           
static int ENPTUI_SELECTION_TYPE_MULTICHOICEFIELD
           
static int ENPTUI_SELECTION_TYPE_MULTICHOICEINPULLDOWN
           
static int ENPTUI_SELECTION_TYPE_MULTICHOICELIST
           
static int ENPTUI_SELECTION_TYPE_PUSHBUTTON
           
static int ENPTUI_SELECTION_TYPE_PUSHBUTTONINPULLDOWN
           
static int ENPTUI_SELECTION_TYPE_SINGLECHOICEFIELD
           
static int ENPTUI_SELECTION_TYPE_SINGLECHOICEINPULLDOWN
           
static int ENPTUI_SELECTION_TYPE_SINGLECHOICELIST
           
static String MATCH_AUTOENTER_EITHER
           
static String MATCH_AUTOENTER_FALSE
           
static String MATCH_AUTOENTER_TRUE
           
static String PROPERTY_MATCH_AUTOENTER
           
static String PROPERTY_MATCH_MENUBAR
           
static String PROPERTY_MATCH_MLTCHCFLD
           
static String PROPERTY_MATCH_PSHBUTTON
           
static String PROPERTY_MATCH_SNGCHCFLD
           
 
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
EnptuiSelectionFieldComponent(HsrScreen hostScreen)
          Constructs a new FieldComponent object.
 
Method Summary
protected  void addToElementList(ComponentElement element)
           
 int convertPosToCol(int pos)
           
 int convertPosToRow(int pos)
           
protected  void debugInputVector(Vector v)
           
 int fieldLookup(int spot)
          returns which field is at the given location.
 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.
static String getInputFieldAttributeDetails(ECLInputFieldAttribute fld)
           
 int getPropertyPageCount()
          Returns the number of property pages associated with this object.
protected  String getSelectionFieldTypeString(int seltype)
           
protected  void handleChoiceSelection(ECLInputFieldAttribute fld, BlockScreenRegion region, boolean isMultiSelect)
           
 boolean isAllowed(ContextAttributes contextAttributes)
          Gets whether or not this object should be visible in the studio given some context attributes.
static boolean isMultiSelectFieldType(ECLInputFieldAttribute fld)
           
static boolean isMultiSelectFieldType(int selectionFieldType)
           
 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 useENPTUIFields(Vector v, 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

ENPTUI_SELECTION_TYPE_MENUBAR

public static final int ENPTUI_SELECTION_TYPE_MENUBAR
See Also:
Constant Field Values

ENPTUI_SELECTION_TYPE_SINGLECHOICEFIELD

public static final int ENPTUI_SELECTION_TYPE_SINGLECHOICEFIELD
See Also:
Constant Field Values

ENPTUI_SELECTION_TYPE_MULTICHOICEFIELD

public static final int ENPTUI_SELECTION_TYPE_MULTICHOICEFIELD
See Also:
Constant Field Values

ENPTUI_SELECTION_TYPE_SINGLECHOICELIST

public static final int ENPTUI_SELECTION_TYPE_SINGLECHOICELIST
See Also:
Constant Field Values

ENPTUI_SELECTION_TYPE_MULTICHOICELIST

public static final int ENPTUI_SELECTION_TYPE_MULTICHOICELIST
See Also:
Constant Field Values

ENPTUI_SELECTION_TYPE_SINGLECHOICEINPULLDOWN

public static final int ENPTUI_SELECTION_TYPE_SINGLECHOICEINPULLDOWN
See Also:
Constant Field Values

ENPTUI_SELECTION_TYPE_MULTICHOICEINPULLDOWN

public static final int ENPTUI_SELECTION_TYPE_MULTICHOICEINPULLDOWN
See Also:
Constant Field Values

ENPTUI_SELECTION_TYPE_PUSHBUTTON

public static final int ENPTUI_SELECTION_TYPE_PUSHBUTTON
See Also:
Constant Field Values

ENPTUI_SELECTION_TYPE_PUSHBUTTONINPULLDOWN

public static final int ENPTUI_SELECTION_TYPE_PUSHBUTTONINPULLDOWN
See Also:
Constant Field Values

PROPERTY_MATCH_SNGCHCFLD

public static final String PROPERTY_MATCH_SNGCHCFLD
See Also:
Constant Field Values

PROPERTY_MATCH_MLTCHCFLD

public static final String PROPERTY_MATCH_MLTCHCFLD
See Also:
Constant Field Values

PROPERTY_MATCH_PSHBUTTON

public static final String PROPERTY_MATCH_PSHBUTTON
See Also:
Constant Field Values

PROPERTY_MATCH_MENUBAR

public static final String PROPERTY_MATCH_MENUBAR
See Also:
Constant Field Values

PROPERTY_MATCH_AUTOENTER

public static final String PROPERTY_MATCH_AUTOENTER
See Also:
Constant Field Values

MATCH_AUTOENTER_TRUE

public static final String MATCH_AUTOENTER_TRUE
See Also:
Constant Field Values

MATCH_AUTOENTER_FALSE

public static final String MATCH_AUTOENTER_FALSE
See Also:
Constant Field Values

MATCH_AUTOENTER_EITHER

public static final String MATCH_AUTOENTER_EITHER
See Also:
Constant Field Values

defaults

public static Properties defaults
Constructor Detail

EnptuiSelectionFieldComponent

public EnptuiSelectionFieldComponent(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

debugInputVector

protected void debugInputVector(Vector v)

useENPTUIFields

protected void useENPTUIFields(Vector v,
                               BlockScreenRegion region)

getInputFieldAttributeDetails

public static String getInputFieldAttributeDetails(ECLInputFieldAttribute fld)

isMultiSelectFieldType

public static boolean isMultiSelectFieldType(ECLInputFieldAttribute fld)

isMultiSelectFieldType

public static boolean isMultiSelectFieldType(int selectionFieldType)

getSelectionFieldTypeString

protected String getSelectionFieldTypeString(int seltype)

addToElementList

protected void addToElementList(ComponentElement element)

handleChoiceSelection

protected void handleChoiceSelection(ECLInputFieldAttribute fld,
                                     BlockScreenRegion region,
                                     boolean isMultiSelect)

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

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)