com.ibm.eNetwork.ECL
Class ECLField

java.lang.Object
  |
  +--com.ibm.eNetwork.ECL.ECLField

All Implemented Interfaces:

ECLConstants, org.ohio.iOhio, org.ohio.iOhioField

public class ECLField

extends java.lang.Object

implements ECLConstants, org.ohio.iOhioField

A field is the fundamental element of a presentation space. A field includes both contents and attributes. The ECLField class encapsulates a presentation space field and provides methods for accessing and manipulating field attributes and contents.

For 3270, 5250, and CICS sessions, ECLField correlates to the fields defined in their respective data streams. For VT emulation, the entire presentation space is represented in a single field.

ECLField objects can be accessed through ECLFieldList objects.

See Also:

ECLFieldList

Fields inherited from interface com.ibm.eNetwork.ECL.ECLConstants

ALL_FIELDS, ALL_PLANES, ALPHANUM_FIELD, ALTCUR_STR, ALTVIEW_STR, ATTN_STR, ATTR_5250_ALPHA_ONLY, ATTR_5250_ALPHANUM, ATTR_5250_ALPHANUM_MASK, ATTR_5250_BIDI_RTL, ATTR_5250_BRIGHT, ATTR_5250_DBCS_KATAKANA, ATTR_5250_DISPLAY, ATTR_5250_MAG_STRIPE, ATTR_5250_MODIFIED, ATTR_5250_NORMAL, ATTR_5250_NUM_ONLY, ATTR_5250_NUM_PLUS, ATTR_5250_NUM_SHIFT, ATTR_5250_NUM_SIGNED, ATTR_5250_PROTECTED, ATTR_ALPHANUM, ATTR_DISPLAY1, ATTR_DISPLAY2, ATTR_MDT, ATTR_PROTECTED, AUTOPUSH_STR, AUTOREV_STR, BACKSP_STR, BACKTAB_STR, BACKTABWORD_STR, BASE_STR, BEGINFLD_STR, BIDI_MODE_OFF_STR, BIDI_MODE_ON_STR, BIDIL_STR, BLUE_3270, CANCELPJOB_STR, CLEAR_STR, CLEARRECT_STR, CLOSE_STR, COLOR_ATTRIBUTES_PLANE, COLOR_PLANE, COLUMNHEAD_STR, CONTEXT_DISP_STR, CONTINUEPJOB_STR, COPY_STR, COPY_TABLE_STR, COPYALL_STR, COPYAPPEND_STR, CRSEL_STR, CSD_STR, CURDOWN_STR, CURLEFT_STR, CURRIGHT_STR, CURSOR_DIRECTION_STR, CURUP_STR, CUT_STR, DB_CA_EXIST, DB_CLEAR, DB_DB1, DB_DBCS, DB_DBHIGH, DB_DEAD, DB_MIX, DB_SI, DB_SO, DB_SOSI_EXIST, DBATTR_DEFAULT, DBATTR_EITHER, DBATTR_ONLY, DBATTR_OPEN, DBATTR_PURE, DBCS_PLANE, DBCSINP_STR, DBDEFALT, DEF_3270, DELCHAR_STR, DELWORD_STR, DISPLAYABLE_FIELD, DOCMODE_STR, DSPSOSI_STR, DUP_CHAR, DUP_STR, EBC_SI, EBC_SO, ENDLINE_STR, ENDPUSH_STR, ENTER_STR, ENTERRESET_STR, ERASEEOF_STR, ERASEFLD_STR, ERASEINPUT_STR, EXFIELD_PLANE, EXT_ATTR_3270_APL, EXT_ATTR_3270_BLINK, EXT_ATTR_3270_CHAR, EXT_ATTR_3270_DBCS, EXT_ATTR_3270_EBCDIC, EXT_ATTR_3270_REVERSE, EXT_ATTR_3270_UNDERLINE, EXT_ATTR_5250_BLINK, EXT_ATTR_5250_COLUMN_SEP, EXT_ATTR_5250_REVERSE, EXT_ATTR_5250_UNDERLINE, EXT_BLINK, EXT_COL_SEP, EXT_D_BOTH, EXT_D_LEFT, EXT_D_OVER, EXT_D_RIGHT, EXT_D_UNDER, EXT_DBCS, EXT_EFA_APL_SET, EXT_EFA_FG_SET, EXT_G_ALL, EXT_G_LEFT, EXT_G_OVER, EXT_G_RIGHT, EXT_G_UNDER, EXT_LINEATTR_CHECK, EXT_LINEATTR_DBLWID, EXT_LINEATTR_DBLWID_DBLHT_BOT, EXT_LINEATTR_DBLWID_DBLHT_TOP, EXT_LINEATTR_NORMAL, EXT_NON_ERASEABLE, EXT_NORMAL, EXT_OPAQUE, EXT_REVERSE, EXT_UNDERLN, F1_STR, F10_STR, F11_STR, F12_STR, F13_STR, F14_STR, F15_STR, F16_STR, F17_STR, F18_STR, F19_STR, F2_STR, F20_STR, F21_STR, F22_STR, F23_STR, F24_STR, F3_STR, F4_STR, F5_STR, F6_STR, F7_STR, F8_STR, F9_STR, FIELD_MARK, FIELD_PLANE, FINAL_STR, FLDBASE_STR, FLDEXT_STR, FLDMINUS_STR, FLDMRK_STR, FLDPLUS_STR, FLDREV_STR, FLDSHAPE_STR, FORMFEED_STR, FWDTAB_STR, GRCURSOR_STR, GREEN_3270, GRID_PLANE, HELP_STR, HILIGHT_FIELD, HINDIL_STR, HOME_STR, HOST_PLANE, HOSTPRT_STR, INITIAL_STR, INSERT_STR, ISOLATED_STR, JUMP_STR, KEYPAD0_STR, KEYPAD1_STR, KEYPAD2_STR, KEYPAD3_STR, KEYPAD4_STR, KEYPAD5_STR, KEYPAD6_STR, KEYPAD7_STR, KEYPAD8_STR, KEYPAD9_STR, KEYPADCOMMA_STR, KEYPADDOT_STR, KEYPADENTER_STR, KEYPADMINUS_STR, LATINL_STR, LOGICAL_DISP_STR, LOLIGHT_FIELD, MARKDOWN_STR, MARKLEFT_STR, MARKRIGHT_STR, MARKUP_STR, MIDDLE_STR, MODIFIED_FIELD, MOVEDOWN_STR, MOVELEFT_STR, MOVERIGHT_STR, MOVEUP_STR, MSR_STR, NATIONAL_DISP_STR, NEUT_3270, NEWLINE_STR, NEXTWORD_STR, NLS_PLANE, NO_TIMEOUT, NOMINAL_DISP_STR, NON_DISPLAYABLE_FIELD, NON_PENDETECTABLE_FIELD, NUMCONTEXT_STR, NUMERIC_FIELD, NUMNATIONAL_STR, NUMNOMINAL_STR, OICR_STR, PA1_STR, PA2_STR, PA3_STR, PAGEDWN_STR, PAGEUP_STR, PASTE_STR, PASTENEXT_STR, PENDETECTABLE_FIELD, PINK_3270, PREVIOUSWORD_STR, PRINT_STR, PROTECTED_FIELD, PRTESTPAGE_STR, PUSH_STR, RAWTEXT_PLANE, RED_3270, RESET_STR, RETRYPRT_STR, ROUNDTRIP_OFF_STR, ROUNDTRIP_ON_STR, RULE_STR, SCREENREV_STR, SEARCH_BACKWARD, SEARCH_FORWARD, SELECTALL_STR, SHIFT_F1_STR, SHIFT_F10_STR, SHIFT_F11_STR, SHIFT_F12_STR, SHIFT_F13_STR, SHIFT_F14_STR, SHIFT_F15_STR, SHIFT_F16_STR, SHIFT_F17_STR, SHIFT_F18_STR, SHIFT_F19_STR, SHIFT_F2_STR, SHIFT_F20_STR, SHIFT_F3_STR, SHIFT_F4_STR, SHIFT_F5_STR, SHIFT_F6_STR, SHIFT_F7_STR, SHIFT_F8_STR, SHIFT_F9_STR, SMARTORDERING_OFF_STR, SMARTORDERING_ON_STR, STARTMAC_STR, SYSREQ_STR, TABWORD_STR, TEST_STR, TEXT_PLANE, THAIL_STR, TOGGLEHEB_STR, TURQ_3270, TXTORL2R_STR, TXTORR2L_STR, TXTTYPEL_STR, TXTTYPEV_STR, UNMARK_STR, UNMODIFIED_FIELD, UNPROTECTED_FIELD, VISUAL_DISP_STR, VTPRINTCONVERT_STR, WORDLFT_STR, WORDRGT_STR, WORDWRAP_STR, YELLOW_3270

