All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.as400.access.SCS5219Writer

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

public class SCS5219Writer
extends SCS5224Writer
The SCS5219Writer class writes an SCS 5219 data stream to an output stream, translating characters into bytes of the specified CCSID. SCS5219Writer extends SCS5224Writer and adds support for left margin, underline, form type (paper or envelope), form size, print quality, code page, character set, source drawer number, and destination drawer number.

See Also:
SCS5224Writer

Variable Index

 o QUALITY_DRAFT
Constant value for draft print quality.
 o QUALITY_NEAR_LETTER
Constant value for near letter print quality.

Constructor Index

 o SCS5219Writer(OutputStream)
Constructs a SCS5219Writer. Deprecated.
 o SCS5219Writer(OutputStream, int)
Constructs a SCS5219Writer. Deprecated.
 o SCS5219Writer(OutputStream, int, AS400)
Constructs a SCS5219Writer.
 o SCS5219Writer(OutputStream, String)
Constructs a SCS5219Writer. Deprecated.

Method Index

 o endPage()
Ends current page.
 o setCodePage(int, int)
Sends Set GCGID through GCID (SCG) command to set the code page and character set.
 o setCPI(int)
Sets characters per inch.
 o setDestinationDrawer(int)
Sets destination drawer number.
 o setEnvelopeSize(double, double)
Sets envelope size.
 o setLeftMargin(double)
Sets the left margin.
 o setPaperSize(double, double)
Sets paper size.
 o setQuality(int)
Sets quality printing.
 o setSourceDrawer(int)
Sets source drawer number.
 o setUnderline(boolean)
Sets underline on or off.

Variables

 o QUALITY_DRAFT
 public static final int QUALITY_DRAFT
Constant value for draft print quality.

 o QUALITY_NEAR_LETTER
 public static final int QUALITY_NEAR_LETTER
Constant value for near letter print quality.

Constructors

 o SCS5219Writer
 public SCS5219Writer(OutputStream out)
Note: SCS5219Writer() is deprecated. Replaced by SCS5219Writer(OutputStream, int, AS400). Any SCS5219Writer object that is created without specifying an AS400 system object on its constructor may not behave as expected in certain environments.

Constructs a SCS5219Writer. The default encoding will be used.

Parameters:
out - An OutputStream.
 o SCS5219Writer
 public SCS5219Writer(OutputStream out,
                      int ccsid) throws UnsupportedEncodingException
Note: SCS5219Writer() is deprecated. Replaced by SCS5219Writer(OutputStream, int, AS400). Any SCS5219Writer object that is created without specifying an AS400 system object on its constructor may not behave as expected in certain environments.

Constructs a SCS5219Writer.

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

Parameters:
out - An OutputStream.
ccsid - The name of the target CCSID to be used.
system - The system.
Throws: UnsupportedEncodingException
If ccsid is invalid.
 o SCS5219Writer
 public SCS5219Writer(OutputStream out,
                      String encoding) throws UnsupportedEncodingException
Note: SCS5219Writer() is deprecated. Replaced by SCS5219Writer(OutputStream, int, AS400). Any SCS5219Writer object that is created without specifying an AS400 system object on its constructor may not behave as expected in certain environments.

Constructs a SCS5219Writer.

Parameters:
out - An OutputStream.
encoding - The name of the target encoding to be used.
Throws: UnsupportedEncodingException
If encoding is invalid.

Methods

 o endPage
 public void endPage() throws IOException
Ends current page.

Throws: IOException
If an error occurs while communicating with the AS/400.
Overrides:
endPage in class SCS5256Writer
 o setCodePage
 public void setCodePage(int codepage,
                         int charset) throws IOException
Sends Set GCGID through GCID (SCG) command to set the code page and character set. This method must be called before the first character is printed. Invalid values of codepage and charset may cause a printer exception.

Parameters:
codepage - The code page to be set.
charset - The new character set.
Throws: IOException
If an error occurs while communicating with the AS/400.
 o setCPI
 public void setCPI(int cpi) throws IOException
Sets characters per inch. All following text will be in the set pitch.

Parameters:
cpi - The characters per inch. Valid values are 10, 12 and 15.
Throws: IOException
If an error occurs while communicating with the AS/400.
Overrides:
setCPI in class SCS5224Writer
 o setDestinationDrawer
 public void setDestinationDrawer(int drawer)
Sets destination drawer number. This is set once at the start of each page. Changes in the destination drawer will not take effect until the next new page.

Parameters:
drawer - The number of the drawer to select. Valid values are 1 to 255.
 o setEnvelopeSize
 public void setEnvelopeSize(double width,
                             double length)
Sets envelope size. This is set once at the start of each page. Changes in the envelope size will not take effect until the next new page.

Parameters:
width - The envelope width in inches. Valid values are 0.1 to 14.0.
length - The envelope width in inches. Valid values are 0.1 to 14.0.
 o setLeftMargin
 public void setLeftMargin(double leftMargin) throws IOException
Sets the left margin. Call this method only while at a line boundary or a printer exception will occur.

Parameters:
leftMargin - The margin distance from the left paper edge in inches. Valid values are 0.0 to 14.0.
Throws: IOException
If an error occurs while communicating with the AS/400.
 o setPaperSize
 public void setPaperSize(double width,
                          double length)
Sets paper size. This is set once at the start of each page. Changes in the paper size will not take effect until the next new page.

Parameters:
width - The paper width in inches. Valid values are 0.1 to 14.0.
length - The paper length in inches. Valid values are 0.1 to 14.0.
 o setQuality
 public void setQuality(int quality)
Sets quality printing. This is set once at the start of each page. Changes in quality will not take effect until the next new page.

Parameters:
quality - The type of quality printing. Valid values are QUALITY_DRAFT and QUALITY_NEAR_LETTER.
 o setSourceDrawer
 public void setSourceDrawer(int drawer)
Sets source drawer number. This is set once at the start of each page. Changes in the source drawer will not take effect until the next new page.

Parameters:
drawer - The number of the drawer to select. Valid values are 1 to 255.
 o setUnderline
 public void setUnderline(boolean ul) throws IOException
Sets underline on or off.

Parameters:
ul - If true, turns underline on; if false, turns underline off.
Throws: IOException
If an error occurs while communicating with the AS/400.

All Packages  Class Hierarchy  This Package  Previous  Next  Index