RW3270Field (FreeHost3270 modules suite 0.2-CURRENT API)

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

```
public class RW3270Field
extends Object
```
Represents a Tn3270 'Field' instance. You can obtain an enumeration of RW3270Field objects by calling RW3270.getFields(). You can also get the 'current' field. (The field that the current cursor position is located in) by calling RW3270.getField(). Finally, you can get the RW3270Field object at any given cursor position by calling RW3270.getField(int cursorPosition).
This class is useful for working with 3270 fields. For example, if you wanted to enter data from a GUI textField:

Since:

0.1

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BLACK`
`static int`	`BLUE`
`static int`	`DEEP_BLUE`
`static int`	`DEFAULT_BGCOLOR`
`static int`	`DEFAULT_FGCOLOR`
`static int`	`GREEN`
`static int`	`GREY`
`static int`	`ORANGE`
`static int`	`PALE_GREEN`
`static int`	`PALE_TURQUOISE`
`static int`	`PINK`
`static int`	`PURPLE`
`static int`	`RED`
`static int`	`TURQUOISE`
`static int`	`WHITE`
`static int`	`YELLOW`

Constructor Summary

Constructors
Modifier Constructor and Description

protected RW3270Field(RW3270Char fa, RW3270 rw)
Not seen by end-programmers.

Constructors
Modifier	Constructor and Description
`protected`	`RW3270Field(RW3270Char fa, RW3270 rw)` Not seen by end-programmers.

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`getBackgroundColor()`
`int`	`getBegin()` Returns the data buffer address of the first character in this field.
`RW3270Char[]`	`getChars()` Gets an array of RW3270Char objects representing the contents of this field.
`char[]`	`getDisplayChars()` Gets an array of characters containing the display representation of this field.
`int`	`getEnd()` Returns the data buffer address of the last character in this field.
`int`	`getFieldAttribute()`
`int`	`getForegroundColor()`
`int`	`getHighlighting()`
`boolean`	`isBold()`
`boolean`	`isHidden()`
`boolean`	`isHighIntensity()`
`boolean`	`isModified()`
`void`	`isModified(boolean b)` Deprecated. since 0.2 preferred method is setModified
`boolean`	`isNumeric()`
`boolean`	`isProtected()` Checks the field to see if the current field is an 'input' field (unprotected)
`protected void`	`isProtected(boolean b)`
`protected void`	`setBegin(int i)`
`void`	`setData(String s)` If the field is an input field (unprotected), this method will set the field to the specified String.
`protected void`	`setEnd(int i)` Sets the data buffer address of the last character in this field.
`void`	`setModified(boolean b)` Sets the MDT for this field.
`int`	`size()` This method returns the size, in characters of the current field.
`String`	`toString()` Returns a string representation of the field.

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

- Field Detail
  - DEFAULT_BGCOLOR
```
public static final int DEFAULT_BGCOLOR
```
    See Also:
    Constant Field Values
  - BLUE
```
public static final int BLUE
```
    See Also:
    Constant Field Values
  - RED
```
public static final int RED
```
    See Also:
    Constant Field Values
  - PINK
```
public static final int PINK
```
    See Also:
    Constant Field Values
  - GREEN
```
public static final int GREEN
```
    See Also:
    Constant Field Values
  - TURQUOISE
```
public static final int TURQUOISE
```
    See Also:
    Constant Field Values
  - YELLOW
```
public static final int YELLOW
```
    See Also:
    Constant Field Values
  - DEFAULT_FGCOLOR
```
public static final int DEFAULT_FGCOLOR
```
    See Also:
    Constant Field Values
  - BLACK
```
public static final int BLACK
```
    See Also:
    Constant Field Values
  - DEEP_BLUE
```
public static final int DEEP_BLUE
```
    See Also:
    Constant Field Values
  - ORANGE
```
public static final int ORANGE
```
    See Also:
    Constant Field Values
  - PURPLE
```
public static final int PURPLE
```
    See Also:
    Constant Field Values
  - PALE_GREEN
```
public static final int PALE_GREEN
```
    See Also:
    Constant Field Values
  - PALE_TURQUOISE
```
public static final int PALE_TURQUOISE
```
    See Also:
    Constant Field Values
  - GREY
```
public static final int GREY
```
    See Also:
    Constant Field Values
  - WHITE
```
public static final int WHITE
```
    See Also:
    Constant Field Values
- Constructor Detail
  - RW3270Field
```
protected RW3270Field(RW3270Char fa,
           RW3270 rw)
