DataStream3270Printer (NetPhantom® 7.7 Java API Specification)

java.lang.Object
- se.entra.phantom.server.tn3270e.DataStream3270
- - se.entra.phantom.server.tn3270e.DataStream3270Printer

public class DataStream3270Printer
extends DataStream3270

Handles the 3270 printer data stream.

Field Summary

Fields
Modifier and Type	Field and Description
`static char`	`ASCII_FA` Special ASCII code: Field Attribute.
`static int`	`ATTR_BASICMASK` The basic attribute mask when getting the attribute to send it to host.
`static int`	`ATTR_EXTENDEDCOLORMASK` The mask used to find out if a character or field attribute has extended color properties.
`static int`	`ATTR_FLAG_ALL_FLAGS`
`static int`	`ATTR_FLAG_BACKCOLOR`
`static int`	`ATTR_FLAG_CHARSET`
`static int`	`ATTR_FLAG_FORECOLOR`
`static int`	`ATTR_FLAG_HIGHLIGHT`
`static int`	`ATTR_FLAG_OUTLINE`
`static int`	`ATTR_GECHAR`
`static int`	`ATTR_HIGHLIGHT_BLINK`
`static int`	`ATTR_HIGHLIGHT_REVERSE`
`static int`	`ATTR_HIGHLIGHT_UNDERLINE`
`static int`	`ATTR_INTENSITY`
`static int`	`ATTR_MASK_ALL_EQUALIZE`
`static int`	`ATTR_MASK_ALL_EXTENDED`
`static int`	`ATTR_MASK_ALL_EXTENDED_BITS` The mask used to find out if a character or field attribute has extended properties, not including the GE character, the special character and the needs update flag.
`static int`	`ATTR_MASK_BACKCOLOR`
`static int`	`ATTR_MASK_CHARSET`
`static int`	`ATTR_MASK_FORECOLOR`
`static int`	`ATTR_MASK_HIGHLIGHT`
`static int`	`ATTR_MASK_OUTLINE`
`static int`	`ATTR_MODIFIED`
`static int`	`ATTR_NEEDSUPDATE`
`static int`	`ATTR_NONDISPLAY`
`static int`	`ATTR_NUMERIC`
`static int`	`ATTR_PROTECTED`
`static int`	`ATTR_RESERVED`
`static int`	`ATTR_SHIFT_BACKCOLOR`
`static int`	`ATTR_SHIFT_CHARSET`
`static int`	`ATTR_SHIFT_FORECOLOR`
`static int`	`ATTR_SHIFT_HIGHLIGHT`
`static int`	`ATTR_SHIFT_OUTLINE`
`static int`	`ATTR_SPECIALCHAR`
`static int`	`ATTR_TRANSGRAPHIC0`
`static int`	`ATTR_TRANSGRAPHIC1`
`static HostPrinterSettings`	`defaultHostPrinterSettings` The default host printer settings.
`static int`	`STATE_FULL`
`static int`	`STATE_NUMERIC`
`static int`	`STATE_PROTECTED`
`static int`	`STATE_SENDING`
`static int`	`STATE_SYSTEM`
`static int`	`STATE_WAITING`

Fields inherited from class se.entra.phantom.server.tn3270e.DataStream3270
hostSession, ORDER_FC_DUP, ORDER_FC_FM

Constructor Summary

Constructors
Constructor and Description

DataStream3270Printer(HostSession3270Printer hs)
Creates the 3270 data stream.

