IRISLIB database
tableOutput Class Reference

This class provides an interface for ZEN report tags to be displayed in a table. More...

Inheritance diagram for tableOutput:
Collaboration diagram for tableOutput:

Public Attributes

 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...
 
- 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 DrawCellFO1 (_.Library.String context, _.Library.GlobalCharacterStream XSL, _.Library.GlobalCharacterStream delay)
 Part of the tableOutput API that displays the element contained in a table cell for. More...
 
_.Library.Status DrawCellToHTML (_.Library.String context, _.Library.GlobalCharacterStream XSL, _.Library.GlobalCharacterStream delay, _.Library.String orient)
 Part of the tableOutput API that displays the element contained in a table cell for. More...
 
_.Library.Status DrawFooterFO (_.Library.String context, _.Library.GlobalCharacterStream XSL, _.Library.GlobalCharacterStream delay, _.Library.Boolean oldSummary, _.Library.String orient)
 
_.Library.Status DrawFooterToAnnotatedXML (_.Library.String context, _.Library.GlobalCharacterStream XSL, _.Library.GlobalCharacterStream delay)
 
_.Library.Status DrawFooterToHTML (_.Library.String context, _.Library.GlobalCharacterStream XSL, _.Library.GlobalCharacterStream delay, _.Library.Boolean oldSummary, _.Library.String orient)
 
_.Library.Status DrawHeaderFO (_.Library.String context, _.Library.GlobalCharacterStream XSL, _.Library.GlobalCharacterStream delay, _.Library.String orient)
 
_.Library.Status DrawHeaderToHTML (_.Library.String context, _.Library.GlobalCharacterStream XSL, _.Library.GlobalCharacterStream delay, _.Library.String orient)
 
 FooterWidth ()
 Returns the width of the footer cell for this object.
 
 HeaderWidth ()
 Returns the width of the header cell for this object.
 
 OldWidth ()
 Returns the width of the cell containing this object.
 
 Width ()
 Returns the width of the cell containing this object.
 

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 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 provides an interface for ZEN report tags to be displayed in a table.

Any tag that will be embedded in a table must extend tableOutput.

When a class that does not implement the "children" property extends tableOutput, it must introduce a children property with XMLPROJECTION="none." See the <p> tag for an example.
When a class that does not implement the "field" or "group" or "removeEmpty" property extends tableOutput it must introduce a "field" or "group" or "removeEmpty" property with XMLPROJECTION="none"

Member Function Documentation

◆ DrawCellFO1()

Part of the tableOutput API that displays the element contained in a table cell for.

the PDF report.

Reimplemented in caption.

◆ DrawCellToHTML()

Part of the tableOutput API that displays the element contained in a table cell for.

the HTML report.

◆ DrawFooterFO()

Part of the tableOutput API that searches for a <summary> child and if it

finds one renders it (just as an <item> tag) as the row/column's footer.

◆ DrawFooterToAnnotatedXML()

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

Part of the tableOutput API that searches for a <summary> child and if it

finds one renders it (just as an <item> tag) as the row/column's footer.

◆ DrawFooterToHTML()

_.Library.Status DrawFooterToHTML ( _.Library.String  context,
_.Library.GlobalCharacterStream  XSL,
_.Library.GlobalCharacterStream  delay,
_.Library.Boolean  oldSummary,
_.Library.String  orient 
)
private

Part of the tableOutput API that searches for a <summary> child and if it

finds one renders it (just as an <item> tag) as the row/column's footer.

◆ DrawHeaderFO()

Part of the tableOutput API that searches for a <caption> child and if it

finds one renders it (just as an <item> tag) as the row/column's header.

As a short-hand, one can simply specify the caption attribute for the tag, but that is less flexible.

◆ DrawHeaderToHTML()

Part of the tableOutput API that searches for a <caption> child and if it

finds one renders it (just as an <item> tag) as the row/column's header.

As a short-hand, one can simply specify the caption attribute for the tag, but that is less flexible.

Member Data Documentation

◆ blockContainerProperty

blockContainerProperty

properties of block container such as overflow='hidden' to truncate data too large

 

◆ caption

Short-hand property to specify the elements caption within the table's header row.

 

◆ colcount

colcount

when grouppath is set, the number of columns in the group

 

◆ colspan

colspan

 

 

◆ crosstabDataGroup

crosstabDataGroup

xpath representing data of cross-tab at row determined by crosstabRowGroup[$row]/

 

◆ crosstabFooterDataField

crosstabFooterDataField

xpath expression, which can use $pos, to get data to display in crosstab footer group

 

◆ crosstabFooterFormatNumber

crosstabFooterFormatNumber

if non-null has footer data is formatted

 

◆ crosstabFooterGroup

crosstabFooterGroup

xpath representing data that will appear in footer

 

◆ crosstabHeaderDataField

crosstabHeaderDataField

Defaults to "".

Field (attribute or element) of crosstabHeaderGroup used in constructing match.

 

◆ crosstabHeaderGroup

crosstabHeaderGroup

cross-tab properties

get headers for cross-tab item from this xpath
used for matching
 

◆ crosstabHeaderGroupLabels

crosstabHeaderGroupLabels

cross-tab properties

get headers for cross-tab item from this xpath
used for writing header labels
 

◆ crosstabHeaderGroupTooLongText

crosstabHeaderGroupTooLongText

cross-tab properties

get headers for cross-tab item from this xpath
used for matching
 

◆ crosstabHeaderLabelDataField

crosstabHeaderLabelDataField

cross-tab properties

get headers for cross-tab item from this xpath
used for writing header labels
relative to crosstabHeaderGroupLabels  

◆ crosstabHeaderMatchField

crosstabHeaderMatchField

xpath representing data that will match against header name crosstabHeaderGroup[$col]

 

◆ crosstabRowGroup

crosstabRowGroup

xpath representing "row" of table where cross-tab data lives

 

◆ crosstabTruncationHeight

crosstabTruncationHeight

the height to use in truncation of cross tab header labels, if not specified inherited from table cell

 

◆ crosstabTruncationWidth

crosstabTruncationWidth

the width to use in truncation of cross tab header lablels, if not specified inherited from table cell

 

◆ foblock

fo attributes of block for things like orphan control

One would specify foblock="orphans='1'"  

◆ grouppath

grouppath

items and captions can now have groups that allow them to repeat on a line

when table draw in orient="col"  

◆ hasFooter

hasFooter

Calculated property that indicates whether or not this element specifies a footer cell.

 

◆ hasHeader

hasHeader

Calculated property that indicates whether or not this element specifies a header cell.

 

◆ includeBlockContainer

includeBlockContainer

Is block wrapped inside a block container.

 

◆ linefeedTreatment

linefeedTreatment

 

 

◆ rowspan

rowspan

 

 

◆ tooLongText

tooLongText

 

 

◆ truncate

truncate

truncate text if it is too long if truncate is true

 

◆ truncationHeight

truncationHeight

the height to use in truncation.

 

◆ truncationWidth

truncationWidth

the width to use in truncation, if not specified inherited from table cell