IRISLIB database
document Class Reference

The <document> tag is used at the top-level to specify dimensions and styling for the report. More...

Inheritance diagram for document:
Collaboration diagram for document:

Public Attributes

 afterGeneralRegionAttributes
 This is a list of attributes in XSL format: 'a1=v1 a2=v2, etc., with a terminating single quote or a double double quote. More...
 
 beforeGeneralRegionAttributes
 This is a list of attributes in XSL format: 'a1=v1 a2=v2, etc., with a terminating single quote or a double double quote. More...
 
 columnCount
 specifies that the fo:region-body is multicolumn. More...
 
 columnGap
 If column-count is greater than 1, a value may be specified for the column-gap property. More...
 
 endGeneralRegionAttributes
 This is a list of attributes in XSL format: 'a1=v1 a2=v2, etc., with a terminating single quote or a double double quote. More...
 
 endSidebarLength
 Specifies the amount of room available for the contents of the <endsidebar> tag. More...
 
 footerHeight
 Specifies the amount of room available for the contents of the <pagefooter> tag. More...
 
 headerHeight
 Specifies the amount of room available for the contents of the <pageheader> tag. More...
 
 height
 Specifies the height of the document. More...
 
 ifexpression
   More...
 
 ifxpath
   More...
 
 margin
 margin attribute on fo:simple-page-master More...
 
 marginBottom
 Specifies the bottom margin of the document. More...
 
 marginLeft
 Specifies the left margin width of the document. More...
 
 marginRight
 Specifies the right margin width of the document. More...
 
 marginTop
 Specifies the top margin of the document. More...
 
 orientation
 extent property More...
 
 referenceOrientation
 value of reference-orientation in XSL-FO region-body More...
 
 regionAfter
 Properties of fo:region-after. More...
 
 regionAfterColor
   More...
 
 regionAfterDisplayAlign
 display-align property More...
 
 regionAfterExtent
 extent property More...
 
 regionAfterName
   More...
 
 regionAfterOrientation
 orientation property More...
 
 regionBefore
 Properties of fo:region-before. More...
 
 regionBeforeColor
   More...
 
 regionBeforeDisplayAlign
 display-align property More...
 
 regionBeforeExtent
 extent property More...
 
 regionBeforeName
   More...
 
 regionBeforeOrientation
 orientation property More...
 
 regionEnd
 Properties of fo:region-end. More...
 
 regionEndColor
   More...
 
 regionEndDisplayAlign
 display-align property More...
 
 regionEndExtent
 extent property More...
 
 regionEndName
   More...
 
 regionEndOrientation
 orientation property More...
 
 regionStart
 Properties of fo:region-start. More...
 
 regionStartColor
   More...
 
 regionStartDisplayAlign
 display-align property More...
 
 regionStartExtent
 extent property More...
 
 regionStartName
 extent property More...
 
 regionStartOrientation
 orientation property More...
 
 size
 size attribute on fo:simple-page-master More...
 
 startGeneralRegionAttributes
 This is a list of attributes in XSL format: 'a1=v1 a2=v2, etc., with a terminating single quote or a double double quote. More...
 
 startSidebarLength
 Specifies the amount of room available for the contents of the <pagestartsidebar> tag. More...
 
 width
 Specifies the width of the document. More...
 
 writingMode
 writing-mode XML attribute. More...
 
 writingModeRegionAfter
 writing-mode XML attribute on the region-after. More...
 
 writingModeRegionBefore
 writing-mode XML attribute on the region-before. More...
 
 writingModeRegionBody
 writing-mode XML attribute on the region-body. More...
 
 writingModeRegionEnd
 writing-mode XML attribute on the region-end. More...
 
 writingModeRegionStart
 writing-mode XML attribute on the region-start. More...
 
- Public Attributes inherited from childrenNode
 children
   More...
 
 parent
   More...
 
 xpath
   More...
 
