Class %ZEN.ComponentEx.documentView

deprecatedclass %ZEN.ComponentEx.documentView extends %ZEN.Component.abstractGroup, %ZEN.Component.dataView

Experimental Document view component.
This provides an way to display a "document" -- data supplied as a graph of JavaScript objects and rendered using a model supplied by another object graph.

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
1	12	12

Summary

Properties
%condition	%controller	%import	%includeFiles
%page	%resource	align	aux
blockStyle	children	composite	containerStyle
controller	controllerId	disabled	documentStyle
dragEnabled	dropEnabled	enclosingClass	enclosingStyle
error	evenRowStyle	headerRowStyle	height
hidden	hint	hintClass	hintStyle
id	index	label	labelClass
labelDisabledClass	labelStyle	name	oddRowStyle
onafterdrag	onbeforedrag	ondrag	ondrop
ongetdata	ongetlayout	onhide	onnotifyView
onrefresh	onshow	onupdate	paraStyle
parent	showLabel	slice	tableBorder
tableStyle	title	titleStyle	tuple
useLayout	valign	visible	width
window

Methods
%AddChild	%AddChildAfter	%AddChildBefore	%AddToSaveSet
%Attr	%BindExport	%ClassIsLatestVersion	%ClassName
%ConstructClone	%DispatchClassMethod	%DispatchGetModified	%DispatchGetProperty
%DispatchMethod	%DispatchSetModified	%DispatchSetMultidimProperty	%DispatchSetProperty
%DrawComponentHTML	%DrawHTML	%DrawJSStrings	%EnclosingDivId
%Eval	%EvalC	%Extends	%ForceClientRender
%GetChildIndex	%GetEventHandlers	%GetParameter	%GetXMLName
%IsA	%IsModified	%MakeId	%New
%NormalizeObject	%ObjectModified	%OnAddToPageAfter	%OnAddToPageBefore
%OnDrawEnclosingDiv	%OnDrawObjectProperties	%OnMutateChildren	%OnObjectSynch
%OnZENDeserialize	%OriginalNamespace	%PackageName	%QuoteValue
%QuoteValueL10N	%RemoveChild	%RemoveChildren	%RemoveFromSaveSet
%Self	%SerializeObject	%SetModified	%ValidateObject
XMLDTD	XMLExport	XMLExportToStream	XMLExportToString
XMLNew	XMLSchema	XMLSchemaNamespace	XMLSchemaType
addChild	addChildAfter	addChildBefore	childrenMutated
dragFinishHandler	dragHandler	dragNotifyHandler	dragStartHandler
dropHandler	dropStartHandler	eval	exposeComponent
findElement	fireOnUpdateEvent	getChildIndex	getController
getEnclosingDiv	getHidden	getHintElement	getLabelElement
getLayout	getProperty	getSettings	getSourceData
getType	invokeSuper	isOfType	makeId
onCreate	onDelete	onDisplayHandler	onEndModalHandler
onPopupAction	onRefreshContents	onSerialize	onStartModalHandler
ondisabledHandler	onloadHandler	onunloadHandler	onupdateHandler
refreshContents	removeChild	render	renderChart
renderContents	renderGeneric	renderImage	renderList
renderPara	renderSVG	resolveNamedStyle	sendEventToController
setControllerId	setHidden	setOverlayMode	setProperty
setPropertyAll	startProgressBar	stopProgressBar

Parameters

• parameter DEFAULTENCLOSINGCLASS = "dvEnclosingClass";

Subclasses can set this to change default enclosingClass used for this component.

Properties

• property blockStyle as %ZEN.Datatype.style;

Style for blocks (sections) within the document. A block encloses a title and paragraph or a table.

• property documentStyle as %ZEN.Datatype.style;

Style for overall document.

• property evenRowStyle as %ZEN.Datatype.style [ InitialExpression = "background:#F8F8F8;" ];

Style for even rows within tables.

• property headerRowStyle as %ZEN.Datatype.style [ InitialExpression = "background:#E0E0FF;" ];

Style for header rows within tables.

• property oddRowStyle as %ZEN.Datatype.style;

Style for odd rows within tables.

• property ongetdata as %ZEN.Datatype.eventHandler;

ongetdata event handler: If defined, this event is returns the source data to be displayed within this component.

• property ongetlayout as %ZEN.Datatype.eventHandler;

ongetlayout event handler: If defined, this event is returns the layout model for the document.

• property paraStyle as %ZEN.Datatype.style;

Style for paragraphs within the document.

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

Display borders for tables.

• property tableStyle as %ZEN.Datatype.style;

Style for tables within the document.

• property titleStyle as %ZEN.Datatype.style;

Style for titles within the document.

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

If false, show a generic view of the data with no layout applied.

Methods

• method %DrawHTML()

Static HTML display method: draw the BODY of this component as HTML.
Subclasses implement this in order to render the static HTML contents of a component.

• method eval(data, expr, context) [ Language = javascript ]

Evaluate a display value expression and return the result.
data is the data source object supplying the data.
expr is the expression. If is starts with "=", it is interpreted as an expression.
An expression can refer to a property within the data source object:
"=[prop]" evaluates to sourceData.prop
"=[propA.propB]" evaluates to sourceData.propA.propB (if propA is not an object, return "")
"=[prop[0]]" evaluates to sourceData.prop[0]
context is current context object (which modifies the reference to the data source object).

• method getLayout() [ Language = javascript ]

Get the layout model the defineds the layout and display of the document.

• method getSourceData() [ Language = javascript ]

Get the source data for the document.

• method renderChart(key, data, sect, context, display) [ Language = javascript ]

Render an embedded chart.

• method renderContents() [ Language = javascript ]

Client-side method to render this control.

• method renderGeneric(data, level, counter) [ Language = javascript ]

Render the HTML for a "generic" view of the given source data.

• method renderImage(key, data, sect, context, display) [ Language = javascript ]

Render an image.

• method renderList(key, data, list, context, display) [ Language = javascript ]

Render a list of items.
key is the key (prefix) used to assign key values to the items.
data is the source data.
list is the list of items.
context is the inherited data context.
displat specifies how to display the items: 'div' or 'td'.

• method renderPara(key, data, sect, context, display) [ Language = javascript ]

Render a paragraph.

• method resolveNamedStyle(namedStyle, data, context) [ Language = javascript ]

Resolve the value of a named style. evaluate and lookup the style in the local list of named styles.

• method setProperty(property, value, value2) [ Language = javascript ]

Set the value of a named property.

Class Reference IRIS for UNIX 2024.1.2
Documentation Search