Class %ZEN.Report.Display.table

deprecatedclass %ZEN.Report.Display.table extends childrenNode, tableOutput

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

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
	32	23

Summary

Properties
align	altcolor	applyLevel	blockContainerProperty
caption	children	class	colcount
colspan	composite	crosstab	crosstabDataGroup
crosstabFooterDataField	crosstabFooterFormatNumber	crosstabFooterGroup	crosstabHeaderDataField
crosstabHeaderGroup	crosstabHeaderGroupLabels	crosstabHeaderGroupTooLongText	crosstabHeaderLabelDataField
crosstabHeaderMatchField	crosstabRowGroup	crosstabTruncationHeight	crosstabTruncationWidth
dataType	defaultWidth	excelGroupName	excelSheetName
field	foBlockStyle	foHeaderStyle	foStyle
foblock	group	groupby	grouppath
groupstartingwith	hasFooter	hasHeader	htmlstyle
id	ifexpression	ifxpath	includeBlockContainer
includeColIfExpression	includeColIfXPath	includeColUnlessExpression	includeColUnlessXPath
layout	level	linefeedTreatment	oldSummary
onCreateResultSet	ongetData	orderby	orient
parameters	preserveLineFeed	queryClass	queryName
removeEmpty	rowAcrossPages	rowspan	selectmode
selectstylecond	selectstylelist	sql	staticTable
style	stylecall	styleparamNames	styleparams
suppressFoTableColumn	tag	template	tooLongText
truncate	truncationHeight	truncationWidth	unlessexpression
width	withinSmallmultiple	writingMode	xmlnamespace
xmlnamespaceprefix	xpath	xslfostyle

Methods
%AddToSaveSet	%ApplyClass	%ApplyLevelParameters	%BeginGroup
%BeginGroupNoInc	%ClassIsLatestVersion	%ClassName	%ConstructClone
%DeclareLevelParameters	%DispatchClassMethod	%DispatchGetModified	%DispatchGetProperty
%DispatchMethod	%DispatchSetModified	%DispatchSetMultidimProperty	%DispatchSetProperty
%DisplayRowCellsFO	%DisplayTableByCols	%DisplayTableByColsFO	%DisplayTableByRows
%DisplayTableByRowsFO	%DrawCellFO	%DrawCellFO1	%DrawCellToHTML
%DrawCellToHTML1	%DrawFooterFO	%DrawFooterToAnnotatedXML	%DrawFooterToHTML
%DrawHeaderFO	%DrawHeaderToHTML	%DrawSort	%DrawStyleToHTML
%DrawToAnnotatedXML	%DrawToHTML	%DrawToXSLFO	%EndGroup
%EndLevel	%Extends	%FooterWidth	%GetAbsoluteURL
%GetParameter	%HeaderWidth	%IncLevel	%IsA
%IsModified	%New	%NormalizeObject	%ObjectModified
%OldWidth	%OriginalNamespace	%PackageName	%QuoteValue
%QuoteValueEmbedded	%QuoteValueL10N	%RemoveFromSaveSet	%SerializeObject
%SetModified	%StyleHTML	%StyleXSLFO	%ValidateObject
%Width	ApplyClass	CSPLinkToFileLink	CountSpaces
DisplayFOChildrenByCols	DisplayFOChildrenByRows	DisplayHTMLChildrenByCols	DisplayHTMLChildrenByRows
DoDocForHTML	GetDocForXSLFO	HTMLStyle	OutputId
UseCallBack	UseSQL	UseXSLT	XMLDTD
XMLExport	XMLExportToStream	XMLExportToString	XMLNew
XMLSchema	XMLSchemaNamespace	XMLSchemaType	XSLFOStyle
XpathWidthExpression	childHasWidth	containsFooter	containsHeader
getColumnWidth	hasFooterGet	hasHeaderGet	insertAxis
isCSPLink	needsURL	parent	processExclamationPoint
qualify	tagGet

Properties

• property align as %ZEN.Datatype.align;

Specifies the alignment of the table within the page or its current container (table cell, etc.)

• property altcolor as %ZEN.Datatype.color;

This property specifies the background color of the alternate rows (2, 4, 6, ...). This is only possible when orient="col" and group is defined. Currently only works with orient="col".

• property crosstab as %ZEN.Datatype.boolean;

• property dataType as %ZEN.Datatype.string(VALUELIST=",text,number,qname",XMLNAME="data-type") [ InitialExpression = "text" ];

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

• property defaultWidth as %ZEN.Datatype.string;

• property excelGroupName as %ZEN.Datatype.caption [ InitialExpression = "group" ];

• property excelSheetName as %ZEN.Datatype.caption [ InitialExpression = "sheet" ];

• property field as %ZEN.Datatype.string(XMLPROJECTION="NONE");

• property foBlockStyle as %ZEN.Datatype.string;

• property foHeaderStyle as %ZEN.Datatype.string;