Constructors
Constructor and Description
`DataStream3270Printer(HostSession3270Printer hs)` Creates the 3270 data stream.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected String`	`checkPrinterOperation(int wcc, String text)` Checks the printer operation type in the WCC for LU3 type printers.
`protected boolean`	`doPrinterCR()` Checks if a printer will handle a CR order.
`protected boolean`	`doPrinterEM(int addr)` Checks if a printer will handle a EM order.
`protected boolean`	`doPrinterFF(int addr)` Checks if a printer will handle a FF order.
`protected boolean`	`doPrinterNL()` Checks if a printer will handle a NL order.
`HostPrinterSettings`	`getHostPrinterSettings()` Gets a copy of the host printer settings for this session.
`static void`	`loadSettings()` Loads the settings from the "server.ini" file.
`protected void`	`markEndOfPrint(int addr)` Marks the last printing address.
`void`	`printPage(Transaction trans)` Prints a page to a transaction.
`void`	`processPrintEOJ()` Processes the inbound print end-of-job.
`void`	`processSCSData(short[] inputBuf, int inputBufLen)` Processes the inbound SCS data stream.
`void`	`setHostPrinterSettings(HostPrinterSettings newSettings)` Sets new host printer settings for this session.
`protected int`	`sfQueryReplyCharacterSets(short[] buf, int n)` Responds to the character sets query.
`protected int`	`sfQueryReplyImplicitPartition(short[] buf, int n)` Responds to the implicit partition query.
`protected int`	`sfQueryReplySummary(short[] buf, int n)` Query Reply Summary.
`protected int`	`sfQueryReplyUseableArea(short[] buf, int n)` Query Reply Usable Area
`protected void`	`sfReadPartitionQuery()` Sends the reply for Read Partition Query structured field.
`protected void`	`sfReadPartitionQueryList(int reqtyp, int pos, short[] buf, int lenQCodes)` Sends the reply for Read Partition Query List structured field.
`protected void`	`writeCommand(int startPos, short[] buf, int buflen)` Write Command.

Methods inherited from class se.entra.phantom.server.tn3270e.DataStream3270
processData, readModifiedCommand, sfQueryReplyHighlighting, sfQueryReplyNull, sfQueryReplyReplyModes, write, writeDisplay

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

- Field Detail
  - defaultHostPrinterSettings
```
public static final HostPrinterSettings defaultHostPrinterSettings
```
    The default host printer settings.
  - STATE_SYSTEM
```
public static final int STATE_SYSTEM
```
    See Also:
    
    Constant Field Values
  - STATE_SENDING
```
public static final int STATE_SENDING
```
    See Also:
    
    Constant Field Values
  - STATE_WAITING
```
public static final int STATE_WAITING
```
    See Also:
    
    Constant Field Values
  - STATE_PROTECTED
```
public static final int STATE_PROTECTED
```
    See Also:
    
    Constant Field Values
  - STATE_FULL
```
public static final int STATE_FULL
```
    See Also:
    
    Constant Field Values
  - STATE_NUMERIC
```
public static final int STATE_NUMERIC
```
    See Also:
    
    Constant Field Values
  - ATTR_MODIFIED
```
public static final int ATTR_MODIFIED
```
    See Also:
    
    Constant Field Values
  - ATTR_RESERVED
```
public static final int ATTR_RESERVED
```
    See Also:
    
    Constant Field Values
  - ATTR_NONDISPLAY
```
public static final int ATTR_NONDISPLAY
```
    See Also:
    
    Constant Field Values
  - ATTR_INTENSITY
```
public static final int ATTR_INTENSITY
```
    See Also:
    
    Constant Field Values
  - ATTR_NUMERIC
```
public static final int ATTR_NUMERIC
```
    See Also:
    
    Constant Field Values
  - ATTR_PROTECTED
```
public static final int ATTR_PROTECTED
```
    See Also:
    
    Constant Field Values
  - ATTR_TRANSGRAPHIC0
```
public static final int ATTR_TRANSGRAPHIC0
```
    See Also:
    
    Constant Field Values
  - ATTR_TRANSGRAPHIC1
```
public static final int ATTR_TRANSGRAPHIC1
```
    See Also:
    
    Constant Field Values
  - ATTR_SHIFT_FORECOLOR
```
public static final int ATTR_SHIFT_FORECOLOR
```
    See Also:
    
    Constant Field Values
  - ATTR_SHIFT_BACKCOLOR
```
public static final int ATTR_SHIFT_BACKCOLOR
```
    See Also:
    
    Constant Field Values
  - ATTR_SHIFT_OUTLINE
```
public static final int ATTR_SHIFT_OUTLINE
```
    See Also:
    
    Constant Field Values
  - ATTR_SHIFT_HIGHLIGHT
```
public static final int ATTR_SHIFT_HIGHLIGHT
```
    See Also:
    
    Constant Field Values
  - ATTR_SHIFT_CHARSET
```
public static final int ATTR_SHIFT_CHARSET
```
    See Also:
    
    Constant Field Values
  - ATTR_MASK_FORECOLOR
```
public static final int ATTR_MASK_FORECOLOR
```
    See Also:
    
    Constant Field Values
  - ATTR_MASK_BACKCOLOR
```
public static final int ATTR_MASK_BACKCOLOR
```
    See Also:
    
    Constant Field Values
  - ATTR_MASK_OUTLINE
```
public static final int ATTR_MASK_OUTLINE
```
    See Also:
    
    Constant Field Values
  - ATTR_MASK_HIGHLIGHT
```
public static final int ATTR_MASK_HIGHLIGHT
```
    See Also:
    
    Constant Field Values
  - ATTR_MASK_CHARSET
```
public static final int ATTR_MASK_CHARSET
```
    See Also:
    
    Constant Field Values
  - ATTR_MASK_ALL_EXTENDED
```
public static final int ATTR_MASK_ALL_EXTENDED
```
    See Also:
    
    Constant Field Values
  - ATTR_MASK_ALL_EQUALIZE
```
public static final int ATTR_MASK_ALL_EQUALIZE
```
    See Also:
    
    Constant Field Values
  - ATTR_FLAG_FORECOLOR
```
public static final int ATTR_FLAG_FORECOLOR
```
    See Also:
    
    Constant Field Values
  - ATTR_FLAG_BACKCOLOR
```
public static final int ATTR_FLAG_BACKCOLOR
```
    See Also:
    
    Constant Field Values
  - ATTR_FLAG_OUTLINE
```
public static final int ATTR_FLAG_OUTLINE
```
    See Also:
    
    Constant Field Values
  - ATTR_FLAG_HIGHLIGHT
```
public static final int ATTR_FLAG_HIGHLIGHT
```
    See Also:
    
    Constant Field Values
  - ATTR_FLAG_CHARSET
```
public static final int ATTR_FLAG_CHARSET
```
    See Also:
    
    Constant Field Values
  - ATTR_FLAG_ALL_FLAGS
```
public static final int ATTR_FLAG_ALL_FLAGS
```
    See Also:
    
    Constant Field Values
  - ATTR_SPECIALCHAR
```
public static final int ATTR_SPECIALCHAR
```
    See Also:
    
    Constant Field Values
  - ATTR_GECHAR
```
public static final int ATTR_GECHAR
```
    See Also:
    
    Constant Field Values
  - ATTR_NEEDSUPDATE
```
public static final int ATTR_NEEDSUPDATE
```
    See Also:
    
    Constant Field Values
  - ATTR_MASK_ALL_EXTENDED_BITS
```
public static final int ATTR_MASK_ALL_EXTENDED_BITS
```
    The mask used to find out if a character or field attribute has extended properties, not including the GE character, the special character and the needs update flag.
    
    See Also:
    
    Constant Field Values
  - ATTR_HIGHLIGHT_BLINK
```
public static final int ATTR_HIGHLIGHT_BLINK
```
    See Also:
    
    Constant Field Values
  - ATTR_HIGHLIGHT_REVERSE
```
public static final int ATTR_HIGHLIGHT_REVERSE
```
    See Also:
    
    Constant Field Values
  - ATTR_HIGHLIGHT_UNDERLINE
```
public static final int ATTR_HIGHLIGHT_UNDERLINE
```
    See Also:
    
    Constant Field Values
  - ATTR_BASICMASK
```
public static final int ATTR_BASICMASK
```
    The basic attribute mask when getting the attribute to send it to host. Removed are ATTR_RESERVED (also ATTR_SPECIALCHAR), ATTR_NEEDSUPDATE and ATTR_CHARATTR_SET.
    
    See Also:
    
    Constant Field Values
  - ATTR_EXTENDEDCOLORMASK
```
public static final int ATTR_EXTENDEDCOLORMASK
```
    The mask used to find out if a character or field attribute has extended color properties.
    
    See Also:
    
    Constant Field Values
  - ASCII_FA
```
public static final char ASCII_FA
```
    Special ASCII code: Field Attribute.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DataStream3270Printer
```
public DataStream3270Printer(HostSession3270Printer hs)
```
    Creates the 3270 data stream.
- Method Detail
  - loadSettings
```
public static void loadSettings()
```
    Loads the settings from the "server.ini" file.
  - getHostPrinterSettings
```
public HostPrinterSettings getHostPrinterSettings()
```
    Gets a copy of the host printer settings for this session.
  - setHostPrinterSettings
```
public void setHostPrinterSettings(HostPrinterSettings newSettings)
```
    Sets new host printer settings for this session. The settings parameter is copied and any reference to the object is not used.
  - checkPrinterOperation
```
protected String checkPrinterOperation(int wcc,
                                       String text)
