This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see the InterSystems IRIS Migration Guide and Migrating to InterSystems IRIS, both available on the WRC Distributions page (login required).

%ZEN.Report.Display.tableOutput

abstract class %ZEN.Report.Display.tableOutput extends %ZEN.Report.Display.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 Inventory (Including Private)

Method Inventory (Including Private)

Properties

property blockContainerProperty as %ZEN.Datatype.string (XMLNAME = "block-container-property");
properties of block container such as overflow='hidden' to truncate data too large
Property methods: blockContainerPropertyDisplayToLogical(), blockContainerPropertyGet(), blockContainerPropertyIsValid(), blockContainerPropertyLogicalToDisplay(), blockContainerPropertyLogicalToOdbc(), blockContainerPropertyNormalize(), blockContainerPropertySet()
property caption as %ZEN.Datatype.caption;
Short-hand property to specify the elements caption within the table's header row.
Property methods: captionDisplayToLogical(), captionGet(), captionIsValid(), captionLogicalToDisplay(), captionLogicalToOdbc(), captionNormalize(), captionSet()
property colcount as %ZEN.Datatype.string;
when grouppath is set, the number of columns in the group
Property methods: colcountDisplayToLogical(), colcountGet(), colcountIsValid(), colcountLogicalToDisplay(), colcountLogicalToOdbc(), colcountNormalize(), colcountSet()
property colspan as %ZEN.Datatype.integer;
Property methods: colspanDisplayToLogical(), colspanGet(), colspanIsValid(), colspanLogicalToDisplay(), colspanLogicalToOdbc(), colspanNormalize(), colspanSet()
property crosstabDataGroup as %ZEN.Datatype.string;
xpath representing data of cross-tab at row determined by crosstabRowGroup[$row]/
Property methods: crosstabDataGroupDisplayToLogical(), crosstabDataGroupGet(), crosstabDataGroupIsValid(), crosstabDataGroupLogicalToDisplay(), crosstabDataGroupLogicalToOdbc(), crosstabDataGroupNormalize(), crosstabDataGroupSet()
property crosstabFooterDataField as %ZEN.Datatype.string;
xpath expression, which can use $pos, to get data to display in crosstab footer group
Property methods: crosstabFooterDataFieldDisplayToLogical(), crosstabFooterDataFieldGet(), crosstabFooterDataFieldIsValid(), crosstabFooterDataFieldLogicalToDisplay(), crosstabFooterDataFieldLogicalToOdbc(), crosstabFooterDataFieldNormalize(), crosstabFooterDataFieldSet()
property crosstabFooterFormatNumber as %ZEN.Datatype.string;
if non-null has footer data is formatted
Property methods: crosstabFooterFormatNumberDisplayToLogical(), crosstabFooterFormatNumberGet(), crosstabFooterFormatNumberIsValid(), crosstabFooterFormatNumberLogicalToDisplay(), crosstabFooterFormatNumberLogicalToOdbc(), crosstabFooterFormatNumberNormalize(), crosstabFooterFormatNumberSet()
property crosstabFooterGroup as %ZEN.Datatype.string;
xpath representing data that will appear in footer
Property methods: crosstabFooterGroupDisplayToLogical(), crosstabFooterGroupGet(), crosstabFooterGroupIsValid(), crosstabFooterGroupLogicalToDisplay(), crosstabFooterGroupLogicalToOdbc(), crosstabFooterGroupNormalize(), crosstabFooterGroupSet()
property crosstabHeaderDataField as %ZEN.Datatype.string;
Defaults to "". Field (attribute or element) of crosstabHeaderGroup used in constructing match.
Property methods: crosstabHeaderDataFieldDisplayToLogical(), crosstabHeaderDataFieldGet(), crosstabHeaderDataFieldIsValid(), crosstabHeaderDataFieldLogicalToDisplay(), crosstabHeaderDataFieldLogicalToOdbc(), crosstabHeaderDataFieldNormalize(), crosstabHeaderDataFieldSet()
property crosstabHeaderGroup as %ZEN.Datatype.string;
cross-tab properties
get headers for cross-tab item from this xpath
used for matching
Property methods: crosstabHeaderGroupDisplayToLogical(), crosstabHeaderGroupGet(), crosstabHeaderGroupIsValid(), crosstabHeaderGroupLabelsDisplayToLogical(), crosstabHeaderGroupLabelsGet(), crosstabHeaderGroupLabelsIsValid(), crosstabHeaderGroupLabelsLogicalToDisplay(), crosstabHeaderGroupLabelsLogicalToOdbc(), crosstabHeaderGroupLabelsNormalize(), crosstabHeaderGroupLabelsSet(), crosstabHeaderGroupLogicalToDisplay(), crosstabHeaderGroupLogicalToOdbc(), crosstabHeaderGroupNormalize(), crosstabHeaderGroupSet(), crosstabHeaderGroupTooLongTextDisplayToLogical(), crosstabHeaderGroupTooLongTextGet(), crosstabHeaderGroupTooLongTextIsValid(), crosstabHeaderGroupTooLongTextLogicalToDisplay(), crosstabHeaderGroupTooLongTextLogicalToOdbc(), crosstabHeaderGroupTooLongTextNormalize(), crosstabHeaderGroupTooLongTextSet()
property crosstabHeaderGroupLabels as %ZEN.Datatype.string;
cross-tab properties
get headers for cross-tab item from this xpath
used for writing header labels
Property methods: crosstabHeaderGroupLabelsDisplayToLogical(), crosstabHeaderGroupLabelsGet(), crosstabHeaderGroupLabelsIsValid(), crosstabHeaderGroupLabelsLogicalToDisplay(), crosstabHeaderGroupLabelsLogicalToOdbc(), crosstabHeaderGroupLabelsNormalize(), crosstabHeaderGroupLabelsSet()
property crosstabHeaderGroupTooLongText as %ZEN.Datatype.string (VALUELIST = ",none,truncate,wrap,unset") [ InitialExpression = "unset" ];
cross-tab properties
get headers for cross-tab item from this xpath
used for matching
Property methods: crosstabHeaderGroupTooLongTextDisplayToLogical(), crosstabHeaderGroupTooLongTextGet(), crosstabHeaderGroupTooLongTextIsValid(), crosstabHeaderGroupTooLongTextLogicalToDisplay(), crosstabHeaderGroupTooLongTextLogicalToOdbc(), crosstabHeaderGroupTooLongTextNormalize(), crosstabHeaderGroupTooLongTextSet()
property crosstabHeaderLabelDataField as %ZEN.Datatype.string;
cross-tab properties
get headers for cross-tab item from this xpath
used for writing header labels
relative to crosstabHeaderGroupLabels
Property methods: crosstabHeaderLabelDataFieldDisplayToLogical(), crosstabHeaderLabelDataFieldGet(), crosstabHeaderLabelDataFieldIsValid(), crosstabHeaderLabelDataFieldLogicalToDisplay(), crosstabHeaderLabelDataFieldLogicalToOdbc(), crosstabHeaderLabelDataFieldNormalize(), crosstabHeaderLabelDataFieldSet()
property crosstabHeaderMatchField as %ZEN.Datatype.string;
xpath representing data that will match against header name crosstabHeaderGroup[$col]
Property methods: crosstabHeaderMatchFieldDisplayToLogical(), crosstabHeaderMatchFieldGet(), crosstabHeaderMatchFieldIsValid(), crosstabHeaderMatchFieldLogicalToDisplay(), crosstabHeaderMatchFieldLogicalToOdbc(), crosstabHeaderMatchFieldNormalize(), crosstabHeaderMatchFieldSet()
property crosstabRowGroup as %ZEN.Datatype.string;
xpath representing "row" of table where cross-tab data lives
Property methods: crosstabRowGroupDisplayToLogical(), crosstabRowGroupGet(), crosstabRowGroupIsValid(), crosstabRowGroupLogicalToDisplay(), crosstabRowGroupLogicalToOdbc(), crosstabRowGroupNormalize(), crosstabRowGroupSet()
property crosstabTruncationHeight as %ZEN.Datatype.string;
the height to use in truncation of cross tab header labels, if not specified inherited from table cell
Property methods: crosstabTruncationHeightDisplayToLogical(), crosstabTruncationHeightGet(), crosstabTruncationHeightIsValid(), crosstabTruncationHeightLogicalToDisplay(), crosstabTruncationHeightLogicalToOdbc(), crosstabTruncationHeightNormalize(), crosstabTruncationHeightSet()
property crosstabTruncationWidth as %ZEN.Datatype.string;
the width to use in truncation of cross tab header lablels, if not specified inherited from table cell
Property methods: crosstabTruncationWidthDisplayToLogical(), crosstabTruncationWidthGet(), crosstabTruncationWidthIsValid(), crosstabTruncationWidthLogicalToDisplay(), crosstabTruncationWidthLogicalToOdbc(), crosstabTruncationWidthNormalize(), crosstabTruncationWidthSet()
property foblock as %ZEN.Datatype.string;
fo attributes of block for things like orphan control One would specify foblock="orphans='1'"
Property methods: foblockDisplayToLogical(), foblockGet(), foblockIsValid(), foblockLogicalToDisplay(), foblockLogicalToOdbc(), foblockNormalize(), foblockSet()
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 methods: grouppathDisplayToLogical(), grouppathGet(), grouppathIsValid(), grouppathLogicalToDisplay(), grouppathLogicalToOdbc(), grouppathNormalize(), grouppathSet()
property hasFooter as %Boolean (XMLPROJECTION = "none") [ Calculated ];
Calculated property that indicates whether or not this element specifies a footer cell.
Property methods: hasFooterDisplayToLogical(), hasFooterGet(), hasFooterIsValid(), hasFooterLogicalToDisplay(), hasFooterLogicalToXSD(), hasFooterNormalize(), hasFooterXSDToLogical()
property hasHeader as %Boolean (XMLPROJECTION = "none") [ Calculated ];
Calculated property that indicates whether or not this element specifies a header cell.
Property methods: hasHeaderDisplayToLogical(), hasHeaderGet(), hasHeaderIsValid(), hasHeaderLogicalToDisplay(), hasHeaderLogicalToXSD(), hasHeaderNormalize(), hasHeaderXSDToLogical()
property includeBlockContainer as %ZEN.Datatype.boolean (XMLNAME = "include-block-container");
Is block wrapped inside a block container
Property methods: includeBlockContainerDisplayToLogical(), includeBlockContainerGet(), includeBlockContainerIsValid(), includeBlockContainerLogicalToDisplay(), includeBlockContainerLogicalToOdbc(), includeBlockContainerLogicalToXSD(), includeBlockContainerNormalize(), includeBlockContainerSet(), includeBlockContainerXSDToLogical()
property linefeedTreatment as %ZEN.Datatype.string (VALUELIST = ",ignore,preserve,treat-as-space,treat-as-zero-width-space", XMLNAME = "linefeed-treatment");
Property methods: linefeedTreatmentDisplayToLogical(), linefeedTreatmentGet(), linefeedTreatmentIsValid(), linefeedTreatmentLogicalToDisplay(), linefeedTreatmentLogicalToOdbc(), linefeedTreatmentNormalize(), linefeedTreatmentSet()
property rowspan as %ZEN.Datatype.integer;
Property methods: rowspanDisplayToLogical(), rowspanGet(), rowspanIsValid(), rowspanLogicalToDisplay(), rowspanLogicalToOdbc(), rowspanNormalize(), rowspanSet()
property tooLongText as %ZEN.Datatype.string (VALUELIST = ",none,truncate,wrap,unset", XMLNAME = "too-long-text") [ InitialExpression = "unset" ];
Property methods: tooLongTextDisplayToLogical(), tooLongTextGet(), tooLongTextIsValid(), tooLongTextLogicalToDisplay(), tooLongTextLogicalToOdbc(), tooLongTextNormalize(), tooLongTextSet()
property truncate as %ZEN.Datatype.boolean;
truncate text if it is too long if truncate is true
Property methods: truncateDisplayToLogical(), truncateGet(), truncateIsValid(), truncateLogicalToDisplay(), truncateLogicalToOdbc(), truncateLogicalToXSD(), truncateNormalize(), truncateSet(), truncateXSDToLogical()
property truncationHeight as %ZEN.Datatype.string (XMLNAME = "truncation-height");
the height to use in truncation.
Property methods: truncationHeightDisplayToLogical(), truncationHeightGet(), truncationHeightIsValid(), truncationHeightLogicalToDisplay(), truncationHeightLogicalToOdbc(), truncationHeightNormalize(), truncationHeightSet()
property truncationWidth as %ZEN.Datatype.string (XMLNAME = "truncation-width");
the width to use in truncation, if not specified inherited from table cell
Property methods: truncationWidthDisplayToLogical(), truncationWidthGet(), truncationWidthIsValid(), truncationWidthLogicalToDisplay(), truncationWidthLogicalToOdbc(), truncationWidthNormalize(), truncationWidthSet()

Methods

method %BeginGroup(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, ByRef delay As %GlobalCharacterStream, mode As %String, name As %String)
method %BeginGroupNoInc(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 %DrawFooterToAnnotatedXML(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, ByRef delay As %GlobalCharacterStream) 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, datatype As %String) as %Status
method %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
method hasHeaderGet() as %Boolean

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

Subclasses

Feedback