com.ibm.as400.access

Class SCS5553Writer

  • All Implemented Interfaces:
    java.io.Closeable, java.io.Flushable, java.lang.Appendable


    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

      Fields 
      Modifier and Type Field and Description
      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

      Constructors 
      Constructor and Description
      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.
    • Field Detail

      • CHARACTER_NORMAL

        public static final int CHARACTER_NORMAL
        Constant for normal character rotation.
        See Also:
        Constant Field Values
      • CHARACTER_ROTATED

        public static final int CHARACTER_ROTATED
        Constant for 270-degree character rotation.
        See Also:
        Constant Field Values
      • SCALE_DOUBLE_HORIZONTAL

        public static final int SCALE_DOUBLE_HORIZONTAL
        Constant for double horizontal font scaling.
        See Also:
        Constant Field Values
      • SCALE_REGULAR

        public static final int SCALE_REGULAR
        Constant for regular font scaling.
        See Also:
        Constant Field Values
      • SETCCP_NO_PRINT

        public static final int SETCCP_NO_PRINT
        Constant for all control characters take no printing positions
        See Also:
        Constant Field Values
      • SETCCP_BLANK_CODE

        public static final int SETCCP_BLANK_CODE
        Constant for SO/SI are printed as A/N/K blank code (default)
        See Also:
        Constant Field Values
      • SETCCP_SI_BLANK

        public static final int SETCCP_SI_BLANK
        Constant for SO takes no position, SI takes 2 A/N/K blanks
        See Also:
        Constant Field Values
    • 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

      • setCPI

        public void setCPI(int cpi)
                    throws java.io.IOException
        Sets characters per inch. All following text will be in the set pitch.
        Overrides:
        setCPI in class SCS5224Writer
        Parameters:
        cpi - The characters per inch. Valid values are 10, 12, 13.3, 15, 18 and 20 but we won't implement 13.3 for now
        Throws:
        java.io.IOException - If an error occurs while communicating with the system.
      • 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 system.
      • 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 system.
      • 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 system.
      • 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 system.
      • 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 system.
      • 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 system.