Four Js Genero Report Writer
FourJs.Report.Runtime.AbstractStreamingClient Class Reference

Class for configuring output to the streaming client. More...

Inheritance diagram for FourJs.Report.Runtime.AbstractStreamingClient:
FourJs.Report.Runtime.LayoutedPagesConsumer FourJs.Report.Runtime.StreamingClientDefaultPrinter FourJs.Report.Runtime.StreamingClientNamedPrinter FourJs.Report.Runtime.StreamingClientPrinterDialog FourJs.Report.Runtime.StreamingClientViewer

Public Types

enum  Orientation { landscape, portrait }
 
enum  Client { GDC, GRV }
 

Static Public Attributes

static String legalCopyright = Version.CLASS_COPYRIGHT
 

Properties

abstract String previewType [get]
 
int fromPage [get, set]
 Sets the first page to be included in the document. fromPage an integer greater than zero and less than or equal to toPage More...
 
int toPage [get, set]
 Sets the first page to be included in the document. fromPage an integer greater than zero and less than or equal to toPage More...
 
bool embedFonts [get, set]
 Activates font embedding if true, external font referencing if false. The default value is true. embedFonts whether fonts are embedded in the document or external references are used More...
 
String charsetToEmbed [get, set]
 Selects a character set for font embedding whose characters will be embedded (if available in the selected fonts). The default value is "DEFAULT". More...
 
Orientation orientationRequested [get, set]
 Informs the renderer of the orientation of the paper in the printer as determined by the orientationRequested argument. Some printers (typically matrix printers) allow can be loaded with both landscape and portrait paper sheets. For most printers however the printer driver is not aware of the orientation of the paper sheets and so the jobs misprint on one of the two paper types (typically landscape). Calling this function allows to fix this deficiency manually. More...
 
bool compressOutput [get, set]
 Indicates whether or not the output will be compressed. Output compression is disabled by default. More...
 
Client client [get, set]
 Sets the client application as determined by the client argument. More...
 
String clientHost [get, set]
 Sets the host name of the remote client application. The default value is parsed from the environment variables FGLSERVER or GRWSERVER in this order. The variables are expected to follow the syntax "host:port" (same syntax as the DISPLAY variable of X Windows). If neither of them are set the default value "localhost" is used. More...
 
int clientPort [get, set]
 Sets the port number at which the client application is listening. The value is expected to be a unsigned 16 bit value. The default value is parsed from the environment variables FGLSERVER or GRWSERVER in this order. if The variables are expected to follow the syntax "host:port" (same syntax as the DISPLAY variable of X Windows). If neither of them are set the default value 6400 is used for GDC and 6401 is used for GRV. clientPort The port number at which the remote application is listening. More...
 

Detailed Description

Class for configuring output to the streaming client.

Streaming client

The streaming client option requires the streaming client component GRV (Genero report viewer) or GDC (Genero desktop client) to be up and running.

Font embedding

Fonts are embedded by default. Embedding is available for any font listed by the utility com.fourjs.report.main.FontInfo.

Processing large documents

The delay between input and output is one page and the client takes advantage of that displaying the pages immediately. Documents not containing "Page N of M" paginations exhibit nearly constant memory consumption while documents containing them have a linear consumption of about 20 KB per page. The paginations do not interfere with the streaming since a referencing mechanism is used to update the paginations at the end of a block when the total number of pages is known. Please not that printing will be delayed for pages containing such forward references until they are resolved. This delaying has no impact on memory consumption as the streaming client temporarily stores delayed pages on disk.

Property Documentation

String FourJs.Report.Runtime.AbstractStreamingClient.charsetToEmbed
getset

Selects a character set for font embedding whose characters will be embedded (if available in the selected fonts). The default value is "DEFAULT".

embedFonts

Client FourJs.Report.Runtime.AbstractStreamingClient.client
getset

Sets the client application as determined by the client argument.

String FourJs.Report.Runtime.AbstractStreamingClient.clientHost
getset

Sets the host name of the remote client application. The default value is parsed from the environment variables FGLSERVER or GRWSERVER in this order. The variables are expected to follow the syntax "host:port" (same syntax as the DISPLAY variable of X Windows). If neither of them are set the default value "localhost" is used.

clientPort

int FourJs.Report.Runtime.AbstractStreamingClient.clientPort
getset

Sets the port number at which the client application is listening. The value is expected to be a unsigned 16 bit value. The default value is parsed from the environment variables FGLSERVER or GRWSERVER in this order. if The variables are expected to follow the syntax "host:port" (same syntax as the DISPLAY variable of X Windows). If neither of them are set the default value 6400 is used for GDC and 6401 is used for GRV. clientPort The port number at which the remote application is listening.

clientHost

See also
client
Exceptions
ArgumentOutOfRangeExceptionif the port isn't an unsigned 16 bit value.
bool FourJs.Report.Runtime.AbstractStreamingClient.compressOutput
getset

Indicates whether or not the output will be compressed. Output compression is disabled by default.

bool FourJs.Report.Runtime.AbstractStreamingClient.embedFonts
getset

Activates font embedding if true, external font referencing if false. The default value is true. embedFonts whether fonts are embedded in the document or external references are used

int FourJs.Report.Runtime.AbstractStreamingClient.fromPage
getset

Sets the first page to be included in the document. fromPage an integer greater than zero and less than or equal to toPage

Exceptions
ArgumentOutOfRangeExceptionif the above condition is violated.
Orientation FourJs.Report.Runtime.AbstractStreamingClient.orientationRequested
getset

Informs the renderer of the orientation of the paper in the printer as determined by the orientationRequested argument. Some printers (typically matrix printers) allow can be loaded with both landscape and portrait paper sheets. For most printers however the printer driver is not aware of the orientation of the paper sheets and so the jobs misprint on one of the two paper types (typically landscape). Calling this function allows to fix this deficiency manually.

int FourJs.Report.Runtime.AbstractStreamingClient.toPage
getset

Sets the first page to be included in the document. fromPage an integer greater than zero and less than or equal to toPage

Exceptions
ArgumentOutOfRangeExceptionif the above condition is violated.