Class EnsPortal.PEXComponents

class EnsPortal.PEXComponents extends EnsPortal.Template.viewerPage

Page for registering a PEX component

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
2	3	38

Summary

This is a Zen Page class. It belongs to the application EnsPortal.Application.

Properties
%condition	%import	%includeFiles	%page
%resource	HelpAddress	ISREADONLY	LocatorHeader
ParentURL	StdTitle	aboutPage	align
aux	backgroundTimerInterval	canEdit	cellAlign
cellSize	cellStyle	cellVAlign	children
composite	contactPage	containerStyle	cssLevel
currSortMode	currStep	currViewMode	currentPage
currentPageStart	detailsHidden	detailsWidth	disabled
dragAndDrop	dragEnabled	dropEnabled	enableAutoRefresh
enclosingClass	enclosingStyle	error	groupClass
groupStyle	height	hidden	hideDetailsMsg
hideSearchMsg	hint	hintClass	hintStyle
home	homePage	id	index
isFirstPage	isLastPage	keepAliveInterval	label
labelClass	labelDisabledClass	labelPosition	labelStyle
layout	lblDetails	lblTitle	limitPopups
msgCloseDetail	msgNotPermitted	name	onafterdrag
onbeforedrag	onclick	ondrag	ondrop
onhide	onrefresh	onshow	onupdate
pageId	pageModified	pageNumberId	pageSizeId
parent	queryAtEnd	resultsTableId	searchCriteria
searchJob	searchKey	searchQuery	selectedId
showDetailsMsg	showLabel	showSearchMsg	slice
tablePaneUsesSQLAttrib	tempPortalNode	title	tuple
useSVG	useSoftModals	valign	visible
width	window	zenPersistentPopup

