com.ibm.as400.access
Class SCS5553Writer

java.lang.Object
  |
  +--java.io.Writer
        |
        +--java.io.OutputStreamWriter
              |
              +--com.ibm.as400.access.SCS5256Writer
                    |
                    +--com.ibm.as400.access.SCS5224Writer
                          |
                          +--com.ibm.as400.access.SCS5553Writer

public class SCS5553Writer
extends SCS5224Writer

The SCS5553Writer class writes an SCS 5553 data stream to an output stream, translating characters into bytes of the specified CCSID. SCS5553Writer extends the SCS5224Writer and adds support for presentation of control characters, character rotation, grid lines, and font scaling. The 5553 is a DBCS data stream.

See Also:
SCS5224Writer

Field Summary
static int CHARACTER_NORMAL
          Constant for normal character rotation.
static int CHARACTER_ROTATED
          Constant for 270-degree character rotation.
static int SCALE_DOUBLE_HORIZONTAL
          Constant for double horizontal font scaling.
static int SCALE_REGULAR
          Constant for regular font scaling.
static int SETCCP_BLANK_CODE
          Constant for SO/SI are printed as A/N/K blank code (default)
static int SETCCP_NO_PRINT
          Constant for all control characters take no printing positions
static int SETCCP_SI_BLANK
          Constant for SO takes no position, SI takes 2 A/N/K blanks
 
Fields inherited from class java.io.Writer
lock
 
Constructor Summary
SCS5553Writer(java.io.OutputStream out)
          Deprecated. Replaced by SCS5553Writer(OutputStream, int, AS400). Any SCS5553Writer object that is created without specifying an AS400 system object on its constructor may not behave as expected in certain environments.
SCS5553Writer(java.io.OutputStream out, int ccsid)
          Deprecated. Replaced by SCS5553Writer(OutputStream, int, AS400). Any SCS5553Writer object that is created without specifying an AS400 system object on its constructor may not behave as expected in certain environments.
SCS5553Writer(java.io.OutputStream out, int ccsid, AS400 system)
          Constructs a SCS5553Writer.
SCS5553Writer(java.io.OutputStream out, java.lang.String encoding)
          Deprecated. Replaced by SCS5553Writer(OutputStream, int, AS400). Any SCS5553Writer object that is created without specifying an AS400 system object on its constructor may not behave as expected in certain environments.
 
Method Summary
 void printHorizontalGridLine(double start, double stop)
          Prints a horizontal grid line at the current line.
 void setCharacterRotation(int rotation)
          Sets character rotation.
 void setControlCharPresentation(int set)
          Defines the action taken by the SI/SO characters.
 void setFontScaling(int scale)
          Sets font scaling.
 void startVerticalGridLines(double[] positions)
          Starts printing vertical grid lines at the specified positions.
 void stopVerticalGridLines()
          Stops printing vertical grid lines.
 
Methods inherited from class com.ibm.as400.access.SCS5224Writer
setCPI, setLPI
 
Methods inherited from class com.ibm.as400.access.SCS5256Writer
absoluteHorizontalPosition, absoluteVerticalPosition, carriageReturn, close, endPage, flush, getEncoding, lineFeed, newLine, relativeHorizontalPosition, relativeVerticalPosition, setVerticalFormat, write, write, write, write
 
Methods inherited from class java.io.Writer
write
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CHARACTER_NORMAL

public static final int CHARACTER_NORMAL
Constant for normal character rotation.

CHARACTER_ROTATED

public static final int CHARACTER_ROTATED
Constant for 270-degree character rotation.

SCALE_DOUBLE_HORIZONTAL

public static final int SCALE_DOUBLE_HORIZONTAL
Constant for double horizontal font scaling.

SCALE_REGULAR

public static final int SCALE_REGULAR
Constant for regular font scaling.

SETCCP_NO_PRINT

public static final int SETCCP_NO_PRINT
Constant for all control characters take no printing positions

SETCCP_BLANK_CODE

public static final int SETCCP_BLANK_CODE
Constant for SO/SI are printed as A/N/K blank code (default)

SETCCP_SI_BLANK

