HS.UI.BaseUtil
class HS.UI.BaseUtil extends %ZEN.Component.page
Property Inventory
Method Inventory
- %CheckHSClass()
- %DrawAutoLogout()
- %OnDrawHTMLHead()
- %OnDrawHTMLMeta()
- %OnHSPreHTTP()
- %OnPreHTTP()
- CheckFormatting()
- HSUILink()
- OnPreHyperEvent()
- checkChildStatus()
- getUsername()
- inNavFrame()
- logoutChild()
- onloadHandler()
- pollChildUrl()
- postMessageToParent()
- setActivityCheck()
- triggerLogoutNotification()
- verifyUsername()
Parameters
parameter HSDEPLOY = 1;
Properties
property StdTitle as %ZEN.Datatype.string [ InitialExpression = $P($ZU(86),"*",2) _" - "_$Case(##class(%ZHSLIB.HealthShareMgr).IsHealthShareInstance(),1:"HealthShare",:"Health") ];
This text can be displayed on browser tab as the title next to the small favoriate icon.
To display it, you need to define the title attribute for a Zen page in the XData Contents in this fashion:
E.g:
To display it, you need to define the title attribute for a Zen page in the XData Contents in this fashion:
E.g:
Property methods: StdTitleDisplayToLogical(), StdTitleGet(), StdTitleIsValid(), StdTitleLogicalToDisplay(), StdTitleLogicalToOdbc(), StdTitleNormalize(), StdTitleSet()
Methods
classmethod %CheckHSClass(pClassName=..%ClassName(1)) as %Boolean
method %DrawAutoLogout()
Write JavaScript to automatically logout out this page
when session ends
method %OnDrawHTMLHead() as %Status
Inherited description: This callback is called at the end of the HTML HEAD section of the page.
(default implementation is a simple expression).
(default implementation is a simple expression).
method %OnDrawHTMLMeta() as %Status
Inherited description: 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. The default implementation writes out an IE-specific meta tag to ensure that IE 9 and 10 don't fall back into Compatibility Mode when we are returning an HTML5 page (i.e. cssLevel is set to 3).
It allows a page to write out meta tags, if desired. The default implementation writes out an IE-specific meta tag to ensure that IE 9 and 10 don't fall back into Compatibility Mode when we are returning an HTML5 page (i.e. cssLevel is set to 3).
classmethod %OnHSPreHTTP() as %Boolean
final classmethod %OnPreHTTP() as %Boolean
Inherited description: Zen page notification of an HTTP request. This method can be overwritten
by subclasses.
This is called before the standard Zen pre-HTTP processing occurs.
This is called before the standard Zen pre-HTTP processing occurs.
classmethod CheckFormatting(string) as %Boolean [ ZenMethod ]
Return 1 if the string is improperly formatted.
No apostrophes
Utility Method used by $$$HSUILink and $$$HSUILinkQuery and $$$HSUILinkNS
Event handler which is invoked before a hyperevent method is called on all Zen pages.
This dispatched to a common PreHyperEvent handler.
If an application overrides this method, then it must invoke this base implementation code (using ##super).
If an application overrides this method, then it must invoke this base implementation code (using ##super).
clientmethod checkChildStatus() [ Language = javascript ]
Callback that tells the parent that the child is still showing a valid page.
If we are showing some other page, like the login page or a non-HealthShare page,
this function won't exist, so we won't tell the parent that this page is active.
method getUsername() as %String [ ZenMethod ]
Return the username of the current user
If in the Nav Frame, return true, otherwise return false.
clientmethod logoutChild() [ Language = javascript ]
Send log out message to nav app to sign out nav app and this child app
clientmethod onloadHandler() [ Language = javascript ]
Inherited description: This client event, if present, is fired when the page is loaded.
clientmethod pollChildUrl() [ Language = javascript ]
Callback that updates the parent with the child active URL
clientmethod postMessageToParent(eventName, arg) [ Language = javascript ]
Helper method to simplify the logic for calling a parent function by using ISC-Frame postEvent function
with parameters eventName and one argument. This argument could be a string, boolean or object.
clientmethod setActivityCheck(eventName, activityCheckInterval) [ Language = javascript ]
clientmethod triggerLogoutNotification() [ Language = javascript ]
Helper method to notify a parent frame that a child frame is going to log out.
clientmethod verifyUsername(eventName, usernameParentApp) [ Language = javascript ]
Verify that the user logged into the isc-frame parent is the user logged into this child app
Inherited Members
Inherited Properties
- %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
- %AddChild()
- %AddChildAfter()
- %AddChildBefore()
- %AddComponent()
- %AddImportedComponents()
- %AddToSaveSet()
- %ApplyURLParms()
- %Attr()
- %BindExport()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %DrawClassDefinitions()
- %DrawComponentHTML()
- %DrawHTML()
- %DrawHTMLPage()
- %DrawJSStrings()
- %DrawObjectDefinitions()
- %EnclosingDivId()
- %EndBackgroundMethod()
- %EndScript()
- %Eval()
- %EvalC()
- %Extends()
- %ForceClientRender()
- %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()
- %OnDrawObjectProperties()
- %OnFinishBackgroundTask()
- %OnMonitorBackgroundTask()
- %OnMutateChildren()
- %OnObjectSynch()
- %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()
- JavaInstalled()
- Link()
- OnHTTPHeader()
- OnPage()
- OnPageError()
- OnPostHTTP()
- OnPostHyperEvent()
- OnPreHTTP()
- 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()
- 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()
- onhandleAutoLogoutWarn()
- onkeydownHandler()
- onkeyupHandler()
- onlayoutHandler()
- onlogoutHandler()
- onoverlayHandler()
- onresizeHandler()
- onunloadHandler()
- onupdateHandler()
- popupActionHandler()
- refreshContents()
- removeChild()
- render()
- renderContents()
- renderSVG()
- setComponentId()
- setHidden()
- setOverlayMode()
- setProperty()
- setPropertyAll()
- setTraceOption()
- startModal()
- startProgressBar()
- stopProgressBar()