All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface org.ohio.iOhioField

public interface iOhioField
extends iOhio
A field is the fundamental element of a virtual screen. A field includes both data and attributes describing the field. The iOhioField class encapsulates a virtual screen field and provides methods for accessing and manipulating field attributes and data.

iOhioField objects can be accessed only through the iOhioFields object.

See Also:
iOhioFields

Method Index

 o getAttribute()
Returns the raw attribute byte for the field.
 o getData(int)
Returns data from the different planes (text, color, extended) associated with the field.
 o getEnd()
Returns the ending position of the field.
 o getLength()
Returns the length of the field.
 o getStart()
Returns the starting position of the field.
 o getString()
Returns the text plane data for the field.
 o isHidden()
Indicates whether or not the field is hidden.
 o isHighIntensity()
Indicates whether or not the field is high-intensity.
 o isModified()
Indicates whether or not the field has been modified.
 o isNumeric()
Indicates whether or not the field is numeric-only.
 o isPenSelectable()
Indicates whether or not the field is pen-selectable.
 o isProtected()
Indicates whether or not the field is protected.
 o setString(String)
Sets the field's text plane to the specified string.

Methods

 o getStart
 public abstract iOhioPosition getStart()
Returns the starting position of the field. The position can range 1 to the size of the virtual screen. The starting position of a field is the position of the first character in the field.

Returns:
The starting position of the field.
 o getEnd
 public abstract iOhioPosition getEnd()
Returns the ending position of the field. The position can range from 1 to the size of the presentation space. The ending position of a field is the position of the last character in the field.

Returns:
The ending position of the field.
 o getLength
 public abstract int getLength()
Returns the length of the field. A field's length can range from 1 to the size of the presentation space. No zero length fields are allowed.

Returns:
The length of the field.
 o getAttribute
 public abstract int getAttribute()
Returns the raw attribute byte for the field.

Returns:
The raw attribute byte of the field.
 o isModified
 public abstract boolean isModified()
Indicates whether or not the field has been modified.

Returns:
True if the field has been modified, otherwise return false.
 o isProtected
 public abstract boolean isProtected()
Indicates whether or not the field is protected.

Returns:
True if the field is protected, otherwise return false.
 o isNumeric
 public abstract boolean isNumeric()
Indicates whether or not the field is numeric-only.

Returns:
True if the field is numeric only, otherwise return false.
 o isHighIntensity
 public abstract boolean isHighIntensity()
Indicates whether or not the field is high-intensity.

Returns:
True if the field is high intensity, otherwise return false.
 o isPenSelectable
 public abstract boolean isPenSelectable()
Indicates whether or not the field is pen-selectable.

Returns:
True if the field is pen-selectable, otherwise return false.
 o isHidden
 public abstract boolean isHidden()
Indicates whether or not the field is hidden.

Returns:
True if the field is hidden, otherwise return false.
 o getString
 public abstract String getString()
Returns the text plane data for the field. This is similar to the getData() method, passing the OHIO_PLANE_TEXT parameter except the data is returned as a string instead of a character array.

Returns:
The text content of the field returned as a string
 o setString
 public abstract void setString(String text)
Sets the field's text plane 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. A subsequent call to getText on this field will not show the changed text. To see the changed text, do a refresh on the iOhioFields collection and retrieve the refreshed field object.

Parameters:
text - The text to be placed in the field's text plane.
 o getData
 public abstract char[] getData(int targetPlane)
Returns data from the different planes (text, color, extended) associated with the field. The data is returned as a character array.

Parameters:
targetPlane - An OHIO_PLANE value indicating from which plane to retrieve the data:

Constant Value Description
OHIO_PLANE_TEXT 1 Field attr represented as spaces
OHIO_PLANE_COLOR 2 Standard HLLAPI CGA color values
OHIO_PLANE_FIELD 4 Field Attr bytes (See OHIO_FIELD)
OHIO_PLANE_EXTENDED 8 Extended attr bytes (see OHIO_EXTENDED)

Returns:
A character array containing the field data from the target plane.

All Packages  Class Hierarchy  This Package  Previous  Next  Index