HS.UI.Base
class HS.UI.Base extends HS.UI.BaseUtil
Base HealthShare UI classProperty Inventory
Method Inventory
- %CheckProductionRunning()
- %OnCreateApplication()
- %OnHSPreHTTP()
- GetDocPage()
- OnPreHTTP()
- hsBubbleResetAutoLogout()
- hsResetAutoLogout()
- onlogoutHandler()
- showHelp()
Parameters
parameter APPLICATION = HS.UI.Application;
Class name of application this page belongs to.
parameter DOMAIN = HS;
Domain used for localization.
parameter FAVORITEICON = $$$ISCFAVORITEICON;
Inherited description: If defined, this is the url of the "favorite" (or shortcut) icon to display for this page.
Defining this causes Zen to include a <link rel="shortcut icon" href="FAVORITEICON"> in the head section of the page.
For maximum browser compatibility this should be an .ico file.
Defining this causes Zen to include a <link rel="shortcut icon" href="FAVORITEICON"> in the head section of the page.
For maximum browser compatibility this should be an .ico file.
parameter HSDEPLOY = 0;
parameter HSHELPKEY;
When running HealthShare, this will be part of the docbook link, i.e. DocBook.UI.PortalHelpPage.cls?Key=thisvalue
Properties
property HomeApplication as %ZEN.Datatype.string [ InitialExpression = ##class(%ZHSLIB.SessionEventUtil).GetHomePageForNamespace() ];
Property methods: HomeApplicationDisplayToLogical(), HomeApplicationGet(), HomeApplicationIsValid(), HomeApplicationLogicalToDisplay(), HomeApplicationLogicalToOdbc(), HomeApplicationNormalize(), HomeApplicationSet()
Methods
Utility method. Can add this to your %OnHSPreHTTP by having its expression be:
..%CheckProductionRunning()
final classmethod %OnCreateApplication(Output pStatus As %Status, pApplicationName As %String) as %ZEN.application
This looks up an alternate application class in the HealthShare registry, and will use that
instead of the default HS.UI.Application
The alternate application class should extend HS.UI.Application
classmethod %OnHSPreHTTP() as %Boolean
Override this instead of %OnPreHTTP for all HS.UI Zen classes
classmethod GetDocPage() as %String [ ZenMethod ]
classmethod OnPreHTTP() as %Boolean
Executes once to get user preferences and possibily set a custom timeout period.
clientmethod hsBubbleResetAutoLogout() [ Language = javascript ]
Call this from an child page to reset the Zen autologout timer on the parent page(s)
clientmethod hsResetAutoLogout() [ Language = javascript ]
clientmethod onlogoutHandler() [ Language = javascript ]
Inherited description: This client method, if defined and the AUTOLOGOUT parameter for this
page is true, is invoked when the logout timer for this
page fires.
If this method return true then the normal page logout behavior will fire. That is, the page will be reloaded causing a login page to appear if the current session has ended.
If this method return true then the normal page logout behavior will fire. That is, the page will be reloaded causing a login page to appear if the current session has ended.
clientmethod showHelp() [ Language = javascript ]
Show documentation.
Inherited Members
Inherited Properties
- %condition
- %import
- %includeFiles
- %page
- %resource
- StdTitle
- 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()
- %CheckHSClass()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %DrawAutoLogout()
- %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()
- %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()
- CheckFormatting()
- ConvertParameter()
- Decrypt()
- Encrypt()
- EscapeHTML()
- EscapeURL()
- HSUILink()
- HyperEventCall()
- HyperEventHead()
- Include()
- InsertHiddenField()
- InsertHiddenFields()
- IsPrivate()
- JavaInstalled()
- Link()
- OnHTTPHeader()
- OnPage()
- OnPageError()
- OnPostHTTP()
- OnPostHyperEvent()
- OnPreHyperEvent()
- Page()
- QuoteJS()
- RewriteURL()
- ShowError()
- StartTimer()
- StopTimer()
- ThrowError()
- UnescapeHTML()
- UnescapeURL()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()
- addChild()
- addChildAfter()
- addChildBefore()
- cancelPopup()
- checkChildStatus()
- 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()
- getUsername()
- gotoPage()
- inNavFrame()
- invokeSuper()
- isOfType()
- launchPopupWindow()
- logoutChild()
- makeId()
- onCreate()
- onDelete()
- onDisplayHandler()
- onEndModalHandler()
- onPopupAction()
- onRefreshContents()
- onSerialize()
- onServerMethodCall()
- onServerMethodError()
- onServerMethodReturn()
- onStartModalHandler()
- ondisabledHandler()
- onhandleAutoLogoutWarn()
- onkeydownHandler()
- onkeyupHandler()
- onlayoutHandler()
- onloadHandler()
- onoverlayHandler()
- onresizeHandler()
- onunloadHandler()
- onupdateHandler()
- pollChildUrl()
- popupActionHandler()
- postMessageToParent()
- refreshContents()
- removeChild()
- render()
- renderContents()
- renderSVG()
- setActivityCheck()
- setComponentId()
- setHidden()
- setOverlayMode()
- setProperty()
- setPropertyAll()
- setTraceOption()
- startModal()
- startProgressBar()
- stopProgressBar()
- triggerLogoutNotification()
- verifyUsername()