```
    Checks the printer operation type in the WCC for LU3 type printers.
    
    Overrides:
    
    checkPrinterOperation in class DataStream3270
  - doPrinterCR
```
protected boolean doPrinterCR()
```
    Checks if a printer will handle a CR order.
    
    Overrides:
    
    doPrinterCR in class DataStream3270
  - doPrinterNL
```
protected boolean doPrinterNL()
```
    Checks if a printer will handle a NL order.
    
    Overrides:
    
    doPrinterNL in class DataStream3270
  - doPrinterFF
```
protected boolean doPrinterFF(int addr)
```
    Checks if a printer will handle a FF order.
    
    Overrides:
    
    doPrinterFF in class DataStream3270
  - doPrinterEM
```
protected boolean doPrinterEM(int addr)
```
    Checks if a printer will handle a EM order.
    
    Overrides:
    
    doPrinterEM in class DataStream3270
  - markEndOfPrint
```
protected void markEndOfPrint(int addr)
```
    Marks the last printing address.
    
    Overrides:
    
    markEndOfPrint in class DataStream3270
  - writeCommand
```
protected void writeCommand(int startPos,
                            short[] buf,
                            int buflen)
                     throws IOException
```
    Write Command.
    The Write command writes data into specified locations of the character buffer. Data is stored in successive buffer locations until an order is encountered in the data stream.
    During the write operation, the buffer address is advanced one location as each character is stored.
    The buffer location where the entry of data starts depends on the starting location specified by the SBA order that follows the WCC. If an SBA does not follow the WCC, the starting location is the buffer address where the cursor is positioned.
    
    Overrides:
    
    writeCommand in class DataStream3270
    
    Throws:
    
    IOException - if an I/O error occurs.
  - sfReadPartitionQuery
```
protected void sfReadPartitionQuery()
                             throws IOException
