Home > Class Reference > %SYS namespace > %ZEN.Mojo.Component.documentView

%ZEN.Mojo.Component.documentView

class %ZEN.Mojo.Component.documentView extends %ZEN.Component.component, %ZEN.Component.dataView

This component 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.

Property Inventory

Method Inventory

Parameters

parameter DEFAULTENCLOSINGCLASS = dvEnclosingClass;
Inherited description: Subclasses can set this to change default enclosingClass used for this component.
parameter NAMESPACE = http://www.intersystems.com/zen/mojo;
Inherited description: This is the XML namespace used for library components.
parameter SYSMODULE = core;
Inherited description: If set, this indicates that this system component should be placed in the given "module". A module is a grouping of components within the same class package that share common include (js or css) files. Note that certain root classes are implicitly placed within the "core" module.
Classes outside of the Zen library should not set this, they should use the MODULE instead.

Properties

property OnDrawContent as %ZEN.Datatype.delegator (FORMALSPEC = "seed:%ZEN.Datatype.string", RETURNTYPE = "%Status", ZENENCRYPT = 0);
Optional. Name of Server-side callback method that provides HTML content for this component.
If defined, this callback is invoked on the server when this component is drawn. It provides HTML content by using &html or by using the WRITE command.
This must be the name of a server-only method in the page class that contains this view component.
Property methods: OnDrawContentDisplayToLogical(), OnDrawContentGet(), OnDrawContentIsValid(), OnDrawContentLogicalToDisplay(), OnDrawContentLogicalToOdbc(), OnDrawContentNormalize(), OnDrawContentSet()
property currLevel as %ZEN.Datatype.integer (XMLPROJECTION = "none") [ InitialExpression = 0 ];
Keep track of the current displayed level of content.
Property methods: currLevelDisplayToLogical(), currLevelGet(), currLevelIsValid(), currLevelLogicalToDisplay(), currLevelLogicalToOdbc(), currLevelNormalize(), currLevelSet()
property developerMode as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, show developer diagnostics.
Property methods: developerModeDisplayToLogical(), developerModeGet(), developerModeIsValid(), developerModeLogicalToDisplay(), developerModeLogicalToOdbc(), developerModeLogicalToXSD(), developerModeNormalize(), developerModeSet(), developerModeXSDToLogical()
property effectsEnabled as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
If true, then effects, such as fading and sliding, are enabled.
Property methods: effectsEnabledDisplayToLogical(), effectsEnabledGet(), effectsEnabledIsValid(), effectsEnabledLogicalToDisplay(), effectsEnabledLogicalToOdbc(), effectsEnabledLogicalToXSD(), effectsEnabledNormalize(), effectsEnabledSet(), effectsEnabledXSDToLogical()
property initialDocumentKey as %ZEN.Datatype.string;
Optional starting value of document key (set on the client).
Property methods: initialDocumentKeyDisplayToLogical(), initialDocumentKeyGet(), initialDocumentKeyIsValid(), initialDocumentKeyLogicalToDisplay(), initialDocumentKeyLogicalToOdbc(), initialDocumentKeyNormalize(), initialDocumentKeySet()
property initialLayoutKey as %ZEN.Datatype.string;
Optional starting value of layout key (set on the client).
Property methods: initialLayoutKeyDisplayToLogical(), initialLayoutKeyGet(), initialLayoutKeyIsValid(), initialLayoutKeyLogicalToDisplay(), initialLayoutKeyLogicalToOdbc(), initialLayoutKeyNormalize(), initialLayoutKeySet()
property maxPanels as %ZEN.Datatype.integer [ InitialExpression = 5 ];
Maximum number of allowed panels.
Property methods: maxPanelsDisplayToLogical(), maxPanelsGet(), maxPanelsIsValid(), maxPanelsLogicalToDisplay(), maxPanelsLogicalToOdbc(), maxPanelsNormalize(), maxPanelsSet()
property minContentHeight as %ZEN.Datatype.length;
Minimum height of panels within the document view.
If defined, this is used as the min-height setting for the dvInnerPanel div that wraps each panel.
Note, you must specify units for this property.
Property methods: minContentHeightDisplayToLogical(), minContentHeightGet(), minContentHeightIsValid(), minContentHeightLogicalToDisplay(), minContentHeightLogicalToOdbc(), minContentHeightNormalize(), minContentHeightSet()
property minContentWidth as %ZEN.Datatype.length;
Minimum width of panels within the document view.
If defined, this is used as the min-width setting for the dvInnerPanel div that wraps each panel.
Note, you must specify units for this property.
Property methods: minContentWidthDisplayToLogical(), minContentWidthGet(), minContentWidthIsValid(), minContentWidthLogicalToDisplay(), minContentWidthLogicalToOdbc(), minContentWidthNormalize(), minContentWidthSet()
property ongetdata as %ZEN.Datatype.eventHandler;
ongetdata event handler: If defined, this event returns the source data to be displayed within this component.
Property methods: ongetdataDisplayToLogical(), ongetdataGet(), ongetdataIsValid(), ongetdataLogicalToDisplay(), ongetdataLogicalToOdbc(), ongetdataNormalize(), ongetdataSet()
property ongetlayout as %ZEN.Datatype.eventHandler;
ongetlayout event handler: If defined, this event returns the layout model for the document.
Property methods: ongetlayoutDisplayToLogical(), ongetlayoutGet(), ongetlayoutIsValid(), ongetlayoutLogicalToDisplay(), ongetlayoutLogicalToOdbc(), ongetlayoutNormalize(), ongetlayoutSet()
property onload as %ZEN.Datatype.eventHandler;
onload event handler: If defined, this event provides notification that the documentView is being rendered.
Property methods: onloadDisplayToLogical(), onloadGet(), onloadHandler(), onloadIsValid(), onloadLogicalToDisplay(), onloadLogicalToOdbc(), onloadNormalize(), onloadSet()
property onrender as %ZEN.Datatype.eventHandler;
onrender event handler: If defined, this event provides notification that a document is being rendered.
Property methods: onrenderDisplayToLogical(), onrenderGet(), onrenderIsValid(), onrenderLogicalToDisplay(), onrenderLogicalToOdbc(), onrenderNormalize(), onrenderSet()
property onresolvemethod as %ZEN.Datatype.eventHandler;
onresolvemethod event handler: If defined, this event is called whenever "=[$method.xxx]" is encountered. which will be the name of the "method".
context will contain the associated "context" object.
Property methods: onresolvemethodDisplayToLogical(), onresolvemethodGet(), onresolvemethodIsValid(), onresolvemethodLogicalToDisplay(), onresolvemethodLogicalToOdbc(), onresolvemethodNormalize(), onresolvemethodSet()
property onresolvepluginconflicts as %ZEN.Datatype.eventHandler;
onresolvepluginconflicts event handler: If defined, this event fires after plugin registration has finished and multiple plugins registered for a layout object type. If no conflict occured the event is not fired.
Property methods: onresolvepluginconflictsDisplayToLogical(), onresolvepluginconflictsGet(), onresolvepluginconflictsIsValid(), onresolvepluginconflictsLogicalToDisplay(), onresolvepluginconflictsLogicalToOdbc(), onresolvepluginconflictsNormalize(), onresolvepluginconflictsSet()

