Represents a page within a Zen application. More...

Inheritance diagram for abstractPage:

[legend]

Collaboration diagram for abstractPage:

[legend]

Public Member Functions
_.Library.Boolean	DrawFrameSet ()
	If defined, draw out a frameset definition instead of the normal body tags.

_.Library.Status	DrawJSResources ()
	Write out JS code to set up resource strings.

_.Library.Status	GetJSResources (_.Library.String pResources)
	Get the list of localized JavaScript resource strings for this page.

_.Library.Status	OnGetJSResources (_.Library.String pResources)
	Pages can implement this callback method in order to define a set of. More...

_.Library.Status	OnNew ()
	Note: This is marked as Final. More...

	cancelPopup ()
	This client method will cancel a popup page (i.e. More...

	correctIELayering (div)
	Correct for an embedded object layering bug that has persisted in IE since the invention. More...

	createComponent (name)
	Client-side method to create a Zen component on the client. More...

	createComponentNS (ns, name, parent, div)
	Client-side method to create a Zen component on the client. More...

	deleteComponent (comp, refresh, sync)
	Client-side method to remove a Zen component from a page on the client. More...

	endModal ()
	End the current modal component; restore previous modal item. More...

	fireOnResizeEvent ()
	Client-side method: fire onresize event for page component.

	fireOnUnloadEvent ()
	Client-side method: fire onunload event for every component that defines one. More...

	firePopupAction (action, value, close)
	This client method will notify the parent window of this popup that. More...

	getComponent (index)
	Client-side method to find component by component index. More...

	getComponentById (id, tuple)
	Client-side method to find a component by user-assigned id value. More...

	getOpener ()
	Helper method to get a reference to the window that launched this window. More...

	gotoPage (url)
	Set the location of the browser to a new url. More...

	launchPopupWindow (url, pageName, features, parms, parent)
	Open a popup window with given url url and page name pageName. More...

	onServerMethodCall (method)
	If implemented, this method is called just. More...

	onServerMethodError (err, errObject)
	If implemented, this method is called whenever. More...

	onServerMethodReturn (method)
	If implemented, this method is called just. More...

	onhandleAutoLogoutWarn ()
	Handle client page modifications while the session is still valid before the page is reloaded. More...

	onkeydownHandler (evt)
	This client event, if present, is fired when a keydown event occurs on the page.

	onkeyupHandler (evt)
	This client event, if present, is fired when a keyup event occurs on the page.

	onlayoutHandler (load)
	This client event, if present, is fired when the page. More...

	onloadHandler ()
	This client event, if present, is fired when the page is loaded.

	onlogoutHandler ()
	This client method, if defined and the AUTOLOGOUT parameter for this. More...

	onoverlayHandler (index)
	This client event, if present, is fired when a component with. More...

	onresizeHandler ()
	This client event, if present, is fired when the page is resized.

	popupActionHandler (parent, name, action, value)
	Internal method. More...

	setComponentId (obj, id)
	Change id of given component.

	setTraceOption (name, flag)
	This client method lets you turn the various client-side. More...

	startModal (component)
	Make the given component modal; That is all events outside of this. More...

Public Member Functions inherited from group
	LayoutChildren (_.Library.Integer pTuple)
	Does the actual work of laying out the children of this group. More...

	setProperty (property, value, value2)
	Set the value of a named property. More...

Public Member Functions inherited from abstractGroup
	addChild (component, refresh)
	Client-side method. More...

	addChildAfter (component, sibling, refresh)
	Client-side method. More...

	addChildBefore (component, sibling, refresh)
	Client-side method. More...

	childrenMutated ()
	Notification to subclasses that a child has been added or removed. More...

	exposeComponent ()
	This manages the ondisplay event callback handling. More...

	getChildIndex (child)
	Look for the given child object within this group's set of. More...

	onRefreshContents ()
	This client event, if present, is fired when the page is loaded.

	ondisabledHandler ()
	Client-side method that is called when a group's disabled. More...

	removeChild (component)
	Client-side method. More...

	setOverlayMode (mode)
	Set overlay mode for each child of this group.

	setPropertyAll (property, value, value2)
	Apply the given value to the specified property for. More...

Public Member Functions inherited from component
	dragFinishHandler (dragData)
	This is called when a drag operation started within this component. More...

	dragHandler ()
	This is called by the layout manager when a drag-and-drop operation. More...

	dragNotifyHandler (dragData)
	This is called by the layout manager when a drag operation. More...

	dragStartHandler (dragData)
	This is called when a drag operation is started within this component. More...

	dropHandler ()
	This is called by the layout manager when a drag-and-drop operation. More...

	dropStartHandler (dragData)
	This is called when a data drop operation is started within this component. More...

	getEnclosingDiv ()
	Client-side method returns the div element that encloses. More...

_.Library.String	getHidden ()
	Return whether this component is hidden.

	getHintElement ()
	Client-side method returns the HTML element that displays. More...

	getLabelElement ()
	Client-side method returns the HTML element that displays. More...

	onDisplayHandler ()
	This client callback is called from exposeComponent after. More...

	onEndModalHandler (zindex)
	Notification that this component is about to stop being modal.

	onPopupAction (popupName, action, value)
	This client event, if present, is fired when a popup page has specified. More...

	onStartModalHandler (zindex)
	Notification that this component is about to become modal. More...

	refreshContents (sync)
	This method, called from a client page, invokes this component's. More...

	setHidden (flag)
	If flag is true, hide this component. More...

	startProgressBar (div)
	Start the display of a progress bar within display. More...

	stopProgressBar ()
	Stop the timer used by the Progress bar.

Public Member Functions inherited from object
_.Library.Status	OnNew (_.Library.RawString initvalue)
	Constructor for Zen objects. More...

	findElement (subid)
	Client-side utility method that finds an HTML element with a. More...

	fireOnUpdateEvent ()
	This is called when an object is updated from the server. More...

_.Library.String	getProperty (property, key)
	Return the value of a named property (i.e. More...

	getSettings (settings)
	Client-side method that returns a list of this component's. More...

	getType ()
	Returns the component type of this object. More...

	invokeSuper (method, args)
	Invoke the superclass method method of the current. More...

	isOfType (type)
	Returns true if this object is of the given component type. More...

	makeId (subid)
	client-side utility method that constructs a component-specific id More...

	onCreate ()
	This client method, if present, is called when this component is. More...

	onDelete ()
	This client method, if present, is called when this component is. More...

	onSerialize ()
	This client event, if present, is fired before a component. More...

	onunloadHandler ()
	This client event, if present, is fired when the page is unloaded. More...

	onupdateHandler ()
	This client method, if present, is fired when the object is updated from the server.

	render ()
	This causes a component that draws its contents dynamically. More...

	renderContents ()
	This method, if present, is called when this component. More...

	renderSVG (document, parent)
	This method is only needed for SVG components. More...

Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...

_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...

_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...

_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...

Public Member Functions inherited from Adaptor
_.Library.Status	XMLExport (_.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent, _.Library.Boolean local, _.Net.MIMEPart mimeAttachments)
	Serialize an XML enabled class as an XML document and write. More...

_.Library.Status	XMLExportToStream (_.Stream.Object export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
	Serialize an XML enabled class as an XML document and appends it to a stream. More...

_.Library.Status	XMLExportToString (_.Library.String export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
	Serialize an XML enabled class as an XML document and write it to a string. More...

Static Public Member Functions
_.Library.Boolean	JavaInstalled ()
	Wrapper method for ZEN.Utils. More...

_.Library.Status	OnPage ()
	Render the contents of this Zen page.

	OnPostHTTP ()
	PostHTTP handler for all Zen pages. More...

_.Library.Status	OnPostHyperEvent ()
	Event handler which is invoked after a hyperevent method is called on this page.

_.Library.Boolean	OnPreHTTP ()
	PreHTTP handler for all Zen pages. More...

_.Library.Status	OnPreHyperEvent (_.Library.String class, _.Library.String method)
	Event handler which is invoked before a hyperevent method is called on all Zen pages. More...

Static Public Member Functions inherited from Adaptor
_.Library.Status	XMLDTD (_.Library.String top, _.Library.String format, _.Library.Boolean input, dtdlist)
	Write the DTD to the current device for this XML enabled class serialized as. More...

_.Library.RegisteredObject	XMLNew (_.XML.Document document, _.Library.Integer node, _.Library.RegisteredObject containerOref)
	Get an instance of an XML enabled class. More...

_.Library.Status	XMLSchema (_.Library.String top, _.Library.String format, _.Library.String namespacePrefix, _.Library.Boolean input, _.Library.Boolean refOnly, schema)
	Write an XML Schema fragment to the current device which describes an XML enabled class and dependent classes. More...

_.Library.String	XMLSchemaNamespace ()
	Get the namespace to which this class belongs for use in schema generation. More...

_.Library.Status	XMLSchemaType (_.XML.Schema schemaInstance, _.XML.Node node, _.Library.String top, _.Library.Boolean encoded, _.Library.Boolean summary, _.Library.Boolean input, _.Library.Boolean refOnly)
	Add a complexType to the schema that is respresented by an <class>XML.Schema</class> instance. More...

Static Public Member Functions inherited from Page
_.Library.Status	ConvertParameter (_.Library.String url, _.Library.String name, _.Library.String value)
	You pass this the <parameter>url</parameter> of the page you are going to and a. More...

_.Library.Binary	Decrypt (_.Library.String data)
	Decrypts the input string using the session.Key value that is unique to. More...

_.Library.String	Encrypt (_.Library.Binary data)
	Encrypts the input string using the session.Key value that is unique to this. More...

_.Library.String	EscapeHTML (in)
	This method converts input HTML text into Escaped HTML text.

_.Library.String	EscapeURL (_.Library.String in, _.Library.String charset)
	This method converts the in input URL string into Escaped URL string. More...

_.Library.String	HyperEventCall (_.Library.String methodName, _.Library.String args, _.Library.Integer type, _.Library.Boolean mobile)
	This method returns the string that needs to be written to the current. More...

_.Library.String	HyperEventHead (_.Library.Boolean iframeOnly, _.Library.Boolean strict, _.Library.Boolean optionalBroker)
	This method returns the string that needs to be written to the current. More...

	Include (_.Library.String url)
	Include another csp page or file in the output at this point. More...

_.Library.String	InsertHiddenField (_.Library.String url, _.Library.String name, _.Library.String value, _.Library.String extra)
	Inserts a '<input type="hidden" name="Name" value="Value">' tag into the current document. More...

_.Library.String	InsertHiddenFields (_.Library.String url, _.Library.String query)
	Return the string containing the hidden form tags. More...

_.Library.Boolean	IsPrivate ()
	Returns 1 if this page is in fact a private page (see <parameter>PRIVATE</parameter>).

_.Library.Status	OnHTTPHeader (_.Library.Boolean OutputBody)
	Event handler for PAGE event: this is invoked in order to More...

	OnPageError (_.Library.Status sc)
	Event handler for any error that occurs on the page. More...

_.Library.Status	OnPostHyperEvent (_.Library.String class, _.Library.String method)
	Event handler which is invoked after a hyperevent method is called on this page.

_.Library.Status	Page (_.Library.Boolean skipheader)
	Process a request to serve a CSPPage. More...

_.Library.String	QuoteJS (in)
	This method converts input string into quoted JavaScript literal.

_.Library.String	RewriteURL (_.Library.String url)
	This method will rewrite a URL to use #url()# if needed.

	ShowError (_.Library.Status sc)
	Display a <class>Status</class> error code to the CSP Page.

	StartTimer (_.Library.String name)
	Used to get performance information on your CSP pages. More...

	StopTimer (_.Library.String name)
	Used to time performance information on your CSP pages. More...

	ThrowError (_.Library.Status sc)
	Passed a <class>Status</class> code this goes to the error page passing this status code.

_.Library.String	UnescapeHTML (in)
	This method converts Escaped HTML text into normal HTML text.

_.Library.String	UnescapeURL (_.Library.String in, _.Library.String charset)
	This method converts the in Escaped URL string back to its original form. More...

Public Attributes
	backgroundTimerInterval
	This is the interval, in milliseconds, at which timer events are fired in order. More...

	cssLevel
	This property specifies what level of CSS support is used by this page. More...

	dragAndDrop
	If true, then drag and drop supported is enabled for this page. More...

	title
	Title of this page. More...

	useSVG
	If true, then the various JavaScript include files for SVG component are included for this page. More...

	useSoftModals
	This property specifies whether modal dialogs launched using zenLaunchPopupWindow() should. More...

	zenPersistentPopup
	This flag indicates whether the current Zen page should not sever its connection to its. More...

Public Attributes inherited from group
	cellAlign
	Specifies horizontal alignment of cells layed out within this group. More...

	cellSize
	Specifies how the size of cells within this group should be calculated (along layout direction). More...

	cellStyle
	Specifies additional style for cells layed out within this group. More...

	cellVAlign
	Specifies vertical alignment of cells layed out within this group. More...

	groupClass
	Optional CSS class used for table displayed by this group. More...

	groupStyle
	Optional style used for table displayed by this group. More...

	labelPosition
	Specifies where labels should be displayed for components within this group. More...

	layout
	Specifies how components within this group should be layed out. More...

	onclick
	onclick event handler: More...

Public Attributes inherited from abstractGroup
	children
	Set of components within this group. More...

	disabled
	If true, this group and its children are disabled. More...

Public Attributes inherited from component
	align
	Specifies how this component should be horizontally aligned within its layout cell. More...

	containerStyle
	CSS style applied to the td element used to contain this child component within. More...

	dragEnabled
	If this value is true and dragAndDrop is enabled for the page, then. More...

	dropEnabled
	If this value is true and dragAndDrop is enabled for the page, then. More...

	enclosingClass
	Optional CSS class used for this component's enclosing div. More...

	enclosingStyle
	Optional CSS style applied to this component's enclosing div. More...

	error
	Run-time value; Set to indicate an error within this component. More...

	height
	Specifies the height of this component with respect to its container. More...

	hidden
	If true, this component is hidden. More...

	hint
	User defined hint text used to display additional hint text for this component. More...

	hintClass
	Optional CSS class used for the component hint. More...

	hintStyle
	User defined style used for the component hint. More...

	label
	User defined label used to label this component. More...

	labelClass
	Optional CSS class used for the component label. More...

	labelDisabledClass
	Optional CSS class used for the component label when disabled. More...

	labelStyle
	User defined style used for the component label. More...

	onafterdrag
	onafterdrag event handler: More...

	onbeforedrag
	onbeforedrag event handler: More...

	ondrag
	ondrag event handler: More...

	ondrop
	ondrop event handler: More...

	onhide
	onhide event handler: More...

	onrefresh
	onrefresh event handler: More...

	onshow
	onshow event handler: More...

	showLabel
	Controls whether a label is displayed for this component. More...

	slice
	User-defined number of units of relative space this. More...

	title
	Help text (tool tip) displayed when mouse hovers over this component (or its label). More...

	valign
	Specifies how this component should be vertically aligned within its layout cell. More...

	width
	Specifies the width of this component with respect to its container. More...

Public Attributes inherited from object
	aux
	@qualifier final This is an auxiliary property that is provided More...

	composite
	@qualifier final For components that are created as part of a composite component, More...

	id
	@qualifier final This is a unique identifier that is used to distinguish this object More...

	index
	@qualifier final System-assigned index number used internally to identify this component. More...

	name
	@qualifier final Name of this object. More...

	onupdate
	onupdate event handler: More...

	parent
	@qualifier final Link to the component that contains this object More...

	tuple
	@qualifier final Special property indicating which tuple of a More...

	visible
	This property indicates whether a component is visible and thus layed out. More...

	window
	@qualifier final This is a client-only property that refers to the JavaScript More...

Static Public Attributes
	APPLICATION = None
	This is the class name of this application this page belongs to. More...

	AUTOLOGOUT = None
	If true, then attempt to refresh this page when its session timeout period has expired. More...

	AUTONS = None
	If true, auto-switch namespace to whatever $NAMESPACE is passed in.

	CHECKMODIFIEDBEFORELOGOUT = None
	If true and AUTOLOGOUT is true then call onhandleAutoLogout 30 seconds. More...

	CLIENTCACHE = None
	If false (the default) disable browser caching of pages.

	CSS3INCLUDES = None
	Comma-separated list of additional CSS3 include files for the page. More...

	CSSINCLUDES = None
	Comma-separated list of additional CSS include files for the page. More...

	DOMAIN = None
	Localization domain.

	ERRORDIVID = None
	The id of the <div> element used to display errors encountered in the page definition. More...

	FAVORITEICON = None
	If defined, this is the url of the "favorite" (or shortcut) icon to display for this page. More...

	HTMLATTRS = None
	If defined, this string will be written as attributes within the html element at. More...

	HTMLDOCTYPE = None
	If HTMLDTD is true we will look here for the DOCTYPE declaration. More...

	HTMLDTD = None
	If true, draw an HTML Document Type Declaration at the start of this page.

	IFRAMEALLOWED = None
	Allow pages to have iframes by not setting x-frame-options: same origin. More...

	INLINESVG = None
	Experimental parameter. More...

	JSINCLUDES = None
	Comma-separated list of additional JS include files for the page.

	PAGENAME = None
	Optional. More...

	PAGETITLE = None
	Optional. More...

	RESOURCE = None
	This is a comma-delimited list of system Resources and associated. More...

	SHOWSTATS = None
	If true, then display server statistics (within a comment) at the end of this page.

	SYSTEMMODULES = None
	Comma-separated list of Zen library modules whose HTML class. More...

	USERPACKAGES = None
	Comma-separated list of User class packages whose HTML class. More...

	USERSVGPACKAGES = None
	Comma-separated list of User class packages whose SVG class. More...

	VALIDATEXML = None
	If true, validate XML Contents using the Zen schema.

Static Public Attributes inherited from group
	DEFAULTCELLALIGN = None
	Subclasses can set this to change default cellAlign for a group.

	DEFAULTCELLSIZE = None
	Subclasses can set this to change default cellSize for a group.

	DEFAULTCELLSTYLE = None
	Subclasses can set this to change default cellStyle for a group.

	DEFAULTCELLVALIGN = None
	Subclasses can set this to change default cellVAlign for a group.

	DEFAULTGROUPCLASS = None
	Subclasses can set this to change default css class for a group.

	DEFAULTGROUPSTYLE = None
	Subclasses can set this to change default groupStyle for a group.

	DEFAULTLABELPOSITION = None
	Subclasses can set this to change default labelPosition for a group.

	DEFAULTLAYOUT = None
	Subclasses can set this to change default layout for a group.

Static Public Attributes inherited from abstractGroup
	DEFAULTGROUPCLASS = None
	Subclasses can set this to change default css class for a group.

Static Public Attributes inherited from component
	DEFAULTENCLOSINGCLASS = None
	Subclasses can set this to change default enclosingClass used for this. More...

	DEFAULTHEIGHT = None
	Subclasses can set this to change default height for a component.

	DEFAULTHIDDEN = None
	Subclasses can set this to change default hidden property for a component.

	DEFAULTHINTCLASS = None
	Subclasses can set this to change default css class used for hints.

	DEFAULTLABELCLASS = None
	Subclasses can set this to change default css class used for labels.

	DEFAULTLABELDISABLEDCLASS = None
	Subclasses can set this to change default css class used for disabled labels.

	DEFAULTVISIBLE = None
	Subclasses can set this to change default visibilty for a component.

	DEFAULTWIDTH = None
	Subclasses can set this to change default width for a component.

Static Public Attributes inherited from object
	DEFAULTVISIBLE = None
	Subclasses can set this to change default visibilty for a component.

	INCLUDEFILES = None
	CSV list of additional include files (either .js or .css) that. More...

	MODULE = None
	If set, this indicates that this system component should be. More...

	NAMESPACE = None
	This is the XML namespace used for library components.

	POSTCOMPILEACTIONS = None
	This is a comma-delimited list of which post-compile actions this component. More...

	USECOMMONDIRECTORY = None
	If true, then the include files generated for this component, are placed in the. More...

	XMLFORMAT = None
	If XMLFORMAT="Literal", then only support for literal format import and export is generated. More...

	XMLIGNOREINVALIDATTRIBUTE = None
	By setting this to 0, we disallow use of invalid attribute names in Zen XML documents.

Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...

	JAVATYPE = None
	The Java type to be used when exported.

	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Static Public Attributes inherited from Adaptor
	ATTRIBUTEQUALIFIED = None
	ATTRIBUTEQUALIFIED controls the format of exported XML by controlling whether attributes. More...

	ELEMENTQUALIFIED = None
	ELEMENTQUALIFIED controls the format of exported XML. More...

	NAMESPACE = None
	NAMESPACE specifies the XML namespace to be used when projecting the. More...

	SUPPRESSTYPEPREFIX = None
	SUPPRESSTYPEPREFIX allows the type name that refers to this class. More...

	XMLDEFAULTREFERENCE = None
	XMLDEFAULTREFERENCE specifies the default value of the XMLREFERENCE property parameter. More...

	XMLENABLED = None
	If this parameter is true then XML-enabling methods. More...

	XMLFORMAT = None
	The XMLFORMAT parameter controls the generation of the XMLExport and XMLImport. More...

	XMLIGNOREINVALIDATTRIBUTE = None
	The XMLIGNOREINVALIDATTRIBUTE parameter allows the programmer to control handling of unexpected. More...

	XMLIGNOREINVALIDTAG = None
	The XMLIGNOREINVALIDTAG parameter allows the programmer to control handling of unexpected. More...

	XMLIGNORENULL = None
	XMLIGNORENULL allows the programmer to override the default XML handling. More...

	XMLINCLUDEINGROUP = None
	XMLINCLUDEINGROUP allows the programmer to control whether a class is included. More...

	XMLINHERITANCE = None
	If the XMLINHERITANCE parameter is set to "LEFT", then in the case of multiple. More...

	XMLNAME = None
	This parameter provides the default XMLNAME for the class. More...

	XMLNIL = None
	The XMLNIL class parameter controls the use of xsi:nil by XMLExport. More...

	XMLNILNOOBJECT = None
	The XMLNILNOOBJECT parameter allows creation of an object to be skipped for elements. More...

	XMLPREFIX = None
	The XMLPREFIX parameter controls the prefix to be used for the XML namespace that. More...

	XMLSEQUENCE = None
	If the XMLSEQUENCE = 1, then the order of the XML elements must match the. More...

	XMLSUMMARY = None
	The summary fields to be used when an object is referenced are specified. More...

	XMLTYPE = None
	This parameter provides the default XMLTYPE for the class. More...

	XMLUNSWIZZLE = None
	If the XMLUNSWIZZLE parameter is set to 1, then single object. More...

	XMLUSEEMPTYELEMENT = None
	If the XMLUSEEMPTYELEMENT parameter is set to 1, then the empty element shorthand (<tag>) More...

Static Public Attributes inherited from Page
	CHARSET = None
	The <CLASS>CSP.Page</CLASS> object serves as an event handler for CSP requests. More...

	CONTENTTYPE = None
	Specifies the default content type for the page. More...

	CONVERTINPUTSTREAM = None
	Specifies if input request.Content or request.MimeData values are converted from their. More...

	CSPFILE = None
	If this page was compiled from a .csp file, then this parameter contains the. More...

	CSPSTRICT = None
	The CSPSTRICT parameter is set to 1, if the DOCTYPE indicates that this. More...

	CSPURL = None
	This parameter is used to make sure that if multiple. More...

	CSPXHTML = None
	The CSPXHTML parameter is set to 1, if the DOCTYPE indicates that this. More...

	DOMAIN = None
	The default domain for csp:text, span and div tags. More...

	ENCODED = None
	Controls how the query parameters for this page are passed, it can. More...

	ERRORPAGE = None
	Specify a custom error page to call if there are any problems with generating this page. More...

	EXPIRES = None
	Specified the default value for the response.Expires. More...

	NOCHARSETCONVERT = None
	Specifies if we wish to turn off charset conversion for this page. More...

	PAGETIMING = None
	If this parameter is true then we automatically record timing statistics of how long it takes to. More...

	PRIVATE = None
	Controls the access to the page, it can be set to one of the following: More...

	SECURITYRESOURCE = None
	This is a comma-delimited list of system Resources and associated. More...

	TIMINGSLOTS = None
	Used by the timing to decide how many slots a day should be divided up into. More...

	UseSession = None
	This parameter controls the CSP session support. More...

Private Member Functions
_.Library.Status	AddComponent (_.ZEN.Component.object pComponent)
	Called by a component to register that it is part of this page.

_.Library.Status	ApplyURLParms ()
	Copy URL parameters supplied to this page into the. More...

	DrawAutoLogout ()
	Write JavaScript to automatically logout out this page. More...

	DrawClassDefinitions ()
	Draw out client-side class definitions for components on this page. More...

	DrawHTMLPage (_.Library.Boolean pMobileMode)
	Draw html contents of this page. More...

	DrawObjectDefinitions ()
	Write out client-side object definitions for components on this page. More...

_.ZEN.Component.object	GetComponent (_.Library.Integer idx)
	Server-only method for finding a component within this. More...

_.ZEN.Component.object	GetComponentById (_.Library.String id)
	Server-only method for finding a component within this. More...

_.ZEN.Component.object	GetComponentByName (_.Library.String pName)
	Server-only method for finding a component within this. More...

_.Library.String	GetValueById (_.Library.String pID)
	Server-side method: More...

_.Library.String	GetValueByName (_.Library.String pID)
	Server-side method: More...

_.Library.String	Link (_.Library.String link, _.Library.String query, _.Library.Boolean addQ)
	Zen-wrapper for <class>CSP.Page</class> <method>Link</method> method. More...

_.Library.Status	OnAfterCreatePage ()
	This callback is called after the server-side page. More...

_.Library.Status	OnCreatePage ()
	This callback is called just after the server-side page. More...

_.Library.Integer	OnDetermineCSSLevel ()
	This callback method determines lets a page specify level of CSS support is used by this page. More...

_.Library.Status	OnDrawHTMLBody ()
	This callback is called at the start of the HTML BODY section of the page. More...

_.Library.Status	OnDrawHTMLHead ()
	This callback is called at the end of the HTML HEAD section of the page. More...

_.Library.Status	OnDrawHTMLMeta ()
	This callback is called at the start of the HTML HEAD section of the page (just after the title). More...

_.Library.Status	RemoveComponent (_.ZEN.Component.object pComponent)
	Called by a component when it is removed from this page. More...

	SetErrorById (_.Library.String pID, _.Library.String pError)
	Server-side method: More...

	SetErrorByName (_.Library.String pName, _.Library.String pError)
	Server-side method: More...

	SetValueById (_.Library.String pID, _.Library.String pValue)
	Server-side method: More...

	SetValueByName (_.Library.String pName, _.Library.String pValue)
	Server-side method: More...

	SetValuesByName (_.Library.String pValues)
	Server-side method: More...

Static Private Member Functions
	EndBackgroundMethod ()
	This method is called by a method running in the background when it is. More...

_.Library.String	EndScript ()
	Return string used to end client-side script code.

_.Library.Status	GetLinks ()
	Return csv-list of links defined by the Contents of this page.

_.Library.String	GetPageName ()
	Server-side utility method: More...

_.Library.String	LinkCSS (_.Library.String pFile)
	Return string used to include a CSS file.

_.Library.String	LinkScript (_.Library.String pFile)
	Return string used to include a script file.

_.Library.Status	OnBeforeCreatePage ()
	This class method callback is called just before the server-side page. More...

_.ZEN.application	OnCreateApplication (_.Library.Status pStatus, _.Library.String pApplicationName)
	This callback, if implemented, is invoked when this page is about to create an instance. More...

	OnFinishBackgroundTask (_.Library.String pTaskID)
	This server-side callback method is called whenever the client. More...

	OnMonitorBackgroundTask (_.Library.String pTaskID, _.Library.String pStatus, _.Library.Float pPercentComplete)
	This server-side callback method is called whenever the client. More...

_.Library.Boolean	OnPreHTTP ()
	Zen page notification of an HTTP request. More...

_.Library.Status	OnSubmit (_.ZEN.Submit pSubmit)
	This callback is called when a form on this page is submitted. More...

_.Library.Boolean	OnUseSoftModals ()
	Return whether the current page should use soft modal divs. More...

_.Library.Status	RunBackgroundMethod (_.Library.String pMethod, args)
	Start a background job to run a class method of this page. More...

	SetBackgroundMethodStatus (_.Library.String pStatus, _.Library.Float pPercentComplete)
	This method is called by a method running in the background to update. More...

_.Library.String	StartScript ()
	Return string used to introduce client-side script code.

_.Library.String	ZENVersion ()
	Return Zen Library version. More...

Detailed Description

Represents a page within a Zen application.

This is the base class used for all pages. User pages will extend from the <class>page</class> class, which is a subclass of this.

Member Function Documentation

◆ ApplyURLParms()

_.Library.Status ApplyURLParms ( )

private

Copy URL parameters supplied to this page into the.

appropriate properties of this page.

◆ DrawAutoLogout()

DrawAutoLogout ( )

private

Write JavaScript to automatically logout out this page.

when session ends

◆ DrawClassDefinitions()

DrawClassDefinitions ( )

private

Draw out client-side class definitions for components on this page.

Caller is responsible for drawing enclosing script tags.

◆ DrawHTMLPage()

DrawHTMLPage ( _.Library.Boolean pMobileMode )

private

Draw html contents of this page.

If present, this will invoke the user callback methods: <method>OnDrawHTMLHead</method> and <method>OnDrawHTMLBody</method>.

◆ DrawObjectDefinitions()

DrawObjectDefinitions ( )

private

Write out client-side object definitions for components on this page.

Caller is responsible for drawing enclosing script tags.

◆ EndBackgroundMethod()

EndBackgroundMethod ( )

staticprivate

This method is called by a method running in the background when it is.

finished in order to delete its status information (see <method>RunBackgroundMethod</method>).

◆ GetComponent()

_.ZEN.Component.object GetComponent ( _.Library.Integer idx )

private

Server-only method for finding a component within this.

page given its index number.

◆ GetComponentById()

_.ZEN.Component.object GetComponentById ( _.Library.String id )

private

Server-only method for finding a component within this.

page given its id.

◆ GetComponentByName()

_.ZEN.Component.object GetComponentByName ( _.Library.String pName )

private

Server-only method for finding a component within this.

page given its name.
If multiple components have the same name, returns the first one.

◆ GetPageName()

_.Library.String GetPageName ( )

staticprivate

Server-side utility method:

Return display name of this page.

◆ GetValueById()

_.Library.String GetValueById ( _.Library.String pID )

private

Server-side method:

Find control on this page with id pID and return its value.

◆ GetValueByName()

_.Library.String GetValueByName ( _.Library.String pID )

private

Server-side method:

Find control on this page with name pName and get its value.

◆ Link()

_.Library.String Link	(	_.Library.String	link,
		_.Library.String	query,
		_.Library.Boolean	addQ
	)

private

Zen-wrapper for <class>CSP.Page</class> <method>Link</method> method.

Tranforms the link specified by link into a URL and returns it as a string.

The URL may be encrypted.

The array, query, contains an optional set of name-value pairs which are added to the URL.

If the optional argument addQ is true, then a ? or &, as appropriate, is added to end of the URL

Reimplemented from Page.

◆ OnAfterCreatePage()

_.Library.Status OnAfterCreatePage ( )

private

This callback is called after the server-side page.

object and all of its children are created.
Subclasses can override this to add, remove, or modify items within the page object model, or to provide values for controls.

Reimplemented in Home, JavaHome, DotNetHome, XSLTransformWizard, XMLSchemaWizard, SOAPWizard, ZENTablePaneWizard, ZENStyleWizard, ZENReportWizard, ZENReportCompositeWizard, ZENPageWizard, ZENMethodWizard, ZENFormWizard, ZENElementInspector, ZENComponentWizard, ZENChartWizard, ZENApplicationWizard, WebServiceWizard, WebServicePolicyWizard, ZENPageEditor, ZENAppEditor, launcher, standardPage, searchDialog, routineSelect, qualifierSelect, namespaceSelect, finderDialog, fileSelect, errorDialog, cssValueEditor, cssDeclarationEditor, confirmationDialog, componentValueEditor, WebServers, Tests, ShowUrls, Script, RunHistory, Run, RecordStatus, Record, NoResults, NoDelays, Home, Generators, Errors, Controller, AppServers, TestSuite, TestMethod, TestCase, Indices, InstallerWizard, selectNamespace, openDomain, compileDomain, buildDomain, Architect, AbstractAnalysis, MeasureValue, ManualTester, ClassifierBuilder, Workflow, standardPage, Home, ErrorPage, DashboardViewer, WorksheetSave, WidgetWizard, WidgetSaveToTheme, WidgetSave, WidgetCatalog, SubjectAreaAddItem, ShowQuery, SendMail, SendAlert, SelectCubeList, ReportSave, RepairBuild, ReorderItems, RegisterUser, RangeExpression, QualityMeasureSave, PivotVariable, PivotSave, PivotPrintOptions, PivotOptions, PivotLevelOptions, PivotEditRule, PivotBreakdown, PivotAnalysis, namespaceSelect, ListingGroupAdd, LinkSave, ImageUpload, GetResource, GetProperties, GetList, GetDictionaryList, FormatString, finderDialog, FieldList, DataPropertyWizard, DashboardSave, DashboardEditDefaultValue, DashboardEditDataSeries, DashboardEditDataProperty, CubeSave, CubeRegistryAdd, CubeCompile, CubeBuild, CubeAddItem, CubeAdd, ControlWizard, BookCoverBuilder, Analyzer, AdvancedFilter, AddCalculatedMember, Regression, Distribution, Clustering, WorksheetBuilder, WidgetPreview, TermListManager, Settings, QualityMeasures, ModelBrowser, MDXQuery, LogViewer, ListingGroupManager, FolderManager, CubeRegistry, CaptionEditor, ArchitectSA, Architect, Analyzer, DeepSeeKPIWizard, PageSetUpDialog, NewReportWizard, Definition, TableAnalysis, perfbypage, Property, List, ShowPlanAlt, RuntimeStatsSettings, RuntimeStats, ReportLoader, ReportGenerator, IndexAnalyzer, TSQL, SQL, ISQL, TuneTable, PrintTable, PrintQuery, ImportStatement, Home, ExportStatement, CurrentStatements, TableDetails, Settings, Rebalance, Enable, Configure, Assign, NodelevelConfig, Configuration, Configuration, ClientList, Client, ServerList, ServerConfiguration, ConfigurationList, Configuration, Administration, Configurations, Configuration, SSL, RemoveLocalConfig, NodeAddressEdit, JoinNewMember, FailoverRemoveOthers, FailoverRemoveConfig, EditFilter, DNUpdates, AsyncStopTracking, AsyncRemoveConfig, AsyncEdit, AddAsync, Monitor, JoinFailover, JoinAsync, EditFailover, EditAsync, Create, ConnectionList, Connection, Authorize, Routine, Package, Global, Print, Key, ZenReportRenderServerAction, ZenReportPrintServerAction, ZenReportExcelServerAction, SQLView, SQLTuneTables, SQLStatementDetails, SQLReportGenerator, SQLParametersPrompt, ShadowDBMapping, Service, SchemaPriv, RoleResourceNew, RoleResourceEdit, Resource, ReportsRenderServerAction, ReportsPrintServerAction, ReportsExcelServerAction, RemoteDatabase, NamespaceDelete, MLConfigurationPriv, MirrorPromote, MirrorDBActions, LicenseActivate, IntegLog, Import, ExportResource, Export, ExpandVolume, ECPDataServer, DBMirrorAdd, DBActions, DatabaseWizard, DatabaseDelete, Compile, ColumnPriv, ChangePassword, Broadcast, ValueEditor, Telnet, SubTypes, SubType, SQLDataTypes, SQLDataType, MagTapes, MagTape, LogDaemon, IO, Devices, Device, Cluster, AdvancedTable, TaskInfo, DatabaseTruncate, DatabaseDefragment, DatabaseCompact, View, UserEvents, UserEvent, SystemEvents, PurgeLog, ExportLog, CopyLog, ActionTemplate, WebList, Web, PrivRoutineList, PrivRoutine, DocDBList, DocDB, ClientList, Client, xDBCErrors, xDBCErrorNamespaces, X509Credentials, X509Credential, WQMCategory, WQMCategories, Utils, Users, UserProfile, User, Transactions, Template, TasksUpcoming, TasksOnDemand, TaskSchedule, TaskInfo, TaskHistoryId, TaskHistory, SSLList, SSL, SourceControl, Services, Servers, Server, RoutineList, RoutineCompare, Roles, Role, Resources, ReportsRenderServers, ReportsRenderServer, ReportsPrintServers, ReportsPrintServer, ReportsExcelServers, ReportsExcelServer, ReportServers, ReportServerConfiguration, ReportServer, Reports, RemoteDatabases, Processes, ProcessDetails, PKI, PhoneProviders, PhoneProvider, Parameters, OpDatabases, ObjectSettings, NLSImport, NLSEdit, NLS, Namespaces, NamespaceEdit, Namespace, Monitoring, MemoryStartup, Mappings, Manifests, Manifest, Machines, Machine, LocksView, Locks, LicenseUsage, LicenseServers, LDAPTest, LDAPsRO, LDAPs, LDAPRO, LDAP, Kits, Kit, Journal, InteroperabilityUsage, InstanceUpdate, Instances, Instance, Installs, Install, GlobalList, ExternalLanguageServerStop, ExternalLanguageServerStart, ExternalLanguageServers, ExternalLanguageServerActivities, ExternalLanguageServer, EnsembleMonitor, EncryptionManaged, EncryptionManage, EncryptionDatabase, EncryptionCreate, ECPDataServers, ECPAppServers, ECP, Default, DatabaseVolumes, DatabaseTruncate, Databases, DatabaseMirror, DatabaseDetails, Database, CSPSessions, ClassList, BackgroundTaskList, BackgroundTaskError, Authentication, Archives, Archive, Manager, standardDialog, ResourceDialog, and Home.

◆ OnBeforeCreatePage()

_.Library.Status OnBeforeCreatePage ( )

staticprivate

This class method callback is called just before the server-side page.

object is created.

◆ OnCreateApplication()

_.ZEN.application OnCreateApplication	(	_.Library.Status	pStatus,
		_.Library.String	pApplicationName
	)

staticprivate

This callback, if implemented, is invoked when this page is about to create an instance.

of the <class>ZEN.application</class> class.
If this method returns a <class>ZEN.application</class> object, then this object will be used as the application object for the page. If this method returns "", then the application class specified by the APPLICATION parameter will be used.
pApplicationName contains the value of the APPLICATION parameter for the page.
This method should set pStatus to a $$$ERROR code if it fails.

◆ OnCreatePage()

_.Library.Status OnCreatePage ( )

private

This callback is called just after the server-side page.

object is created but before its children are created.

Reimplemented in ListingGroupManager.

◆ OnDetermineCSSLevel()

_.Library.Integer OnDetermineCSSLevel ( )

private

This callback method determines lets a page specify level of CSS support is used by this page.

The default is to return "", which indicates that the built-in ZEN CSS level detection is used. A page can override this and return 2 or 3.

Reimplemented in Manager.

◆ OnDrawHTMLBody()

_.Library.Status OnDrawHTMLBody ( )

private

This callback is called at the start of the HTML BODY section of the page.

(default implementation is a simple expression).

◆ OnDrawHTMLHead()

_.Library.Status OnDrawHTMLHead ( )

private

This callback is called at the end of the HTML HEAD section of the page.

(default implementation is a simple expression).

Reimplemented in AbstractEditor, finderDialog, openDomain, AbstractAnalysis, standardPage, DashboardViewer, WidgetPreview, QualityMeasures, ArchitectSA, Architect, Analyzer, TaskInfo, ProcessDetails, EnsembleMonitor, and DatabaseDetails.

◆ OnDrawHTMLMeta()

_.Library.Status OnDrawHTMLMeta ( )

private

This callback is called at the start of the HTML HEAD section of the page (just after the title).

It allows a page to write out meta tags, if desired. The default implementation writes out an IE-specific meta tag to ensure that IE 9 and 10 don't fall back into Compatibility Mode when we are returning an HTML5 page (i.e. <property>cssLevel</property> is set to 3).

Reimplemented in studioTemplate, standardPage, mobilePage, standardPage, standardDialog, and Manager.

◆ OnFinishBackgroundTask()

OnFinishBackgroundTask ( _.Library.String pTaskID )

staticprivate

This server-side callback method is called whenever the client.

calls to monitor the current background task and the task is complete. Typically a subclass uses this to send back JavaScript to update the page.

Reimplemented in dropDomain, buildDomain, Entities, Content, ClassifierBuilder, PrintQuery, and Home.

◆ OnGetJSResources()

_.Library.Status OnGetJSResources ( _.Library.String pResources )

Pages can implement this callback method in order to define a set of.

client-side resources: javascript strings that have been localized.
This method should fill in the array pResources with a set of localized strings, indexed by resource id:

Set pResources("MyId") = $$$Text("Some string")

Javascript methods can refer to these resources using the helper function zenGetResource:

alert(zenText('MyId'));

Zen defines a set of built-in resource strings using this mechanism. These have a "zen" prefix to keep them seperate from user ids.
You can also override the same callback method within your <class>ZEN.application</class> class if you wish to share resources across an application. In this case, the application-wide callback is invoked first.

Reimplemented in ShowPlanAlt, RuntimeStatsDetails, RuntimeStats, OpenDetails, and Contact.

◆ OnMonitorBackgroundTask()

OnMonitorBackgroundTask	(	_.Library.String	pTaskID,
		_.Library.String	pStatus,
		_.Library.Float	pPercentComplete
	)

staticprivate

This server-side callback method is called whenever the client.

calls to monitor the current background task. Typically a subclass uses this to send back JavaScript to update a progress bar.

Reimplemented in buildDomain, ClassifierBuilder, PrintQuery, and Home.

◆ OnNew()

_.Library.Status OnNew ( )

Note: This is marked as Final.

Subclasses can use the

<method>OnCreatePage</method> callback if they need notification on object creation.

Reimplemented from RegisteredObject.

◆ OnPreHTTP() [1/2]

_.Library.Boolean OnPreHTTP ( )

staticprivate

Zen page notification of an HTTP request.

This method can be overwritten

by subclasses.
This is called before the standard Zen pre-HTTP processing occurs.

Reimplemented from Page.

Reimplemented in XSLTransformWizard, XMLSchemaWizard, SOAPWizard, studioTemplate, Record, standardPage, DashboardViewer, WorksheetBuilder, TermListManager, Settings, QualityMeasures, MDXQuery, FolderManager, Analyzer, PKI, Mappings, Journal, and Home.

◆ OnSubmit()

_.Library.Status OnSubmit ( _.ZEN.Submit pSubmit )

staticprivate

This callback is called when a form on this page is submitted.

pSubmit is a <class>ZEN.Submit</class> object containing details of the form submit.
Subclasses override this method.

Reimplemented in studioTemplate.

◆ OnUseSoftModals()

_.Library.Boolean OnUseSoftModals ( )

staticprivate

Return whether the current page should use soft modal divs.

The default behaviour is to return 1 for the current instance, but users may set the ^ISC.ZEN.useSoftModals global change this system-wide. In some cases, it may be worth modifying the value of the flag based on the user agent, particularly if users are expected to access the application from mobile devices where new windows behave differently.

Reimplemented in standardPage, mobilePage, and standardDialog.

◆ RemoveComponent()

_.Library.Status RemoveComponent ( _.ZEN.Component.object pComponent )

private

Called by a component when it is removed from this page.

Applications should not call this method directly. If you need to remove a component from a page, use the <method>RemoveChild</method> of <class>ZEN.Component.group</class> instead.

Reimplemented in page.

◆ RunBackgroundMethod()

_.Library.Status RunBackgroundMethod	(	_.Library.String	pMethod,
			args
	)

staticprivate

Start a background job to run a class method of this page.

pMethod is the name of the method to run.
args is a variable number of arguments that are passed on to the background method.
Only one background task is monitored at a time. If this method is called while a previous background task is running, the new method will become the current monitored task (the previous task will run to completion, but the client will not be notified).

◆ SetBackgroundMethodStatus()

SetBackgroundMethodStatus	(	_.Library.String	pStatus,
		_.Library.Float	pPercentComplete
	)

staticprivate

This method is called by a method running in the background to update.

its status information (see <method>RunBackgroundMethod</method>). pStatus is the status message (which will be seen by the client page).
pPercentComplete is an optional value indicating the how much of the background task is complete (as a percentage between 0 and 100). A client page may use this information to display progress to the user.

◆ SetErrorById()

SetErrorById	(	_.Library.String	pID,
		_.Library.String	pError
	)

private

Server-side method:

Find component on this page with id pID and set its error value.
This is used to associate an error message with a component.

◆ SetErrorByName()

SetErrorByName	(	_.Library.String	pName,
		_.Library.String	pError
	)

private

Server-side method:

Find component on this page with name pName and set its error value.
This is used to associate an error message with a component.

◆ SetValueById()

SetValueById	(	_.Library.String	pID,
		_.Library.String	pValue
	)

private

Server-side method:

Find control on this page with id pID and set its value.

◆ SetValueByName()

SetValueByName	(	_.Library.String	pName,
		_.Library.String	pValue
	)

private

Server-side method:

Find control on this page with name pName and set its value.

◆ SetValuesByName()

SetValuesByName ( _.Library.String pValues )

private

Server-side method:

Given an array of values, subscripted by control name, apply the values to the controls.

◆ ZENVersion()

_.Library.String ZENVersion ( )

staticprivate

Return Zen Library version.

This is used to make sure that the class library is in sync with the zenutils.js file and any generated js files. This must match the value in the zenutils.js file.

◆ JavaInstalled()

_.Library.Boolean JavaInstalled ( )

static

Wrapper method for ZEN.Utils.

JavaInstalled()

Returns a true if Java is installed

◆ OnPostHTTP()

OnPostHTTP ( )

static

PostHTTP handler for all Zen pages.

Users should not override this method. This dispatched to a common PostHTTP handler

Reimplemented from Page.

Reimplemented in studioTemplate.

◆ OnPreHTTP() [2/2]

_.Library.Boolean OnPreHTTP ( )

static

PreHTTP handler for all Zen pages.

Users should not override this method; If you need to be notified use the <method>OnPreHTTP</method> supplied by Zen.
This dispatched to a common PreHTTP handler

Reimplemented from Page.

Reimplemented in XSLTransformWizard, XMLSchemaWizard, SOAPWizard, studioTemplate, Record, standardPage, DashboardViewer, WorksheetBuilder, TermListManager, Settings, QualityMeasures, MDXQuery, FolderManager, Analyzer, PKI, Mappings, Journal, and Home.

◆ OnPreHyperEvent()

_.Library.Status OnPreHyperEvent	(	_.Library.String	class,
		_.Library.String	method
	)

static

Event handler which is invoked before a hyperevent method is called on all Zen pages.

This dispatched to a common PreHyperEvent handler.
If an application overrides this method, then it must invoke this base implementation code (using ##super).

Reimplemented from Page.

Reimplemented in finderDialog, and LDAPTest.

◆ cancelPopup()

cancelPopup ( )

This client method will cancel a popup page (i.e.

close the window with

no additional action).
It is only valid to call this method on a page that has been launched as a popup window.

◆ correctIELayering()

correctIELayering ( div )

Correct for an embedded object layering bug that has persisted in IE since the invention.

of the embed tag. The symptom of this bug is the inability of a pop-up to obscure part or all of an SVG element. This routine should be called on the enclosing div of the popped-up component (or zenModalDiv if using a standard pop-up) IMMEDIATELY AFTER the div has been made visible

◆ createComponent()

createComponent ( name )

Client-side method to create a Zen component on the client.

name is the name of the component class. (e.g. "text").
Note: this will only create components in the "zen" XML NAMESPACE; Use <method>createComponentNS</method> to create components in other namespaces.
Use this and not the new operator to create ZEN components.

◆ createComponentNS()

createComponentNS	(	ns,
		name,
		parent,
		div
	)

Client-side method to create a Zen component on the client.

ns is the XML namespace of the component (e.g., "http://www.intersystems.com/zendemo").
Note that components within the Zen library use an internal shorthand for namespaces.
name is the name of the component class. (e.g. "text").
Use this and not the new operator to create Zen components.
parent, if provided, is the Zen group to which the newly created component will be added.
div, if provided, is an HTML div element that will become the enclosing div for the newly created component. In this case, the component be rendered by this methd. This feature should only be used by components that can adequately create this div element.

◆ deleteComponent()

deleteComponent	(	comp,
		refresh,
		sync
	)

Client-side method to remove a Zen component from a page on the client.

If refresh is defined and is false, then the page will not be refreshed after the delete. This is useful if you know that subsequent code will cause such a refresh. The default is to refresh.
If sync is defined and is true, the refresh of the group containing the deleted component will be executed synchronously. The default is asynchronous.

◆ endModal()

endModal ( )

End the current modal component; restore previous modal item.

or, if none, restore normal window behavior.

◆ fireOnUnloadEvent()

fireOnUnloadEvent ( )

Client-side method: fire onunload event for every component that defines one.

If any component's onunload handler returns a string value, then that is used as the return value of the HTML page's onbeforeunload handler.

◆ firePopupAction()

firePopupAction	(	action,
		value,
		close
	)

This client method will notify the parent window of this popup that.

a user action has ocurred. If action is not specified, then 'ok' is used as the action code. value is passed to the parent window as well.
If close is true (the default), then the popup window is closed after notifying the parent window.
It is only valid to call this method on a page that has been launched as a popup window.

◆ getComponent()

getComponent ( index )

Client-side method to find component by component index.

index is typically the system-assigned index number of the the component.
For components within repeating groups, index may include a dot followed by a tuple number, (a 1-based number indicated the position of this component within the repeating group).

◆ getComponentById()

getComponentById	(	id,
		tuple
	)

Client-side method to find a component by user-assigned id value.

For components within repeating groups, the optional tuple number indicates the position of this component within the repeating group).

◆ getOpener()

getOpener ( )

Helper method to get a reference to the window that launched this window.

The helper is required to handle cases where this window has been opened as a soft modal.

Reimplemented in standardDialog.

◆ gotoPage()

gotoPage ( url )

Set the location of the browser to a new url.

Use this function to navigate to new pages within JavaScript to ensure that urls are encoded correctly. Please note this does not allow usage of Private pages. To make those links you must make a round trip to the Server and call ..Link()

◆ launchPopupWindow()

launchPopupWindow	(	url,
		pageName,
		features,
		parms,
		parent
	)

Open a popup window with given url url and page name pageName.

features is optional list of window features. If features does not include top,left,width, or height, defaults will be provided.
parms, if provided, is a JavaScript object whose properties are used to supply URL parameters for the popup window.
parent, if provided, is the Zen component that will be notified when the popup action fires (by calling its <method>onPopupAction</method> method).

◆ onServerMethodCall()

onServerMethodCall ( method )

If implemented, this method is called just.

before a server method is invoked.
method is the name of the method invoked.

◆ onServerMethodError()

onServerMethodError	(	err,
		errObject
	)

If implemented, this method is called whenever.

a server method call returns an error from the server.
err is the error message. errObject is an object of type cspHyperEventError which has the following properties:

code - HTTP response code for the error, most likely 500 to indicate a server error, except when the user is no longer logged in, in which case it should be 401.
text - HTTP error message corresponding to the HTTP code
serverCode - the server side error status code, which may be null
serverText - the server side error text
exception - the Javascript exception which triggered the problem
arguments - the arguments to the function where the exception was caught

Reimplemented in standardPage, standardPage, and EnsembleMonitor.

◆ onServerMethodReturn()

onServerMethodReturn ( method )

If implemented, this method is called just.

after a server method is processed.
method is the name of the method invoked.

◆ onhandleAutoLogoutWarn()

onhandleAutoLogoutWarn ( )

Handle client page modifications while the session is still valid before the page is reloaded.

The auto reminder timer is reset after each server side call. It is not reset after firing.

◆ onlayoutHandler()

onlayoutHandler ( load )

This client event, if present, is fired when the page.

is first loaded or whenever it is resized.
If this is called at load time, then load will be true.

Reimplemented in ZENTablePaneWizard, ZENChartWizard, studioTemplate, ZENAppEditor, standardDialog, Architect, standardPage, AbstractAnalysis, WorksheetBuilder, WidgetPreview, TermListManager, Settings, QualityMeasures, MDXQuery, LogViewer, ListingGroupManager, FolderManager, CubeRegistry, CaptionEditor, ArchitectSA, Architect, Analyzer, ShowPlanAlt, RuntimeStats, ReportLoader, SQL, TuneTable, Home, Configuration, Client, Configuration, EditTemplate, User, SourceControl, Role, EnsembleMonitor, Manager, and Home.

◆ onlogoutHandler()

onlogoutHandler ( )

This client method, if defined and the AUTOLOGOUT parameter for this.

page is true, is invoked when the logout timer for this page fires.
If this method return true then the normal page logout behavior will fire. That is, the page will be reloaded causing a login page to appear if the current session has ended.

Reimplemented in standardPage, DashboardViewer, and Analyzer.

◆ onoverlayHandler()

onoverlayHandler ( index )

This client event, if present, is fired when a component with.

an overlay is clicked on.
index is index of the component.
This is used by page editing tools.

◆ popupActionHandler()

popupActionHandler	(	parent,
		name,
		action,
		value
	)

Internal method.

This does the actual work of dispatching an action sent by a popup window. parent is the component index of the component that should be notified (or '').

◆ setTraceOption()

setTraceOption	(	name,
		flag
	)

This client method lets you turn the various client-side.

tracing flags on or off.
name is the name of the tracing option:
'events' – trace client events.
'js' – display JavaScript returned from server.
'serialize' – display object serializations.
flag is a boolean value that specifies whether the option should be on or off.

◆ startModal()

startModal ( component )

Make the given component modal; That is all events outside of this.

component are captured. Also invokes the onStartModal callback for the component. By default, this makes the component visible, but it could be overrided by a component.

Member Data Documentation

◆ APPLICATION

APPLICATION = None

static

This is the class name of this application this page belongs to.

If not defined, this page does not belong to an application.

◆ AUTOLOGOUT

AUTOLOGOUT = None

static

If true, then attempt to refresh this page when its session timeout period has expired.

This will cause a login page to display if the current session has ended and security is set to require login.

◆ CHECKMODIFIEDBEFORELOGOUT

CHECKMODIFIEDBEFORELOGOUT = None

static

If true and AUTOLOGOUT is true then call onhandleAutoLogout 30 seconds.

prior to AUTOLOGOUT. This allows the page to handle client page modifications while the session is still valid before the page is reloaded.

◆ CSS3INCLUDES

CSS3INCLUDES = None

static

Comma-separated list of additional CSS3 include files for the page.

If this is defined and this page is using CSS3, then the CSSINCLUDES parameter is ignored. If this is not defined and this page is using CSS3, then the CSSINCLUDES parameter is used.

◆ CSSINCLUDES

CSSINCLUDES = None

static

Comma-separated list of additional CSS include files for the page.

If this page is using CSS3 then the CSS3INCLUDES parameter is used (if defined).

◆ ERRORDIVID

ERRORDIVID = None

static

The id of the <div> element used to display errors encountered in the page definition.

The default value is "zenErrorDiv".

◆ FAVORITEICON

FAVORITEICON = None

static

If defined, this is the url of the "favorite" (or shortcut) icon to display for this page.

Defining this causes Zen to include a <link rel="shortcut icon" href="<var>FAVORITEICON</var>"> in the head section of the page.
For maximum browser compatibility this should be an .ico file.

◆ HTMLATTRS

HTMLATTRS = None

static

If defined, this string will be written as attributes within the html element at.

the top of the page.

◆ HTMLDOCTYPE

HTMLDOCTYPE = None

static

If HTMLDTD is true we will look here for the DOCTYPE declaration.

Using this option can lead to less optimal behavior in zen library components For legacy purposes this defaults to the original doctype declaration for HTMLDTD

◆ IFRAMEALLOWED

IFRAMEALLOWED = None

static

Allow pages to have iframes by not setting x-frame-options: same origin.

Default set as allowed to prevent backwards incompatibility.

◆ INLINESVG

INLINESVG = None

static

Experimental parameter.

If true, this page uses inline SVG as opposed to using the embed element. This is only supported for W3C compliant browsers.

◆ PAGENAME

PAGENAME = None

static

Optional.

This is the display name used for this page.

If not provided, the class name is used.

◆ PAGETITLE

PAGETITLE = None

static

Optional.

This is the default value for the page's

<property>title</property>.

◆ RESOURCE

RESOURCE = None

static

This is a comma-delimited list of system Resources and associated.

permissions. A user must hold the specified permissions on at least one of the specified resources in order to view this page or invoke any of its server-side methods from the client.
The format of each item in the list should be as follows:
Resource[:Permission]
Permission is optional, and defaults to USE if not supplied. If it is supplied, it should be one of USE, READ or WRITE.

◆ SYSTEMMODULES

SYSTEMMODULES = None

static

Comma-separated list of Zen library modules whose HTML class.

and style definitions are in pre-generated include files.

◆ USERPACKAGES

USERPACKAGES = None

static

Comma-separated list of User class packages whose HTML class.

and style definitions are in pre-generated include files.

◆ USERSVGPACKAGES

USERSVGPACKAGES = None

static

Comma-separated list of User class packages whose SVG class.

and style definitions are in pre-generated include files.
This is ignored unless <property>useSVG</property> is true.

◆ backgroundTimerInterval

backgroundTimerInterval

This is the interval, in milliseconds, at which timer events are fired in order.

to check on the status of background tasks started by this page.

◆ cssLevel

cssLevel

This property specifies what level of CSS support is used by this page.

Currently this can be 2 or 3. This is set by the <method>OnDetermineCSSLevel</method> method. If the page has a CSS level of 3 or higher, then the <!DOCTYPE html> directive will be served at the top of the web page.
By default, cssLevel is set to 3 for any browser whose user agent includes Mozilla/5.0 or above. You can turn this off by overriding the <method>OnDetermineCSSLevel</method> for a page or change it globally by setting the ^ISC.ZEN.cssLevel global to 2.

◆ dragAndDrop

dragAndDrop

If true, then drag and drop supported is enabled for this page.

This must be set before the page is initially displayed; it cannot be used to enable or disable drag and drop once the page has been loaded.

◆ title

title

Title of this page.

◆ useSVG

useSVG

If true, then the various JavaScript include files for SVG component are included for this page.

If the page contains one or more <class>svgFrame</class> components, then this flag is automatically set true. Pages only need to set this in the case where the initial page definition does not contain any <class>svgFrame</class> components and SVG components are later created dynamically.
This must be set before the page is initially displayed or it will have no effect.

◆ useSoftModals

useSoftModals

This property specifies whether modal dialogs launched using zenLaunchPopupWindow() should.

use a soft modal group in a div element instead of a new window. The default value for this property is 1 (as returned from <method>OnUseSoftModals</method>()). Users should either override the <method>OnUseSoftModals</method>() method in their pages as needed to control this behaviour, or set the ^ISC.ZEN.useSoftModals global node to 1 to use modal divs for popups by default or 0 to launch popups in native browser windows.

◆ zenPersistentPopup

zenPersistentPopup

This flag indicates whether the current Zen page should not sever its connection to its.

parent window when the page is opened as a popup and the popup window's onbeforeunload event is triggered. The default behaviour (when the flag is 0/false) is to notify the parent window (through window.opener) that the popup is being closed whenever the onbeforeunload event is triggered. If the flag is set to 1/true, then this notification will no longer occur, and the user code is then responsible for two things:

When the popup is closed (or is otherwise determined to need closing), the zenPopupClosed() function attached to the parent window should be invoked if it exists. The function should exist as window.opener.zenPopupClosed() (if called from the popup) or window.zenPopupClosed() (if called from the parent window). This invocation provides the parent window with notification that the popup has in fact been closed.
The user code needs to be adjusted to handle the various cases where the popup context, especially the Javascript environment, may be different to the situation where the page has been launched as a popup. In particular, actions such as POSTs or refreshes may either clear the current Javascript context or leave certain references pointing to outdated objects (this last could occur if users maintain independent maps to Zen components).

In general, the use of this flag should be used in limited circumstances where popups absolutely must perform multiple actions.

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Private Member Functions

Static Private Member Functions

Detailed Description

Member Function Documentation

◆ ApplyURLParms()

◆ DrawAutoLogout()

◆ DrawClassDefinitions()

◆ DrawHTMLPage()

◆ DrawObjectDefinitions()

◆ EndBackgroundMethod()

◆ GetComponent()

◆ GetComponentById()

◆ GetComponentByName()

◆ GetPageName()

◆ GetValueById()

◆ GetValueByName()

◆ Link()

◆ OnAfterCreatePage()

◆ OnBeforeCreatePage()

◆ OnCreateApplication()

◆ OnCreatePage()

◆ OnDetermineCSSLevel()

◆ OnDrawHTMLBody()

◆ OnDrawHTMLHead()

◆ OnDrawHTMLMeta()

◆ OnFinishBackgroundTask()

◆ OnGetJSResources()

◆ OnMonitorBackgroundTask()

◆ OnNew()

◆ OnPreHTTP() [1/2]

◆ OnSubmit()

◆ OnUseSoftModals()

◆ RemoveComponent()

◆ RunBackgroundMethod()

◆ SetBackgroundMethodStatus()

◆ SetErrorById()

◆ SetErrorByName()

◆ SetValueById()

◆ SetValueByName()

◆ SetValuesByName()

◆ ZENVersion()

◆ JavaInstalled()

◆ OnPostHTTP()

◆ OnPreHTTP() [2/2]

◆ OnPreHyperEvent()

◆ cancelPopup()

◆ correctIELayering()

◆ createComponent()

◆ createComponentNS()

◆ deleteComponent()

◆ endModal()

◆ fireOnUnloadEvent()

◆ firePopupAction()

◆ getComponent()

◆ getComponentById()

◆ getOpener()

◆ gotoPage()

◆ launchPopupWindow()

◆ onServerMethodCall()

◆ onServerMethodError()

◆ onServerMethodReturn()

◆ onhandleAutoLogoutWarn()

◆ onlayoutHandler()

◆ onlogoutHandler()

◆ onoverlayHandler()

◆ popupActionHandler()

◆ setTraceOption()

◆ startModal()

Member Data Documentation

◆ APPLICATION

◆ AUTOLOGOUT

◆ CHECKMODIFIEDBEFORELOGOUT

◆ CSS3INCLUDES

◆ CSSINCLUDES

◆ ERRORDIVID

◆ FAVORITEICON