RW3270Char (FreeHost3270 modules suite 0.2-CURRENT API)

java.lang.Object
- net.sf.freehost3270.client.RW3270Char

```
public class RW3270Char
extends Object
```
Represents a single 'character' in the client's data buffer/screen.
Field attributes (Highlighting, Color, etc.) should be manipulated using the RW3270Field object, which can obtained from any RW3270Char object by calling the getField() method. An array of RW3270Char objects representing the current 3270 screen can be obtained by calling the RW3270.getDataBuffer() method.

See Also:
RW3270Field, RW3270

Field Summary

Fields
Modifier and Type	Field and Description
`static short`	`BGCOLOR_DEFAULT`
`static short`	`BLACK`
`static short`	`BLUE`
`static short`	`DEEP_BLUE`
`static short`	`FGCOLOR_DEFAULT`
`static short`	`GREEN`
`static short`	`GREY`
`static short`	`HL_BLINK`
`static short`	`HL_DEFAULT`
`static short`	`HL_INTENSIFY`
`static short`	`HL_NORMAL`
`static short`	`HL_REVERSE`
`static short`	`HL_UNDERSCORE`
`static short`	`OL_LEFT`
`static short`	`OL_NONE`
`static short`	`OL_OVER`
`static short`	`OL_OVER_LEFT`
`static short`	`OL_OVER_LEFT_UNDER`
`static short`	`OL_OVER_RIGHT_LEFT`
`static short`	`OL_OVER_RIGHT_UNDER`
`static short`	`OL_RECTANGLE`
`static short`	`OL_RIGHT`
`static short`	`OL_RIGHT_LEFT`
`static short`	`OL_RIGHT_OVER`
`static short`	`OL_UNDER`
`static short`	`OL_UNDER_LEFT`
`static short`	`OL_UNDER_OVER`
`static short`	`OL_UNDER_RIGHT`
`static short`	`OL_UNDER_RIGHT_LEFT`
`static short`	`ORANGE`
`static short`	`PALE_GREEN`
`static short`	`PALE_TURQUOISE`
`static short`	`PINK`
`static short`	`PURPLE`
`static short`	`RED`
`static short`	`TURQUOISE`
`static short`	`WHITE`
`static short`	`YELLOW`

Constructor Summary

Constructors
Modifier Constructor and Description

protected RW3270Char(int position)
Instanitates a new RW3270 character.