Fields inherited from interface org.ohio.iOhio

OHIO_COLOR_BLACK, OHIO_COLOR_BLUE, OHIO_COLOR_CYAN, OHIO_COLOR_GREEN, OHIO_COLOR_MAGENTA, OHIO_COLOR_RED, OHIO_COLOR_WHITE, OHIO_COLOR_YELLOW, OHIO_DIRECTION_BACKWARD, OHIO_DIRECTION_FORWARD, OHIO_EXTENDED_COLOR, OHIO_EXTENDED_COLOR_BLUE, OHIO_EXTENDED_COLOR_DEFAULT, OHIO_EXTENDED_COLOR_GREEN, OHIO_EXTENDED_COLOR_PINK, OHIO_EXTENDED_COLOR_RED, OHIO_EXTENDED_COLOR_TURQUOISE, OHIO_EXTENDED_COLOR_WHITE, OHIO_EXTENDED_COLOR_YELLOW, OHIO_EXTENDED_HILITE, OHIO_EXTENDED_HILITE_BLINK, OHIO_EXTENDED_HILITE_NORMAL, OHIO_EXTENDED_HILITE_REVERSEVIDEO, OHIO_EXTENDED_HILITE_UNDERSCORE, OHIO_EXTENDED_RESERVED, OHIO_FIELD_ATTRIBUTE, OHIO_FIELD_HIDDEN, OHIO_FIELD_HIGH_INTENSITY, OHIO_FIELD_MODIFIED, OHIO_FIELD_NUMERIC, OHIO_FIELD_PEN_SELECTABLE, OHIO_FIELD_PROTECTED, OHIO_FIELD_RESERVED, OHIO_INPUTINHIBITED_COMMCHECK, OHIO_INPUTINHIBITED_MACHINECHECK, OHIO_INPUTINHIBITED_NOTINHIBITED, OHIO_INPUTINHIBITED_OTHER, OHIO_INPUTINHIBITED_PROGCHECK, OHIO_INPUTINHIBITED_SYSTEM_WAIT, OHIO_OWNER_APP, OHIO_OWNER_MYJOB, OHIO_OWNER_NVT, OHIO_OWNER_SSCP, OHIO_OWNER_UNKNOWN, OHIO_OWNER_UNOWNED, OHIO_PLANE_COLOR, OHIO_PLANE_EXTENDED, OHIO_PLANE_FIELD, OHIO_PLANE_TEXT, OHIO_STATE_CONNECTED, OHIO_STATE_DISCONNECTED, OHIO_TYPE_3270, OHIO_TYPE_5250, OHIO_TYPE_UNKNOWN, OHIO_UPDATE_CLIENT, OHIO_UPDATE_HOST