- Public Attributes inherited from node
 class
 Specifies the node's style class. More...
 
 htmlstyle
 same as style only HTML only More...
 
 level
 use to pass down result set from table when table uses sql to generate itself More...
 
 selectstylecond
 list of conditions - true one at index i selects style More...
 
 selectstylelist
 list of styles - picked by first true index i in list of conditions More...
 
 style
 The style string is given in the form "attribute1:value1;attribute2:value2;...",. More...
 
 stylecall
 stylecall - name of xsl:template to call to output style attributes More...
 
 styleparamNames
 for each name here an xsl:with-param is generated with its name attribute set from here More...
 
 styleparams
 list of xpaths, xpath function calls, and XSLT function calls. More...
 
 tag
 Calculated property that contains the tag name of the node. More...
 
 template
 Specifies the template that can be used to add children to the node. More...
 
 width
 Specifies the width of the element within its containing object (page, table cell, etc.) More...
 
 withinSmallmultiple
 used to flag table or item, etc., as being under a small mutiple More...
 
 xmlnamespace
 We use these to record namespace and namespace prefix for qualified name. More...
 
 xmlnamespaceprefix
   More...
 
 xpath
   More...
 
 xslfostyle
 same as style only XSL-FO only More...
 
- Public Attributes inherited from controller
 applyLevel
   More...
 
 ifexpression
   More...
 
 ifxpath
   More...
 
 includeColIfExpression
   More...
 
 includeColIfXPath
   More...
 
 includeColUnlessExpression
   More...
 
 includeColUnlessXPath
   More...
 
 unlessexpression
   More...
 
