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 SelectorPenComponent

java.lang.Object
  extended by com.ibm.hats.transform.components.Component
      extended by com.ibm.hats.transform.components.SelectorPenComponent
All Implemented Interfaces:
IContextDependent, ICustomPropertySupplier
Direct Known Subclasses:
SelectorPenAttentionComponent, SelectorPenSelectionComponent

public abstract class SelectorPenComponent
extends Component
implements IContextDependent


Field Summary
static String PROPERTY_CONSUME_FIELD_REMAINDER
          Property to determine whether this component will consume the remainder of the field when it matches on a pen selectable field.
 
Fields inherited from class com.ibm.hats.transform.components.Component
CLASS_NAME, 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
SelectorPenComponent(HsrScreen hostScreen)
           
 
Method Summary
protected  FieldComponentElement[] findSelectorFields(BlockScreenRegion region)
          Convenience method to find all pen selectable field segments in the specified region.
 Vector getCustomProperties(int iPageNumber, Properties properties, ResourceBundle bundle)
          Returns a list of this object's custom properties.
 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.
protected  boolean isSelectorField(FieldComponentElement fce)
           
 
Methods inherited from class com.ibm.hats.transform.components.Component
convertPosToCol, convertPosToRow, convertRowColToPos, findFirstDelimiterIndex, findFirstIndexOf, findFirstIndexOf, findFirstIndexOf, findFirstNonWhitespaceIndex, findFirstNonWhitespaceIndex, findFirstNonWhitespaceIndex, getContextAttribute, getContextAttributes, getCustomComposite, getDefaultValues, getHostScreen, getTrailingSpaceCount, newInstance, recognize, recognize, recognize, setContextAttribute, setContextAttributes, setHostScreen
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PROPERTY_CONSUME_FIELD_REMAINDER

public static final String PROPERTY_CONSUME_FIELD_REMAINDER
Property to determine whether this component will consume the remainder of the field when it matches on a pen selectable field. *

See Also:
Constant Field Values
Constructor Detail

SelectorPenComponent

public SelectorPenComponent(HsrScreen hostScreen)
Parameters:
hostScreen -
Method Detail

findSelectorFields

protected FieldComponentElement[] findSelectorFields(BlockScreenRegion region)
Convenience method to find all pen selectable field segments in the specified region.

Parameters:
region - The region where any part of a pen selectable field must exist.
Returns:
All of the pen selectable field segments in a FieldComponentElement array.

isSelectorField

protected boolean isSelectorField(FieldComponentElement fce)

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

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

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)