Method Summary

short	GetAttribute() Gets the raw attribute byte of the field.
int	GetEnd() Gets the ending linear position of the field.
int	GetEndCol() Gets the ending column of the field.
int	GetEndRow() Gets the ending row of the field.
int	GetLength() Gets the length of the field.
int	GetScreen(char[] buffer, int length, int plane) Retrieves information from the different planes (text, color, extended attributes, DBCS, and grid) associated with a field.
int	GetStart() Gets the starting linear position of the field.
int	GetStartCol() Gets the starting column of the field.
int	GetStartRow() Gets the starting row of the field.
int	GetString(char[] buffer, int length) Retrieves text plane information from the field similarly to GetScreen using the TEXT_PLANE parameter, but it handles DBCS characters differently.
boolean	IsDisplay() Determines whether or not the field is displayable.
boolean	IsHighIntensity() Determines whether or not the field is high-intensity.
boolean	IsModified() Determines whether or not the field has been modified.
boolean	IsNumeric() Determines whether or not the field is numeric-only.
boolean	IsPenDetectable() Determines whether or not the field is pen-detectable.
boolean	IsProtected() Determines whether or not the field is protected.
void	SetString(java.lang.String text) Sets the text plane of the field to the specified string similarly to SetText, but it handles DBCS characters differently.
void	SetText(java.lang.String text) Sets the text plane of the field to the specified string.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.ohio.iOhioField

