com.remedy.arsys.api
Class PropInfo

java.lang.Object
  |
  +--com.remedy.arsys.api.PropInfo

All Implemented Interfaces:

java.lang.Cloneable

public class PropInfo

extends java.lang.Object

implements java.lang.Cloneable

The PropInfo class uses a tag-value pair (AR_DROP_/AR_DVAL_) to describe the properties of server objects in the AR System.

Field Summary

static int	AR_DPROP_ALIAS_ABBREV_PLURAL A very short, plural form of the name for the logical items represented by entries in the form this view is associated with
static int	AR_DPROP_ALIAS_ABBREV_SINGULAR A very short, singular form of the name for the logical items represented by entries in the form this view is associated with
static int	AR_DPROP_ALIAS_PLURAL The plural form of the name for the logical items represented by entries in this form this view is associated with
static int	AR_DPROP_ALIAS_SHORT_PLURAL A short, plural form of the name for the logical items represented by entries in the form this view is associated with
static int	AR_DPROP_ALIAS_SHORT_SINGULAR A short, singular form of the name for the logical items represented by entries in the form this view is associated with
static int	AR_DPROP_ALIAS_SINGULAR The singular form of the name for the logical items represented by entries in the form this view is associated with
static int	AR_DPROP_ALIGN A value indicating the vertical alignment of text within its bounding box.
static int	AR_DPROP_APPLY_DIRTY Apply to dirty bit
static int	AR_DPROP_AR_OBJECT_NAME (char) character string.
static int	AR_DPROP_ATTACH_ADD_LABEL (character string) Label for the Add button for an attachment's web view.
static int	AR_DPROP_ATTACH_DELETE_LABEL (character string) Label for the Delete button for an attachment's web view.
static int	AR_DPROP_ATTACH_DISPLAY_LABEL (character string) Label for the Display button for an attachment's web view.
static int	AR_DPROP_ATTACH_FILENAME_TITLE (character string) Title of an attachment pool's file name column.
static int	AR_DPROP_ATTACH_FILESIZE_TITLE (character string) Title of an attachment pool's file size column.
static int	AR_DPROP_ATTACH_LABEL_TITLE (character string) Title of an attachment pool's label column.
static int	AR_DPROP_ATTACH_SAVE_LABEL (character string) Label for the Save button for an attachment's web view.
static int	AR_DPROP_AUTO_REFRESH A value indicating whether automatic refresh is enabled.
static int	AR_DPROP_AUTOFIT_COLUMNS Allow horizontal scrollbar in table field.
static int	AR_DPROP_BACKGROUND_MODE A value indicating whether the background of a field is opaque or transparent.
static int	AR_DPROP_BBOX A set of coordinates (X,Y) that specify the screen boundaries (bounding box) for the field (applicable for all fields except page and column fields).
static int	AR_DPROP_BUTTON_2D A flag indicating whether the button appears as a two-dimensional image with no border (applicable for control fields only).
static int	AR_DPROP_BUTTON_IMAGE_POSITION A value that determines the position of the button image relative to the button label.
static int	AR_DPROP_BUTTON_MAINTAIN_RATIO A flag indicating whether a scaled button image will preserve its original width-to-height ratio (applicable for control fields only).
static int	AR_DPROP_BUTTON_SCALE_IMAGE A flag indicating whether the button image will shrink or grow to fill the space available after allocating space for the button label (applicable for control fields only).
static int	AR_DPROP_BUTTON_TEXT The button label for the field (applicable for control fields only).
static int	AR_DPROP_CNTL_TYPE A bitmask indicating the screen appearance for control fields.
static int	AR_DPROP_COLOR_FILL Fill color.
static int	AR_DPROP_COLOR_LINE Line color
static int	AR_DPROP_COLOR_TEXT Text color
static int	AR_DPROP_COLUMN_ORDER The order of a column in a table field
static int	AR_DPROP_COLUMN_WIDTH The width of a column in a table field
static int	AR_DPROP_COORDS A set of coordinates that specify the vertex location
static int	AR_DPROP_DATA_BBOX A set of coordinates (X,Y) that specify the screen boundaries (bounding box) for the field's data area (applicable for data fields only).
static int	AR_DPROP_DATA_COLS The number of text columns to display for the field (applicable for data fields only).
static int	AR_DPROP_DATA_EXPAND_BBOX A set of coordinates that specify the screen boundaries of the field's text editor button (applicable for diary and long character fields only).
static int	AR_DPROP_DATA_MENU A flag indicating whether the field has a drop-down list (applicable for selection fields only).
static int	AR_DPROP_DATA_MENU_BBOX A set of coordinates that specify the screen boundaries of the field's menu button (applicable for character fields with an attached menu only).
static int	AR_DPROP_DATA_RADIO A flag indicating whether the field uses radio option buttons (applicable for selection fields only).
static int	AR_DPROP_DATA_ROWS The number of text rows to display for the field (applicable for data fields only).
static int	AR_DPROP_DATA_SPIN A flag indicating whether the field has a numeric spinner (applicable for integer fields only).
static int	AR_DPROP_DATETIME_POPUP A value indicating the display type of a date/time field.
static int	AR_DPROP_DEFAULT_PAGE Specifies the default page.
static int	AR_DPROP_DEPTH_AMOUNT Depth
static int	AR_DPROP_DEPTH_EFFECT Value indicating the three-dimensional style for the tield.
static int	AR_DPROP_DETAIL_BANNER_VISIBILITY A value indicating whether the details banner is visible 0: Invisible 1: Visible
static int	AR_DPROP_DETAIL_PANE_COLOR The background color of the details pane.
static int	AR_DPROP_DETAIL_PANE_HEIGHT The height of the details pane
static int	AR_DPROP_DETAIL_PANE_IMAGE The background image for the details pane.
static int	AR_DPROP_DETAIL_PANE_VISIBILITY A value indicating the visibility of the detail pane of the VUI.
static int	AR_DPROP_DETAIL_PANE_WIDTH The width of the details pane.
static int	AR_DPROP_DISPLAY_AS_TEXT_ONLY (integer) Boolean value.
static int	AR_DPROP_DISPLAY_FIELD_APP (char) character string.
static int	AR_DPROP_DISPLAY_PARENT A value indicating the parent field that the field will display in.
static int	AR_DPROP_DRILL_DOWN A value indicating whether drill-down is enabled fora table field.
static int	AR_DPROP_ENABLE (unsigned long) A value identifying the enabled/disabled status of the field.
static int	AR_DPROP_ENDCAP_END Line specific display properties -- end of line.
static int	AR_DPROP_ENDCAP_START Line specific display properties -- start of line.
static int	AR_DPROP_ENUM_LABELS Display labels for selection fields
static int	AR_DPROP_HELP Use field/VUI help
static int	AR_DPROP_HIDE_PAGE_TABS_BORDERS (integer) Boolean value.
static int	AR_DPROP_HIDE_WEBHELP (integer) If Boolean value set to True, field displays help link.
static int	AR_DPROP_HTML_TEXT The text for a text-type trim field that includes a URL.
static int	AR_DPROP_HTML_TEXT_COLOR The color of the linked text for a text-type trim field that includes a URL (see AR_DPROP_HTML_TEXT.
static int	AR_DPROP_IMAGE The icon image for a toolbar-type control field.
static int	AR_DPROP_IMAGE_ALIGN A value indicating the vertical alignment of the background image for the details pane.
static int	AR_DPROP_IMAGE_CACHE Runtime cache of internal image format
static int	AR_DPROP_IMAGE_JUSTIFY A value indicating the horizontal justification of the background image for the details pane.
static int	AR_DPROP_JOINT_STYLE Joint style.
static int	AR_DPROP_JUSTIFY A value indicating the horizontal justification of text within its bounding box.
static int	AR_DPROP_LABEL Screen label for the field (applicable for data fields only).
static int	AR_DPROP_LABEL_ALIGN Label alignment.
static int	AR_DPROP_LABEL_BBOX A set of coordinates (X,Y) that specify the screen boundaries (bounding box) for the field label (applicable for data fields only).
static int	AR_DPROP_LABEL_COLOR_FILL Label fill color
static int	AR_DPROP_LABEL_COLOR_LINE Label line color
static int	AR_DPROP_LABEL_COLOR_TEXT Color of the field label.
static int	AR_DPROP_LABEL_FONT_SIZE Font size
static int	AR_DPROP_LABEL_FONT_STYLE Font style
static int	AR_DPROP_LABEL_JUSTIFY Label justify.
static int	AR_DPROP_LABEL_POS_ALIGN Value indicating the vertical alignment of the label within the sector.
static int	AR_DPROP_LABEL_POS_JUSTIFY Value indicating the horizontal alignment fo the label within the sector.
static int	AR_DPROP_LABEL_POS_SECTOR Bitmask value indicating the label position relative to the field.
static int	AR_DPROP_LINE_PATTERN Line pattern
static int	AR_DPROP_LINE_WIDTH Line width for the field
static int	AR_DPROP_MANAGE_EXPAND_BOX (integer) Control over presence of expand boxes.
static int	AR_DPROP_MENU_ACCESS A list of client interface items an administrator can control
static int	AR_DPROP_MENU_HELP The help text for a menu-type control field.
static int	AR_DPROP_MENU_MODE A value indicating the type of menu item.
static int	AR_DPROP_MENU_PARENT A value identifying the parent menu item for the field (applicable for control fields only).
static int	AR_DPROP_MENU_POS A value that determines the menu position for the field (applicable for control fields only).
static int	AR_DPROP_MENU_TEXT The menu item text for the field (applicable for control fields only).
static int	AR_DPROP_NAMED_SEARCHES A list of administrator-defined searches
static int	AR_DPROP_NONE Indicates the NULL display property of the field.
static int	AR_DPROP_PAGE_ARRANGEMENT A value that specifies how pages should be displayed if pages cannot fit in page holder.
static int	AR_DPROP_PAGE_LABEL_DISPLAY Field/value pair for position on page holder where page labels should appear.
static int	AR_DPROP_PAGE_ORDER Order of appearance of a page
static int	AR_DPROP_PANE_LAYOUT A value indicating how the panes of the VUI are arranged.
static int	AR_DPROP_PANE_VISIBILITY_OPTION Determines whether pane visibility for view is determined by admin or by user.
static int	AR_DPROP_PROMPT No prompt.
static int	AR_DPROP_PROMPT_BANNER_VISIBILITY A value indicating whether the prompt banner is visible 0: Invisible 1: Visible
static int	AR_DPROP_PROMPT_PANE_VISIBILITY A value indicating the visibility of the prompt pane of the VUI.
static int	AR_DPROP_PUSH_BUTTON_IMAGE The icon image for a button.
static int	AR_DPROP_QUERY_LIST_COLOR The name of the field whose value for a given entry controls the display color of that entry in a query results list
static int	AR_DPROP_REFRESH (integer) Table field refresh enabled.
static int	AR_DPROP_REQUEST_IDENTIFIER Request identifier
static int	AR_DPROP_RESULT_BANNER_VISIBILITY A value indicating whether the results pane is visible 0: Invisible 1: Visible
static int	AR_DPROP_RESULT_PANE_VISIBILITY A value indicating the visibility of the result pane of the VUI.
static int	AR_DPROP_SORT_DIR A value indicating the sort direction of a column in a table field.
static int	AR_DPROP_SORT_SEQ The sort order of a column in a table field
static int	AR_DPROP_TAB_COORD Tab coordinate control.
static int	AR_DPROP_TAB_MODE Tab mode control.
static int	AR_DPROP_TAB_NEXT Inter-field keyboard relationships.
static int	AR_DPROP_TAB_ORDER A value that determines the field tab order for fields in view (from lowest to highest).
static int	AR_DPROP_TAB_TEXT Tab text
static int	AR_DPROP_TABLE_AUTOREFRESH (character string) Auto-refresh string.
static int	AR_DPROP_TABLE_CHUNK_NEXT (character string) Label for next chunk.
static int	AR_DPROP_TABLE_CHUNK_PREV (character string) Label for previous chunk.
static int	AR_DPROP_TABLE_CHUNK_SIZE (integer) chunk size
static int	AR_DPROP_TABLE_COL_DISPLAY_TYPE (enum) Column states.
static int	AR_DPROP_TABLE_COL_INITVAL (char) Initial value for all cells in column
static int	AR_DPROP_TABLE_DELETE (character string) Delete button.
static int	AR_DPROP_TABLE_DESELECT_ALL (character string) Clear all rows in table.
static int	AR_DPROP_TABLE_DISPLAY_TYPE Field/value pair to display table fields in web browser.
static int	AR_DPROP_TABLE_DRILL_COL Drill down column.
static int	AR_DPROP_TABLE_ENTRIES_RETURNED (character string) Localization of strings in table header about records displayed.
static int	AR_DPROP_TABLE_NOT_REFRESHED (character string) Localization of strings in table header when not refreshed.
static int	AR_DPROP_TABLE_READ (character string) Read button for notifications.
static int	AR_DPROP_TABLE_REFRESH (character string) Refresh button.
static int	AR_DPROP_TABLE_REPORT (character string) Report button.
static int	AR_DPROP_TABLE_SELECT_ALL (character string) Select all rows in table.
static int	AR_DPROP_TABLE_SELECTIONCOLUMN_LABEL (character string) Displays the label of selection column for table or query list view field in Netscape browser 4.75.
static int	AR_DPROP_TABLE_SELINIT Field/value pair controlling initial selection in results list and table fields.
static int	AR_DPROP_TABLE_SELREFRESH Field/value pair for refreshing table fields.
static int	AR_DPROP_TABLE_SELROWS_DISABLE Field/value pair to enable or disable user from selecting rows by clicking.
static int	AR_DPROP_TABLE_UNREAD (character string) Unread button for notifications.
static int	AR_DPROP_TEXT The text for a text-type trim field.
static int	AR_DPROP_TEXT_FONT_SIZE The size of the font style to use for a text-type trim field.
static int	AR_DPROP_TEXT_FONT_STYLE The name of the font style to use for a tex-type trim field
static int	AR_DPROP_TITLE_BAR_ICON_IMAGE The icon image for the title bar.
static int	AR_DPROP_TOOLBAR_MODE A value indicating the type of toolbar item.
static int	AR_DPROP_TOOLBAR_POS A value that determines the toolbar position for the field (applicable for control fields only).
static int	AR_DPROP_TOOLBAR_TEXT Toolbar text
static int	AR_DPROP_TOOLTIP The tooltip text for a toolbar-type control field.
static int	AR_DPROP_TRIM_TYPE A value indicating the type of trim fields.
static int	AR_DPROP_VIEW_GRID_BBOX A set of X,Y coordinates (0,0), (25,25) of the grid for the bounding box.
static int	AR_DPROP_VISIBLE (integer) A flag indicating the visibility of the field.
static int	AR_DPROP_VUI_DEFAULT A flag identifying the default view (VUI) for the form.
static int	AR_DPROP_Z_ORDER (unsigned long) A value that determines the field drawing order.
static int	AR_DVAL_ENABLE_DEFAULT Sets value of data field to default (read/write).
static int	AR_DVAL_ENABLE_DISABLE Disabled (data,trim,or control) field
static int	AR_DVAL_ENABLE_READ_ONLY View and select only (data) in field; disabled (trim or control)
static int	AR_DVAL_ENABLE_READ_WRITE View, select, and change (data) in field; enabled (trim or control)
static int	AR_OPROP_APP_WEB_ALIAS (CHAR) Unique Application Alias used while deploying JSP page for the Web Server.
static int	AR_OPROP_COPYRIGHT Indicates the copyright string.
static int	AR_OPROP_FORM_NAME_WEB_ALIAS (CHAR) Unique Form Alias used while deploying JSP page for the Web Server.
static int	AR_OPROP_GUID Indicates the globally unique identifier for the object.
static int	AR_OPROP_INTERVAL_VALUE (INT) Interval value used to indicate the time interval between an active link's timed executions
static int	AR_OPROP_SCC_DATA_LOCATION Indicates the location within the SCC system where the data or entries stored in a form under revision control.
static int	AR_OPROP_SCC_DATA_LOCKED_BY Indicates the name of the user who has "locked" the data or entries stored in a form under revision control.
static int	AR_OPROP_SCC_DATA_TIMESTAMP Indicates the SCC version of the data or entries stored in a form under revision control.
static int	AR_OPROP_SCC_DATA_USER Indicates the SCC username fore the data or entries stored in a form under revision control.
static int	AR_OPROP_SCC_DATA_VERSION Indicates the SCC version of the data or entries stored in a form under revision control.
static int	AR_OPROP_SCC_LOCATION Indicates the location within the SCC system where the object may be found.
static int	AR_OPROP_SCC_LOCKED_BY Indicates the name of user who has locked the object.
static int	AR_OPROP_SCC_TIMESTAMP Indicates the SCC timestamp.
static int	AR_OPROP_SCC_USER Indicates the SCC username.
static int	AR_OPROP_SCC_VERSION Indicates the version of the SCC system.
static int	AR_OPROP_VENDOR_NAME Indicates the vendor name.
static int	AR_OPROP_VENDOR_PRODUCT Indicates the product name.
static int	AR_OPROP_VENDOR_VERSION Indicates the vendor version.
static int	AR_OPROP_VIEW_LABEL_WEB_ALIAS (CHAR) Unique View Label Alias used while deploying JSP page for the Web Server.
static int	AR_OPROP_WINDOW_OPEN_ELSE_SAMPLE_SERVER_SCHEMA (CHAR) Sample Server and Schema name for ELSE Window open action in Advanced Mode.
static int	AR_OPROP_WINDOW_OPEN_SAMPLE_SERVER_SCHEMA (CHAR) Sample Server and Schema name for IF Window open action in Advanced Mode.

Constructor Summary

PropInfo(int tag, Value val)
Constructs a new PropInfo object which consists of a tag-value pair and is used to describe the properties of server objects in the AR System.

Method Summary

java.lang.Object	clone() Makes a deep copy of the object
boolean	equals(java.lang.Object anObject) Use this method for checking equality.
int	getPropertyTag() Retrieves the tag associated with the PropInfo object
Value	getPropertyValue() Retrieves the value associated with the PropInfo object
int	hashCode() This method can be used to populate a hash table.
void	setPropertyValue(Value value)

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

AR_DPROP_NONE

public static final int AR_DPROP_NONE

Indicates the NULL display property of the field. You can specify no display properties by passing an empty property list. This property will be ignored if the list also contains other display properties.

AR_DPROP_TRIM_TYPE

public static final int AR_DPROP_TRIM_TYPE

A value indicating the type of trim fields.

• 0: Unknown trim (Constants.AR_DVAL_TRIM_NONE)
• 1: Horizontal or vertical line(Constants.AR_DVAL_TRIM_LINE)
• 2: Box (Constants.AR_DVAL_TRIM_SHAPE)
• 3: One or more rows of text (Constants.AR_DVAL_TRIM_TEXT)
• 4: Static image (Constants.AR_DVAL_TRIM_IMAGE)

AR_DPROP_CNTL_TYPE

public static final int AR_DPROP_CNTL_TYPE

A bitmask indicating the screen appearance for control fields.

• Bit 1: Button (Constants.AR_DVAL_CNTL_BUTTON)
• Bit 2: Menu item (Constants.AR_DVAL_CNTL_MENU)
• Bit 4: Toolbar button (Constants.AR_DVAL_CNTL_TOOLBAR)
• Bit 8: Tabbed dialog switch (Constants.AR_DVAL_CNTL_TAB_SWITCH)
• Bit 16: URL type button (Constants.AR_DVAL_CNTL_URL)
• Bit 32: Chart type (Constants.AR_DVAL_CNTL_CHART)
• Bit 64: Meter type (Constants.AR_DVAL_CNTL_METER)

AR_DPROP_BBOX

public static final int AR_DPROP_BBOX

A set of coordinates (X,Y) that specify the screen boundaries (bounding box) for the field (applicable for all fields except page and column fields). The first coordinate pair identifies the upper-left corner for the field. The second coordinate pair identifies the lower-right corner (see also AR_DPROP_COORDS).

AR_DPROP_VISIBLE

public static final int AR_DPROP_VISIBLE

(integer) A flag indicating the visibility of the field. Valid values for this property are 0 (hidden) and 1 (visible). The default value is 1 (visible). For control fields, this setting applies to all specified screen appearances (see AR_DPROP_CNTL_TYPE).

AR_DPROP_ENABLE

public static final int AR_DPROP_ENABLE

(unsigned long) A value identifying the enabled/disabled status of the field. For control fields, this setting applies to all specified screen appearances (see AR_DPROP_CNTL_TYPE).

• 1: View and select only (data); disabled (trim or control) (AR_DVAL_ENABLE_READ_ONLY).
• 2: View, select, and change (data); enabled (trim or control) (AR_DVAL_ENABLE_READ_WRITE) (default setting).
• 3: Disabled (data, trim, or control) (AR_DVAL_ENABLE_DISABLE).

AR_DVAL_ENABLE_DEFAULT

public static final int AR_DVAL_ENABLE_DEFAULT

Sets value of data field to default (read/write). (AR_DVAL_ENABLE_READ_WRITE)

AR_DVAL_ENABLE_READ_ONLY

public static final int AR_DVAL_ENABLE_READ_ONLY

View and select only (data) in field; disabled (trim or control)

AR_DVAL_ENABLE_READ_WRITE

public static final int AR_DVAL_ENABLE_READ_WRITE

View, select, and change (data) in field; enabled (trim or control)

AR_DVAL_ENABLE_DISABLE

public static final int AR_DVAL_ENABLE_DISABLE

Disabled (data,trim,or control) field

AR_DPROP_HELP

public static final int AR_DPROP_HELP

Use field/VUI help

AR_DPROP_Z_ORDER

public static final int AR_DPROP_Z_ORDER

(unsigned long) A value that determines the field drawing order. The value associated with each field in a view (VUI) determines the back-to-front layering of the fields on the screen (from lowest to highest). The Z-order values of all fields associated with a given view must be unique. If two or more fields have duplicate Z-order values, the system will order them at random.

AR_DPROP_COLOR_FILL

public static final int AR_DPROP_COLOR_FILL

Fill color.

• Transparent (Constants.AR_DVAL_COLOR_NONE)
• Background (Constants.AR_DVAL_COLOR_BG)
• Foreground (Constants.AR_DVAL_COLOR_FG)
• Text edit background (Constants.AR_DVAL_COLOR_EDIT_BG)
• Text edit foreground (Constants.AR_DVAL_COLOR_EDIT_FG)
• Input focus highlight (Constants.AR_DVAL_COLOR_FOCUS)
• 1st level group (Constants.AR_DVAL_COLOR_INSET1)
• 2nd level group (Constants.AR_DVAL_COLOR_INSET2)

AR_DPROP_DEPTH_EFFECT

public static final int AR_DPROP_DEPTH_EFFECT

Value indicating the three-dimensional style for the tield.

• Flat (Constants.AR_DVAL_DEPTH_EFFECT_FLAT)
• Raised (Constants.AR_DVAL_DEPTH_EFFECT_RAISED)
• Sunken (Constants.AR_DVAL_DEPTH_EFFECT_SUNKEN)
• Floating (Constants.AR_DVAL_DEPTH_EFFECT_FLOATING)
• Etched (Constants.AR_DVAL_DEPTH_EFFECT_ETCHED)

AR_DPROP_DEPTH_AMOUNT

public static final int AR_DPROP_DEPTH_AMOUNT

Depth

AR_DPROP_COLOR_LINE

public static final int AR_DPROP_COLOR_LINE

Line color

AR_DPROP_COLOR_TEXT

public static final int AR_DPROP_COLOR_TEXT

Text color

AR_DPROP_PROMPT

public static final int AR_DPROP_PROMPT

No prompt. This form of help is displayed on status line in Windows.

AR_DPROP_HIDE_WEBHELP

public static final int AR_DPROP_HIDE_WEBHELP

(integer) If Boolean value set to True, field displays help link. If set to False, no help link. Applicable for fields in web views.

AR_DPROP_LABEL

public static final int AR_DPROP_LABEL

Screen label for the field (applicable for data fields only). This label can be as many as 30 bytes in length (limited by AR_MAX_NAME_SIZE).

AR_DPROP_LABEL_BBOX

public static final int AR_DPROP_LABEL_BBOX

A set of coordinates (X,Y) that specify the screen boundaries (bounding box) for the field label (applicable for data fields only). The first coordinate pair identifies the upper-left corner for the label. The second coordinate pair identifies the lower-right corner.The coordinates specified are relative to the field's location as specified in its AR_DPROP_BBOX property, not to the window or page containing it.

AR_DPROP_LABEL_FONT_STYLE

public static final int AR_DPROP_LABEL_FONT_STYLE

Font style

AR_DPROP_LABEL_FONT_SIZE

public static final int AR_DPROP_LABEL_FONT_SIZE

Font size

AR_DPROP_LABEL_COLOR_TEXT

public static final int AR_DPROP_LABEL_COLOR_TEXT

Color of the field label. Specify the color as #BBGGRR, a string concatenating the two-digit hexadecimal values for blue, green, and red.

AR_DPROP_LABEL_JUSTIFY

public static final int AR_DPROP_LABEL_JUSTIFY

Label justify.

• 0: Default (Constants.AR_DVAL_JUSTIFY_DEFAULT)
• 1: Left justified (Constants.AR_DVAL_JUSTIFY_LEFT)
• 2: Centered (Constants.AR_DVAL_JUSTIFY_CENTER)
• 3: Fill to both sides (Constants.AR_DVAL_JUSTIFY_FILL)
• 4: Right justified (Constants.AR_DVAL_JUSTIFY_RIGHT)
• 5: Tile to fill both sides (Constants.AR_DVAL_JUSTIFY_TILE)

AR_DPROP_LABEL_ALIGN

public static final int AR_DPROP_LABEL_ALIGN

Label alignment.

• 0: Default (Constants.AR_DVAL_ALIGN_DEFAULT)
• 1: Top (Constants.AR_DVAL_ALIGN_TOP)
• 2: Middle (Constants.AR_DVAL_ALIGN_MIDDLE)
• 3: Fill (Constants.AR_DVAL_ALIGN_FILL)
• 4: Bottom (Constants.AR_DVAL_ALIGN_BOTTOM)
• 5: Tile (Constants.AR_DVAL_ALIGN_TILE)

AR_DPROP_LABEL_POS_SECTOR

public static final int AR_DPROP_LABEL_POS_SECTOR

Bitmask value indicating the label position relative to the field.

• 0: None (Constants.AR_DVAL_SECTOR_NONE)
• 1: Center (Constants.AR_DVAL_SECTOR_CENTER)
• 2: North (Constants.AR_DVAL_SECTOR_NORTH)
• 4: East (Constants.AR_DVAL_SECTOR_EAST)
• 8: South (Constants.AR_DVAL_SECTOR_SOUTH)
• 16: West (Constants.AR_DVAL_SECTOR_WEST)

AR_DPROP_LABEL_POS_JUSTIFY

public static final int AR_DPROP_LABEL_POS_JUSTIFY

Value indicating the horizontal alignment fo the label within the sector.

• 1: Left-justified (Constants.AR_DVAL_JUSTIFY_LEFT)
• 2: Center-justified (Constants.AR_DVAL_JUSTIFY_CENTER)
• 4: Right-justified (Constants.AR_DVAL_JUSTIFY_RIGHT)

AR_DPROP_LABEL_POS_ALIGN

public static final int AR_DPROP_LABEL_POS_ALIGN

Value indicating the vertical alignment of the label within the sector.

• 1: Top-aligned (Constants.AR_DVAL_ALIGN_TOP)
• 2: Middle-aligned (Constants.AR_DVAL_ALIGN_MIDDLE)
• 4: Bottom-aligned (Constants.AR_DVAL_ALIGN_BOTTOM)

AR_DPROP_LABEL_COLOR_FILL

public static final int AR_DPROP_LABEL_COLOR_FILL

Label fill color

AR_DPROP_LABEL_COLOR_LINE

public static final int AR_DPROP_LABEL_COLOR_LINE

Label line color

AR_DPROP_COORDS

public static final int AR_DPROP_COORDS

A set of coordinates that specify the vertex location

AR_DPROP_LINE_WIDTH

public static final int AR_DPROP_LINE_WIDTH

Line width for the field

AR_DPROP_LINE_PATTERN

public static final int AR_DPROP_LINE_PATTERN

Line pattern

AR_DPROP_JOINT_STYLE

public static final int AR_DPROP_JOINT_STYLE

Joint style.

• 0: Small angles with long point (Constants.AR_DVAL_JOINT_EXTENDED)
• 1: angles w/ point, trunc small angles (Constants.AR_DVAL_JOINT_SHARP)
• 2: rounded corners (Constants.AR_DVAL_JOINT_ROUNDED)
• 3: between ROUNDED and MAX_SMOOTH (Constants.AR_DVAL_JOINT_SMOOTH)
• 4: all straight lines smoothed (Constants.AR_DVAL_JOINT_MAX_SMOOTH)

AR_DPROP_ENDCAP_START

public static final int AR_DPROP_ENDCAP_START

Line specific display properties -- start of line.

AR_DPROP_ENDCAP_END

public static final int AR_DPROP_ENDCAP_END

Line specific display properties -- end of line.

• 0: Round (Constants.AR_DVAL_ENDCAP_ROUND)
• 1: Flush (Constants.AR_DVAL_ENDCAP_FLUSH)
• 2: Extended (Constants.AR_DVAL_ENDCAP_EXTENDED)
• 3: Arrow (Constants.AR_DVAL_ENDCAP_ARROW1)

AR_DPROP_DATA_ROWS

public static final int AR_DPROP_DATA_ROWS

The number of text rows to display for the field (applicable for data fields only).

AR_DPROP_DATA_COLS

public static final int AR_DPROP_DATA_COLS

The number of text columns to display for the field (applicable for data fields only). AR_DPROP_DATA_BBOX overrides this value.

AR_DPROP_DATA_SPIN

public static final int AR_DPROP_DATA_SPIN

A flag indicating whether the field has a numeric spinner (applicable for integer fields only). Valid values for this property are 1 (TRUE) and 0 (FALSE). The default value is 0 (no numeric spinner).

AR_DPROP_DATA_MENU

public static final int AR_DPROP_DATA_MENU

A flag indicating whether the field has a drop-down list (applicable for selection fields only). Valid values for this property are 1 (TRUE) and 0 (FALSE). The default value is 0 (no drop-down list).

AR_DPROP_DATA_RADIO

public static final int AR_DPROP_DATA_RADIO

A flag indicating whether the field uses radio option buttons (applicable for selection fields only). Valid values for this property are 1 (TRUE) and 0 (FALSE). The default value is 0 (does not use option buttons).

AR_DPROP_DATA_MENU_BBOX

public static final int AR_DPROP_DATA_MENU_BBOX

A set of coordinates that specify the screen boundaries of the field's menu button (applicable for character fields with an attached menu only). The first coordinate pair identifies the upper-left corner for the button. The second coordinate pair identifies the lower-right corner. The coordinates specified are relative to the field's location as specified in its AR_DPROP_BBOX property, not to the window.

AR_DPROP_DATA_EXPAND_BBOX

public static final int AR_DPROP_DATA_EXPAND_BBOX

A set of coordinates that specify the screen boundaries of the field's text editor button (applicable for diary and long character fields only). The first coordinate pair identifies the upper-left corner for the button. The second coordinate pair identifies the lower-right corner. The coordinates specified are relative to the field's location as specified in its AR_DPROP_BBOX property, not to the window.

AR_DPROP_TEXT

public static final int AR_DPROP_TEXT

The text for a text-type trim field. Text that does not fit within its bounding box causes the form window to scale up to accommodate it (see AR_DPROP_BBOX).

AR_DPROP_TEXT_FONT_STYLE

public static final int AR_DPROP_TEXT_FONT_STYLE

The name of the font style to use for a tex-type trim field

Editor: Font used for data fields.
Optional: Font used for optional data field labels.
PushButton: Font used for button labels.
System: Font used for system-generated data field labels.
RadioButton: Font used for option button choices.
Required: Font used for required data field labels.
Header1: Font used for titles.
Header2: Font used for major headings.
Header3: Font used for minor headings.
Note: Font used for notes.
Detail: Font used for detail information.

AR_DPROP_TEXT_FONT_SIZE

public static final int AR_DPROP_TEXT_FONT_SIZE

The size of the font style to use for a text-type trim field. Derived from field type/option.

AR_DPROP_HTML_TEXT

public static final int AR_DPROP_HTML_TEXT

The text for a text-type trim field that includes a URL. The string must include a standard HTML anchor tag ()that encloses the text to be linked and specifies the URL to link to. Text that does not fit within its bounding box causes the form window to scale up to accommodate it (see AR_DPROP_BBOX).

AR_DPROP_HTML_TEXT_COLOR

public static final int AR_DPROP_HTML_TEXT_COLOR

The color of the linked text for a text-type trim field that includes a URL (see AR_DPROP_HTML_TEXT. Use one of the values listed for AR_DPROP_LABEL_COLOR_TEXT or specify a custom color as 0xBBGGRR, a string concatenating the two-digit hexadecimal values for blue, green, and red. The default value is the link color specified in the user's web browser preferences.

AR_DPROP_JUSTIFY

public static final int AR_DPROP_JUSTIFY

A value indicating the horizontal justification of text within its bounding box.

• 1: Left-justified (Constants.AR_DVAL_JUSTIFY_LEFT)
• 2: Center-justified (Constants.AR_DVAL_JUSTIFY_CENTER)
• 4: Right-justified (Constants.AR_DVAL_JUSTIFY_RIGHT)

AR_DPROP_ALIGN

public static final int AR_DPROP_ALIGN

A value indicating the vertical alignment of text within its bounding box.

• 1: Top-aligned (Constants.AR_DVAL_ALIGN_TOP)
• 2: Middle-aligned (Constants.AR_DVAL_ALIGN_MIDDLE)
• 4: Bottom-aligned (Constants.AR_DVAL_ALIGN_BOTTOM)

AR_DPROP_IMAGE

public static final int AR_DPROP_IMAGE

The icon image for a toolbar-type control field. Specify a byte list type of 1 (AR_BYTE_LIST_WIN30_BITMAP) for images in Windows 3.0 bitmap (.bmp) and DIB (.dib) format. Specify 0 (AR_BYTE_LIST_SELF_DEFINED) for all other image formats.

Note: The only image formats currently supported on toolbar control fields are Windows 3.0 bitmap and DIB. The only image size currently supported is 16 pixels wide by 15 pixels high. Images of other sizes are not scaled to fit. When creating images, use simple images and the 216-color Web palette for best results.

AR_DPROP_PUSH_BUTTON_IMAGE

public static final int AR_DPROP_PUSH_BUTTON_IMAGE

The icon image for a button. Specify a byte list type of 1 (AR_BYTE_LIST_WIN30_BITMAP) for images in Windows 3.0 bitmap (.bmp) and DIB (.dib) format. Specify 2 (AR_BYTE_LIST_JPEG) for JPEG (.jpg or .jpeg) format.

Note: The only image formats currently supported on button fields are JPEG, Windows 3.0 bitmap, and DIB. There is no limit to the pixel dimensions or file size of a button image, but large images can slow down your system's performance. When creating images, use simple images and the 216-color Web palette for best results.

AR_DPROP_BUTTON_TEXT

public static final int AR_DPROP_BUTTON_TEXT

The button label for the field (applicable for control fields only). This label can be as many as 30 bytes in length (limited by AR_MAX_NAME_SIZE).

AR_DPROP_BUTTON_2D

public static final int AR_DPROP_BUTTON_2D

A flag indicating whether the button appears as a two-dimensional image with no border (applicable for control fields only). Valid values for this property are 1 (TRUE) and 0 (FALSE). The default value is 0 (three- dimensional with borders).

AR_DPROP_BUTTON_IMAGE_POSITION

public static final int AR_DPROP_BUTTON_IMAGE_POSITION

A value that determines the position of the button image relative to the button label.

• 0: Centered, no label (Constants.AR_DVAL_IMAGE_CENTER)
• 1: To the left of the label (Constants.AR_DVAL_IMAGE_LEFT)
• 2: To the right of the label (Constants.AR_DVAL_IMAGE_RIGHT)
• 3: Above the label (Constants.AR_DVAL_IMAGE_ABOVE)
• 4: Below the label (Constants.AR_DVAL_IMAGE_BELOW)

AR_DPROP_BUTTON_SCALE_IMAGE

public static final int AR_DPROP_BUTTON_SCALE_IMAGE

A flag indicating whether the button image will shrink or grow to fill the space available after allocating space for the button label (applicable for control fields only). Valid values for this property are 1 (TRUE) and 0 (FALSE). The default value is 0 (leave image at original size).

AR_DPROP_BUTTON_MAINTAIN_RATIO

public static final int AR_DPROP_BUTTON_MAINTAIN_RATIO

A flag indicating whether a scaled button image will preserve its original width-to-height ratio (applicable for control fields only). Valid values for this property are 1 (TRUE) and 0 (FALSE). The default value is 0 (do not preserve ratio). This property only affects the image when AR_DPROP_BUTTON_SCALE_IMAGE is TRUE.

AR_DPROP_MENU_TEXT

public static final int AR_DPROP_MENU_TEXT

The menu item text for the field (applicable for control fields only). This text can be as many as 30 bytes in length (limited by AR_MAX_NAME_SIZE).

AR_DPROP_MENU_POS

public static final int AR_DPROP_MENU_POS

A value that determines the menu position for the field (applicable for control fields only). For leaf-or intermediate-level menu items, the value associated with each field in a view (VUI) determines the top-to-bottom order of the items in the menu (from lowest to highest,starting with one). For top-level menu items, this value determines the left-to-right order of the items in the menu bar.

AR_DPROP_MENU_MODE

public static final int AR_DPROP_MENU_MODE

A value indicating the type of menu item.

• 0: Leaf level menu item (Constants.AR_DVAL_CNTL_ITEM)
• 1: yes|on (checked,depressed) (Constants.AR_DVAL_CNTL_ON)
• 2: Separator item (Constants.AR_DVAL_CNTL_SEPARATOR)
• 3: chosen, 1 of many (dot,depressed) (Constants.AR_DVAL_CNTL_CHOICE)
• 4: dialog will pop up (Constants.AR_DVAL_CNTL_DIALOG)
• 5: Top or intermediate level menu item (Constants.AR_DVAL_CNTL_A_MENU)

AR_DPROP_MENU_PARENT

public static final int AR_DPROP_MENU_PARENT

A value identifying the parent menu item for the field (applicable for control fields only). Specify the field ID of the parent control field for leaf-or intermediate-level menu items. Specify 0 for top-level menu items.

AR_DPROP_MENU_HELP

public static final int AR_DPROP_MENU_HELP

The help text for a menu-type control field. This text can be as many as 30 bytes in length (limited by AR_MAX_NAME_SIZE).

AR_DPROP_TOOLTIP

public static final int AR_DPROP_TOOLTIP

The tooltip text for a toolbar-type control field. This text can be as many as 30 bytes in length (limited by AR_MAX_NAME_SIZE).

AR_DPROP_TOOLBAR_POS

public static final int AR_DPROP_TOOLBAR_POS

A value that determines the toolbar position for the field (applicable for control fields only). The value associated with each field in a view (VUI) determines the left-to-right order of the icons in the toolbar (from lowest to highest, starting with one).

AR_DPROP_TOOLBAR_MODE

public static final int AR_DPROP_TOOLBAR_MODE

A value indicating the type of toolbar item.

• 0: Toolbar button (Constants.AR_DVAL_CNTL_ITEM)
• 2: Toolbar separator (Constants.AR_DVAL_CNTL_SEPARATOR)

AR_DPROP_TOOLBAR_TEXT

public static final int AR_DPROP_TOOLBAR_TEXT

Toolbar text

AR_DPROP_TAB_MODE

public static final int AR_DPROP_TAB_MODE

Tab mode control. Value is AR_DPROP_CNTL_* values, for example, AR_DPROP_CNTL_TYPE. Use with AR_DPROP_MENU_MODE.

AR_DPROP_TAB_COORD

public static final int AR_DPROP_TAB_COORD

Tab coordinate control. (0,0) setting is not specified.
x axis is horizontal (left to right, starting at 1); y axis is vertical (bottom to top, starting at 1).

AR_DPROP_TAB_TEXT

public static final int AR_DPROP_TAB_TEXT

Tab text

AR_DPROP_TAB_ORDER

public static final int AR_DPROP_TAB_ORDER

A value that determines the field tab order for fields in view (from lowest to highest).

AR_DPROP_DATETIME_POPUP

public static final int AR_DPROP_DATETIME_POPUP

A value indicating the display type of a date/time field.

• 0: Both date and time (Constants.AR_DVAL_DATETIME_BOTH)
• 1: Time only (Constants.AR_DVAL_DATETIME_TIME)
• 2: Date only (Constants.AR_DVAL_DATETIME_DATE)

AR_DPROP_BACKGROUND_MODE

public static final int AR_DPROP_BACKGROUND_MODE

A value indicating whether the background of a field is opaque or transparent.

• 0: Opaque (Constants.AR_DVAL_BKG_MODE_OPAQUE)
• 1: Transparent (Constants.AR_DVAL_BKG_MODE_TRANSPARENT)

AR_DPROP_TAB_NEXT

public static final int AR_DPROP_TAB_NEXT

Inter-field keyboard relationships.

AR_DPROP_DATA_BBOX

public static final int AR_DPROP_DATA_BBOX

A set of coordinates (X,Y) that specify the screen boundaries (bounding box) for the field's data area (applicable for data fields only). For example, this property locates the entry box for a character foeld and the buttons for a radio button selection field. The forst coordinate pair identifies the upper-left corner for the data area. The second coordinate pair identifies the lower-right corner. The coordinates specified are relative to the field's location as specified in its AR_DPROP_BBOX property, not to the window or page containing it.

AR_DPROP_VIEW_GRID_BBOX

public static final int AR_DPROP_VIEW_GRID_BBOX

A set of X,Y coordinates (0,0), (25,25) of the grid for the bounding box.

AR_DPROP_VUI_DEFAULT

public static final int AR_DPROP_VUI_DEFAULT

A flag identifying the default view (VUI) for the form. A value of 1 identifies the default VUI (with all other VUIs having a value of 0). The system uses the first VUI returned if you do not specify a default view.

AR_DPROP_PANE_LAYOUT

public static final int AR_DPROP_PANE_LAYOUT

A value indicating how the panes of the VUI are arranged. This property also specifies whether the layout is locked to prevent the user from changing it.

• -1: Results pane left of details, prompt pane on top, locked.
• -2: Details pane left of results, prompt pane on top, locked.
• -3: Results pane above details, prompt pane on top, locked.
• -4: Details pane above results, prompt pane on top, locked.
• -5: Results pane left of details, prompt pane on bottom, locked.
• -6: Details pane left of results, prompt pane on bottom, locked.
• -7: Results pane above details, prompt pane on bottom, locked.
• -8: Details pane above results, prompt pane on bottom, locked.
• 1: Results pane left of details, prompt pane on top, unlocked.
• 2: Details pane left of results, prompt pane on top, unlocked.
• 3: Results pane above details, prompt pane on top, unlocked.
• 4: Details pane above results, prompt pane on top, unlocked.
• 5: Results pane left of details, prompt pane on bottom, unlocked.
• 6: Details pane left of results, prompt pane on bottom, unlocked.
• 7: Results pane above details, prompt pane on bottom, unlocked.
• 8: Details pane above results, prompt pane on bottom, unlocked.

AR_DPROP_DETAIL_PANE_VISIBILITY

public static final int AR_DPROP_DETAIL_PANE_VISIBILITY

A value indicating the visibility of the detail pane of the VUI.

• 0: Pane hidden but can be visible (Constants.AR_DVAL_PANE_VISIBLE)
• 1: Pane visible but can be hidden (Constants.AR_DVAL_PANE_HIDDEN)
• 2: Pane always visible (Constants.AR_DVAL_PANE_ALWAYS_VISIBLE)
• 3: Pane always hidden (Constants.AR_DVAL_PANE_ALWAYS_HIDDEN)

AR_DPROP_PROMPT_PANE_VISIBILITY

public static final int AR_DPROP_PROMPT_PANE_VISIBILITY

A value indicating the visibility of the prompt pane of the VUI.

• 0: Pane hidden but can be visible (Constants.AR_DVAL_PANE_VISIBLE)
• 1: Pane visible but can be hidden (Constants.AR_DVAL_PANE_HIDDEN)
• 2: Pane always visible (Constants.AR_DVAL_PANE_ALWAYS_VISIBLE)
• 3: Pane always hidden (Constants.AR_DVAL_PANE_ALWAYS_HIDDEN)

AR_DPROP_RESULT_PANE_VISIBILITY

public static final int AR_DPROP_RESULT_PANE_VISIBILITY

A value indicating the visibility of the result pane of the VUI.

• 0: Pane hidden but can be visible (Constants.AR_DVAL_PANE_VISIBLE)
• 1: Pane visible but can be hidden (Constants.AR_DVAL_PANE_HIDDEN)
• 2: Pane always visible (Constants.AR_DVAL_PANE_ALWAYS_VISIBLE)
• 3: Pane always hidden (Constants.AR_DVAL_PANE_ALWAYS_HIDDEN)

AR_DPROP_DETAIL_PANE_COLOR

public static final int AR_DPROP_DETAIL_PANE_COLOR

The background color of the details pane. Specify the color as #BBGGRR, a string concatenating the two-digit hexadecimal values for blue, green, and red.

AR_DPROP_DETAIL_PANE_IMAGE

public static final int AR_DPROP_DETAIL_PANE_IMAGE

The background image for the details pane.

• Specify a byte list type of 1 (AR_BYTE_LIST_WIN30_BITMAP) for images in Windows 3.0 bitmap (.bmp) and DIB (.dib) format.
• Specify 2 (AR_BYTE_LIST_JPEG) for JPEG (.jpg or .jpeg) format (see AR_DPROP_PUSH_BUTTON_IMAGE).

AR_DPROP_IMAGE_ALIGN

public static final int AR_DPROP_IMAGE_ALIGN

A value indicating the vertical alignment of the background image for the details pane.

• 1: Top-aligned (Constants.AR_DVAL_ALIGN_TOP)
• 2: Centered (Constants.AR_DVAL_ALIGN_MIDDLE) (default setting)
• 3: Expand to fill (Constants.AR_DVAL_ALIGN_FILL)
• 4: Bottom-aligned (Constants.AR_DVAL_ALIGN_BOTTOM)
• 5: Tile to fill (Constants.AR_DVAL_ALIGN_TILE)

AR_DPROP_IMAGE_JUSTIFY

public static final int AR_DPROP_IMAGE_JUSTIFY

A value indicating the horizontal justification of the background image for the details pane.

• 1: Left-aligned (Constants.AR_DVAL_JUSTIFY_LEFT)
• 2: Centered (Constants.AR_DVAL_JUSTIFY_CENTER)
• 3: Expand to fill (Constants.AR_DVAL_JUSTIFY_FILL)
• 4: Right-aligned (Constants.AR_DVAL_JUSTIFY_RIGHT)
• 5: Tile to fill (Constants.AR_DVAL_JUSTIFY_TILE)

AR_DPROP_DISPLAY_PARENT

public static final int AR_DPROP_DISPLAY_PARENT

A value indicating the parent field that the field will display in. Specify the field ID of the parent. A page holder field is the parent of the page fields displayed in it, and a page field is the parent of the fields displayed in it. A value of 0 indicates that the field's parent is the form view and not another field. The default value is 0.

AR_DPROP_PAGE_ORDER

public static final int AR_DPROP_PAGE_ORDER

Order of appearance of a page

AR_DPROP_PAGE_LABEL_DISPLAY

public static final int AR_DPROP_PAGE_LABEL_DISPLAY

Field/value pair for position on page holder where page labels should appear. For example, use with Constants.AR_DVAL_PAGE_DISPLAY_TOP.

• 0: Top (Constants.AR_DVAL_PAGE_DISPLAY_TOP)
• 1: Bottom (Constants.AR_DVAL_PAGE_DISPLAY_BOTTOM)
• 2: Left (Constants.AR_DVAL_PAGE_DISPLAY_LEFT)
• 3: Right (Constants.AR_DVAL_PAGE_DISPLAY_RIGHT)
• 4: Only one page exposed without any label (Constants.AR_DVAL_PAGE_DISPLAY_NONE)

AR_DPROP_PAGE_ARRANGEMENT

public static final int AR_DPROP_PAGE_ARRANGEMENT

A value that specifies how pages should be displayed if pages cannot fit in page holder.

• 0: Scroll to view the page (Constants.AR_DVAL_PAGE_SCROLL)
• 1: View as layers of pages (Constants.AR_DVAL_PAGE_LAYER)

AR_DPROP_DEFAULT_PAGE

public static final int AR_DPROP_DEFAULT_PAGE

Specifies the default page. Otherwise first page is default

AR_DPROP_TITLE_BAR_ICON_IMAGE

public static final int AR_DPROP_TITLE_BAR_ICON_IMAGE

The icon image for the title bar.

• Specify a byte list type of 1 (AR_BYTE_LIST_WIN30_BITMAP) for images in Windows 3.0 bitmap (.bmp) and DIB (.dib) format.
• Specify 2 (AR_BYTE_LIST_JPEG) for JPEG (.jpg or .jpeg) format.

AR_DPROP_DETAIL_PANE_WIDTH

public static final int AR_DPROP_DETAIL_PANE_WIDTH

The width of the details pane. Negative values are reserved for future use.

AR_DPROP_DETAIL_PANE_HEIGHT

public static final int AR_DPROP_DETAIL_PANE_HEIGHT

The height of the details pane

AR_DPROP_DETAIL_BANNER_VISIBILITY

public static final int AR_DPROP_DETAIL_BANNER_VISIBILITY

A value indicating whether the details banner is visible 0: Invisible 1: Visible

AR_DPROP_PROMPT_BANNER_VISIBILITY

public static final int AR_DPROP_PROMPT_BANNER_VISIBILITY

A value indicating whether the prompt banner is visible 0: Invisible 1: Visible

AR_DPROP_RESULT_BANNER_VISIBILITY

public static final int AR_DPROP_RESULT_BANNER_VISIBILITY

A value indicating whether the results pane is visible 0: Invisible 1: Visible

AR_DPROP_ALIAS_SINGULAR

public static final int AR_DPROP_ALIAS_SINGULAR

The singular form of the name for the logical items represented by entries in the form this view is associated with

AR_DPROP_ALIAS_PLURAL

public static final int AR_DPROP_ALIAS_PLURAL

The plural form of the name for the logical items represented by entries in this form this view is associated with

AR_DPROP_ALIAS_SHORT_SINGULAR

public static final int AR_DPROP_ALIAS_SHORT_SINGULAR

A short, singular form of the name for the logical items represented by entries in the form this view is associated with

AR_DPROP_ALIAS_SHORT_PLURAL

public static final int AR_DPROP_ALIAS_SHORT_PLURAL

A short, plural form of the name for the logical items represented by entries in the form this view is associated with

AR_DPROP_ALIAS_ABBREV_SINGULAR

public static final int AR_DPROP_ALIAS_ABBREV_SINGULAR

A very short, singular form of the name for the logical items represented by entries in the form this view is associated with

AR_DPROP_ALIAS_ABBREV_PLURAL

public static final int AR_DPROP_ALIAS_ABBREV_PLURAL

A very short, plural form of the name for the logical items represented by entries in the form this view is associated with

AR_DPROP_NAMED_SEARCHES

public static final int AR_DPROP_NAMED_SEARCHES

A list of administrator-defined searches

AR_DPROP_MENU_ACCESS

public static final int AR_DPROP_MENU_ACCESS

A list of client interface items an administrator can control

AR_DPROP_PANE_VISIBILITY_OPTION

public static final int AR_DPROP_PANE_VISIBILITY_OPTION

Determines whether pane visibility for view is determined by admin or by user.

• 0: User defined (Constants.AR_DVAL_PANE_VISIBILITY_USER_CHOICE)
• 1: Admin defined (Constants.AR_DVAL_PANE_VISIBILITY_ADMIN)

AR_DPROP_REQUEST_IDENTIFIER

public static final int AR_DPROP_REQUEST_IDENTIFIER

Request identifier

AR_DPROP_QUERY_LIST_COLOR

public static final int AR_DPROP_QUERY_LIST_COLOR

The name of the field whose value for a given entry controls the display color of that entry in a query results list

AR_DPROP_COLUMN_WIDTH

public static final int AR_DPROP_COLUMN_WIDTH

The width of a column in a table field

AR_DPROP_COLUMN_ORDER

public static final int AR_DPROP_COLUMN_ORDER

The order of a column in a table field

AR_DPROP_SORT_SEQ

public static final int AR_DPROP_SORT_SEQ

The sort order of a column in a table field

AR_DPROP_SORT_DIR

public static final int AR_DPROP_SORT_DIR

A value indicating the sort direction of a column in a table field.

• 0: Ascending (Constants.AR_DVAL_SORT_DIR_ASCENDING)
• 1: Descending (Constants.AR_DVAL_SORT_DIR_DESCENDING)

AR_DPROP_DRILL_DOWN

public static final int AR_DPROP_DRILL_DOWN

A value indicating whether drill-down is enabled fora table field.

• 0: Disable (Constants.AR_DVAL_DRILL_DOWN_NONE)
• 1: Enable (Constants.AR_DVAL_DRILL_DOWN_ENABLE)

AR_DPROP_REFRESH

public static final int AR_DPROP_REFRESH

(integer) Table field refresh enabled.

• 0: Value that denies users the ability to refresh table data when the request in which the table is embedded appears in the Details pane. (AR_DVAL_REFRESH_NONE)
• 1: Value that allows users to refresh table data when the request in which the table is embedded appears in the Details pane, according to the maximum defined for table field. This feature can definitely impact performance. (AR_DVAL_REFRESH_TABLE_MAX)

AR_DPROP_AUTO_REFRESH

public static final int AR_DPROP_AUTO_REFRESH

A value indicating whether automatic refresh is enabled.

• 0: Disable (Constants.AR_DVAL_REFRESH_NONE)
• 1: Enable (Constants.AR_DVAL_REFRESH_TABLE_MAX)

AR_DPROP_AUTOFIT_COLUMNS

public static final int AR_DPROP_AUTOFIT_COLUMNS

Allow horizontal scrollbar in table field.

• 0: Disable (Constants.AR_DVAL_AUTOFIT_COLUMNS_NONE)
• 1: Enable (Constants.AR_DVAL_AUTOFIT_COLUMNS_SET)

AR_DPROP_APPLY_DIRTY

public static final int AR_DPROP_APPLY_DIRTY

Apply to dirty bit

AR_DPROP_IMAGE_CACHE

public static final int AR_DPROP_IMAGE_CACHE

Runtime cache of internal image format

AR_DPROP_ENUM_LABELS

public static final int AR_DPROP_ENUM_LABELS

Display labels for selection fields

AR_DPROP_MANAGE_EXPAND_BOX

public static final int AR_DPROP_MANAGE_EXPAND_BOX

(integer) Control over presence of expand boxes.

• Default value -- hidden -- for expand box used in character field (AR_DVAL_EXPAND_BOX_DEFAULT)
• Hide the expand box (AR_DVAL_EXPAND_BOX_HIDE)
• Display the expand box (AR_DVAL_EXPAND_BOX_SHOW)

AR_DPROP_ATTACH_ADD_LABEL

public static final int AR_DPROP_ATTACH_ADD_LABEL

(character string) Label for the Add button for an attachment's web view.

AR_DPROP_ATTACH_DELETE_LABEL

public static final int AR_DPROP_ATTACH_DELETE_LABEL

(character string) Label for the Delete button for an attachment's web view.

AR_DPROP_ATTACH_DISPLAY_LABEL

public static final int AR_DPROP_ATTACH_DISPLAY_LABEL

(character string) Label for the Display button for an attachment's web view.

AR_DPROP_ATTACH_SAVE_LABEL

public static final int AR_DPROP_ATTACH_SAVE_LABEL

(character string) Label for the Save button for an attachment's web view.

AR_DPROP_ATTACH_LABEL_TITLE

public static final int AR_DPROP_ATTACH_LABEL_TITLE

(character string) Title of an attachment pool's label column.

AR_DPROP_ATTACH_FILENAME_TITLE

public static final int AR_DPROP_ATTACH_FILENAME_TITLE

(character string) Title of an attachment pool's file name column.

AR_DPROP_ATTACH_FILESIZE_TITLE

public static final int AR_DPROP_ATTACH_FILESIZE_TITLE

(character string) Title of an attachment pool's file size column.

AR_DPROP_HIDE_PAGE_TABS_BORDERS

public static final int AR_DPROP_HIDE_PAGE_TABS_BORDERS

(integer) Boolean value.

• 0 = the default to show the borders and Tab.
• 1 = to hide.

AR_DPROP_DISPLAY_AS_TEXT_ONLY

public static final int AR_DPROP_DISPLAY_AS_TEXT_ONLY

(integer) Boolean value. To display the characters in any data field as text only.

AR_DPROP_AR_OBJECT_NAME

public static final int AR_DPROP_AR_OBJECT_NAME

(char) character string. AR System object name reference.

AR_DPROP_DISPLAY_FIELD_APP

public static final int AR_DPROP_DISPLAY_FIELD_APP

(char) character string. Name of the display field's application type.

AR_DPROP_TABLE_DISPLAY_TYPE

public static final int AR_DPROP_TABLE_DISPLAY_TYPE

Field/value pair to display table fields in web browser. Dictates the appearance of a table field on the web.

• 0: Sets table to look like table in web browser (AR_DVAL_TABLE_DISPLAY_TABLE)
• 1: Sets the table to look like a results list in the web browser. (AR_DVAL_TABLE_DISPLAY_RESULTS_LIST)
• 2: Sets the table to look like a notification alert in the web browser. (AR_DVAL_TABLE_DISPLAY_NOTIFICATION)

AR_DPROP_TABLE_SELINIT

public static final int AR_DPROP_TABLE_SELINIT

Field/value pair controlling initial selection in results list and table fields.

• 0: Selects and fires workflow in initial selection in results list and table fields. (AR_DVAL_TABLE_SELINIT_SELFIRE)
• 1: Selects but does not fire workflow in initial selection in results list and table fields. (AR_DVAL_TABLE_SELINIT_SELNOFIRE)
• 2: No selection in results list and table fields. (AR_DVAL_TABLE_SELINIT_NOSEL)

AR_DPROP_TABLE_SELREFRESH

public static final int AR_DPROP_TABLE_SELREFRESH

Field/value pair for refreshing table fields.

• 0: When table field is refreshed, selection is refreshed and workflow is fired. (AR_DVAL_TABLE_SELREFRESH_RETFIRE)
• 1: When table field is refreshed, selection is refreshed but workflow is not fired. (AR_DVAL_TABLE_SELREFRESH_RETNOFIRE)
• 2: When table field is refreshed, select first entry, then workflow is fired. (AR_DVAL_TABLE_SELREFRESH_FIRSTFIRE)
• 3: When table field is refreshed, select first entry but workflow is not fired. (AR_DVAL_TABLE_SELREFRESH_FIRSTNOFIRE)
• 4: When table field is refreshed, no entry is selected. (AR_DVAL_TABLE_SELREFRESH_NOSEL)

AR_DPROP_TABLE_CHUNK_SIZE

public static final int AR_DPROP_TABLE_CHUNK_SIZE

(integer) chunk size

AR_DPROP_TABLE_CHUNK_NEXT

public static final int AR_DPROP_TABLE_CHUNK_NEXT

(character string) Label for next chunk.

AR_DPROP_TABLE_CHUNK_PREV

public static final int AR_DPROP_TABLE_CHUNK_PREV

(character string) Label for previous chunk.

AR_DPROP_TABLE_NOT_REFRESHED

public static final int AR_DPROP_TABLE_NOT_REFRESHED

(character string) Localization of strings in table header when not refreshed.

AR_DPROP_TABLE_ENTRIES_RETURNED

public static final int AR_DPROP_TABLE_ENTRIES_RETURNED

(character string) Localization of strings in table header about records displayed.

AR_DPROP_TABLE_AUTOREFRESH

public static final int AR_DPROP_TABLE_AUTOREFRESH

(character string) Auto-refresh string.

AR_DPROP_TABLE_DRILL_COL

public static final int AR_DPROP_TABLE_DRILL_COL

Drill down column.

AR_DPROP_TABLE_SELROWS_DISABLE

public static final int AR_DPROP_TABLE_SELROWS_DISABLE

Field/value pair to enable or disable user from selecting rows by clicking.

• 0: User not disabled from selecting rows by clicking. (AR_DVAL_TABLE_SELROWS_DISABLE_NO)
• 1: Disable user to select rows by clicking. (AR_DVAL_TABLE_SELROWS_DISABLE_YES)

AR_DPROP_TABLE_SELECT_ALL

public static final int AR_DPROP_TABLE_SELECT_ALL

(character string) Select all rows in table.

AR_DPROP_TABLE_DESELECT_ALL

public static final int AR_DPROP_TABLE_DESELECT_ALL

(character string) Clear all rows in table.

AR_DPROP_TABLE_REFRESH

public static final int AR_DPROP_TABLE_REFRESH

(character string) Refresh button.

AR_DPROP_TABLE_REPORT

public static final int AR_DPROP_TABLE_REPORT

(character string) Report button.

AR_DPROP_TABLE_DELETE

public static final int AR_DPROP_TABLE_DELETE

(character string) Delete button.

AR_DPROP_TABLE_READ

public static final int AR_DPROP_TABLE_READ

(character string) Read button for notifications.

AR_DPROP_TABLE_UNREAD

public static final int AR_DPROP_TABLE_UNREAD

(character string) Unread button for notifications.

AR_DPROP_TABLE_SELECTIONCOLUMN_LABEL

public static final int AR_DPROP_TABLE_SELECTIONCOLUMN_LABEL

(character string) Displays the label of selection column for table or query list view field in Netscape browser 4.75.

AR_DPROP_TABLE_COL_DISPLAY_TYPE

public static final int AR_DPROP_TABLE_COL_DISPLAY_TYPE

(enum) Column states.

• 0: Not editable. (AR_DVAL_TABLE_COL_DISPLAY_NONEDITABLE)
• 1: Allow editing. (AR_DVAL_TABLE_COL_DISPLAY_EDITABLE)
• 2: Display HTML in column. (AR_DVAL_TABLE_COL_DISPLAY_HTML)

AR_DPROP_TABLE_COL_INITVAL

public static final int AR_DPROP_TABLE_COL_INITVAL

(char) Initial value for all cells in column

AR_OPROP_VENDOR_NAME

public static final int AR_OPROP_VENDOR_NAME

Indicates the vendor name. For example, Peregrine Systems.

AR_OPROP_VENDOR_PRODUCT

public static final int AR_OPROP_VENDOR_PRODUCT

Indicates the product name. For example, AR System.

AR_OPROP_VENDOR_VERSION

public static final int AR_OPROP_VENDOR_VERSION

Indicates the vendor version. For example, 5.0.

AR_OPROP_GUID

public static final int AR_OPROP_GUID

Indicates the globally unique identifier for the object.

AR_OPROP_COPYRIGHT

public static final int AR_OPROP_COPYRIGHT

Indicates the copyright string.

AR_OPROP_SCC_LOCKED_BY

public static final int AR_OPROP_SCC_LOCKED_BY

Indicates the name of user who has locked the object.

AR_OPROP_SCC_VERSION

public static final int AR_OPROP_SCC_VERSION

Indicates the version of the SCC system.

AR_OPROP_SCC_TIMESTAMP

public static final int AR_OPROP_SCC_TIMESTAMP

Indicates the SCC timestamp.

AR_OPROP_SCC_USER

public static final int AR_OPROP_SCC_USER

Indicates the SCC username.

AR_OPROP_SCC_LOCATION

public static final int AR_OPROP_SCC_LOCATION

Indicates the location within the SCC system where the object may be found.

AR_OPROP_SCC_DATA_LOCKED_BY

public static final int AR_OPROP_SCC_DATA_LOCKED_BY

Indicates the name of the user who has "locked" the data or entries stored in a form under revision control. The AR Server does not enforce this lock and thus it is to be considered an advisory lock only.

AR_OPROP_SCC_DATA_VERSION

public static final int AR_OPROP_SCC_DATA_VERSION

Indicates the SCC version of the data or entries stored in a form under revision control.

AR_OPROP_SCC_DATA_TIMESTAMP

public static final int AR_OPROP_SCC_DATA_TIMESTAMP

Indicates the SCC version of the data or entries stored in a form under revision control.

AR_OPROP_SCC_DATA_USER

public static final int AR_OPROP_SCC_DATA_USER

Indicates the SCC username fore the data or entries stored in a form under revision control.

AR_OPROP_SCC_DATA_LOCATION

public static final int AR_OPROP_SCC_DATA_LOCATION

Indicates the location within the SCC system where the data or entries stored in a form under revision control.

AR_OPROP_WINDOW_OPEN_SAMPLE_SERVER_SCHEMA

public static final int AR_OPROP_WINDOW_OPEN_SAMPLE_SERVER_SCHEMA

(CHAR) Sample Server and Schema name for IF Window open action in Advanced Mode.

AR_OPROP_WINDOW_OPEN_ELSE_SAMPLE_SERVER_SCHEMA

public static final int AR_OPROP_WINDOW_OPEN_ELSE_SAMPLE_SERVER_SCHEMA

(CHAR) Sample Server and Schema name for ELSE Window open action in Advanced Mode.

AR_OPROP_FORM_NAME_WEB_ALIAS

public static final int AR_OPROP_FORM_NAME_WEB_ALIAS

(CHAR) Unique Form Alias used while deploying JSP page for the Web Server. Unique in a given Server.

AR_OPROP_VIEW_LABEL_WEB_ALIAS

public static final int AR_OPROP_VIEW_LABEL_WEB_ALIAS

(CHAR) Unique View Label Alias used while deploying JSP page for the Web Server. Unique in a given Form.

AR_OPROP_APP_WEB_ALIAS

public static final int AR_OPROP_APP_WEB_ALIAS

(CHAR) Unique Application Alias used while deploying JSP page for the Web Server. Unique in a given Server.

AR_OPROP_INTERVAL_VALUE

public static final int AR_OPROP_INTERVAL_VALUE

(INT) Interval value used to indicate the time interval between an active link's timed executions

Constructor Detail

PropInfo

public PropInfo(int tag,
                Value val)

Constructs a new PropInfo object which consists of a tag-value pair and is used to describe the properties of server objects in the AR System.

Parameters:

tag - A long value identifying the tag for a particular display property.

val - The value for the property represented as a Value object.

Method Detail

getPropertyTag

public int getPropertyTag()

Retrieves the tag associated with the PropInfo object

getPropertyValue

public Value getPropertyValue()

Retrieves the value associated with the PropInfo object

setPropertyValue

public void setPropertyValue(Value value)

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Makes a deep copy of the object

Overrides:

clone in class java.lang.Object

equals

public boolean equals(java.lang.Object anObject)

Use this method for checking equality. The result is true if and only if the argument is not null, is of same type and represents the same content.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

This method can be used to populate a hash table. Implicitly used method to test equality of objects.

Overrides:

hashCode in class java.lang.Object