Methods
%AddCSPShareHyperevents	%AddChild	%AddChildAfter	%AddChildBefore
%AddComponent	%AddEnsExceptionHandler	%AddImportedComponents	%AddLocatorLinks
%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
%GetChildIndex	%GetComponent	%GetComponentById	%GetComponentByName
%GetEventHandlers	%GetHomePage	%GetHomeParam	%GetLinks
%GetLocatorLinks	%GetPageName	%GetParameter	%GetProductName
%GetRootLink	%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	%OnGetPageName	%OnGetProductName
%OnGetSmallMenu	%OnGetTableLinkMenu	%OnGetTitle	%OnMonitorBackgroundTask
%OnMutateChildren	%OnObjectSynch	%OnPreHTTP	%OnSubmit
%OnUseSoftModals	%OnZENDeserialize	%OriginalNamespace	%PackageName
%QuoteValue	%QuoteValueL10N	%Register	%RemoveChild
%RemoveChildren	%RemoveComponent	%RemoveFromSaveSet	%RunBackgroundMethod
%Self	%SerializeObject	%SetBackgroundMethodStatus	%SetErrorById
%SetErrorByName	%SetModified	%SetValueById	%SetValueByName
%SetValuesByName	%StartScript	%ValidateObject	%ZENVersion
BuildMenu	CheckAllBlanks	CheckContextLinks	CheckEnterpriseManager
ClearTempPortalNode	ConvertParameter	Decrypt	DoDeleteComponent
DoLogout	DoRegisterClass	DrawDetailsContent	DrawLocator
DrawRibbon	DrawTitle	Encrypt	EscapeHTML
EscapeURL	EvalResult	GetCSPURL	GetColumnsAndFrom
GetContextLinks	GetDocURL	GetHomePage	GetHyperEventResources
GetMessage	GetNewURL	GetPEXComponent	GetQuickLinks
GetRegistrationLink	GetRemoteSearchJob	GetResultSet	GetStatus
GetTotalCount	HTMLPopup	HyperEventCall	HyperEventHead
Include	InsertHiddenField	InsertHiddenFields	IsPrivate
JavaInstalled	Link	OnDrawRibbon	OnGetRibbonInfo
OnHTTPHeader	OnPage	OnPageError	OnPostHTTP
OnPostHyperEvent	OnPreHTTP	OnPreHyperEvent	Page
PrepareCancel	QuoteJS	RegisterClassInBackground	RegisterRecent
RemoveTempData	ResetQuery	RewriteURL	ShowError
SignalCancel	SimpleKeepAlive	StartTimer	StopTimer
ThrowError	UnescapeHTML	UnescapeURL	XMLDTD
XMLExport	XMLExportToStream	XMLExportToString	XMLNew
XMLSchema	XMLSchemaNamespace	XMLSchemaType	addChild
addChildAfter	addChildBefore	addPopupSuffix	adjustExpanderText
arrowClick	cancelPopup	cancelSearch	changePassword
changeURLNamespace	checkEdit	childrenMutated	clientKeepAlive
correctIELayering	createComponent	createComponentNS	createTimeWarning
deleteComponent	deletePEXComponent	disableCommandButton	displayCountDown
doRefresh	doSearch	doUpdateRegStatus	dragFinishHandler
dragHandler	dragNotifyHandler	dragStartHandler	dropHandler
dropStartHandler	enableCommandButton	endModal	executeSearch
exposeComponent	findElement	fireOnResizeEvent	fireOnUnloadEvent
fireOnUpdateEvent	firePopupAction	getChildIndex	getComponent
getComponentById	getContentAreaHeight	getEnclosingDiv	getHidden
getHintElement	getLabelElement	getNextData	getOpener
getPageTitle	getProperty	getResultsTable	getSearchForm
getSettings	getTitleAreaHeight	getType	goHome
goMenu	gotoNamespace	gotoPage	hideCommandButton
hideTimeoutWarning	hideWarnContinue	htmlToTooltip	inResizeLoop
indicateIfCancelled	initPopupSuffix	invokeSuper	isOfType
launchPopupWindow	layoutTabGroup	logout	makeId
manualKeepAlive	navigate	newComponent	onAfterPageChange
onAfterSearch	onChangeResultsPage	onCreate	onDelete
onDisplayHandler	onEndModalHandler	onEnsException	onPopupAction
onRefreshContents	onSearchHandler	onSelectItem	onSerialize
onServerMethodCall	onServerMethodError	onServerMethodReturn	onStartModalHandler
onToggleDetails	onToggleSearch	onUpdate	ondisabledHandler
onhandleAutoLogoutWarn	onkeydownHandler	onkeyupHandler	onlayoutHandler
onloadHandler	onlogoutHandler	onoverlayHandler	onresizeHandler
onunloadHandler	onupdateHandler	populateControls	popupActionHandler
refreshContents	removeChild	removePopupSuffix	render
renderClasspathsTable	renderContents	renderSVG	renderSettingsTable
resetForm	searchBlur	searchBoxHandler	searchFocus
searchKeyDown	searchKeyPress	selectItem	selectRow
setComponentId	setConnectivityStatusMsg	setHidden	setModified
setOverlayMode	setPageTitle	setProperty	setPropertyAll
setSortMode	setSortModeHandler	setTraceOption	setViewMode
setViewModeHandler	setWarnInnerHTML	showAbout	showCommandButton
showContact	showDocumentation	showHelp	showQuery
showTimeoutWarning	startKeepAlive	startModal	startProgressBar
stopKeepAlive	stopProgressBar	switchNamespace	toggleCancelState
toggleDetails	toggleSearch	toggleSearchState	updateActions
updateComponent	updateCounts	updateNavigationButtons	updatePageData
updatePageNumber	updatePageSize	warnclickListener

Parameters

• parameter PAGENAME = "Production EXtensions";

Name of this page.

• parameter RESOURCE = "%Ens_Code:WRITE";

User needs WRITE permissions on the %Ens_Code resource to view this page.

Properties

• property resultsTableId as %ZEN.Datatype.id [ InitialExpression = "resultsTable" ];

Id of the results tablePane

• property searchCriteria as %ZEN.proxyObject [ InitialExpression = $$$NULLOREF ];

Search criteria from the client.
This is a proxy object whose contents are filled in from the search form by the doSearch method. It is expected that the search query will use this information to determine what results to display.

• property tempPortalNode as %ZEN.Datatype.string;

This is the temp global used for cancelling search

Methods

• classmethod %OnFinishBackgroundTask(pTaskID As %String)