Constructors
Modifier	Constructor and Description
`protected`	`RW3270Char(int position)` Instanitates a new RW3270 character.

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`clear()` Clears the this location in the character buffer
`int`	`getBackground()` Returns the background color of this character/field.
`char`	`getChar()` Returns the contents of hidden fields.
`char`	`getDisplayChar()` This method returns the actual Screen representation of an object If the character is hidden or null, this method returns ' '; Use this method if you plan on displaying this character to the user.
`RW3270Field`	`getField()` DOCUMENT ME!
`short`	`getFieldAttribute()` DOCUMENT ME!
`int`	`getForeground()` Returns the foreground (font) color of this character/field
`protected short`	`getHighlighting()` Returns the highlighting attributes for this character/startField (assuming it's a StartField.)
`int`	`getOutlining()` DOCUMENT ME!
`int`	`getPosition()` DOCUMENT ME!
`boolean`	`isBold()` DOCUMENT ME!
`boolean`	`isHidden()` DOCUMENT ME!
`boolean`	`isHighIntensity()`
`protected boolean`	`isModified()`
`protected void`	`isModified(boolean b)` Sets the MDT for this field (assuming it's a SF character)
`boolean`	`isNumeric()`
`boolean`	`isProtected()` DOCUMENT ME!
`void`	`isProtected(boolean b)`
`boolean`	`isStartField()` DOCUMENT ME!
`protected void`	`setBackground(short in)` Sets the background color of this character field.
`protected void`	`setChar(char c)` Sets the actual ASCII char stored in this object.
`protected void`	`setField(RW3270Field field)` Creates a pointer to the RW3270Field object that 'contains' this character.
`protected void`	`setFieldAttribute(short in)` Stores the short that represents the FA
`protected void`	`setForeground(short in)` Sets the foreground (font) color for this character/field
`protected void`	`setHighlighting(short in)` Sets the highlighting attributes for this character/startField (assuming it's a StartField.)
`protected void`	`setOutlining(short in)` Sets the outlining attributes for this character/startField (assuming it's a StartField.)
`protected void`	`setStartField()` Sets this position in the data buffer as a start field
`protected void`	`setValidation(short in)` Sets the validation attributes for this character/field.
`String`	`toString()` DOCUMENT ME!

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - HL_DEFAULT
```
public static final short HL_DEFAULT
```
    See Also:
    Constant Field Values
  - HL_NORMAL
```
public static final short HL_NORMAL
```
    See Also:
    Constant Field Values
  - HL_BLINK
```
public static final short HL_BLINK
```
    See Also:
    Constant Field Values
  - HL_REVERSE
```
public static final short HL_REVERSE
```
    See Also:
    Constant Field Values
  - HL_UNDERSCORE
```
public static final short HL_UNDERSCORE
```
    See Also:
    Constant Field Values
  - HL_INTENSIFY
```
public static final short HL_INTENSIFY
```
    See Also:
    Constant Field Values
  - BGCOLOR_DEFAULT
```
public static final short BGCOLOR_DEFAULT
```
    See Also:
    Constant Field Values
  - FGCOLOR_DEFAULT
```
public static final short FGCOLOR_DEFAULT
```
    See Also:
    Constant Field Values
  - BLUE
```
public static final short BLUE
```
    See Also:
    Constant Field Values
  - RED
```
public static final short RED
```
    See Also:
    Constant Field Values
  - PINK
```
public static final short PINK
```
    See Also:
    Constant Field Values
  - GREEN
```
public static final short GREEN
```
    See Also:
    Constant Field Values
  - TURQUOISE
```
public static final short TURQUOISE
```
    See Also:
    Constant Field Values
  - YELLOW
```
public static final short YELLOW
```
    See Also:
    Constant Field Values
  - BLACK
```
public static final short BLACK
```
    See Also:
    Constant Field Values
  - DEEP_BLUE
```
public static final short DEEP_BLUE
```
    See Also:
    Constant Field Values
  - ORANGE
```
public static final short ORANGE
```
    See Also:
    Constant Field Values
  - PURPLE
```
public static final short PURPLE
```
    See Also:
    Constant Field Values
  - PALE_GREEN
```
public static final short PALE_GREEN
```
    See Also:
    Constant Field Values
  - PALE_TURQUOISE
```
public static final short PALE_TURQUOISE
```
    See Also:
    Constant Field Values
  - GREY
```
public static final short GREY
```
    See Also:
    Constant Field Values
  - WHITE
```
public static final short WHITE
```
    See Also:
    Constant Field Values
  - OL_NONE
```
public static final short OL_NONE
```
    See Also:
    Constant Field Values
  - OL_UNDER
```
public static final short OL_UNDER
```
    See Also:
    Constant Field Values
  - OL_RIGHT
```
public static final short OL_RIGHT
```
    See Also:
    Constant Field Values
  - OL_OVER
```
public static final short OL_OVER
```
    See Also:
    Constant Field Values
  - OL_LEFT
```
public static final short OL_LEFT
```
    See Also:
    Constant Field Values
  - OL_UNDER_RIGHT
```
public static final short OL_UNDER_RIGHT
```
    See Also:
    Constant Field Values
  - OL_UNDER_OVER
```
public static final short OL_UNDER_OVER
```
    See Also:
    Constant Field Values
  - OL_UNDER_LEFT
```
public static final short OL_UNDER_LEFT
```
    See Also:
    Constant Field Values
  - OL_RIGHT_OVER
```
public static final short OL_RIGHT_OVER
```
    See Also:
    Constant Field Values
  - OL_RIGHT_LEFT
```
public static final short OL_RIGHT_LEFT
```
    See Also:
    Constant Field Values
  - OL_OVER_LEFT
```
public static final short OL_OVER_LEFT
```
    See Also:
    Constant Field Values
  - OL_OVER_RIGHT_UNDER
```
public static final short OL_OVER_RIGHT_UNDER
```
    See Also:
    Constant Field Values
  - OL_UNDER_RIGHT_LEFT
```
public static final short OL_UNDER_RIGHT_LEFT
```
    See Also:
    Constant Field Values
  - OL_OVER_LEFT_UNDER
```
public static final short OL_OVER_LEFT_UNDER
```
    See Also:
    Constant Field Values
  - OL_OVER_RIGHT_LEFT
```
public static final short OL_OVER_RIGHT_LEFT
```
    See Also:
    Constant Field Values
  - OL_RECTANGLE
```
public static final short OL_RECTANGLE
```
    See Also:
    Constant Field Values
- Constructor Detail
  - RW3270Char
```
protected RW3270Char(int position)
```
    Instanitates a new RW3270 character.
    Normally is called by RW3270. End-programmers have no reason to create RW3270Objects, as they are managed completely by the data stream and session instantiation.
    
    Parameters:
    position - The position of this character in the buffer
- Method Detail
  - getBackground
```
public int getBackground()
```
    Returns the background color of this character/field.
    
    Returns:
    DOCUMENT ME!
  - getChar
```
public char getChar()
```
    Returns the contents of hidden fields.
    NOTE: Do not use for display of characters, only for testing contents. For displaying the character, use getDisplayChar()
    
    Returns:
    the character represented by this object.
  - getDisplayChar
```
public char getDisplayChar()
```
    This method returns the actual Screen representation of an object If the character is hidden or null, this method returns ' '; Use this method if you plan on displaying this character to the user.
    
    Returns:
    the 'display' character represented by this object
  - getField
```
public RW3270Field getField()
```
    DOCUMENT ME!
    
    Returns:
    the field in which this character is contained
  - getFieldAttribute
```
public short getFieldAttribute()
```
    DOCUMENT ME!
    
    Returns:
    the byte representation of this Field Attribute (assuming it's a StartField.
  - getForeground
```
public int getForeground()
```
    Returns the foreground (font) color of this character/field
    
    Returns:
    DOCUMENT ME!
  - getOutlining
```
public int getOutlining()
```
    DOCUMENT ME!
    
    Returns:
    int corresponding to Outlining constants outlined below.
  - getPosition
```
public int getPosition()
```
    DOCUMENT ME!
    
    Returns:
    the position of this character relative to the data buffer (screen)
  - isBold
```
public boolean isBold()
```
    DOCUMENT ME!
    
    Returns:
    True if this field should be rendered in Bold type
  - isHidden
```
public boolean isHidden()
```
    DOCUMENT ME!
    
    Returns:
    True if this field should be hidden
  - isNumeric
```
public boolean isNumeric()
```
  - isProtected
```
public boolean isProtected()
```
    DOCUMENT ME!
    
    Returns:
    True if this character/field is protected. (Accessed through RW3270Field)
  - isProtected
```
public void isProtected(boolean b)
```
  - isStartField
```
public boolean isStartField()
```
    DOCUMENT ME!
    
    Returns:
    True if this character marks the beginning of a 3270 Field.
  - isHighIntensity
```
public boolean isHighIntensity()
```
  - toString
```
public String toString()
```
    DOCUMENT ME!
    
    Overrides:
    
    toString in class Object
    
    Returns:
    the representation of this character
  - clear
```
protected void clear()
```
    Clears the this location in the character buffer
  - getHighlighting
```
protected short getHighlighting()
```
    Returns the highlighting attributes for this character/startField (assuming it's a StartField.)
    
    Returns:
    DOCUMENT ME!
  - isModified
```
protected void isModified(boolean b)
```
    Sets the MDT for this field (assuming it's a SF character)
    
    Parameters:
    b - DOCUMENT ME!
  - isModified
```
protected boolean isModified()
```
  - setBackground
```
protected void setBackground(short in)
```
    Sets the background color of this character field.
    
    Parameters:
    in - DOCUMENT ME!
  - setChar
```
protected void setChar(char c)
```
    Sets the actual ASCII char stored in this object.
    
    Parameters:
    c - character stored in this buffer location
  - setField
```
protected void setField(RW3270Field field)
```
    Creates a pointer to the RW3270Field object that 'contains' this character.
    
    Parameters:
    field - the field in which this character is contained
  - setFieldAttribute
```
protected void setFieldAttribute(short in)
```
    Stores the short that represents the FA
    
    Parameters:
    in - DOCUMENT ME!
  - setForeground
```
protected void setForeground(short in)
```
    Sets the foreground (font) color for this character/field
    
    Parameters:
    in - DOCUMENT ME!
  - setHighlighting
```
protected void setHighlighting(short in)
```
    Sets the highlighting attributes for this character/startField (assuming it's a StartField.)
    
    Parameters:
    in - DOCUMENT ME!
  - setOutlining
```
protected void setOutlining(short in)
```
    Sets the outlining attributes for this character/startField (assuming it's a StartField.)
    
    Parameters:
    in - DOCUMENT ME!
  - setStartField
```
protected void setStartField()
```
    Sets this position in the data buffer as a start field
  - setValidation
```
protected void setValidation(short in)
```
    Sets the validation attributes for this character/field.
    
    Parameters:
    in - DOCUMENT ME!

Class RW3270Char

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

HL_DEFAULT

HL_NORMAL

HL_BLINK

HL_REVERSE

HL_UNDERSCORE

HL_INTENSIFY

BGCOLOR_DEFAULT

FGCOLOR_DEFAULT

BLUE

RED

PINK

GREEN

TURQUOISE

YELLOW

BLACK

DEEP_BLUE

ORANGE

PURPLE

PALE_GREEN

PALE_TURQUOISE

GREY

WHITE

OL_NONE

OL_UNDER

OL_RIGHT

OL_OVER

OL_LEFT

OL_UNDER_RIGHT

OL_UNDER_OVER

OL_UNDER_LEFT

OL_RIGHT_OVER

OL_RIGHT_LEFT

OL_OVER_LEFT

OL_OVER_RIGHT_UNDER

OL_UNDER_RIGHT_LEFT

OL_OVER_LEFT_UNDER

OL_OVER_RIGHT_LEFT

OL_RECTANGLE

Constructor Detail

RW3270Char

Method Detail

getBackground

getChar

getDisplayChar

getField

getFieldAttribute

getForeground

getOutlining

getPosition

isBold

isHidden

isNumeric

isProtected

isProtected

isStartField

isHighIntensity

toString

clear

getHighlighting

isModified

isModified

setBackground

setChar

setField

setFieldAttribute

setForeground

setHighlighting

setOutlining

setStartField

setValidation