• property foStyle as %ZEN.Datatype.string;

• property group as %ZEN.Datatype.string;

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.

• property groupby as %ZEN.Datatype.string;

xpath by which the group will be group-by

• property groupstartingwith as %ZEN.Datatype.string;

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

• property layout as %ZEN.Datatype.string(VALUELIST=",none,fixed,auto") [ InitialExpression = "fixed" ];

Possible values are "auto" and "fixed."
Currently, Apache's FOP rendering engine only supports "fixed."

• property linefeedTreatment as %ZEN.Datatype.string(VALUELIST=",ignore,preserve,treat-as-space,treat-as-zero-width-space",XMLNAME="linefeed-treatment");

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

• property oldSummary as %ZEN.Datatype.boolean [ InitialExpression = 1 ];

• property onCreateResultSet as %ZEN.Datatype.string;

Specifies callback method which returns ResultSe

• property ongetData as %ZEN.Datatype.string;

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.

• property orderby as %ZEN.Datatype.string;

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

• property orient as %ZEN.Datatype.string(VALUELIST=",row,col") [ InitialExpression = "col" ];

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.

• property parameters as list of %ZEN.Report.Display.parameter(XMLNAME="parameter",XMLPROJECTION="ELEMENT");

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.

• property preserveLineFeed as %ZEN.Datatype.boolean [ InitialExpression = 0 ];

• property queryClass as %ZEN.Datatype.className;

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.

• property queryName as %ZEN.Datatype.classMember;

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.

• property removeEmpty as %ZEN.Datatype.boolean [ InitialExpression = 0 ];

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

• property rowAcrossPages as %ZEN.Datatype.boolean [ InitialExpression = 1 ];

Boolean value used to trigger "keep-together" logic within the element to not allow a row to split across a page

• property selectmode as %ZEN.Datatype.integer(VALUELIST=",0,1,2");

Specifies %SELECTMODE of sql or query. 0=Logical, 1=ODBC, 2=Display.

• property sql as %ZEN.Datatype.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.

• property staticTable as %ZEN.Datatype.boolean [ InitialExpression = 0 ];

if staticTable is set we draw table as is specified by elements etc.

• property suppressFoTableColumn as %ZEN.Datatype.boolean [ InitialExpression = 0 ];

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

• property writingMode as %ZEN.Datatype.string(VALUELIST=",lr-tb,rl-tb,tb-rl,lr,rl,tb,inherit",XMLNAME="writing-mode");

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

Methods

• method %DisplayRowCellsFO(ByRef context As %String, XSL As %GlobalCharacterStream, delay As %GlobalCharacterStream, ByRef incell As %Boolean, tableSection As %String) as %Status

• method %DisplayTableByCols(ByRef context As %String, XSL As %GlobalCharacterStream, delay As %GlobalCharacterStream) as %Status

• method %DisplayTableByColsFO(ByRef context As %String, XSL As %GlobalCharacterStream, delay As %GlobalCharacterStream) as %Status

• method %DisplayTableByRows(ByRef context As %String, XSL As %GlobalCharacterStream, delay As %GlobalCharacterStream) as %Status

• method %DisplayTableByRowsFO(ByRef context As %String, XSL As %GlobalCharacterStream, delay As %GlobalCharacterStream, ByRef incell As %Boolean) as %Status

• method %DrawToAnnotatedXML(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, ByRef delay As %GlobalCharacterStream) as %Status

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.

• method %DrawToHTML(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, delay As %GlobalCharacterStream) as %Status

This method outputs the necessary stylesheet information for the HTML report. Every tag should override this method.

• method %DrawToXSLFO(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, delay As %GlobalCharacterStream, ByRef incell As %Boolean = 0) as %Status

This method outputs the necessary stylesheet information for the PDF report. Every tag should override this method.

• method DisplayFOChildrenByCols(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, ByRef delay As %GlobalCharacterStream, pLevel As %Integer) as %Status

• method DisplayFOChildrenByRows(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, ByRef delay As %GlobalCharacterStream, pLevel As %Integer, containsHeader, containsFooter, IsSQL As %Boolean, tableSection As %String)

• method DisplayHTMLChildrenByCols(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, ByRef delay As %GlobalCharacterStream, pLevel As %Integer)

• method DisplayHTMLChildrenByRows(ByRef context As %String, ByRef XSL As %GlobalCharacterStream, ByRef delay As %GlobalCharacterStream, pLevel As %Integer, IsSQL As %Boolean) as %Status

• method UseCallBack()

• method UseSQL()

• method UseXSLT()

• classmethod XpathWidthExpression(width As %String)

• method childHasWidth() as %String

• method containsFooter() as %Boolean

• method containsHeader() as %Boolean

• method getColumnWidth(colType As %String) as %String

Note: colType is either "header", "body", or "footer" used only in tables by row

Class Reference IRIS for UNIX 2024.1.2
Documentation Search