public static final int SETCCP_SI_BLANK
Constant for SO takes no position, SI takes 2 A/N/K blanks
Constructor Detail

SCS5553Writer

public SCS5553Writer(java.io.OutputStream out)
Deprecated. Replaced by SCS5553Writer(OutputStream, int, AS400). Any SCS5553Writer object that is created without specifying an AS400 system object on its constructor may not behave as expected in certain environments.

Constructs a SCS5553Writer. The default encoding will be used.
Parameters:
out - An OutputStream.

SCS5553Writer

public SCS5553Writer(java.io.OutputStream out,
                     int ccsid)
              throws java.io.UnsupportedEncodingException
Deprecated. Replaced by SCS5553Writer(OutputStream, int, AS400). Any SCS5553Writer object that is created without specifying an AS400 system object on its constructor may not behave as expected in certain environments.

Constructs a SCS5553Writer.
Parameters:
out - An OutputStream.
ccsid - The name of the target CCSID to be used.
Throws:
java.io.UnsupportedEncodingException - If ccsid is invalid.

SCS5553Writer

public SCS5553Writer(java.io.OutputStream out,
                     int ccsid,
                     AS400 system)
              throws java.io.UnsupportedEncodingException
Constructs a SCS5553Writer.
Parameters:
out - An OutputStream.
ccsid - The name of the target CCSID to be used.
system - The system.
Throws:
java.io.UnsupportedEncodingException - If ccsid is invalid.

SCS5553Writer

public SCS5553Writer(java.io.OutputStream out,
                     java.lang.String encoding)
              throws java.io.UnsupportedEncodingException
Deprecated. Replaced by SCS5553Writer(OutputStream, int, AS400). Any SCS5553Writer object that is created without specifying an AS400 system object on its constructor may not behave as expected in certain environments.

Constructs a SCS5553Writer.
Parameters:
out - An OutputStream.
encoding - The name of the target encoding to be used.
Throws:
java.io.UnsupportedEncodingException - If encoding is invalid.
Method Detail

printHorizontalGridLine

public void printHorizontalGridLine(double start,
                                    double stop)
                             throws java.io.IOException
Prints a horizontal grid line at the current line.
Parameters:
start - The absolute position in inches, from the left paper edge, to start the grid line.
stop - The absolute position in inches, from the left paper edge, to stop the grid line.
Throws:
java.io.IOException - If an error occurs while communicating with the AS/400.

setCharacterRotation

public void setCharacterRotation(int rotation)
                          throws java.io.IOException
Sets character rotation. Characters can be rotated 270 degrees for vertical printing.
Parameters:
rotation - The value of character rotation. Valid values are CHARACTER_NORMAL and CHARACTER_ROTATED.
Throws:
java.io.IOException - If an error occurs while communicating with the AS/400.

setControlCharPresentation

public void setControlCharPresentation(int set)
                                throws java.io.IOException
Defines the action taken by the SI/SO characters. These characters are either not printed at all or printed as spaces.
Parameters:
set - The parameter that defines the presentation option. Valid values are SETCCP_NO_PRINT, SETCCP_BLANK_CODE, and SETCCP_SI_BLANK.
Throws:
java.io.IOException - If an error occurs while communicating with the AS/400.

setFontScaling

public void setFontScaling(int scale)
                    throws java.io.IOException
Sets font scaling. Allows doubling the horizontal size of the font. Applies to both A/N/K and IGC characters. Actual characters per inch is affected.
Parameters:
scale - The value of font scaling. Valid values are SCALE_REGULAR and SCALE_DOUBLE_HORIZONTAL.
Throws:
java.io.IOException - If an error occurs while communicating with the AS/400.

startVerticalGridLines

public void startVerticalGridLines(double[] positions)
                            throws java.io.IOException
Starts printing vertical grid lines at the specified positions.
Parameters:
positions - An array of absolute positions in inches, from the left paper edge, to start a vertical grid line.
Throws:
java.io.IOException - If an error occurs while communicating with the AS/400.

stopVerticalGridLines

public void stopVerticalGridLines()
                           throws java.io.IOException
Stops printing vertical grid lines.
Throws:
java.io.IOException - If an error occurs while communicating with the AS/400.