IRISLIB database
table Class Reference

This class defines how tables are displayed within a generated ZEN report stylesheet. More...

Inheritance diagram for table:
Collaboration diagram for table:

Public Member Functions

_.Library.String getColumnWidth (_.Library.String colType)
 Note: colType is either "header", "body", or "footer". More...
 
- 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...
 

Public Attributes

 align
 Specifies the alignment of the table within the page or its current container. More...
 
 altcolor
 This property specifies the background color of the alternate rows (2, 4, 6, ...). More...
 
 crosstab
   More...
 
 dataType
 specify type of data used in table sort orderby - text, number or qname More...
 
 defaultWidth
   More...
 
 excelGroupName
   More...
 
 excelSheetName
   More...
 
 field
   More...
 
 foBlockStyle
   More...
 
 foHeaderStyle
   More...
 
 foStyle
   More...
 
 group
 Specifies a group of data for the table to display. More...
 
 groupby
 xpath by which the group will be group-by More...
 
 groupstartingwith
 xpath by which the group will be group-starting-with More...
 
 layout
 Possible values are "auto" and "fixed."
More...
 
 linefeedTreatment
 Set the linefeed-treatment (a property defined by XSL-FO standard) More...
 
 oldSummary
   More...
 
 onCreateResultSet
 Specifies callback method which returns ResultSe. More...
 
 ongetData
 Specifies call back method to get data for table, method must fill in two dimensional array where rows are first index and columns are second index. More...
 
 orderby
 comma separated list of xpaths by which the table will be sorted More...
 
 orient
 Defines the orientation of the table. More...
 
 parameters
 User-defined list of query parameters. More...
 
 preserveLineFeed
   More...
 
 queryClass
 Specifies class for query that the table will display. More...
 
 queryName
 Specifies query for the table to display. More...
 
 removeEmpty
 If orient is row and removeEmpty is 1 then empty rows are removed from the table display. More...
 
 rowAcrossPages
 Boolean value used to trigger "keep-together" logic within the. More...
 
 selectmode
 Specifies SELECTMODE of sql or query. More...
 
 sql
 Specifies sql for the table to display. More...
 
 staticTable
 if staticTable is set we draw table as is specified by <thead> <tbody> elements etc. More...
 
 suppressFoTableColumn
 if suppressFoTableColumn is true then don't generate fo:table-column More...
 
 writingMode
 writing-mode XML attribute. 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...
 
- Public Attributes inherited from tableOutput
 blockContainerProperty
 properties of block container such as overflow='hidden' to truncate data too large More...
 
 caption
 Short-hand property to specify the elements caption within the table's header row. More...
 
 colcount
 when grouppath is set, the number of columns in the group More...
 
 colspan
   More...
 
 crosstabDataGroup
 xpath representing data of cross-tab at row determined by crosstabRowGroup[$row]/ More...
 
 crosstabFooterDataField
 xpath expression, which can use $pos, to get data to display in crosstab footer group More...
 
 crosstabFooterFormatNumber
 if non-null has footer data is formatted More...
 
 crosstabFooterGroup
 xpath representing data that will appear in footer More...
 
 crosstabHeaderDataField
 Defaults to "". More...
 
 crosstabHeaderGroup
 cross-tab properties
More...
 
 crosstabHeaderGroupLabels
 cross-tab properties
More...
 
 crosstabHeaderGroupTooLongText
 cross-tab properties
More...
 
 crosstabHeaderLabelDataField
 cross-tab properties
More...
 
 crosstabHeaderMatchField
 xpath representing data that will match against header name crosstabHeaderGroup[$col] More...
 
 crosstabRowGroup
 xpath representing "row" of table where cross-tab data lives More...
 
 crosstabTruncationHeight
 the height to use in truncation of cross tab header labels, if not specified inherited from table cell More...
 
 crosstabTruncationWidth
 the width to use in truncation of cross tab header lablels, if not specified inherited from table cell More...
 
 foblock
 fo attributes of block for things like orphan control More...
 
 grouppath
 items and captions can now have groups that allow them to repeat on a line More...
 
 hasFooter
 Calculated property that indicates whether or not this element specifies a footer cell. More...
 
 hasHeader
 Calculated property that indicates whether or not this element specifies a header cell. More...
 
 includeBlockContainer
 Is block wrapped inside a block container. More...
 
 linefeedTreatment
   More...
 
 rowspan
   More...
 
 tooLongText
   More...
 
 truncate
 truncate text if it is too long if truncate is true More...
 
 truncationHeight
 the height to use in truncation. More...
 
 truncationWidth
 the width to use in truncation, if not specified inherited from table cell More...
 

