HS.UI.Template
abstract class HS.UI.Template extends HS.HC.UI.Template, HS.UI.Util
Template for maintaining reference tables Includes methods for adding, selecting, and deleting entries Parameters MODELCLASS and ENTITY define the entity being maintained. Parameters TABLE and FIELDSET define the list and detail controls.Property Inventory
Method Inventory
- %GetCurrentClinician()
- %SetFilterParams()
- DeleteId()
- DrawTitle()
- addOrRemove()
- addRecord()
- arrowClick()
- deleteRecord()
- refreshDisplay()
- rowSelected()
Parameters
parameter ENTITY;
Display value for the entity being maintained
parameter FIELDSET;
Name of the detail field set
parameter MODELCLASS;
Name of class that supplies data for the form.
parameter RESOURCE = %HSAdmin_HubManagement;
Security requirement
parameter ShowInternalErrorDetails = 1;
Indicates whether internal details are to be displayed in error messages to the UI
parameter TABLE;
Name of the list table
Properties
property Entity as %String [ InitialExpression = ..#ENTITY ];
Holds the display value of the entity being maintained
Property methods: EntityDisplayToLogical(), EntityGet(), EntityIsValid(), EntityLogicalToDisplay(), EntityLogicalToOdbc(), EntityNormalize(), EntitySet()
property FieldSet as %String [ InitialExpression = ..#FIELDSET ];
Holds the name of the detail field set
Property methods: FieldSetDisplayToLogical(), FieldSetGet(), FieldSetIsValid(), FieldSetLogicalToDisplay(), FieldSetLogicalToOdbc(), FieldSetNormalize(), FieldSetSet()
property ModelClass as %String [ InitialExpression = ..#MODELCLASS ];
Holds the name of the model class.
Property methods: ModelClassDisplayToLogical(), ModelClassGet(), ModelClassIsValid(), ModelClassLogicalToDisplay(), ModelClassLogicalToOdbc(), ModelClassNormalize(), ModelClassSet()
property PageTitle as %ZEN.Datatype.caption;
Holds the page title
Property methods: PageTitleDisplayToLogical(), PageTitleGet(), PageTitleIsValid(), PageTitleLogicalToDisplay(), PageTitleLogicalToOdbc(), PageTitleNormalize(), PageTitleSet()
property Table as %String [ InitialExpression = ..#TABLE ];
Holds the name of the list table
Property methods: TableDisplayToLogical(), TableGet(), TableIsValid(), TableLogicalToDisplay(), TableLogicalToOdbc(), TableNormalize(), TableSet()
property msgAddAction as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Add") ];
Field set header when adding
Property methods: msgAddActionDisplayToLogical(), msgAddActionGet(), msgAddActionIsValid(), msgAddActionLogicalToDisplay(), msgAddActionLogicalToOdbc(), msgAddActionNormalize(), msgAddActionSet()
property msgEditAction as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Edit") ];
Field set header when editting
Property methods: msgEditActionDisplayToLogical(), msgEditActionGet(), msgEditActionIsValid(), msgEditActionLogicalToDisplay(), msgEditActionLogicalToOdbc(), msgEditActionNormalize(), msgEditActionSet()
Methods
method %GetCurrentClinician(Output pClinicianId) as %Status
Get the current clinician from the session and load it into the form
classmethod %SetFilterParams(pTxtField, pObj) as %Integer
Set filter parameters into UI
Delete a record, server side
clientmethod addOrRemove(id, add) [ Language = javascript ]
Descendent can add or remove list items from the database here (instead of deferring filing)
clientmethod addRecord() [ Language = javascript ]
Add a record
clientmethod arrowClick(from, to, sort) [ Language = javascript ]
Move a list item from one box to the next, then remove it from the original box
after validating that the database updated correctly
clientmethod deleteRecord(id) [ Language = javascript ]
Delete a record
clientmethod refreshDisplay() [ Language = javascript ]
Refresh the display after change, save, or delete
clientmethod rowSelected(table) [ Language = javascript ]
Load the object with the given id into the form.
Inherited Members
Inherited Properties
- %condition
- %import
- %includeFiles
- %page
- %resource
- HomeApplication
- StdTitle
- align
- aux
- backgroundTimerInterval
- cellAlign
- cellSize
- cellStyle
- cellVAlign
- children
- composite
- containerStyle
- cssLevel
- disabled
- dragAndDrop
- dragEnabled
- dropEnabled
- enclosingClass
- enclosingStyle
- error
- excludeFields
- 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()
- %CheckError()
- %CheckHSClass()
- %CheckProductionRunning()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DisableControl()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %DrawAutoLogout()
- %DrawClassDefinitions()
- %DrawComponentHTML()
- %DrawHTML()
- %DrawHTMLPage()
- %DrawJSStrings()
- %DrawObjectDefinitions()
- %EnclosingDivId()
- %EndBackgroundMethod()
- %EndScript()
- %EscapeComma()
- %Eval()
- %EvalC()
- %Extends()
- %ForceClientRender()
- %FormatError()
- %GetChildIndex()
- %GetComponent()
- %GetComponentById()
- %GetComponentByName()
- %GetEventHandlers()
- %GetLinks()
- %GetPageName()
- %GetParameter()
- %GetSummaryReports()
- %GetSummaryTypes()
- %GetValueById()
- %GetValueByName()
- %GetXMLName()
- %HideDropdownArrow()
- %HideFields()
- %InFacilityList()
- %IsA()
- %IsModified()
- %Link()
- %LinkCSS()
- %LinkScript()
- %MakeId()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OnAddToPageAfter()
- %OnAddToPageBefore()
- %OnAfterCreatePage()
- %OnBeforeCreatePage()
- %OnCreateApplication()
- %OnCreatePage()
- %OnDetermineCSSLevel()
- %OnDrawEnclosingDiv()
- %OnDrawHTMLBody()
- %OnDrawHTMLHead()
- %OnDrawHTMLMeta()
- %OnDrawObjectProperties()
- %OnFinishBackgroundTask()
- %OnHSPreHTTP()
- %OnMonitorBackgroundTask()
- %OnMutateChildren()
- %OnObjectSynch()
- %OnPreHTTP()
- %OnSubmit()
- %OnUseSoftModals()
- %OnZENDeserialize()
- %OriginalNamespace()
- %PackageName()
- %QuoteValue()
- %QuoteValueL10N()
- %RemoveChild()
- %RemoveChildren()
- %RemoveComponent()
- %RemoveFromSaveSet()
- %RunBackgroundMethod()
- %Self()
- %SerializeObject()
- %SetBackgroundMethodStatus()
- %SetErrorById()
- %SetErrorByName()
- %SetItemsIntoUI()
- %SetListIntoUI()
- %SetModified()
- %SetValueById()
- %SetValueByName()
- %SetValuesByName()
- %StartScript()
- %ValidateObject()
- %ZENVersion()
- AddOption()
- CheckFormatting()
- CheckUIVersion()
- CommonLinkMenu()
- ConfigValue()
- ConvertParameter()
- Decrypt()
- Encrypt()
- EscapeHTML()
- EscapeURL()
- GetDocPage()
- GetFolderCount()
- GetImplied()
- GetLoginLink()
- GetPortalMessagesPage()
- GetPortalPage()
- GetSearchPage()
- HSUILink()
- HyperEventCall()
- HyperEventHead()
- Include()
- InsertHiddenField()
- InsertHiddenFields()
- InsertOption()
- IsPrivate()
- JavaInstalled()
- Link()
- LoadComboBox()
- OnHTTPHeader()
- OnPage()
- OnPageError()
- OnPostHTTP()
- OnPostHyperEvent()
- OnPreHTTP()
- OnPreHyperEvent()
- OutputXMLToBrowser()
- Page()
- QuoteJS()
- RewriteURL()
- ShowError()
- StartTimer()
- StopTimer()
- ThrowError()
- UnescapeHTML()
- UnescapeURL()
- UserCanBreakTheGlass()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()
- addChild()
- addChildAfter()
- addChildBefore()
- cancelPopup()
- checkChildStatus()
- childrenMutated()
- comboBoxMatch()
- convertQuotes()
- correctIELayering()
- createComponent()
- createComponentNS()
- deleteComponent()
- disableControl()
- disableSave()
- displayCheck()
- 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()
- hsBubbleResetAutoLogout()
- hsResetAutoLogout()
- inNavFrame()
- invokeSuper()
- isOfType()
- jsQuote()
- launchPopupWindow()
- logoutChild()
- makeId()
- multiUserIdentified()
- onCreate()
- onDelete()
- onDisplayHandler()
- onEndModalHandler()
- onPopupAction()
- onRefreshContents()
- onSerialize()
- onServerMethodCall()
- onServerMethodError()
- onServerMethodReturn()
- onStartModalHandler()
- ondisabledHandler()
- onhandleAutoLogoutWarn()
- onkeydownHandler()
- onkeyupHandler()
- onlayoutHandler()
- onloadHandler()
- onlogoutHandler()
- onoverlayHandler()
- onresizeHandler()
- onunloadHandler()
- onupdateHandler()
- pollChildUrl()
- popupActionHandler()
- popupUser()
- postMessageToParent()
- refreshContents()
- removeChild()
- render()
- renderContents()
- renderSVG()
- setActivityCheck()
- setComponentId()
- setHidden()
- setListBoxItems()
- setOverlayMode()
- setProperty()
- setPropertyAll()
- setTraceOption()
- showHelp()
- sortList()
- startModal()
- startProgressBar()
- stopProgressBar()
- toggle()
- triggerLogoutNotification()
- userIdentified()
- validateTime()
- verifyUsername()