com.wrq.apptrieve.appconn
Class TerminalAttributes

java.lang.Object
  extended by com.wrq.apptrieve.appconn.TerminalAttributes

public class TerminalAttributes
extends java.lang.Object

TerminalAttributes provides terminal attribute information about a Host Integrator entity attribute or recordset field. An instance of this class is returned by the following methods:

  • com.wrq.apptrieve.appconn.AppConnModelRecord.getTerminalAttributes
  • com.wrq.apptrieve.appconn.AppConnModelRecord.getTerminalAttributesByIndex

  • Field Summary
    static int COLOR_HOST_BLUE
              Return value from getColor() when the attribute/field color is HostBlue.
    static int COLOR_HOST_GREEN
              Return value from getColor() when the attribute/field color is HostGreen.
    static int COLOR_HOST_NOCOLOR
              Return value from getColor() when the attribute/field does not have a color.
    static int COLOR_HOST_PINK
              Return value from getColor() when the attribute/field color is HostPink.
    static int COLOR_HOST_RED
              Return value from getColor() when the attribute/field color is HostRed.
    static int COLOR_HOST_TURQUOISE
              Return value from getColor() when the attribute/field color is HostTurquoise.
    static int COLOR_HOST_WHITE
              Return value from getColor() when the attribute/field color is HostWhite.
    static int COLOR_HOST_YELLOW
              Return value from getColor() when the attribute/field color is HostYellow.
     
    Constructor Summary
    TerminalAttributes(com.wrq.apptrieve.agent.TerminalAttrs saObject)
              Constructor for internal use only.
     
    Method Summary
     int getColor()
              Gets the color terminal attribute of this object.
     boolean isBlinking()
              Discovers whether the blinking terminal attribute is set for this object.
     boolean isColumnSeparated()
              Discovers whether the column separated terminal attribute is set for this object.
     boolean isHalfBrite()
              Discovers whether the half-brite terminal attribute is set for this object.
     boolean isIntense()
              Discovers whether the intense terminal attribute is set for this object.
     boolean isNonDisplay()
              Discovers whether the nondisplay terminal attribute is set for this object.
     boolean isNumeric()
              Discovers whether the numeric terminal attribute is set for this object.
     boolean isPenDetect()
              Discovers whether the pen detect terminal attribute is set for this object.
     boolean isProtected()
              Discovers whether the protected terminal attribute is set for this object.
     boolean isReverse()
              Discovers whether the reverse terminal attribute is set for this object.
     boolean isUnderscore()
              Discovers whether the underscore terminal attribute is set for this object.
     java.lang.String toString()
              Generates a String object that represents the current values of this TerminalAttributes object.
     
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
     

    Field Detail

    COLOR_HOST_NOCOLOR

    public static final int COLOR_HOST_NOCOLOR
    Return value from getColor() when the attribute/field does not have a color.

    See Also:
    Constant Field Values

    COLOR_HOST_BLUE

    public static final int COLOR_HOST_BLUE
    Return value from getColor() when the attribute/field color is HostBlue.


    COLOR_HOST_RED

    public static final int COLOR_HOST_RED
    Return value from getColor() when the attribute/field color is HostRed.


    COLOR_HOST_PINK

    public static final int COLOR_HOST_PINK
    Return value from getColor() when the attribute/field color is HostPink.


    COLOR_HOST_GREEN

    public static final int COLOR_HOST_GREEN
    Return value from getColor() when the attribute/field color is HostGreen.


    COLOR_HOST_TURQUOISE

    public static final int COLOR_HOST_TURQUOISE
    Return value from getColor() when the attribute/field color is HostTurquoise.


    COLOR_HOST_YELLOW

    public static final int COLOR_HOST_YELLOW
    Return value from getColor() when the attribute/field color is HostYellow.


    COLOR_HOST_WHITE

    public static final int COLOR_HOST_WHITE
    Return value from getColor() when the attribute/field color is HostWhite.

    Constructor Detail

    TerminalAttributes

    public TerminalAttributes(com.wrq.apptrieve.agent.TerminalAttrs saObject)
    Constructor for internal use only.

    Parameters:
    saObject - data
    Method Detail

    getColor

    public int getColor()
    Gets the color terminal attribute of this object.

    There are fields defined for some of the colors that a host may use:

    If there is no color, the method returns COLOR_HOST_NOCOLOR (-1)

    Returns:
    int - the color value

    isBlinking

    public boolean isBlinking()
    Discovers whether the blinking terminal attribute is set for this object.

    Returns:
    boolean - true if so, false otherwise

    isColumnSeparated

    public boolean isColumnSeparated()
    Discovers whether the column separated terminal attribute is set for this object.

    Returns:
    boolean - true if so, false otherwise

    isHalfBrite

    public boolean isHalfBrite()
    Discovers whether the half-brite terminal attribute is set for this object.

    Returns:
    boolean - true if so, false otherwise

    isIntense

    public boolean isIntense()
    Discovers whether the intense terminal attribute is set for this object.

    Returns:
    boolean - true if so, false otherwise

    isNonDisplay

    public boolean isNonDisplay()
    Discovers whether the nondisplay terminal attribute is set for this object.

    Returns:
    boolean - true if so, false otherwise

    isNumeric

    public boolean isNumeric()
    Discovers whether the numeric terminal attribute is set for this object.

    Returns:
    boolean - true if so, false otherwise

    isPenDetect

    public boolean isPenDetect()
    Discovers whether the pen detect terminal attribute is set for this object.

    Returns:
    boolean - true if so, false otherwise

    isProtected

    public boolean isProtected()
    Discovers whether the protected terminal attribute is set for this object.

    Returns:
    boolean - true if so, false otherwise

    isReverse

    public boolean isReverse()
    Discovers whether the reverse terminal attribute is set for this object.

    Returns:
    boolean - true if so, false otherwise

    isUnderscore

    public boolean isUnderscore()
    Discovers whether the underscore terminal attribute is set for this object.

    Returns:
    boolean - true if so, false otherwise

    toString

    public java.lang.String toString()
    Generates a String object that represents the current values of this TerminalAttributes object.

    Overrides:
    toString in class java.lang.Object
    Returns:
    java.lang.String - the string representation of this object