%ZEN.Mojo.abstractPage

abstract class %ZEN.Mojo.abstractPage extends %ZEN.Component.page, %ZEN.Mojo.localizableObject, %ZEN.Mojo.abstractPageOverride

Foundation class for all pages within Zen Mojo This provides the core functionality shared by all pages within the framework.

Property Inventory

%appSettings
currMode
embedded
layout
linkList

Parameters

parameter APPLICATION;

Class name of application this page belongs to.

parameter DOMAIN = %ZEN;

Inherited description: Localization domain

parameter LOGICALNAME = HOME;

Logical name of this page. Overriden by application class.

parameter PAGENAME = Zen Mojo;

Displayed name of this page. Overriden by application class.

parameter POSTCOMPILEACTIONS = HTML;

Internal parameter. There is nothing to queue up for page classes.

Properties

property %appSettings as %ZEN.proxyObject;

Server-side copy of application settings object

Property methods: %appSettingsGet(), %appSettingsGetSwizzled(), %appSettingsIsValid(), %appSettingsNewObject(), %appSettingsSet()

property currMode as %ZEN.Datatype.string (ZENURL = "MODE");

Optional display mode of the page. The page can provide a different appearance depending on this value. This value is passed on the application class.

Property methods: currModeDisplayToLogical(), currModeGet(), currModeIsValid(), currModeLogicalToDisplay(), currModeLogicalToOdbc(), currModeNormalize(), currModeSet()

property embedded as %ZEN.Datatype.boolean (ZENURL = "EMBED") [ InitialExpression = 0 ];

If true, only show the core content.

Property methods: embeddedDisplayToLogical(), embeddedGet(), embeddedIsValid(), embeddedLogicalToDisplay(), embeddedLogicalToOdbc(), embeddedLogicalToXSD(), embeddedNormalize(), embeddedSet(), embeddedXSDToLogical()

property layout as %ZEN.Datatype.string (MAXLEN = 250, ZENENCRYPT = 0) [ InitialExpression = ..#DEFAULTLAYOUT ];

Specifies how components within this group should be layed out. (VALUELIST = ",vertical,horizontal")

Property methods: layoutDisplayToLogical(), layoutGet(), layoutIsValid(), layoutLogicalToDisplay(), layoutLogicalToOdbc(), layoutNormalize(), layoutSet()

property linkList as array of %String;

Array of named links (from application settings).

Property methods: linkListBuildValueArray(), linkListCollectionToDisplay(), linkListCollectionToOdbc(), linkListDisplayToCollection(), linkListDisplayToLogical(), linkListGet(), linkListGetObject(), linkListGetObjectId(), linkListGetSwizzled(), linkListIsValid(), linkListLogicalToDisplay(), linkListLogicalToOdbc(), linkListNormalize(), linkListOdbcToCollection(), linkListSet(), linkListSetObject(), linkListSetObjectId()

Methods

method %GetAppSettings() as %ZEN.proxyObject

Return an object containing the various configured settings for the portal.

method %OnAfterCreatePage() as %Status

This callback is called after the server-side page object and all of its children are created.

method %OnDetermineCSSLevel() as %Integer

Inherited description: 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.

method %OnDrawHTMLHead() as %Status

This callback is called at the end of the HTML HEAD section of the page.
(default implementation is a simple expression).

method %OnDrawHTMLMeta() as %Status

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. (default implementation is a simple expression).

method %OnDrawObjectProperties()

Ensure that we include the correct localization data for the page and its templates.

classmethod %OnUseSoftModals() as %Boolean

Inherited description: 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.

classmethod SetSessionLanguage(pLanguageCode As %String = "") as %Boolean [ ZenMethod ]

clientmethod getOrientation() [ Language = javascript ]

Return the device orientation.

clientmethod isEmbedded() [ Language = javascript ]

Test if this page is "embedded".

clientmethod isMobile() [ Language = javascript ]

Helper method; test if we are running in a mobile client.

clientmethod onServerMethodError(err, errObject) [ Language = javascript ]

Override onServerMethodError to catch HyperEvent errors.

clientmethod onloadHandler() [ Language = javascript ]

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

Inherited Members

Inherited Properties

Inherited Methods

Subclasses

%ZEN.Mojo.basePage