```
    Sends the reply for Read Partition Query structured field.
    
    Throws:
    
    IOException - if an I/O error occurs.
  - sfReadPartitionQueryList
```
protected void sfReadPartitionQueryList(int reqtyp,
                                        int pos,
                                        short[] buf,
                                        int lenQCodes)
                                 throws IOException
```
    Sends the reply for Read Partition Query List structured field.
    
    Throws:
    
    IOException - if an I/O error occurs.
  - sfQueryReplySummary
```
protected int sfQueryReplySummary(short[] buf,
                                  int n)
```
    Query Reply Summary.
    Informs host of supported QCODES.
    
    Overrides:
    
    sfQueryReplySummary in class DataStream3270
  - sfQueryReplyUseableArea
```
protected int sfQueryReplyUseableArea(short[] buf,
                                      int n)
```
    Query Reply Usable Area
    Informs host of base information.
    
    Overrides:
    
    sfQueryReplyUseableArea in class DataStream3270
  - sfQueryReplyCharacterSets
```
protected int sfQueryReplyCharacterSets(short[] buf,
                                        int n)
                                 throws IOException
```
    Responds to the character sets query.
    
    Overrides:
    
    sfQueryReplyCharacterSets in class DataStream3270
    
    Throws:
    
    IOException - if an I/O error occurs.
  - sfQueryReplyImplicitPartition
```
protected int sfQueryReplyImplicitPartition(short[] buf,
                                            int n)
```
    Responds to the implicit partition query. Returns the size of the default screen 80x24 and the alternate one. If no alternate one exist, 80x24 is used.
    
    Overrides:
    
    sfQueryReplyImplicitPartition in class DataStream3270
  - processSCSData
```
public void processSCSData(short[] inputBuf,
                           int inputBufLen)
                    throws IOException
```
    Processes the inbound SCS data stream.
    
    Throws:
    
    IOException - if an I/O error occurs.
  - processPrintEOJ
```
public void processPrintEOJ()
                     throws IOException
```
    Processes the inbound print end-of-job.
    
    Throws:
    
    IOException - if an I/O error occurs.
  - printPage
```
public void printPage(Transaction trans)
```
    Prints a page to a transaction.

Class DataStream3270Printer

Field Summary

Fields inherited from class se.entra.phantom.server.tn3270e.DataStream3270

Constructor Summary

Method Summary

Methods inherited from class se.entra.phantom.server.tn3270e.DataStream3270

Methods inherited from class java.lang.Object

Field Detail

defaultHostPrinterSettings

STATE_SYSTEM

STATE_SENDING

STATE_WAITING

STATE_PROTECTED

STATE_FULL

STATE_NUMERIC

ATTR_MODIFIED

ATTR_RESERVED

ATTR_NONDISPLAY

ATTR_INTENSITY

ATTR_NUMERIC

ATTR_PROTECTED

ATTR_TRANSGRAPHIC0

ATTR_TRANSGRAPHIC1

ATTR_SHIFT_FORECOLOR

ATTR_SHIFT_BACKCOLOR

ATTR_SHIFT_OUTLINE

ATTR_SHIFT_HIGHLIGHT

ATTR_SHIFT_CHARSET

ATTR_MASK_FORECOLOR

ATTR_MASK_BACKCOLOR

ATTR_MASK_OUTLINE

ATTR_MASK_HIGHLIGHT

ATTR_MASK_CHARSET

ATTR_MASK_ALL_EXTENDED

ATTR_MASK_ALL_EQUALIZE

ATTR_FLAG_FORECOLOR

ATTR_FLAG_BACKCOLOR

ATTR_FLAG_OUTLINE

ATTR_FLAG_HIGHLIGHT

ATTR_FLAG_CHARSET

ATTR_FLAG_ALL_FLAGS

ATTR_SPECIALCHAR

ATTR_GECHAR

ATTR_NEEDSUPDATE

ATTR_MASK_ALL_EXTENDED_BITS

ATTR_HIGHLIGHT_BLINK

ATTR_HIGHLIGHT_REVERSE

ATTR_HIGHLIGHT_UNDERLINE

ATTR_BASICMASK

ATTR_EXTENDEDCOLORMASK

ASCII_FA

Constructor Detail

DataStream3270Printer

Method Detail

loadSettings

getHostPrinterSettings

setHostPrinterSettings

checkPrinterOperation

doPrinterCR

doPrinterNL

doPrinterFF

doPrinterEM

markEndOfPrint

writeCommand

sfReadPartitionQuery

sfReadPartitionQueryList

sfQueryReplySummary

sfQueryReplyUseableArea

sfQueryReplyCharacterSets

sfQueryReplyImplicitPartition

processSCSData

processPrintEOJ

printPage