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 EnptuiScrollbarComponent

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

public class EnptuiScrollbarComponent
extends Component
implements IContextDependent

The EnptuiScrollbar component is responsible for recognizing, obviously, ENPTUI Scroll bars.

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
           
 
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
EnptuiScrollbarComponent(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)
           
static String getInputFieldAttributeDetails(ECLInputFieldAttribute fld, int numcols)
           
protected  void handleScrollbar(ECLInputFieldAttribute fld)
           
 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 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, getCustomProperties, getDefaultValues, getHostScreen, getPropertyPageCount, 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
Constructor Detail

EnptuiScrollbarComponent

public EnptuiScrollbarComponent(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,
                                                   int numcols)

addToElementList

protected void addToElementList(ComponentElement element)

handleScrollbar

protected void handleScrollbar(ECLInputFieldAttribute fld)

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)