class %ZEN.Component.page
extends 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.
There are a number of server-side callback methods that a page class can
override to control the behavior of the page. (See
%ZEN.Component.abstractPage.) These include:
This class also provided the definition of the client-side
zenPage object
that represents the client-side version of the page object.
This is a Zen Page class.
• 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.
• final method %AddComponent(pComponent As %ZEN.Component.object)
as %Status
Called by a component to register that it is part of this page.
• final method %AddImportedComponents(pImportList As %String)
as %Status
Internal method.
Take a list of imported classes and add them the ComponentClasses list.
• method %GetChildIndex(pChild As %ZEN.Component.component)
as %Integer
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.
• method %RemoveChild(pComponent As %ZEN.Component.object)
as %Boolean
Remove child component pComponent from this group.
Returns true if the component was found and removed.
• final method %RemoveChildren(pDynamicOnly As %Boolean = 0)
Remove all children from this group.
• final method %RemoveComponent(pComponent As %ZEN.Component.object)
as %Status
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
Local override.
• method XMLExport(top As %String = "", format As %String = "", namespaces As %XML.Namespaces = "", attrs="", createId As %String = "", typeAttr As %String = "", ByRef oreflist, ByRef idlist, initialIndent As %String = "", local As %Boolean = 0)
as %Status
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
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
Local override.
• classmethod XMLSchema(top As %String, format As %String, namespacePrefix As %String = "", input As %Boolean, refOnly As %Boolean, ByRef schema)
as %Status
Local override.
