|
Four Js Genero Report Writer
|
Class for conversion of a XML data stream to a layouted PXML document via a ".4rp" template. This class exists for convenience and is a composition of the classes FourRpProcessor and PXMLLayouter containing the methods of both classes. For details refer to the respective documentation. More...
Public Member Functions | |
| FourRpProcessor | getProcessor () |
| FourRpLayouter (String filename, LayoutedPagesConsumer consumer) | |
| Creates a FourRpLyouter object for the specified template file that outputs to the given consumer object. If the file name is a relative path then the environment variable (or system property) FGLRESOURCEPATH will be used to search for files (The variable is expected to follow CLASSPATH syntax). More... | |
| void | runFromXML (String fileName) |
| Streams the specified file thru the rendering pipe. More... | |
| void | runFromSerializable (Object data) |
| Streams the data thru the rendering pipe. More... | |
| XmlWriter | createXmlWriter () |
| Creates an XmlWriter into which the input document can be streamed thru the rendering pipe. The XmlWriter can be used for one stream only. | |
 Public Member Functions inherited from FourJs.Report.Runtime.LayoutedPagesProducer | |
| LayoutedPagesProducer (LayoutedPagesConsumer consumer) | |
| Creates a LayoutedPagesProducer object that outputs to the given consumer object. More... | |
Public Attributes | |
| FourRpProcessor | processor |
Static Public Attributes | |
| static String | legalCopyright = Version.CLASS_COPYRIGHT |
Properties | |
| int | debugLevel [set] |
Sets the debug level as determined by the level. Only Messages with a message level lower or equal to level will be displayed and logged. There following six message levels are defined: More... | |
| String | recordingFileName [set] |
Specifies input recording for the purpose of play back or debugging. In parallel to the regular processing the input is written in XML format to the file specified by recordingFileName. In the case of a RemoteConnection remote connection the file is created on the remote server. More... | |
| String | pageWidth [set] |
| Specifies the page width as a PXML numeric expression (e.g. "21cm" or "a4width"). More... | |
| String | pageLength [set] |
| Specifies the page height as a PXML numeric expression (e.g. "8.5in" or "letterlength"). More... | |
| String | leftMargin [set] |
| Specifies the left margin as a PXML numeric expression (e.g. "1.5cm") More... | |
| String | topMargin [set] |
| Specifies the top margin as a PXML numeric expression (e.g. "1.5cm") More... | |
| String | rightMargin [set] |
| Specifies the right margin as a PXML numeric expression (e.g. "1.5cm") More... | |
| String | bottomMargin [set] |
| Specifies the bottom margin as a PXML numeric expression (e.g. "1.5cm") More... | |
| String | title [set] |
| Sets the report title. If the target file format supports meta data then the value is inserted into the target document. The value overrides the report title property defined in the report template file (".4rp)
on the root element and allows to specify title values for report not created with the <see cref="FourRpProcessor"/>. More... | |
| String | author [set] |
| Sets the report title. If the target file format supports meta data then the value is inserted into the target document. The value overrides the report title property defined in the report template file (".4rp)
on the root element and allows to specify title values for report not created with the <see cref="FourRpProcessor"/>. More... | |
| String | creator [set] |
| Sets the report creator. If the target file format supports meta data then the value is inserted into the target document. The value overrides the report creator property defined in the report template file (".4rp) on the root element and allows to specify title values for report not created with the FourRpProcessor. More... | |
| String | subject [set] |
| Sets the report subject. If the target file format supports meta data then the value is inserted into the target document. The value overrides the report subject property defined in the report template file (".4rp)
on the root element and allows to specify title values for report not created with the <see cref="FourRpProcessor"/>. More... | |
| String | keywords [set] |
| Sets the report's keywords meta data attribute. If the target file format supports meta data then the value is inserted into the target document. The value overrides the report keyword property defined in the report template file (".4rp)
on the root element and allows to specify title values for report not created with the <see cref="FourRpProcessor"/>. More... | |
| bool | markOverfullBoxesInDocument [set] |
| Activates visual marking of overfull boxes if true. If activated, overfull boxes will be highlighted in red for the purpose of debugging. The default value is More... | |
| LayoutedPagesConsumer | consumer [set] |
| Sets the output consumer. More... | |
| String | fglLocalizationCharset [set] |
| Specified the charset in which the ".42s" localization files are encoded. By default the system encoding is assumed. More... | |
| String[] | fglLocalizationResourcePath [set] |
| Specifies the search path for localization (".42s") files. More... | |
| String | fglLocalizationNumberFormat [set] |
| Specifies the format pattern to be used for number formatting. The format is compatible with the format of the 4GL DBFORMAT environment variable. More... | |
| String | reportFileName [set] |
| Specifies the template file that is used for the transformation of the input. If the file name is a relative path then the environment variable (or system property) FGLRESOURCEPATH will be used to search for files (The variable is expected to follow CLASSPATH syntax). More... | |
| Dictionary< string, string > | environment [set] |
| Specifies variable values in the private environment of the report Can be used to specify the value of environment variables like GREOUTPUTDIR or user defined variables for the purpose of using the values in calls to the RTL function Runtime.getEnvironmentVariable(). More... | |
| Dictionary< string, string > | renderingHints [set] |
| Specifies rendering hints to be used during the rendering process Can be used to specify the value of rendering hints. More... | |
| Properties inherited from FourJs.Report.Runtime.LayoutedPagesProducer | |
| LayoutedPagesConsumer | consumer [get, set] |
Sets the specified consumer as the consumer for the output produced by this processor. More... | |
| Properties inherited from FourJs.Report.Runtime.DataConsumer | |
| int | debugLevel [get, set] |
| Sets the debug level as determined by the More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from FourJs.Report.Runtime.LayoutedPagesProducer | |
| LayoutedPagesProducer () | |
| Creates a LayoutedPagesProducer object. Constructor for the purpose of serialization of classes extending this class. More... | |
Class for conversion of a XML data stream to a layouted PXML document via a ".4rp" template. This class exists for convenience and is a composition of the classes FourRpProcessor and PXMLLayouter containing the methods of both classes. For details refer to the respective documentation.
| FourJs.Report.Runtime.FourRpLayouter.FourRpLayouter | ( | String | filename, |
| LayoutedPagesConsumer | consumer | ||
| ) |
Creates a FourRpLyouter object for the specified template file that outputs to the given consumer object. If the file name is a relative path then the environment variable (or system property) FGLRESOURCEPATH will be used to search for files (The variable is expected to follow CLASSPATH syntax).
| filename | A '.4rp' file |
| consumer | A LayoutedPageConsumer |
| void FourJs.Report.Runtime.FourRpLayouter.runFromSerializable | ( | Object | data | ) |
Streams the data thru the rendering pipe.
Implements FourJs.Report.Runtime.DataConsumer.
| void FourJs.Report.Runtime.FourRpLayouter.runFromXML | ( | String | fileName | ) |
Streams the specified file thru the rendering pipe.
Implements FourJs.Report.Runtime.DataConsumer.
|
set |
Sets the report title. If the target file format supports meta data then the value is inserted into the target document. The value overrides the report title property defined in the report template file (".4rp) on the root element and allows to specify title values for report not created with the <see cref="FourRpProcessor"/>.
|
set |
Specifies the bottom margin as a PXML numeric expression (e.g. "1.5cm")
exception cref="ArgumentException">if the expression isn't a valid PXML numeric expression
|
set |
Sets the output consumer.
|
set |
Sets the report creator. If the target file format supports meta data then the value is inserted into the target document. The value overrides the report creator property defined in the report template file (".4rp) on the root element and allows to specify title values for report not created with the FourRpProcessor.
|
set |
Sets the debug level as determined by the level. Only Messages with a message level lower or equal to level will be displayed and logged. There following six message levels are defined:
A level of 0 suppresses all messages. The default value is 3. The value applies to the local GRE only and not to a remote RemoteConnection server.
exception cref="ArgumentOutOfRangeException">if the level<c> is not in the range 0..9
|
set |
Specifies variable values in the private environment of the report Can be used to specify the value of environment variables like GREOUTPUTDIR or user defined variables for the purpose of using the values in calls to the RTL function Runtime.getEnvironmentVariable().
|
set |
Specified the charset in which the ".42s" localization files are encoded. By default the system encoding is assumed.
|
set |
Specifies the format pattern to be used for number formatting. The format is compatible with the format of the 4GL DBFORMAT environment variable.
|
set |
Specifies the search path for localization (".42s") files.
|
set |
Sets the report's keywords meta data attribute. If the target file format supports meta data then the value is inserted into the target document. The value overrides the report keyword property defined in the report template file (".4rp) on the root element and allows to specify title values for report not created with the <see cref="FourRpProcessor"/>.
|
set |
Specifies the left margin as a PXML numeric expression (e.g. "1.5cm")
exception cref="ArgumentException">if the expression isn't a valid PXML numeric expression
|
set |
Activates visual marking of overfull boxes if true. If activated, overfull boxes will be highlighted in red for the purpose of debugging. The default value is
false.
|
set |
Specifies the page height as a PXML numeric expression (e.g. "8.5in" or "letterlength").
exception cref="ArgumentException">if the expression isn't a valid PXML numeric expression
|
set |
Specifies the page width as a PXML numeric expression (e.g. "21cm" or "a4width").
exception cref="ArgumentException">if the expression isn't a valid PXML numeric expression
|
set |
Specifies input recording for the purpose of play back or debugging. In parallel to the regular processing the input is written in XML format to the file specified by recordingFileName. In the case of a RemoteConnection remote connection the file is created on the remote server.
| recordingFileName |
|
set |
Specifies rendering hints to be used during the rendering process Can be used to specify the value of rendering hints.
|
set |
Specifies the template file that is used for the transformation of the input. If the file name is a relative path then the environment variable (or system property) FGLRESOURCEPATH will be used to search for files (The variable is expected to follow CLASSPATH syntax).
|
set |
Specifies the right margin as a PXML numeric expression (e.g. "1.5cm")
exception cref="ArgumentException">if the expression isn't a valid PXML numeric expression
|
set |
Sets the report subject. If the target file format supports meta data then the value is inserted into the target document. The value overrides the report subject property defined in the report template file (".4rp) on the root element and allows to specify title values for report not created with the <see cref="FourRpProcessor"/>.
|
set |
Sets the report title. If the target file format supports meta data then the value is inserted into the target document. The value overrides the report title property defined in the report template file (".4rp) on the root element and allows to specify title values for report not created with the <see cref="FourRpProcessor"/>.
|
set |
Specifies the top margin as a PXML numeric expression (e.g. "1.5cm")
exception cref="ArgumentException">if the expression isn't a valid PXML numeric expression
1.8.9.1 
