abstract class %ZEN.Report.Display.tableOutput
extends controller
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"
• property blockContainerProperty
as %ZEN.Datatype.string(XMLNAME="block-container-property");
properties of block container such as overflow='hidden' to truncate data too large
• property caption
as %ZEN.Datatype.caption;
Short-hand property to specify the elements caption within the table's header row.
• property colcount
as %ZEN.Datatype.string;
when grouppath is set, the number of columns in the group
• property colspan
as %ZEN.Datatype.integer;
• property crosstabDataGroup
as %ZEN.Datatype.string;
xpath representing data of cross-tab at row determined by crosstabRowGroup[$row]/
• property crosstabFooterFormatNumber
as %ZEN.Datatype.string;
if non-null has footer data is formatted
• property crosstabFooterGroup
as %ZEN.Datatype.string;
xpath representing data that will appear in footer
• property crosstabHeaderDataField
as %ZEN.Datatype.string;
Defaults to "". Field (attribute or element) of crosstabHeaderGroup used in constructing match.
• property crosstabHeaderGroup
as %ZEN.Datatype.string;
cross-tab properties
get headers for cross-tab item from this xpath
• property crosstabHeaderMatchField
as %ZEN.Datatype.string;
xpath representing data that will match against header name crosstabHeaderGroup[$col]
• property crosstabRowGroup
as %ZEN.Datatype.string;
xpath representing "row" of table where cross-tab data lives
• property foblock
as %ZEN.Datatype.string;
fo attributes of block for things like orphan control
One would specify foblock="orphans='1'"
• property grouppath
as %ZEN.Datatype.string;
items and captions can now have groups that allow them to repeat on a line
when table draw in orient="col"
• property hasFooter
as %Boolean(XMLPROJECTION="none") [ Calculated ];
Calculated property that indicates whether or not this element specifies a footer cell.
• property hasHeader
as %Boolean(XMLPROJECTION="none") [ Calculated ];
Calculated property that indicates whether or not this element specifies a header cell.
• property includeBlockContainer
as %ZEN.Datatype.boolean(XMLNAME="include-block-container");
Is block wrapped inside a block container
• property linefeedTreatment
as %ZEN.Datatype.string(VALUELIST=",ignore,preserve,treat-as-space,treat-as-zero-width-space",XMLNAME="linefeed-treatment");
• property rowspan
as %ZEN.Datatype.integer;
• property tooLongText
as %ZEN.Datatype.string(VALUELIST=",none,truncate,wrap,unset",XMLNAME="too-long-text") [ InitialExpression = "unset" ];
• property truncate
as %ZEN.Datatype.boolean;
truncate text if it is too long if truncate is true
• property truncationHeight
as %ZEN.Datatype.string(XMLNAME="truncation-height");
the height to use in truncation.
• property truncationWidth
as %ZEN.Datatype.string(XMLNAME="truncation-width");
the width to use in truncation, if not specified inherited from table cell
• classmethod %BeginGroup(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, ByRef delay As %GlobalCharacterStream, mode As %String, name As %String)
• method %DrawCellFO(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, ByRef delay As %GlobalCharacterStream, orient As %String)
as %Status
• method %DrawCellFO1(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, ByRef delay As %GlobalCharacterStream)
as %Status
Part of the tableOutput API that displays the element contained in a table cell for
the PDF report.
• method %DrawCellToHTML(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, ByRef delay As %GlobalCharacterStream, orient As %String)
as %Status
Part of the tableOutput API that displays the element contained in a table cell for
the HTML report.
• method %DrawCellToHTML1(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, ByRef delay As %GlobalCharacterStream)
as %Status
• method %DrawFooterFO(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, ByRef delay As %GlobalCharacterStream, oldSummary As %Boolean, orient As %String)
as %Status
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.
• method %DrawFooterToHTML(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, ByRef delay As %GlobalCharacterStream, oldSummary As %Boolean, orient As %String)
as %Status
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.
• method %DrawHeaderFO(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, ByRef delay As %GlobalCharacterStream, orient As %String)
as %Status
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.
• method %DrawHeaderToHTML(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, ByRef delay As %GlobalCharacterStream, orient As %String)
as %Status
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.
• classmethod %DrawSort(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, ByRef delay As %GlobalCharacterStream, orderby As %String)
as %Status
• classmethod %EndGroup(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, ByRef delay As %GlobalCharacterStream, mode As %String, name As %String)
• method %FooterWidth()
Returns the width of the footer cell for this object.
• method %HeaderWidth()
Returns the width of the header cell for this object.
• method %OldWidth()
Returns the width of the cell containing this object.
• method %Width()
Returns the width of the cell containing this object.
• method hasFooterGet()
as %Boolean
This is a Get accessor method for the hasFooter property.
• method hasHeaderGet()
as %Boolean
This is a Get accessor method for the hasHeader property.