getAttribute, getData, getEnd, getLength, getStart, getString, isHidden, isHighIntensity, isModified, isNumeric, isPenSelectable, isProtected, setString

Methods inherited from interface org.ohio.iOhio

getOhioVersion, getVendorName, getVendorObject, getVendorProductVersion

Method Detail

GetStart

public int GetStart()

Gets the starting linear position of the field. The linear positions can range from 1 to the size of the presentation space. The starting linear position of a field is the position of the first character in the field. If the field is zero-length, the linear position of the attribute byte of the field is returned.

Returns:

The starting linear position of the field.

See Also:

GetEnd()

GetStartRow

public int GetStartRow()

Gets the starting row of the field. The row can range from 1 to the number of rows in the presentation space. The starting row of a field is the row which contains the first character in the field. If the field is zero-length, the row of the attribute byte of the field is returned.

Returns:

The starting row of the field within the PS.

See Also:

GetEndRow(), GetStartCol()

GetStartCol

public int GetStartCol()

Gets the starting column of the field. The column can range from 1 to the number of columns in the presentation space. The starting column of a field is the column which contains the first character in the field. If the field is zero-length, the column of the attribute byte of the field is returned.

Returns:

The starting column of the field within the PS.

See Also:

GetEndCol(), GetStartRow()

GetEnd

public int GetEnd()

Gets the ending linear position of the field. The linear positions can range from 1 to the size of the presentation space. The ending linear position of a field is the position of the last character in the field. If the field is zero-length, the linear position of the attribute byte of the field is returned.

Returns:

The ending linear position of the field.

See Also:

GetStart()

GetEndRow

public int GetEndRow()

Gets the ending row of the field. The row can range from 1 to the number of rows in the presentation space. The ending row of a field is the row which contains the last character in the field. If the field is zero-length, the row of the attribute byte of the field is returned.

Returns:

The ending row of the field within the PS.

See Also:

GetStartRow(), GetEndCol()

GetEndCol

public int GetEndCol()

Gets the ending column of the field. The column can range from 1 to the number of columns in the presentation space. The ending column of a field is the column which contains the last character in the field. If the field is zero-length, the column of the attribute byte of the field is returned.

Returns:

The ending column of the field within the PS.

See Also:

GetStartCol(), GetEndRow()

GetLength

public final int GetLength()

Gets the length of the field. The length of the field can range from zero to the size of the presentation space.

Returns:

The length of the field.

GetScreen

public int GetScreen(char[] buffer,
                     int length,
                     int plane)
              throws ECLErr

Retrieves information from the different planes (text, color, extended attributes, DBCS, and grid) associated with a field. The application must supply a buffer for the returned data and the length of the buffer. Data is returned starting from the beginning of the field and continuing until the buffer is full, or the entire field contents have been copied. The buffer must include one extra position for the addition of a terminating null character.