This server-side callback method is called whenever the client calls to monitor the current background task and the task is complete. Typically a subclass uses this to send back JavaScript to update the page.

• method %OnGetPageName() as %String

Get the (localized) name of the page.

• method %OnGetTitle() as %String

Get the (localized) title string for the page.

• method ClearTempPortalNode() [ ZenMethod ]

• method DoDeleteComponent(pClassname As %String) as %String [ ZenMethod ]

• classmethod DoRegisterClass(pClassname As %String, pELS As %String, pClasspaths As %String = "", pProxy As %String = "", pOverwrite As %Boolean = 0, pTempPortalNode As %String, pBounce As %Boolean = 0) as %Status

• classmethod GetHyperEventResources(pMethod As %String = "") as %String

Callback to return a list of resources required for a specific HyperEvent. The user must have sufficient privileges on one of the resource/permission pairs to be permitted to execute the hyperevent. An empty string implies the user already has sufficient privileges for the ZenMethod specified in pMethod.

• method GetMessage() as %String [ ZenMethod ]

• method GetPEXComponent(ByRef pParms, Output pObject As %RegisteredObject) as %Status

• method GetRegistrationLink(pClassname As %String = "") as %String [ ZenMethod ]

• method GetResultSet(Output pSC As %Status, pInfo As %ZEN.Auxiliary.QueryInfo) as %ResultSet

Callback that is executed to create the resultset for the main table.

• method GetStatus() as %String [ ZenMethod ]

• method GetTotalCount() as %Integer [ ZenMethod ]

• method HTMLPopup(key) [ Language = javascript ]

Helper method to set up popup for each setting's online help

• method OnDrawRibbon() as %Status

Add to the contents of the tool ribbon.

• method OnGetRibbonInfo(Output pDisplay As %Boolean, Output pViewIcons As %List, Output pSortOptions As %List, Output pSearchBox As %Boolean, Output pRibbonTitle As %String, Output pCommands As %List) as %Status

Get information to display in the ribbon bar.

• method RegisterClassInBackground(pClassname As %String, pELS As %String, pClasspaths As %String = "", pProxy As %String = "", pOverwrite As %Boolean = 0, pBounce As %Boolean = 0) [ ZenMethod ]

This is called when the client clicks OK.

• method deletePEXComponent() [ Language = javascript ]

Unregister a PEX component. This will delete the proxy class, but not the original remote class

• method doRefresh() [ Language = javascript ]

• method doSearch() [ Language = javascript ]

Invoke a search using values from the search form.

• method doUpdateRegStatus() [ Language = javascript ]

• method htmlToTooltip(input) [ Language = javascript ]

Helper method to interpret HTML setting descriptions for display as tooltips Taken from EnsPortal.ProductionConfig

• method layoutTabGroup() [ Language = javascript ]

Handle the client-side rendering the of the right hand pane.

• method newComponent() [ Language = javascript ]

Register a PEX component

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

Returning from file select and setting the value into the appropriate field.

• method onSearchHandler() [ Language = javascript ]

User clicked the Search button

• method onSelectItem() [ Language = javascript ]

populate detailTable for the selected row or no selected row

• method onUpdate(table) [ Language = javascript ]

override resultsTable TablePane methods

• method onlayoutHandler(load) [ Language = javascript ]

Adjust sizes of components on the page. Do this differently for PEX than for other children of EnsPortal.Template.viewerPage (hence the override). In this case the details pane does not change size when the search pane is minimized.

• method onloadHandler() [ Language = javascript ]

This client event, if present, is fired when the page is loaded.

• method populateControls() [ Language = javascript ]

• method renderClasspathsTable(classpaths) [ Language = javascript ]

Update the contents of the Attributes table.

• method renderSettingsTable(settings) [ Language = javascript ]

Update the contents of the Attributes table.

• method resetForm() [ Language = javascript ]

Reset the form programmatically

• method selectRow(row, scroll, which) [ Language = javascript ]

Overrides TablePane method

• method updateActions() [ Language = javascript ]

• method updateComponent() [ Language = javascript ]

Register a PEX component

• method updateCounts() [ Language = javascript ]


[USER] > [EnsPortal] > [PEXComponents]		Private Storage