```
    Not seen by end-programmers. The data stream handles the creation and destruction of field objects.
- Method Detail
  - isProtected
```
public boolean isProtected()
```
    Checks the field to see if the current field is an 'input' field (unprotected)
    
    Returns:
    true if the field is protected, false otherwise.
  - isProtected
```
protected void isProtected(boolean b)
```
  - setBegin
```
protected void setBegin(int i)
```
  - getBegin
```
public int getBegin()
```
    Returns the data buffer address of the first character in this field.
    
    Returns:
    the data buffer address of the FA (first character) in this field.
  - setEnd
```
protected void setEnd(int i)
```
    Sets the data buffer address of the last character in this field. (Not visible to end-programmers... handled by the data stream)
  - getEnd
```
public int getEnd()
```
    Returns the data buffer address of the last character in this field.
    
    Returns:
    the data buffer address of the last character in this field
  - isModified
```
public boolean isModified()
```
    Returns:
    true if this field has been modified by the operator
  - isModified
```
public void isModified(boolean b)
                throws IsProtectedException
```
    Deprecated. since 0.2 preferred method is setModified
    
    Throws:
    
    IsProtectedException
  - setModified
```
public void setModified(boolean b)
                 throws IsProtectedException
```
    Sets the MDT for this field.
    If you change the data via the setData() method this method is called for you automatically. Otherwise, be sure to call this method whenever you change the data in an unprotected (input) field.
    
    Parameters:
    b - true if the field has been modified.
    
    Throws:
    
    IsProtectedException
  - getChars
```
public RW3270Char[] getChars()
```
    Gets an array of RW3270Char objects representing the contents of this field.
    This method is only useful if you need to operate on the individual RW3270Char objects. For display of data buffer (screen), use getDisplayChars() instead.
    
    Returns:
    array of RW3270Char objects.
    See Also:
    RW3270Char
  - getDisplayChars
```
public char[] getDisplayChars()
```
    Gets an array of characters containing the display representation of this field.
    Specifically, hidden and null characters are represented by an ' '
    
    Returns:
    array of characters.
  - setData
```
public void setData(String s)
             throws IOException,
                    IsProtectedException
```
    If the field is an input field (unprotected), this method will set the field to the specified String. If the string is longer than the field, this method will throw an IOException.
    
    Parameters:
    s - The string to insert into this field
    
    Throws:
    
    IOException - thrown if the string is longer than the field
    
    IsProtectedException - thrown if the current field is protected
  - size
```
public int size()
```
    This method returns the size, in characters of the current field.
    Be aware that this includes the Field Attribute for the field, as well as the characters
    
    Returns:
    The size (in characters) of this Field object
  - getForegroundColor
```
public int getForegroundColor()
```
    Returns:
    the foreground (text) color of this field. (Corresponding to the color constants defined in the RW3270Char class)
  - getBackgroundColor
```
public int getBackgroundColor()
```
    Returns:
    the background color of this field. (Corresponding to the color constants defined in the RW3270Char class)
  - getHighlighting
```
public int getHighlighting()
```
    Returns:
    the highlighting scheme for this field. (Corresponding to the highlighting constants defined in the RW3270Char class)
  - isHidden
```
public boolean isHidden()
```
    Returns:
    true if the field is hidden (i.e. password field), dalse otherwise.
  - isBold
```
public boolean isBold()
```
    Returns:
    true if the field is bold, false if it is not.
  - isNumeric
```
public boolean isNumeric()
```
    Returns:
    True if the field only accepts numeric data, False if it will accept any alphanumeric input. Client implementations should test input if this method returns true and reject it if it is not numeric/
  - isHighIntensity
```
public boolean isHighIntensity()
```
  - getFieldAttribute
```
public int getFieldAttribute()
```
  - toString
```
public String toString()
```
    Returns a string representation of the field.
    
    Overrides:
    
    toString in class Object
    
    Since:
    
    0.2

Class RW3270Field

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_BGCOLOR

BLUE

RED

PINK

GREEN

TURQUOISE

YELLOW

DEFAULT_FGCOLOR

BLACK

DEEP_BLUE

ORANGE

PURPLE

PALE_GREEN

PALE_TURQUOISE

GREY

WHITE

Constructor Detail

RW3270Field

Method Detail

isProtected

isProtected

setBegin

getBegin

setEnd

getEnd

isModified

isModified

setModified

getChars

getDisplayChars

setData

size

getForegroundColor

getBackgroundColor

getHighlighting

isHidden

isBold

isNumeric

isHighIntensity

getFieldAttribute

toString