Methods

clientmethod browserSupportsCanvas() as %Boolean [ Language = javascript ]
returns true if the browser supports canvas, false otherwise
clientmethod getControlValue(key, level) [ Language = javascript ]
Return the (internal) value of a the control with the given key.
clientmethod getDocumentCriteria() [ Language = javascript ]
Get the document "criteria" for the current level. Criteria is an object or string value that is used to further qualify the data for this document. For example, you can use criteria to hold the search terms for a search results document.
clientmethod getDocumentKey() [ Language = javascript ]
Get the document data "key" for the current level.
clientmethod getItemByKey(key, level) [ Language = javascript ]
Find a layout object given its (qualified) key value and optional level.
clientmethod getLayout() [ Language = javascript ]
Get the layout model the defines the layout and display of the document.
clientmethod getLayoutCriteria() [ Language = javascript ]
Get the layout "criteria" for the current level.
clientmethod getLayoutKey() [ Language = javascript ]
Get the layout "key" for the current level.
clientmethod getLevel() [ Language = javascript ]
Get the current level (indicates how many layers have been pushed on the view).
clientmethod getPluginByLayoutObjectType(identifier) [ Language = javascript ]
returns the plugin for a given layout object type (e.g. "$loop") returns null if no plugin is registered for this layout object type
clientmethod getPluginByName(pluginName) [ Language = javascript ]
returns a plugin for a given plugin name. returns null if no plugin is registered for this name
clientmethod getPluginConflicts() [ Language = javascript ]
clientmethod getPluginMapping(identifier) [ Language = javascript ]
Get the plugin which maps to the given layout object type (e.g. '$loop')
clientmethod getSourceData() [ Language = javascript ]
Get the source data for the document.
This may come from: (a) the layout object (if it defines a sourceData property), (b) the data cache for the current level, or (c) by calling the ongetdata callback.
clientmethod hideItem(key, hide, level) [ Language = javascript ]
Hide or show the item with the given key.
clientmethod injectEventHandler(content, instance) [ Language = javascript ]
clientmethod invalidate() [ Language = javascript ]
Invalidate all cached data and layout for this document view.
clientmethod onloadHandler() [ Language = javascript ]
Inherited description: This client event, if present, is fired when the page is loaded.
clientmethod popAll(render, clearDataCache) [ Language = javascript ]
Pop all "levels" from the document. If render is true, re-render the newly revealed panel. If clearDataCache is also true, then clear the cached data for the revealed panel.
clientmethod popDocument(render, clearDataCache) [ Language = javascript ]
Pop the top-most layout (and data content) off of the document. If render is true, re-render the newly revealed panel. If clearDataCache is also true, then clear the cached data for the revealed panel.
clientmethod popDocuments(number, render, clearDataCache) [ Language = javascript ]
Pop n documents from the document stack. If render is true, re-render the newly revealed panel. If clearDataCache is also true, then clear the cached data for the revealed panel.
clientmethod pushDocument(layoutKey, layoutCriteria, dataKey, dataCriteria) [ Language = javascript ]
Push a new level (panel) onto the document.
The new level uses the given layout key and criteria and data key and criteria to fetch its layout and data.
If dataKey is not provided, then the data from the current level is used.
clientmethod refreshItem(key, level) [ Language = javascript ]
Given a key value and optional level, refresh the associated layout object
clientmethod setControlValue(key, value, level) [ Language = javascript ]
Set the value of a the control with the given key.
Does not fire a change event.
clientmethod setDocumentKey(key, criteria, level) [ Language = javascript ]
Set the document data "key", key and optional search criteria, criteria (json format), for the current level.
Invalidate any data cached for the current level.
clientmethod setItemValue(key, value, level) [ Language = javascript ]
Set the value of a the item with the given key.
clientmethod setLayoutKey(key, criteria, level) [ Language = javascript ]
Set the document layout "key", key and optional search criteria, criteria (json format), for the current level.
Invalidate any data cached for the current level.
clientmethod setPluginMapping(identifier, pluginName) [ Language = javascript ]
Set the plugin which maps to the layout object type (e.g. '$loop')
clientmethod setSize(width, height) [ Language = javascript ]
Set the actual width and height of this component. The containing page should call this to set the size of this component.
clientmethod updateLayout(effect) [ Language = javascript ]
Update the current layout.
effect is the name of an optional transitional effect to apply: e.g. ("fade").

Inherited Members

Inherited Properties

Inherited Methods