Home > Class Reference > ENSLIB namespace > %ZEN.Mobile.mobilePage


class %ZEN.Mobile.mobilePage extends %ZEN.Component.page

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


Parameters Properties Methods Queries Indices ForeignKeys Triggers
13 10 19


This is a Zen Page class. It belongs to the application %ZEN.Portal.Application.

%condition %import %includeFiles %page
%resource align aux backgroundTimerInterval
bodyScrollTop cellAlign cellSize cellStyle
cellVAlign children composite containerStyle
cssLevel disabled dragAndDrop dragEnabled
dropEnabled enclosingClass enclosingStyle error
extentHeight extentWidth groupClass groupStyle
height hidden hideURLBar hint
hintClass hintStyle id index
label labelClass labelDisabledClass labelPosition
labelStyle layout maxScale minScale
name onafterdrag onbeforedrag onclick
ondrag ondrop onhide onrefresh
onshow onupdate parent preventDefaultGestures
showLabel simulatedDeviceHeight simulatedDeviceWidth slice
title tuple useSVG useSoftModals
userScalable valign visible width
window zenPersistentPopup
%AddChild %AddChildAfter %AddChildBefore %AddComponent
%AddImportedComponents %AddToSaveSet %ApplyURLParms %Attr
%BindExport %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %DrawAutoLogout
%DrawClassDefinitions %DrawComponentHTML %DrawHTML %DrawHTMLPage
%DrawJSStrings %DrawObjectDefinitions %EnclosingDivId %EndBackgroundMethod
%EndScript %Eval %EvalC %Extends
%ForceClientRender %GenerateMetaContent %GetChildIndex %GetComponent
%GetComponentById %GetComponentByName %GetEventHandlers %GetLinks
%GetPageName %GetParameter %GetValueById %GetValueByName
%GetXMLName %IsA %IsModified %Link
%LinkCSS %LinkScript %MakeId %New
%NormalizeObject %ObjectModified %OnAddToPageAfter %OnAddToPageBefore
%OnAfterCreatePage %OnBeforeCreatePage %OnCreateApplication %OnCreatePage
%OnDetermineCSSLevel %OnDrawEnclosingDiv %OnDrawHTMLBody %OnDrawHTMLHead
%OnDrawHTMLMeta %OnDrawObjectProperties %OnFinishBackgroundTask %OnMonitorBackgroundTask
%OnMutateChildren %OnObjectSynch %OnPreHTTP %OnSubmit
%OnUseSoftModals %OnZENDeserialize %OriginalNamespace %PackageName
%QuoteValue %QuoteValueL10N %RemoveChild %RemoveChildren
%RemoveComponent %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 XMLDTD
XMLExport XMLExportToStream XMLExportToString XMLNew
XMLSchema XMLSchemaNamespace XMLSchemaType addChild
addChildAfter addChildBefore cancelPopup childrenMutated
correctIELayering createComponent createComponentNS deleteComponent
dragFinishHandler dragHandler dragNotifyHandler dragStartHandler
dropHandler dropStartHandler endModal exposeComponent
findElement fireOnDeviceMotionEvent fireOnLoadEvent fireOnResizeEvent
fireOnRotateEvent fireOnTouchStartEvent fireOnUnloadEvent fireOnUpdateEvent
firePopupAction getBodyScrollTop getChildIndex getComponent
getComponentById getEnclosingDiv getHidden getHintElement
getLabelElement getNativeWindowHeight getNativeWindowWidth getOpener
getProperty getSettings getType gotoPage
initDeviceInterface invokeSuper isDesktopBrowser isOfType
launchPopupWindow makeId onCreate onDelete
onDisplayHandler onEndModalHandler onPopupAction onRefreshContents
onSerialize onServerMethodCall onServerMethodError onServerMethodReturn
onStartModalHandler ondevicemotionHandler ondisabledHandler onkeydownHandler
onkeyupHandler onlayoutHandler onloadHandler onlogoutHandler
onoverlayHandler onresizeHandler onrotateHandler ontouchendHandler
ontouchmoveHandler ontouchstartHandler onunloadHandler onupdateHandler
popupActionHandler refreshContents removeChild render
renderContents renderSVG setComponentId setHidden
setOverlayMode setProperty setPropertyAll setTraceOption
startModal startProgressBar stopProgressBar updateMetaSettings


