|
HATS 7.5.1 Web API ReferencePublicly accessible methods not documented here are for IBM internal use only and may change in a future release of the product. |
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.ibm.hats.transform.components.Component
com.ibm.hats.transform.components.DialogComponent
com.ibm.hats.transform.components.EnptuiWindowComponent
public class EnptuiWindowComponent
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.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 |
|---|
public static final String CLASS_NAME
public static Properties defaults
| Constructor Detail |
|---|
public EnptuiWindowComponent(HsrScreen hostScreen)
FieldComponent object.
hostScreen - | Method Detail |
|---|
public int convertPosToCol(int pos)
public int convertPosToRow(int pos)
public ComponentElement[] recognize(BlockScreenRegion region,
Properties settings)
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.
recognize in class DialogComponentregion - rectangular region to search insettings - recognition settings (not applicable)
FieldRowComponentElement objects.Component.recognize(BlockScreenRegion, Properties),
DialogRowComponentElement,
DisabledAreaComponentElement,
FieldComponent,
FieldRowComponentElement
public ComponentElement[] recognize(com.ibm.hats.transform.regions.LinearScreenRegion region,
Properties settings)
recognize in class DialogComponentComponent.recognize(LinearScreenRegion, Properties)
protected void useENPTUIWindows(com.ibm.hats.common.HostScreenEnptuiWindow[] hsewArray,
BlockScreenRegion region,
Properties settings)
protected BlockScreenRegion getBlockRegion(com.ibm.hats.common.HostScreenEnptuiWindow hsew)
protected BlockScreenRegion validateWindowArea(BlockScreenRegion[] windowArray,
int i,
BlockScreenRegion region)
public void addBorderToElementsList(BlockScreenRegion consume,
BlockScreenRegion region,
int type,
Properties settings,
boolean isDefaultRendering)
public void addBorderToElementsList(BlockScreenRegion consume,
BlockScreenRegion region,
int type,
Properties settings,
boolean isDefaultRendering,
String windowTitle)
protected void addToElementList(ComponentElement element)
public int fieldLookup(int spot)
spot - The position to look for the field at.
public boolean isPropertyAllowed(String name,
ContextAttributes contextAttributes)
IContextDependent
isPropertyAllowed in interface IContextDependentisPropertyAllowed in class DialogComponentname - property name
public boolean isAllowed(ContextAttributes contextAttributes)
IContextDependent
isAllowed in interface IContextDependentisAllowed in class DialogComponentpublic int getPropertyPageCount()
ICustomPropertySupplierNote: Currently only 0 or 1 pages are supported.
getPropertyPageCount in interface ICustomPropertySuppliergetPropertyPageCount in class DialogComponentpublic Properties getDefaultValues(int iPageNumber)
ICustomPropertySupplier
getDefaultValues in interface ICustomPropertySuppliergetDefaultValues in class DialogComponentiPageNumber - page for which to retrieve default properties
|
HATS 7.5.1 (201005110649) | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||