Parameters:

buffer - An array of characters used to store the return values.

length - The number of characters to copy to the buffer.

plane - The plane to return. The valid values follow:

TEXT_PLANE - The character contents of the field. The text plane contains no null or non-printable characters.

COLOR_PLANE - The color attributes for each character in the plane.

EXFIELD_PLANE - The extended field attributes for each character in the plane.

DBCS_PLANE - The double byte character set (DBCS) character and field attribute data.

GRID_PLANE - The DBCS grid information.

Returns:

The number of characters copied to the buffer, not including the terminating null when the text plane is copied.

Throws:

ECLErr - Thrown if the buffer parameter is null or if the plane parameter is incorrect.

GetString

public int GetString(char[] buffer,
                     int length)
              throws ECLErr

Retrieves text plane information from the field similarly to GetScreen using the TEXT_PLANE parameter, but it handles DBCS characters differently. While GetScreen returns the raw text plane data, GetString removes duplicate DBCS characters before the text plane data is returned.

The application must supply a buffer for the returned data and the length of the buffer. Data is returned starting from the beginning of the field and continuing until the buffer is full or the entire field contents have been copied. The buffer must include one extra position for the addition of a terminating null character.

Note: GetString functions identically to GetScreen when the text plane of the field contains no DBCS characters.

See Text Plane in Appendix B. Host Access Class Library Planes -- Format and Content for more information on the representation of DBCS characters in the text plane.

Parameters:

buffer - An array of characters that contains the returned data.

length - The length of the buffer.

Returns:

The number of characters copied to the buffer, not including the terminating null.

Throws:

ECLErr - Thrown if the buffer parameter is null.

SetText

public void SetText(java.lang.String text)
             throws ECLErr

Sets the text plane of the field to the specified string. If the string is shorter than the length of the field, the rest of the field is cleared. If the string is longer than the field, the text is truncated.

Parameters:

text - The text used to replace the current text.

Throws:

ECLErr - An ECLErr will be thrown if the field is protected.

See Also:

SetString(java.lang.String)

SetString

public void SetString(java.lang.String text)
               throws ECLErr

Sets the text plane of the field to the specified string similarly to SetText, but it handles DBCS characters differently. While SetText copies the given string directly to the text plane of the field, SetString automatically duplicates DBCS characters before copying the string to the text plane.

If the string is shorter than the length of the field, the rest of the field is cleared. If the string is longer than the field, the text is truncated.

Note: SetString functions identically to SetText when the given text string contains no DBCS characters.

See Text Plane in Appendix B. Host Access Class Library Planes -- Format and Content for more information on the representation of DBCS characters in the text plane.

Parameters:

text - The text used to replace the current text.

Throws:

ECLErr - An ECLErr will be thrown if the field is protected.

See Also:

SetText(java.lang.String)

IsModified

public final boolean IsModified()

Determines whether or not the field has been modified.

Returns:

True if the field has been modified, false otherwise.

IsProtected

public final boolean IsProtected()

Determines whether or not the field is protected.

Returns:

True if the field is protected, false otherwise.

IsNumeric

public boolean IsNumeric()

Determines whether or not the field is numeric-only.

Returns:

True if the field is numeric only, false otherwise.

IsHighIntensity

public boolean IsHighIntensity()

Determines whether or not the field is high-intensity.

Returns:

True if the field is high intensity, false otherwise.

IsPenDetectable

public final boolean IsPenDetectable()

Determines whether or not the field is pen-detectable.

Returns:

True if the field is pen detectable, false otherwise.

IsDisplay

public final boolean IsDisplay()

Determines whether or not the field is displayable.

Returns:

True if the field is displayable, false otherwise.

GetAttribute

public final short GetAttribute()

Gets the raw attribute byte of the field. Refer to the Field Plane for additional information on the format of the field attribute byte.

Returns:

The raw attribute byte of the field.