parameter APPLICATION = "%ZEN.Portal.Application";
Set this to the appropriate application class.
parameter AUTONS = 0;
If true, auto-switch namespace to whatever $NAMESPACE is passed in.
parameter DEFAULTEXTENTHEIGHT = "device-height";
Default maximum extent of this page
parameter DEFAULTEXTENTWIDTH = "device-width";
Default maximum extent of this page
parameter DEFAULTHIDEURL = 1;
Default setting for hiding the URL bar on small screens (where possible)
parameter DEFAULTLAYOUT = "none";
Subclasses can set this to change default layout for a group.
parameter DEFAULTMAXSCALE = "1.0";
Default maximum scale factor
parameter DEFAULTMINSCALE = "1.0";
Default minimum scale factor
Default setting for prevent default processing of page level gestures
Default setting for user scaling
parameter DOMAIN = "%Utility";
Set this to the correct domain.
parameter JSINCLUDES = "zenCSLM.js";
Comma-separated list of additional JS include files for the page.
parameter PAGENAME = "Standard Mobile Page";
Name of this page.


property bodyScrollTop as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
property extentHeight as %ZEN.Datatype.integer [ InitialExpression = ..#DEFAULTEXTENTHEIGHT ];
property extentWidth as %ZEN.Datatype.integer [ InitialExpression = ..#DEFAULTEXTENTWIDTH ];
property hideURLBar as %ZEN.Datatype.integer [ InitialExpression = ..#DEFAULTHIDEURL ];
property maxScale as %ZEN.Datatype.integer [ InitialExpression = ..#DEFAULTMAXSCALE ];
property minScale as %ZEN.Datatype.integer [ InitialExpression = ..#DEFAULTMINSCALE ];
property preventDefaultGestures as %ZEN.Datatype.integer [ InitialExpression = ..#DEFAULTPREVENTGESTURES ];
property simulatedDeviceHeight as %ZEN.Datatype.integer [ InitialExpression = 320 ];
property simulatedDeviceWidth as %ZEN.Datatype.integer [ InitialExpression = 480 ];
property userScalable as %ZEN.Datatype.string [ InitialExpression = ..#DEFAULTUSERSCALABLE ];


method %GenerateMetaContent() as %String
This method is used by the default OnDrawHTMLMeta() callback to generate the contents of the viewport meta tag
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).
classmethod %OnUseSoftModals() as %Boolean
Use soft modals for the portal.
final method fireOnDeviceMotionEvent(event) [ Language = javascript ]
final method fireOnLoadEvent() [ 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.
method fireOnRotateEvent() [ Language = javascript ]
method fireOnTouchStartEvent(event) [ Language = javascript ]
Call the (potentially redefined) ontouchstartHandler for the page and implmenet the preventDefaultGesture logic as needed
method getBodyScrollTop() [ Language = javascript ]
method getNativeWindowHeight() [ Language = javascript ]
method getNativeWindowWidth() [ Language = javascript ]
final method initDeviceInterface() [ Language = javascript ]
method isDesktopBrowser() [ Language = javascript ]
method onPopupAction(popupName, action, value) [ Language = javascript ]
This client event, if present, is fired when a popup page has specified this component as its parent and fires an action.
popupName is the name of the popup window sending the action.
action is the name of the action.
value is the value associated with the action.
method ondevicemotionHandler(event) [ Language = javascript ]
This method may be redefined to specify custom handling of device motion events
method onrotateHandler() [ Language = javascript ]
This method may be redfined to specify custom handling when the orientation of the mobile device changes
method ontouchendHandler(event) [ Language = javascript ]
This method may be redefined to specify custom handling of touch end events
method ontouchmoveHandler(event) [ Language = javascript ]
This method may be redefined to specify custom handling of touch move events
method ontouchstartHandler(event) [ Language = javascript ]
This method may be redefined to specify custom handling of touch start events
method updateMetaSettings() [ Language = javascript ]