%ZEN.Component.page
class %ZEN.Component.page extends %ZEN.Component.abstractPage
Represents a page within a Zen application.User pages within a Zen application are derived from this class.
A page class defines and serves the contents of a Zen page. The contents of the page are defined by a set of Zen components contained by the page object. This set of components is typically defined within an XData block named Contents. It is also possible to define or modify this set of components by overriding the %OnAfterCreatePage() callback method.
There are a number of class parameters that a page class can use to control the behavior of the page. These include:
- APPLICATION - the name of the %ZEN.application class the page belongs to.
- RESOURCE - a resource for which the current user must hold USE privileges in order to use this page.
- PAGENAME - a logical name used to refer to the page.
- DOMAIN - the localization domain used to localize text within the page.
- JSINCLUDES - a comma-separated list of additional JavaScript include files the page should include.
- CSSINCLUDES - a comma-separated list of additional CSS style files the page should include.
- CSS3INCLUDES - a comma-separated list of additional CSS3 style files the page should include.
- %OnBeforeCreatePage() - called before page model is created.
- %OnCreatePage() - called after page object is created but before page model is created.
- %OnAfterCreatePage() - called after page model is created.
- %OnDrawHTMLHead() - called when the HTML head section is rendered.
- %OnDrawHTMLBody() - called when the HTML body section is rendered.
Method Inventory (Including Private)
- %AddComponent()
- %AddImportedComponents()
- %DrawJSResources()
- %GetChildIndex()
- %GetJSResources()
- %LayoutChildren()
- %RemoveChild()
- %RemoveChildren()
- %RemoveComponent()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLSchema()
Parameters
parameter POSTCOMPILEACTIONS;
Internal parameter.
There is nothing to queue up for page classes.
parameter VALIDATEXML = 0;
Validate user pages
parameter XMLINCLUDEINGROUP = 0;
User pages do not have an XML representation
parameter XMLNAME;
Reset XMLNAME parameter.
Methods (Including Private)
final method %AddComponent(pComponent As %ZEN.Component.object) as %Status [ Language = objectscript ]
Inherited description: Called by a component to register that it is part of this page.
Inherited description: Internal method.
Take a list of imported classes and add them the ComponentClasses list.
Take a list of imported classes and add them the ComponentClasses list.
private final method %DrawJSResources() as %Status [ Language = objectscript ]
Local override.
method %GetChildIndex(pChild As %ZEN.Component.component) as %Integer [ Language = objectscript ]
Inherited description: Server-only method: Look for the given child object within this group's set of
children and return its 1-based index number.
Returns -1 if unable to find the child.
Returns -1 if unable to find the child.
private final method %GetJSResources(ByRef pResources As %String) as %Status [ Language = objectscript ]
Local override.
private final method %LayoutChildren(pTuple As %Integer = "") [ Language = objectscript ]
Inherited description: Does the actual work of laying out the children of this group.
pTuple indicates the current tuple number in the
case of a repeatingGroup.
method %RemoveChild(pComponent As %ZEN.Component.object) as %Boolean [ Language = objectscript ]
Remove child component pComponent from this group.
Returns true if the component was found and removed.
final method %RemoveChildren(pDynamicOnly As %Boolean = 0) [ Language = objectscript ]
Remove all children from this group.
final method %RemoveComponent(pComponent As %ZEN.Component.object) as %Status [ Language = objectscript ]
Inherited description: 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
%RemoveChild() of %ZEN.Component.group instead.
classmethod XMLDTD(top As %String, format As %String, input As %Boolean, ByRef dtdlist) as %Status [ Language = objectscript ]
Local override.
method XMLExport(top As %Library.String = "", format As %Library.String = "", namespaces As %XML.Namespaces = "", attrs As %Library.String = "", createId As %Library.String = "", typeAttr As %Library.String = "", ByRef oreflist As %Library.String, ByRef idlist As %Library.String, initialIndent As %Library.String = "", local As %Library.Boolean = 0, mimeAttachments As %Net.MIMEPart) as %Status [ Language = objectscript ]
Local override.
method XMLExportToStream(ByRef export As %Stream.Object, top As %String, format As %String, namespaces As %XML.Namespaces, attrs, createId As %String, typeAttr As %String, ByRef oreflist, ByRef idlist, initialIndent As %String) as %Status [ Language = objectscript ]
Local override.
method XMLExportToString(ByRef export As %String, top As %String, format As %String, namespaces As %XML.Namespaces, attrs, createId As %String, typeAttr As %String, ByRef oreflist, ByRef idlist, initialIndent As %String) as %Status [ Language = objectscript ]
Local override.
classmethod XMLSchema(top As %String, format As %String, namespacePrefix As %String = "", input As %Boolean, refOnly As %Boolean, ByRef schema) as %Status [ Language = objectscript ]
Local override.
Inherited Members
Inherited Properties (Including Private)
- %condition
- %import
- %includeFiles
- %page
- %resource
- align
- aux
- backgroundTimerInterval
- cellAlign
- cellSize
- cellStyle
- cellVAlign
- children
- composite
- containerStyle
- cssLevel
- disabled
- dragAndDrop
- dragEnabled
- dropEnabled
- enclosingClass
- enclosingStyle
- error
- groupClass
- groupStyle
- height
- hidden
- hint
- hintClass
- hintStyle
- id
- index
- label
- labelClass
- labelDisabledClass
- labelPosition
- labelStyle
- layout
- name
- onafterdrag
- onbeforedrag
- onclick
- ondrag
- ondrop
- onhide
- onrefresh
- onshow
- onupdate
- parent
- showLabel
- slice
- title
- tuple
- useSVG
- useSoftModals
- valign
- visible
- width
- window
- zenPersistentPopup
Inherited Methods (Including Private)
- %AddChild()
- %AddChildAfter()
- %AddChildBefore()
- %AddToSaveSet()
- %ApplyURLParms()
- %Attr()
- %BindExport()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %ConstructCloneInit()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %DrawAutoLogout()
- %DrawClassDefinitions()
- %DrawComponentHTML()
- %DrawFrameSet()
- %DrawHTML()
- %DrawHTMLPage()
- %DrawJSStrings()
- %DrawObjectDefinitions()
- %EnclosingDivId()
- %EndBackgroundMethod()
- %EndScript()
- %Eval()
- %EvalC()
- %Extends()
- %ForceClientRender()
- %GetComponent()
- %GetComponentById()
- %GetComponentByName()
- %GetEventHandlers()
- %GetLinks()
- %GetPageName()
- %GetParameter()
- %GetValueById()
- %GetValueByName()
- %GetXMLName()
- %IsA()
- %IsModified()
- %Link()
- %LinkCSS()
- %LinkScript()
- %MakeId()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OnAddToPageAfter()
- %OnAddToPageBefore()
- %OnAddToSaveSet()
- %OnAfterCreatePage()
- %OnBeforeCreatePage()
- %OnClose()
- %OnConstructClone()
- %OnCreateApplication()
- %OnCreatePage()
- %OnDetermineCSSLevel()
- %OnDrawEnclosingDiv()
- %OnDrawHTMLBody()
- %OnDrawHTMLHead()
- %OnDrawHTMLMeta()
- %OnDrawObjectProperties()
- %OnFinishBackgroundTask()
- %OnGetJSResources()
- %OnMonitorBackgroundTask()
- %OnMutateChildren()
- %OnNew()
- %OnObjectSynch()
- %OnPreHTTP()
- %OnSubmit()
- %OnUseSoftModals()
- %OnValidateObject()
- %OnZENDeserialize()
- %OriginalNamespace()
- %PackageName()
- %QuoteValue()
- %QuoteValueL10N()
- %RemoveFromSaveSet()
- %RunBackgroundMethod()
- %Self()
- %SerializeObject()
- %SetBackgroundMethodStatus()
- %SetErrorById()
- %SetErrorByName()
- %SetModified()
- %SetValueById()
- %SetValueByName()
- %SetValuesByName()
- %StartScript()
- %ValidateObject()
- %ZENVersion()
- ConvertParameter()
- Decrypt()
- Encrypt()
- EscapeHTML()
- EscapeURL()
- HyperEventCall()
- HyperEventHead()
- Include()
- InsertHiddenField()
- InsertHiddenFields()
- IsPrivate()
- Link()
- OnHTTPHeader()
- OnPage()
- OnPageError()
- OnPostHTTP()
- OnPostHyperEvent()
- OnPreHTTP()
- OnPreHyperEvent()
- Page()
- QuoteJS()
- RewriteURL()
- ShowError()
- StartTimer()
- StopTimer()
- ThrowError()
- UnescapeHTML()
- UnescapeURL()
- XMLNew()
- XMLSchemaNamespace()
- XMLSchemaType()
- addChild()
- addChildAfter()
- addChildBefore()
- cancelPopup()
- childrenMutated()
- correctIELayering()
- createComponent()
- createComponentNS()
- deleteComponent()
- dragFinishHandler()
- dragHandler()
- dragNotifyHandler()
- dragStartHandler()
- dropHandler()
- dropStartHandler()
- endModal()
- exposeComponent()
- findElement()
- fireOnResizeEvent()
- fireOnUnloadEvent()
- fireOnUpdateEvent()
- firePopupAction()
- getChildIndex()
- getComponent()
- getComponentById()
- getEnclosingDiv()
- getHidden()
- getHintElement()
- getLabelElement()
- getOpener()
- getProperty()
- getSettings()
- getType()
- gotoPage()
- invokeSuper()
- isOfType()
- launchPopupWindow()
- makeId()
- onCreate()
- onDelete()
- onDisplayHandler()
- onEndModalHandler()
- onPopupAction()
- onRefreshContents()
- onSerialize()
- onServerMethodCall()
- onServerMethodError()
- onServerMethodReturn()
- onStartModalHandler()
- ondisabledHandler()
- onkeydownHandler()
- onkeyupHandler()
- onlayoutHandler()
- onloadHandler()
- onlogoutHandler()
- onoverlayHandler()
- onresizeHandler()
- onunloadHandler()
- onupdateHandler()
- popupActionHandler()
- refreshContents()
- removeChild()
- render()
- renderContents()
- renderSVG()
- setComponentId()
- setHidden()
- setOverlayMode()
- setProperty()
- setPropertyAll()
- setTraceOption()
- startModal()
- startProgressBar()
- stopProgressBar()
Subclasses
- %CSP.UI.Portal.BackgroundTasks
- %CSP.Util.perfbydate
- %CSP.Util.perfbypage
- %DeepSee.PMML.Definition
- %DeepSee.UI.Analysis.AbstractAnalysis
- %DeepSee.UI.MDXPrint
- %DeepSee.UI.WidgetPreview
- %DeepSee.UserPortal.standardPage
- %DeepSee.extensions.clusters.TableAnalysis
- %WebStress.Portal.ShowUrls
- %ZEN.Dialog.standardDialog
- %ZEN.Mobile.mobilePage
- %ZEN.Portal.standardPage
- %ZEN.Report.launcher
- %ZEN.StudioDocument.AbstractEditor
- %ZEN.Template.AddInWizard.Atelier.SOAPWizard
- %ZEN.Template.WebFormWizard.Settings
- %ZEN.Template.studioTemplate
- %iKnow.Classification.UI.ManualTester