ReportGenerator (NetPhantom® 7.7 Java API Specification)

java.lang.Object
- se.entra.phantom.server.ReportGenerator

```
public class ReportGenerator
extends Object
```
The report generator. Will only handle one single report at a time.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ADJ_CNTR` Constant defining the integer flag for centered text.
`static int`	`ADJ_LEFT` Constant defining the integer flag for left adjusted text.
`static int`	`ADJ_RGHT` Constant defining the integer flag for right adjusted text.
`static int`	`HEIGHT_A3P` Constant defining the width for A3 portrait size.
`static int`	`HEIGHT_A4P` Constant defining the width for A4 portrait size.
`static int`	`HEIGHT_A5P` Constant defining the width for A5 portrait size.
`static int`	`HEIGHT_LGP` Constant defining the width for Legal portrait size.
`static int`	`HEIGHT_LTP` Constant defining the width for Letter portrait size.
`static String`	`SIZE_A3L` Constant defining the predefined name for A3 landscape size.
`static String`	`SIZE_A3P` Constant defining the predefined name for A3 portrait size.
`static String`	`SIZE_A4L` Constant defining the predefined name for A4 landscape size.
`static String`	`SIZE_A4P` Constant defining the predefined name for A4 portrait size.
`static String`	`SIZE_A5L` Constant defining the predefined name for A5 landscape size.
`static String`	`SIZE_A5P` Constant defining the predefined name for A5 portrait size.
`static String`	`SIZE_LGL` Constant defining the predefined name for Legal landscape size.
`static String`	`SIZE_LGP` Constant defining the predefined name for Legal portrait size.
`static String`	`SIZE_LTL` Constant defining the predefined name for Legal landscape size.
`static String`	`SIZE_LTP` Constant defining the predefined name for Legal portrait size.
`static int`	`WIDTH_A3P` Constant defining the width for A3 portrait size.
`static int`	`WIDTH_A4P` Constant defining the width for A4 portrait size.
`static int`	`WIDTH_A5P` Constant defining the width for A5 portrait size.
`static int`	`WIDTH_LGP` Constant defining the width for Legal portrait size.
`static int`	`WIDTH_LTP` Constant defining the width for Letter portrait size.

Constructor Summary

Constructors
Constructor and Description

ReportGenerator(PhantomWorker worker)
Creates a new ReportGenerator.

Constructors
Constructor and Description
`ReportGenerator(PhantomWorker worker)` Creates a new ReportGenerator.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`dispose()` Disposes of everything before the Report generator is disposed of.
`PhantomWorker`	`getWorker()` Gets the PhantomWorker.
`String`	`parseCommand(String com, String p1, String p2, String p3, String p4, String p5)` Parses the commands to the report generator.

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

- Field Detail
  - ADJ_LEFT
```
public static final int ADJ_LEFT
```
    Constant defining the integer flag for left adjusted text.
    
    See Also:
    
    Constant Field Values
  - ADJ_RGHT
```
public static final int ADJ_RGHT
```
    Constant defining the integer flag for right adjusted text.
    
    See Also:
    
    Constant Field Values
  - ADJ_CNTR
```
public static final int ADJ_CNTR
```
    Constant defining the integer flag for centered text.
    
    See Also:
    
    Constant Field Values
  - SIZE_A3P
```
public static final String SIZE_A3P
```
    Constant defining the predefined name for A3 portrait size.
    
    See Also:
    
    Constant Field Values
  - SIZE_A3L
```
public static final String SIZE_A3L
```
    Constant defining the predefined name for A3 landscape size.
    
    See Also:
    
    Constant Field Values
  - SIZE_A4P
```
public static final String SIZE_A4P
```
    Constant defining the predefined name for A4 portrait size.
    
    See Also:
    
    Constant Field Values
  - SIZE_A4L
```
public static final String SIZE_A4L
```
    Constant defining the predefined name for A4 landscape size.
    
    See Also:
    
    Constant Field Values
  - SIZE_A5P
```
public static final String SIZE_A5P
```
    Constant defining the predefined name for A5 portrait size.
    
    See Also:
    
    Constant Field Values
  - SIZE_A5L
```
public static final String SIZE_A5L
```
    Constant defining the predefined name for A5 landscape size.
    
    See Also:
    
    Constant Field Values
  - SIZE_LGP
```
public static final String SIZE_LGP
```
    Constant defining the predefined name for Legal portrait size.
    
    See Also:
    
    Constant Field Values
  - SIZE_LGL
```
public static final String SIZE_LGL
```
    Constant defining the predefined name for Legal landscape size.
    
    See Also:
    
    Constant Field Values
  - SIZE_LTP
```
public static final String SIZE_LTP
```
    Constant defining the predefined name for Legal portrait size.
    
    See Also:
    
    Constant Field Values
  - SIZE_LTL
```
public static final String SIZE_LTL
```
    Constant defining the predefined name for Legal landscape size.
    
    See Also:
    
    Constant Field Values
  - WIDTH_A3P
```
public static final int WIDTH_A3P
```
    Constant defining the width for A3 portrait size.
    
    See Also:
    
    Constant Field Values
  - HEIGHT_A3P
```
public static final int HEIGHT_A3P
```
    Constant defining the width for A3 portrait size.
    
    See Also:
    
    Constant Field Values
  - WIDTH_A4P
```
public static final int WIDTH_A4P
```
    Constant defining the width for A4 portrait size.
    
    See Also:
    
    Constant Field Values
  - HEIGHT_A4P
```
public static final int HEIGHT_A4P
```
    Constant defining the width for A4 portrait size.
    
    See Also:
    
    Constant Field Values
  - WIDTH_A5P
```
public static final int WIDTH_A5P
```
    Constant defining the width for A5 portrait size.
    
    See Also:
    
    Constant Field Values
  - HEIGHT_A5P
```
public static final int HEIGHT_A5P
```
    Constant defining the width for A5 portrait size.
    
    See Also:
    
    Constant Field Values
  - WIDTH_LGP
```
public static final int WIDTH_LGP
```
    Constant defining the width for Legal portrait size.
    
    See Also:
    
    Constant Field Values
  - HEIGHT_LGP
```
public static final int HEIGHT_LGP
```
    Constant defining the width for Legal portrait size.
    
    See Also:
    
    Constant Field Values
  - WIDTH_LTP
```
public static final int WIDTH_LTP
```
    Constant defining the width for Letter portrait size.
    
    See Also:
    
    Constant Field Values
  - HEIGHT_LTP
```
public static final int HEIGHT_LTP
```
    Constant defining the width for Letter portrait size.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ReportGenerator
```
public ReportGenerator(PhantomWorker worker)
```
    Creates a new ReportGenerator. Will automatically create a ReportRequester, that will handle the communication with the ReportPrinter in the client.
    
    Parameters:
    
    worker - The PhantomWorker that asked for the creation of the ReportGenerator.
- Method Detail
  - dispose
```
public void dispose()
```
    Disposes of everything before the Report generator is disposed of.
  - parseCommand
```
public String parseCommand(String com,
                           String p1,
                           String p2,
                           String p3,
                           String p4,
                           String p5)
```
    Parses the commands to the report generator.
    
    Parameters:
    
    com - The command to execute.
    
    p1 - The first parameter to the command.
    
    p2 - The second parameter to the command.
    
    p3 - The third parameter to the command.
    
    p4 - The fourth parameter to the command.
    
    p5 - The fifth parameter to the command.
    
    Returns:
    
    An integer value indicating the result of the command.
  - getWorker
```
public PhantomWorker getWorker()
```
    Gets the PhantomWorker.
    
    Returns:
    
    The PhantomWorker.

Class ReportGenerator

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ADJ_LEFT

ADJ_RGHT

ADJ_CNTR

SIZE_A3P

SIZE_A3L

SIZE_A4P

SIZE_A4L

SIZE_A5P

SIZE_A5L

SIZE_LGP

SIZE_LGL

SIZE_LTP

SIZE_LTL

WIDTH_A3P

HEIGHT_A3P

WIDTH_A4P

HEIGHT_A4P

WIDTH_A5P

HEIGHT_A5P

WIDTH_LGP

HEIGHT_LGP

WIDTH_LTP

HEIGHT_LTP

Constructor Detail

ReportGenerator

Method Detail

dispose

parseCommand

getWorker