Skip to main content

%ZEN.Mobile.mobilePage

Class %ZEN.Mobile.mobilePage Extends %ZEN.Component.page [ Deprecated, LegacyInstanceContext, System = 3 ]

This base class provides a standard template for pages on mobile devices implemented using Zen.

Parameters​

JSINCLUDES​

Parameter JSINCLUDES = "zenCSLM.js";

APPLICATION​

Parameter APPLICATION = "%ZEN.Portal.Application";

Set this to the appropriate application class.

AUTONS​

Parameter AUTONS As BOOLEAN = 0;

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

DOMAIN​

Parameter DOMAIN = "%Utility";

Set this to the correct domain.

PAGENAME​

Parameter PAGENAME = "Standard Mobile Page";

Name of this page.

DEFAULTEXTENTWIDTH​

Parameter DEFAULTEXTENTWIDTH = "device-width";

Default maximum extent of this page

DEFAULTEXTENTHEIGHT​

Parameter DEFAULTEXTENTHEIGHT = "device-height";

Default maximum extent of this page

DEFAULTMAXSCALE​

Parameter DEFAULTMAXSCALE = 1.0;

Default maximum scale factor

DEFAULTMINSCALE​

Parameter DEFAULTMINSCALE = 1.0;

Default minimum scale factor

DEFAULTUSERSCALABLE​

Parameter DEFAULTUSERSCALABLE = "no";

Default setting for user scaling

DEFAULTHIDEURL​

Parameter DEFAULTHIDEURL = 1;

Default setting for hiding the URL bar on small screens (where possible)

DEFAULTPREVENTGESTURES​

Parameter DEFAULTPREVENTGESTURES = 0;

Default setting for prevent default processing of page level gestures

DEFAULTLAYOUT​

Parameter DEFAULTLAYOUT = "none";

Properties​

extentWidth​

Property extentWidth As %ZEN.Datatype.integer [ InitialExpression = {..#DEFAULTEXTENTWIDTH} ];

extentHeight​

Property extentHeight As %ZEN.Datatype.integer [ InitialExpression = {..#DEFAULTEXTENTHEIGHT} ];

maxScale​

Property maxScale As %ZEN.Datatype.integer [ InitialExpression = {..#DEFAULTMAXSCALE} ];

minScale​

Property minScale As %ZEN.Datatype.integer [ InitialExpression = {..#DEFAULTMINSCALE} ];

userScalable​

Property userScalable As %ZEN.Datatype.string [ InitialExpression = {..#DEFAULTUSERSCALABLE} ];

simulatedDeviceWidth​

Property simulatedDeviceWidth As %ZEN.Datatype.integer [ InitialExpression = 480 ];

simulatedDeviceHeight​

Property simulatedDeviceHeight As %ZEN.Datatype.integer [ InitialExpression = 320 ];

hideURLBar​

Property hideURLBar As %ZEN.Datatype.integer [ InitialExpression = {..#DEFAULTHIDEURL} ];

preventDefaultGestures​

Property preventDefaultGestures As %ZEN.Datatype.integer [ InitialExpression = {..#DEFAULTPREVENTGESTURES} ];

bodyScrollTop​

Property bodyScrollTop As %ZEN.Datatype.boolean [ InitialExpression = 0 ];

XDatas​

Style​

XData Style

Methods​

%OnUseSoftModals​

ClassMethod %OnUseSoftModals() As %Boolean [ CodeMode = expression ]

Use soft modals for the portal.

%GenerateMetaContent​

Method %GenerateMetaContent() As %String

This method is used by the default OnDrawHTMLMeta() callback to generate the contents of the viewport meta tag

%OnDrawHTMLMeta​

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).

isDesktopBrowser​

ClientMethod isDesktopBrowser() [ Language = javascript ]

getNativeWindowWidth​

ClientMethod getNativeWindowWidth() [ Language = javascript ]

getNativeWindowHeight​

ClientMethod getNativeWindowHeight() [ Language = javascript ]

getBodyScrollTop​

ClientMethod getBodyScrollTop() [ Language = javascript ]

updateMetaSettings​

ClientMethod updateMetaSettings() [ Language = javascript ]

initDeviceInterface​

ClientMethod initDeviceInterface() [ Final, Language = javascript ]

fireOnDeviceMotionEvent​

ClientMethod fireOnDeviceMotionEvent(event) [ Final, Language = javascript ]

fireOnLoadEvent​

ClientMethod fireOnLoadEvent() [ Final, Language = javascript ]

Client-side method: fire onload event for every component that defines one. This are fired in reverse order, so that the page's handler is called last.

fireOnRotateEvent​

ClientMethod fireOnRotateEvent() [ Language = javascript ]

fireOnTouchStartEvent​

ClientMethod fireOnTouchStartEvent(event) [ Language = javascript ]

Call the (potentially redefined) ontouchstartHandler for the page and implmenet the preventDefaultGesture logic as needed

ontouchstartHandler​

ClientMethod ontouchstartHandler(event) [ Language = javascript ]

This method may be redefined to specify custom handling of touch start events

ontouchmoveHandler​

ClientMethod ontouchmoveHandler(event) [ Language = javascript ]

This method may be redefined to specify custom handling of touch move events

ontouchendHandler​

ClientMethod ontouchendHandler(event) [ Language = javascript ]

This method may be redefined to specify custom handling of touch end events

onrotateHandler​

ClientMethod onrotateHandler() [ Language = javascript ]

This method may be redfined to specify custom handling when the orientation of the mobile device changes

ondevicemotionHandler​

ClientMethod ondevicemotionHandler(event) [ Language = javascript ]

This method may be redefined to specify custom handling of device motion events

onPopupAction​

ClientMethod onPopupAction(popupName, action, value) [ Language = javascript ]