|
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
public class DialogComponent
The Dialog component is responsible for recognizing pop-ups (also known as modals or dialogs) in a specified region of a host screen.
A recognized dialog can be rendered by the following widgets:
recognize() methods of this component return ComponentElement objects of type:
| Property | Description | Type | Default Value |
|---|---|---|---|
| horizontalBorder | The attributed string which contains the choice characters of the top and bottom of the dialog | String | {p rv}|.|-|_ |
| verticalBorder | The attributed string which contains the choice characters of the sides of the dialog | String | {p rv}|:|&vl. |
| validateCursor | Whether the cursor has to be inside of the dialog | Boolean | true |
| interact | Whether or not the area outside of the border should be disabled | Boolean | true |
| matchSides | Whether or not the sides of the dialog should match | Boolean | true |
| takeFirstMatch | whether or not to keep looking once we find a match, only valid when validateCursor is false | Boolean | true |
| interact | Whether or not the area outside of the border should be disabled | Boolean | true |
| acceptOutsideCursorAt | If the cursor is in a position where there is no dialog, the cursor default location if there is a dialog. Useful for pages where the cursor defaults to an area because there is no input field | NumberedSet | 1 |
| minCols | the minimum amount of columns to consider an area to be a Dialog | Integer | 3 |
| minRows | the minimum amount of rows to consider an area to be a Dialog | Integer | 3 |
DialogRowComponentElement,
DisabledAreaComponentElement,
FieldRowComponentElement,
BasicDialogWidget| Field Summary | |
|---|---|
static int |
BOTTOM_BORDER
|
static int |
BOTTOMLEFTCORNER_BORDER
|
static int |
BOTTOMRIGHTCORNER_BORDER
|
static String |
CLASS
|
static String |
CLASS_NAME
|
static Properties |
defaults
|
static int |
LEFT_BORDER
|
static String |
PROPERTY_ALLOW_EXTERNAL_INTERACTION
|
static String |
PROPERTY_CURSOR_AT_ORIGIN
|
static String |
PROPERTY_CURSORLOGIC
|
static String |
PROPERTY_HORIZONTAL_CHARS
|
static String |
PROPERTY_MATCH_SIDES
|
static String |
PROPERTY_MINIMUM_COLS
|
static String |
PROPERTY_MINIMUM_ROWS
|
static String |
PROPERTY_MINIMUM_TOP_HEADER_CHARS
|
static String |
PROPERTY_SEARCHMORE
|
static String |
PROPERTY_TAKE_FIRST_MATCH
|
static String |
PROPERTY_VALIDATE_CURSOR
|
static String |
PROPERTY_VERTICAL_CHARS
|
static int |
RIGHT_BORDER
|
static int |
TOP_BORDER
|
static int |
TOPLEFTCORNER_BORDER
|
static int |
TOPRIGHTCORNER_BORDER
|
static String |
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 | |
|---|---|
DialogComponent(HsrScreen hostScreen)
Constructs a new DialogComponent object. |
|
| Method Summary | |
|---|---|
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. |
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 ComponentElement objects representing the screen of the area found
as the border and outside of the dialog. |
ComponentElement[] |
recognize(com.ibm.hats.transform.regions.LinearScreenRegion region,
Properties settings)
Not currently implemented. |
| 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 final String CLASS
public static final String PROPERTY_HORIZONTAL_CHARS
public static final String PROPERTY_VERTICAL_CHARS
public static final String PROPERTY_ALLOW_EXTERNAL_INTERACTION
public static final String PROPERTY_VALIDATE_CURSOR
public static final int LEFT_BORDER
public static final int TOP_BORDER
public static final int RIGHT_BORDER
public static final int BOTTOM_BORDER
public static final int TOPLEFTCORNER_BORDER
public static final int TOPRIGHTCORNER_BORDER
public static final int BOTTOMLEFTCORNER_BORDER
public static final int BOTTOMRIGHTCORNER_BORDER
public static Properties defaults
public static final String PROPERTY_MATCH_SIDES
public static final String PROPERTY_TAKE_FIRST_MATCH
public static final String PROPERTY_CURSOR_AT_ORIGIN
public static final String PROPERTY_MINIMUM_COLS
public static final String PROPERTY_MINIMUM_ROWS
public static final String PROPERTY_MINIMUM_TOP_HEADER_CHARS
public static final String PROPERTY_CURSORLOGIC
public static final String PROPERTY_SEARCHMORE
public static final String VALUE_HALF_LENGTH
| Constructor Detail |
|---|
public DialogComponent(HsrScreen hostScreen)
DialogComponent object.
| Method Detail |
|---|
public boolean isPropertyAllowed(String name,
ContextAttributes contextAttributes)
IContextDependent
isPropertyAllowed in interface IContextDependentname - property name
public boolean isAllowed(ContextAttributes contextAttributes)
IContextDependent
isAllowed in interface IContextDependent
public ComponentElement[] recognize(com.ibm.hats.transform.regions.LinearScreenRegion region,
Properties settings)
recognize in class ComponentComponent.recognize(LinearScreenRegion, Properties)
public ComponentElement[] recognize(BlockScreenRegion region,
Properties settings)
ComponentElement objects representing the screen of the area found
as the border and outside of the dialog. The internal window will be recognized if the dialog is used
as standalone by the FieldComponent, otherwise the area will be left for use by other
Components.
recognize in class Componentregion - BlockScreenRegion to search insettings - recognition settings
Component.recognize(BlockScreenRegion, Properties),
DialogRowComponentElement,
DisabledAreaComponentElement,
FieldComponent,
FieldRowComponentElementpublic int getPropertyPageCount()
ICustomPropertySupplierNote: Currently only 0 or 1 pages are supported.
getPropertyPageCount in interface ICustomPropertySuppliergetPropertyPageCount in class Component
public Vector getCustomProperties(int iPageNumber,
Properties properties,
ResourceBundle bundle)
ICustomPropertySuppliercom.ibm.hats.common.HCustomProperty.
getCustomProperties in interface ICustomPropertySuppliergetCustomProperties in class ComponentiPageNumber - page number containing desired propertiesproperties - existing values for properties defined herebundle - ResourceBundle containing NLS descriptions for the properties
HCustomPropertypublic Properties getDefaultValues(int iPageNumber)
ICustomPropertySupplier
getDefaultValues in interface ICustomPropertySuppliergetDefaultValues in class ComponentiPageNumber - 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 | ||||||||