Private Member Functions

_.Library.Status DrawToAnnotatedXML (_.Library.String context, _.Library.GlobalCharacterStream XSL, _.Library.GlobalCharacterStream delay)
 This method outputs the stylesheet that converts the input xml to the xml with Excel annotations. More...
 
_.Library.Status DrawToXSLFO (_.Library.String context, _.Library.GlobalCharacterStream XSL, _.Library.GlobalCharacterStream delay, _.Library.Boolean incell)
 This method outputs the necessary stylesheet information for the PDF report. More...
 

Additional Inherited Members

- 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

This class defines how tables are displayed within a generated ZEN report stylesheet.

Member Function Documentation

◆ DrawToAnnotatedXML()

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

This method outputs the stylesheet that converts the input xml to the xml with Excel annotations.

report, table and item should override this method. Nested tables not supported.

Reimplemented from childrenNode.

◆ DrawToXSLFO()

This method outputs the necessary stylesheet information for the PDF report.

Every tag should override this method.

Reimplemented from node.

◆ getColumnWidth()

_.Library.String getColumnWidth ( _.Library.String  colType)

Note: colType is either "header", "body", or "footer".

used only in tables by row

Member Data Documentation

◆ align

align

Specifies the alignment of the table within the page or its current container.

(table cell, etc.)  

◆ altcolor

altcolor

This property specifies the background color of the alternate rows (2, 4, 6, ...).


This is only possible when <property>orient</property>="col" and <property>group</property> is defined. Currently only works with <property>orient</property>="col".  

◆ crosstab

crosstab

 

 

◆ dataType

dataType

specify type of data used in table sort orderby - text, number or qname

 

◆ defaultWidth

defaultWidth

 

 

◆ excelGroupName

excelGroupName

 

 

◆ excelSheetName

excelSheetName

 

 

◆ field

field

 

 

◆ foBlockStyle

foBlockStyle

 

 

◆ foHeaderStyle

foHeaderStyle

 

 

◆ foStyle

foStyle

 

 

◆ group

Specifies a group of data for the table to display.

See the <group> class for more

information on displaying groups. In this case, each record contained within the group will appear as a new row/column of the table.  

◆ groupby

groupby

xpath by which the group will be group-by

 

◆ groupstartingwith

groupstartingwith

xpath by which the group will be group-starting-with

 

◆ layout

layout

Possible values are "auto" and "fixed."

Currently, Apache's FOP rendering engine only supports "fixed."  

◆ linefeedTreatment

linefeedTreatment

Set the linefeed-treatment (a property defined by XSL-FO standard)

 

◆ oldSummary

oldSummary

 

 

◆ onCreateResultSet

onCreateResultSet

Specifies callback method which returns ResultSe.

 

◆ ongetData

ongetData

Specifies call back method to get data for table, method must fill in two dimensional array where rows are first index and columns are second index.

When retrieving data, only works with fieldNum in item. Cannot use fieldname.  

◆ orderby

orderby

comma separated list of xpaths by which the table will be sorted

 

◆ orient

orient

Defines the orientation of the table.

Acceptable values are "row" and "col." If

orient is "row," each child tag of table will be placed in a new row. Similarly, if orient is "col" each child tag will be placed in a new column.  

◆ parameters

parameters

User-defined list of query parameters.

These are used to supply

parameter values for the sql,queryName, or onCreateResultSet if they are used by this table.  

◆ preserveLineFeed

preserveLineFeed

 

 

◆ queryClass

queryClass

Specifies class for query that the table will display.

In this case, each record in the sql result set will appear as a new row/column of the table.

queryClass is the class containing the query specified by queryName.  

◆ queryName

queryName

Specifies query for the table to display.

In this case, each record in the sql result set will appear as a new row/column of the table.

queryName specifies the query in queryClass.  

◆ removeEmpty

removeEmpty

If orient is row and removeEmpty is 1 then empty rows are removed from the table display.

 

◆ rowAcrossPages

rowAcrossPages

Boolean value used to trigger "keep-together" logic within the.

<fo:table-row> element to not allow a row to split across a page  

◆ selectmode

selectmode

Specifies SELECTMODE of sql or query.

0=Logical, 1=ODBC, 2=Display.

 

◆ sql

sql

Specifies sql for the table to display.

In this case, each record in the sql result set will appear as a new row/column of the table.

 

◆ staticTable

staticTable

if staticTable is set we draw table as is specified by <thead> <tbody> elements etc.

 

◆ suppressFoTableColumn

suppressFoTableColumn

if suppressFoTableColumn is true then don't generate fo:table-column

 

◆ 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