- Public Attributes inherited from common
 composite
 @qualifier final For components that are created as part of a composite(template component, More...
 
 id
 This is a unique identifier that is used to distinguish this object. More...
 

Private Member Functions

_.Library.Status DrawPageToXSLFO (_.Library.String context, _.Library.GlobalCharacterStream XSL, _.Library.GlobalCharacterStream delay, _.Library.String masterName)
 Renders the dimensions of the page for a PDF report.Proposed change - add "masterName" parameter with default value "main".
 
_.Library.Status DrawStyleToHTML (_.Library.String context, _.Library.GlobalCharacterStream XSL, _.Library.GlobalCharacterStream delay)
 Outputs the style information contained in its <class> children. More...
 
_.Library.Status DrawStyleToXSLFO (_.Library.String context, _.Library.GlobalCharacterStream XSL, _.Library.GlobalCharacterStream delay, _.Library.String SectionName)
 Outputs the style information contained in its <class> children. More...
 

Additional Inherited Members

- Public Member Functions inherited from RegisteredObject
_.Library.Status OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
 This callback method is invoked when the current object is added to the SaveSet,. More...
 
_.Library.Status OnClose ()
 This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
 
_.Library.Status OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
 This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
 
_.Library.Status OnNew ()
 This callback method is invoked by the <METHOD>New</METHOD> method to. More...
 
_.Library.Status OnValidateObject ()
 This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...
 
- Public Member Functions inherited from Adaptor
_.Library.Status XMLExport (_.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent, _.Library.Boolean local, _.Net.MIMEPart mimeAttachments)
 Serialize an XML enabled class as an XML document and write. More...
 
_.Library.Status XMLExportToStream (_.Stream.Object export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
 Serialize an XML enabled class as an XML document and appends it to a stream. More...
 
_.Library.Status XMLExportToString (_.Library.String export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
 Serialize an XML enabled class as an XML document and write it to a string. More...
 
- Static Public Member Functions inherited from Adaptor
_.Library.Status XMLDTD (_.Library.String top, _.Library.String format, _.Library.Boolean input, dtdlist)
 Write the DTD to the current device for this XML enabled class serialized as. More...
 
_.Library.RegisteredObject XMLNew (_.XML.Document document, _.Library.Integer node, _.Library.RegisteredObject containerOref)
 Get an instance of an XML enabled class. More...
 
_.Library.Status XMLSchema (_.Library.String top, _.Library.String format, _.Library.String namespacePrefix, _.Library.Boolean input, _.Library.Boolean refOnly, schema)
 Write an XML Schema fragment to the current device which describes an XML enabled class and dependent classes. More...
 
_.Library.String XMLSchemaNamespace ()
 Get the namespace to which this class belongs for use in schema generation. More...
 
_.Library.Status XMLSchemaType (_.XML.Schema schemaInstance, _.XML.Node node, _.Library.String top, _.Library.Boolean encoded, _.Library.Boolean summary, _.Library.Boolean input, _.Library.Boolean refOnly)
 Add a complexType to the schema that is respresented by an <class>XML.Schema</class> instance. More...
 
- Static Public Attributes inherited from node
 NAMESPACE = None
 XML namespace used for Zen Report display definitions.
 
 XMLIGNOREINVALIDATTRIBUTE = None
 By setting this to 0, we disallow use of invalid attribute names in Zen Report XML documents.
 
- Static Public Attributes inherited from common
 NAMESPACE = None
 XML namespace used for Zen Report display definitions.
 
 XMLFORMAT = None
 If XMLFORMAT="Literal", then only support for literal format import and export is generated. More...
 
- Static Public Attributes inherited from RegisteredObject
 CAPTION = None
 Optional name used by the Form Wizard for a class when generating forms. More...
 
 JAVATYPE = None
 The Java type to be used when exported.
 
 PROPERTYVALIDATION = None
 This parameter controls the default validation behavior for the object. More...
 
- Static Public Attributes inherited from Adaptor
 ATTRIBUTEQUALIFIED = None
 ATTRIBUTEQUALIFIED controls the format of exported XML by controlling whether attributes. More...
 
 ELEMENTQUALIFIED = None
 ELEMENTQUALIFIED controls the format of exported XML. More...
 
 NAMESPACE = None
 NAMESPACE specifies the XML namespace to be used when projecting the. More...
 
 SUPPRESSTYPEPREFIX = None
 SUPPRESSTYPEPREFIX allows the type name that refers to this class. More...
 
 XMLDEFAULTREFERENCE = None
 XMLDEFAULTREFERENCE specifies the default value of the XMLREFERENCE property parameter. More...
 
 XMLENABLED = None
 If this parameter is true then XML-enabling methods. More...
 
 XMLFORMAT = None
 The XMLFORMAT parameter controls the generation of the XMLExport and XMLImport. More...
 
 XMLIGNOREINVALIDATTRIBUTE = None
 The XMLIGNOREINVALIDATTRIBUTE parameter allows the programmer to control handling of unexpected. More...
 
 XMLIGNOREINVALIDTAG = None
 The XMLIGNOREINVALIDTAG parameter allows the programmer to control handling of unexpected. More...
 
 XMLIGNORENULL = None
 XMLIGNORENULL allows the programmer to override the default XML handling. More...
 
 XMLINCLUDEINGROUP = None
 XMLINCLUDEINGROUP allows the programmer to control whether a class is included. More...
 
 XMLINHERITANCE = None
 If the XMLINHERITANCE parameter is set to "LEFT", then in the case of multiple. More...
 
 XMLNAME = None
 This parameter provides the default XMLNAME for the class. More...
 
 XMLNIL = None
 The XMLNIL class parameter controls the use of xsi:nil by XMLExport. More...
 
 XMLNILNOOBJECT = None
 The XMLNILNOOBJECT parameter allows creation of an object to be skipped for elements. More...
 
 XMLPREFIX = None
 The XMLPREFIX parameter controls the prefix to be used for the XML namespace that. More...
 
 XMLSEQUENCE = None
 If the XMLSEQUENCE = 1, then the order of the XML elements must match the. More...
 
 XMLSUMMARY = None
 The summary fields to be used when an object is referenced are specified. More...
 
 XMLTYPE = None
 This parameter provides the default XMLTYPE for the class. More...
 
 XMLUNSWIZZLE = None
 If the XMLUNSWIZZLE parameter is set to 1, then single object. More...
 
 XMLUSEEMPTYELEMENT = None
 If the XMLUSEEMPTYELEMENT parameter is set to 1, then the empty element shorthand (<tag>) More...
 

Detailed Description

The <document> tag is used at the top-level to specify dimensions and styling for the report.

The dimensions only affect the PDF report.

Member Function Documentation

◆ DrawStyleToHTML()

Outputs the style information contained in its <class> children.

for an HTML report.

◆ DrawStyleToXSLFO()

_.Library.Status DrawStyleToXSLFO ( _.Library.String  context,
_.Library.GlobalCharacterStream  XSL,
_.Library.GlobalCharacterStream  delay,
_.Library.String  SectionName 
)
private

Outputs the style information contained in its <class> children.

for a PDF report.

Member Data Documentation

◆ afterGeneralRegionAttributes

afterGeneralRegionAttributes

This is a list of attributes in XSL format: 'a1=v1 a2=v2, etc., with a terminating single quote or a double double quote.

 

◆ beforeGeneralRegionAttributes

beforeGeneralRegionAttributes

This is a list of attributes in XSL format: 'a1=v1 a2=v2, etc., with a terminating single quote or a double double quote.

 

◆ columnCount

columnCount

specifies that the fo:region-body is multicolumn.

The column-count property indicates the number of columns on every page instance formatted using the simple-page-master

to which this region-body belongs.  

◆ columnGap

columnGap

If column-count is greater than 1, a value may be specified for the column-gap property.

The value is either an explicit length or a percentage

of the inline-progression-dimension of the content rectangle of the region-body.  

◆ endGeneralRegionAttributes

endGeneralRegionAttributes

This is a list of attributes in XSL format: 'a1=v1 a2=v2, etc., with a terminating single quote or a double double quote.

 

◆ endSidebarLength

endSidebarLength

Specifies the amount of room available for the contents of the <endsidebar> tag.

 

◆ footerHeight

footerHeight

Specifies the amount of room available for the contents of the <pagefooter> tag.

 

◆ headerHeight

headerHeight

Specifies the amount of room available for the contents of the <pageheader> tag.

 

◆ height

height

Specifies the height of the document.

 

◆ ifexpression

ifexpression

 

 

◆ ifxpath

ifxpath

 

 

◆ margin

margin

margin attribute on fo:simple-page-master

 

◆ marginBottom

marginBottom

Specifies the bottom margin of the document.

This does not include the

space left for the footer.  

◆ marginLeft

marginLeft

Specifies the left margin width of the document.

 

◆ marginRight

marginRight

Specifies the right margin width of the document.

 

◆ marginTop

marginTop

Specifies the top margin of the document.

This does not include the

space left for the header.  

◆ orientation

orientation

extent property

 

◆ referenceOrientation

referenceOrientation

value of reference-orientation in XSL-FO region-body

 

◆ regionAfter

regionAfter

Properties of fo:region-after.

 

◆ regionAfterColor

regionAfterColor

 

 

◆ regionAfterDisplayAlign

regionAfterDisplayAlign

display-align property

 

◆ regionAfterExtent

regionAfterExtent

extent property

 

◆ regionAfterName

regionAfterName

 

 

◆ regionAfterOrientation

regionAfterOrientation

orientation property

 

◆ regionBefore

regionBefore

Properties of fo:region-before.

 

◆ regionBeforeColor

regionBeforeColor

 

 

◆ regionBeforeDisplayAlign

regionBeforeDisplayAlign

display-align property

 

◆ regionBeforeExtent

regionBeforeExtent

extent property

 

◆ regionBeforeName

regionBeforeName

 

 

◆ regionBeforeOrientation

regionBeforeOrientation

orientation property

 

◆ regionEnd

regionEnd

Properties of fo:region-end.

 

◆ regionEndColor

regionEndColor

 

 

◆ regionEndDisplayAlign

regionEndDisplayAlign

display-align property

 

◆ regionEndExtent

regionEndExtent

extent property

 

◆ regionEndName

regionEndName

 

 

◆ regionEndOrientation

regionEndOrientation

orientation property

 

◆ regionStart

regionStart

Properties of fo:region-start.

 

◆ regionStartColor

regionStartColor

 

 

◆ regionStartDisplayAlign

regionStartDisplayAlign

display-align property

 

◆ regionStartExtent

regionStartExtent

extent property

 

◆ regionStartName

regionStartName

extent property

 

◆ regionStartOrientation

regionStartOrientation

orientation property

 

◆ size

size

size attribute on fo:simple-page-master

 

◆ startGeneralRegionAttributes

startGeneralRegionAttributes

This is a list of attributes in XSL format: 'a1=v1 a2=v2, etc., with a terminating single quote or a double double quote.

 

◆ startSidebarLength

startSidebarLength

Specifies the amount of room available for the contents of the <pagestartsidebar> tag.

 

◆ width

width

Specifies the width of the document.

 

◆ writingMode

writingMode

writing-mode XML attribute.

It has the following possible values. Note that not all XSL-FO renderers will support all possible values.

lr-tb Text are written left-to-right and top-to-bottom (normal "alphabetic" text)
rl-tb Text are written right-to-left and top-to-bottom (Arabic and Hebrew text)
tb-rl Text are written top-to-bottom and right-to-left (Chinese and Japanese text)
lr Same as lr-tb
rl Same as rl-tb
tb Same as tb-rl
inherit
Note this places a writing-mode on fo:simple-page-master.
The semantics of writing-mode on simple-page-master differs from page-sequence. Specifically, on simple-page-master, it is used to interpret the meaning of before, after, start, end with respect to resolving the placement of page regions. However, it does not affect the writing-mode trait of reference areas generated by page-sequence. In the latter case, it is the writing-mode on page-sequence that counts.
To place a writing-mode on page-sequence use the writing-mode in the report or section element
 

◆ writingModeRegionAfter

writingModeRegionAfter

writing-mode XML attribute on the region-after.

It has the following possible values. Note that not all XSL-FO renderers will support all possible values.

lr-tb Text are written left-to-right and top-to-bottom (normal "alphabetic" text)
rl-tb Text are written right-to-left and top-to-bottom (Arabic and Hebrew text)
tb-rl Text are written top-to-bottom and right-to-left (Chinese and Japanese text)
lr Same as lr-tb
rl Same as rl-tb
tb Same as tb-rl
inherit
 

◆ writingModeRegionBefore

writingModeRegionBefore

writing-mode XML attribute on the region-before.

It has the following possible values. Note that not all XSL-FO renderers will support all possible values.

lr-tb Text are written left-to-right and top-to-bottom (normal "alphabetic" text)
rl-tb Text are written right-to-left and top-to-bottom (Arabic and Hebrew text)
tb-rl Text are written top-to-bottom and right-to-left (Chinese and Japanese text)
lr Same as lr-tb
rl Same as rl-tb
tb Same as tb-rl
inherit
 

◆ writingModeRegionBody

writingModeRegionBody

writing-mode XML attribute on the region-body.

It has the following possible values. Note that not all XSL-FO renderers will support all possible values.

lr-tb Text are written left-to-right and top-to-bottom (normal "alphabetic" text)
rl-tb Text are written right-to-left and top-to-bottom (Arabic and Hebrew text)
tb-rl Text are written top-to-bottom and right-to-left (Chinese and Japanese text)
lr Same as lr-tb
rl Same as rl-tb
tb Same as tb-rl
inherit
 

◆ writingModeRegionEnd

writingModeRegionEnd

writing-mode XML attribute on the region-end.

It has the following possible values. Note that not all XSL-FO renderers will support all possible values.

lr-tb Text are written left-to-right and top-to-bottom (normal "alphabetic" text)
rl-tb Text are written right-to-left and top-to-bottom (Arabic and Hebrew text)
tb-rl Text are written top-to-bottom and right-to-left (Chinese and Japanese text)
lr Same as lr-tb
rl Same as rl-tb
tb Same as tb-rl
inherit
 

◆ writingModeRegionStart

writingModeRegionStart

writing-mode XML attribute on the region-start.

It has the following possible values. Note that not all XSL-FO renderers will support all possible values.

lr-tb Text are written left-to-right and top-to-bottom (normal "alphabetic" text)
rl-tb Text are written right-to-left and top-to-bottom (Arabic and Hebrew text)
tb-rl Text are written top-to-bottom and right-to-left (Chinese and Japanese text)
lr Same as lr-tb
rl Same as rl-tb
tb Same as tb-rl
inherit