|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.wrq.apptrieve.agent.ScreenField
public class ScreenField
ScreenField provides information about a field on the terminal screen.
Constructor Summary | |
---|---|
ScreenField(TerminalScreen screen,
ScreenFieldPosition pos)
Constructor for internal use only. |
Method Summary | |
---|---|
char |
charAt(int i)
The character at a zero-based offset within the field. |
boolean |
equals(java.lang.Object o)
|
protected int |
fieldToScreen(int i)
Return absolute screen offset from field offset. |
int |
getColor()
Return the color of the first character in this field. |
int |
getColor(int i)
Return the color of the ith (zero-based) character in this field. |
int |
getColumn()
Gets the 0-based column of the start of this field. |
int |
getLength()
Gets the length of this field. |
int |
getOffset()
Gets the 0-based start offset for this field. |
int |
getRow()
Gets the 0-based row of the start of this field. |
java.lang.String |
getText()
The screen text for this field. |
int |
getWrapLength()
Return number of characters which occur before the field wrap. |
boolean |
hasCursor()
Determine if the terminal cursor is within this field. |
boolean |
isBlink()
Return true if the first character of the field is blinking text. |
boolean |
isBlink(int i)
Return true if the ith character of the field is blinking text. |
boolean |
isColumnSeparated()
Return true if the first character of the field is column separated (5250). |
boolean |
isColumnSeparated(int i)
Return true if the ith character of the field is column separated (5250). |
boolean |
isHighIntensity()
Return true if the first character of the field is high intensity. |
boolean |
isHighIntensity(int i)
Return true if the ith character of the field is high intensity. |
boolean |
isInput()
Return true if the first character of the field is for input. |
boolean |
isInput(int i)
Return true if the ith (zero-based) character of the field is for input. |
boolean |
isNumeric()
Return true if the first character of the field has numeric attribute. |
boolean |
isNumeric(int i)
Return true if the ith character of the field has numeric attribute. |
boolean |
isPenDetect()
Return true if the first field character is lightpen detectable. |
boolean |
isPenDetect(int i)
Return true if the ith field character is lightpen detectable. |
boolean |
isReverseVideo()
Return true if the first field character is reverse-video. |
boolean |
isReverseVideo(int i)
Return true if the ith field character is reverse-video. |
boolean |
isUnderscore()
Return true if the first field character is underlined. |
boolean |
isUnderscore(int i)
Return true if the ith field character is underlined. |
boolean |
isUniformAttributes()
Return true if the character attributes (color, highlighting, etc) are the same for each character within this field. |
boolean |
isVisible()
Return true if the first character of the field is visible. |
boolean |
isVisible(int i)
Return true if the ith character of the field is visible. |
protected boolean |
isWithinField(int i)
Tell whether or not this offset is valid (0 <= i < length). |
boolean |
isWrapAround()
Return true if this field wraps around on the screen. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ScreenField(TerminalScreen screen, ScreenFieldPosition pos)
screen
- screenpos
- posMethod Detail |
---|
public java.lang.String getText()
public char charAt(int i)
i
- zero-based offset within this field.
java.lang.IndexOutOfBoundsException
- if the i
argument is out of range.public int getOffset()
public int getColumn()
public int getRow()
public int getLength()
public int getColor()
Expected values are:
public int getColor(int i)
i
- Zero-based index within the field for which the color is
to be obtained.
Expected return values are:
java.lang.IndexOutOfBoundsException
- if the i
argument is out of range.public boolean isInput()
public boolean isInput(int i)
i
- Zero-based character offset within the field.
java.lang.IndexOutOfBoundsException
- if the i
argument is out of range.public boolean hasCursor()
public boolean isNumeric()
public boolean isNumeric(int i)
i
- Zero-based character offset within the field.
java.lang.IndexOutOfBoundsException
- if the i
argument is out of range.public boolean isHighIntensity()
public boolean isHighIntensity(int i)
i
- Zero-based character offset within the field.
java.lang.IndexOutOfBoundsException
- if the i
argument is out of range.public boolean isVisible()
public boolean isVisible(int i)
i
- Zero-based character offset within the field.
java.lang.IndexOutOfBoundsException
- if the i
argument is out of range.public boolean isBlink()
public boolean isBlink(int i)
i
- Zero-based character offset within the field.
java.lang.IndexOutOfBoundsException
- if the i
argument is out of range.public boolean isColumnSeparated()
public boolean isColumnSeparated(int i)
i
- Zero-based character offset within the field.
java.lang.IndexOutOfBoundsException
- if the i
argument is out of range.public boolean isPenDetect()
public boolean isPenDetect(int i)
i
- Zero-based character offset within the field.
java.lang.IndexOutOfBoundsException
- if the i
argument is out of range.public boolean isReverseVideo()
public boolean isReverseVideo(int i)
i
- Zero-based character offset within the field.
java.lang.IndexOutOfBoundsException
- if the i
argument is out of range.public boolean isUnderscore()
public boolean isUnderscore(int i)
i
- Zero-based character offset within the field.
java.lang.IndexOutOfBoundsException
- if the i
argument is out of range.public boolean isUniformAttributes()
public boolean isWrapAround()
public int getWrapLength()
protected boolean isWithinField(int i)
i
- 0-based absolute offset within this field.
protected int fieldToScreen(int i)
i
- Zero-based field offset.
java.lang.IndexOutOfBoundsException
- if the i
argument is out of range.public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |