GXPrintObject (ApplinX API Specification)

java.lang.Object
- com.sabratec.ci.print.GXPrintObject

```
public class GXPrintObject
extends Object
```
This class implements one print job from the host. Every new print job requires a new print object. The object is created by the getPrint() method of the GXPrinter.

See Also:

GXPrinter.getPrint()

Constructor Summary

Constructors
Constructor and Description

GXPrintObject()

Constructors
Constructor and Description
`GXPrintObject()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`completeBuffer()` Completes the buffer using the printer session (if alive).
`String`	`getBuffer()` Returns the buffer that currently exists in the object as string.
`String`	`getBuffer(int size)` Retrieves a portion of the buffer.
`int`	`getBufferLength()` Returns the length of the current buffer.
`int`	`getError()`
`String`	`getErrorMessage()`
`GXIPageInterface`	`getPageAt(int index)` Returns the page at the specified index.
`int`	`getPageCount()` Returns the number of pages in the current print buffer, as they were analyzed by ApplinX.
`GXIPageInterface[]`	`getPages()` Returns an array of GXPage objects according to the current buffer in the print object.
`GXSCS[]`	`getSCSElements()` Returns an array of GXSCS objects that hold all the printer controls that were retrieved along with the current buffer.
`int`	`getSeqPrintNumber()` Returns the sequential print number ? the number of prints received from the host since the beginning of the current session.
`boolean`	`isComplete()` Returns true if the print object holds the complete buffer.
`boolean`	`isCurrentPrint()` Returns true if this print object is the printer session?s current print object.
`boolean`	`isEmpty()` Returns true if the current print object is empty.
`boolean`	`isPassThroughData()`
`void`	`setCharactersPerLine(int maxCharactersPerLine)` Sets the number of characters per page.
`void`	`setLinesPerPage(int maxLinesPerPage)` Sets the number of lines per page.
`String`	`toString()`

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

- Constructor Detail
  - GXPrintObject
```
public GXPrintObject()
```
- Method Detail
  - isPassThroughData
```
public boolean isPassThroughData()
```
  - isCurrentPrint
```
public boolean isCurrentPrint()
```
    Returns true if this print object is the printer session?s current print object.
    
    Returns:
    
    whether this print object is the current print in the printer session.
  - isComplete
```
public boolean isComplete()
```
    Returns true if the print object holds the complete buffer. If it returns false further requests must be sent to the server to retrieve the rest of the buffer.
    
    Returns:
    
    whether the print buffer is complete.
  - isEmpty
```
public boolean isEmpty()
```
    Returns true if the current print object is empty.
  - getSeqPrintNumber
```
public int getSeqPrintNumber()
```
    Returns the sequential print number ? the number of prints received from the host since the beginning of the current session.
    
    Returns:
    
    the sequential print number since the current print session was started.
  - getBuffer
```
public String getBuffer()
```
    Returns the buffer that currently exists in the object as string.
  - getBuffer
```
public String getBuffer(int size)
```
    Retrieves a portion of the buffer.
    
    Parameters:
    
    size - - optional - retrieves a portion of the buffer.
  - getPageAt
```
public GXIPageInterface getPageAt(int index)
```
    Returns the page at the specified index. Page starts from zero.
    
    Parameters:
    
    index - - starts from 0.
    
    Returns:
    
    analyzed page at the specified index.
  - getPages
```
public GXIPageInterface[] getPages()
```
    Returns an array of GXPage objects according to the current buffer in the print object.
  - getPageCount
```
public int getPageCount()
```
    Returns the number of pages in the current print buffer, as they were analyzed by ApplinX.
    
    Returns:
    
    number of pages according to the current buffer in the object.
  - getBufferLength
```
public int getBufferLength()
```
    Returns the length of the current buffer.
    
    Returns:
    
    length of the current buffer.
  - getSCSElements
```
public GXSCS[] getSCSElements()
```
    Returns an array of GXSCS objects that hold all the printer controls that were retrieved along with the current buffer.
    
    Returns:
    
    an array of GXSCS objects for the current print buffer.
  - completeBuffer
```
public int completeBuffer()
```
    Completes the buffer using the printer session (if alive). Sends a request to the server to complete the current buffer. This method can be used only if the print object is the current print object and if its status is not complete already.
  - getError
```
public int getError()
```
  - getErrorMessage
```
public String getErrorMessage()
```
  - setLinesPerPage
```
public void setLinesPerPage(int maxLinesPerPage)
```
    Sets the number of lines per page. Only applicable if you want to change the current print job settings. The default is the setting of the printer session?s configuration, which you configured at the start of the print job.
    
    Parameters:
    
    maxLinesPerPage - the maximum lines per page.
  - setCharactersPerLine
```
public void setCharactersPerLine(int maxCharactersPerLine)
```
    Sets the number of characters per page. Only applicable if you want to change the current print job settings. The default is the setting of the printer session?s configuration, which you configured at the start of the print job.
    
    Parameters:
    
    maxCharactersPerLine - the maximum characters per line.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class GXPrintObject

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GXPrintObject

Method Detail

isPassThroughData

isCurrentPrint

isComplete

isEmpty

getSeqPrintNumber

getBuffer

getBuffer

getPageAt

getPages

getPageCount

getBufferLength

getSCSElements

completeBuffer

getError

getErrorMessage

setLinesPerPage

setCharactersPerLine

toString