DocBook|Search
Class Reference
%iKnow.UI.BasicPortal
   
Server:basexml
Instance:SOAXML
User:UnknownUser
 
-
  [BASEXML] >  [%iKnow] >  [UI] >  [BasicPortal]
Private  Storage  

class %iKnow.UI.BasicPortal extends %iKnow.UI.AbstractPortal

This is a sample User Interface built on top of the iKnow query APIs, displaying a browsable overview of the semantic elements identified by the iKnow Smart Indexing API. Click on an entity in a list to browse to the elements similar, related or containing the selected entity.

Use the filter button to filter the displayed results based on metadata criteria.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 13


Summary

This is a Zen Page class. 

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

Methods
%%OIDGet %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 %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 %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 AddFilter BuildInfoPane
ChangeFilterMDField ChangeFilterMDOp ChangeFilterType ClearFilter
ConvertParameter Decrypt DrawFilter DrawMetadataValue
DrawSource DrawSummary Encrypt EndSession
EscapeHTML EscapeURL ExecuteQuery GetCurrentFilterMode
GetCurrentFilterObject GetCurrentFilterString GetDomain GetInfoPaneText
GetPage GetSource GetSourceObject GetTerm
GetUrlForDomain HyperEventBody HyperEventCall HyperEventFrame
HyperEventHead Include InitPages InputTerm
InsertHiddenField InsertHiddenFields IsPrivate Link
NextPage OnHTTPHeader OnPage OnPageError
OnPostHTTP OnPostHyperEvent OnPreHTTP OnPreHyperEvent
OnUpdateDomain OnUpdateFilter OnUpdateSource OnUpdateTerm
Page PreviousPage QuoteJS RemoveFilterAt
ResetPages RewriteURL SetBlacklists ShowError
StartTimer StopTimer ThrowError ToggleGroupLogic
UnescapeHTML UnescapeURL UpdateDomain UpdateSource
UpdateSummaryLength UpdateTerm XMLDTD XMLExport
XMLExportToStream XMLExportToString XMLNew XMLSchema
XMLSchemaNamespace XMLSchemaType addChild addChildAfter
addChildBefore addFilterClient buildSummaryClient cancelPopup
changeFilterMDFieldClient changeFilterMDOpClient changeFilterTypeClient childrenMutated
clearFilterClient correctIELayering createComponent createComponentNS
deleteComponent displaySourceClient dragFinishHandler dragHandler
dragNotifyHandler dragStartHandler dropHandler dropStartHandler
endModal exposeComponent findElement fireOnLoadEvent
fireOnResizeEvent fireOnUnloadEvent fireOnUpdateEvent firePopupAction
getChildIndex getComponent getComponentById getEnclosingDiv
getHidden getHintElement getLabelElement getOpener
getProperty getSettings getType gotoPage
inputTermClient invokeSuper isOfType launchPopupWindow
makeId nextPageClient onCreate onDelete
onDisplayHandler onEndModalHandler onPopupAction onRefreshContents
onSerialize onServerMethodCall onServerMethodError onServerMethodReturn
onStartModalHandler onTermKeyUp onUpdateFilterClient onUpdateSourceClient
onUpdateTermClient ondisabledHandler onkeydownHandler onkeyupHandler
onlayoutHandler onloadHandler onlogoutHandler onoverlayHandler
onresizeHandler onunloadHandler onupdateHandler popupActionHandler
previousPageClient refreshContents refreshMDFilterFields removeChild
removeFilterClient render renderContents renderSVG
setBlacklistsClient setComponentId setCurrentGroupClient setHidden
setOverlayMode setProperSizes setProperty setPropertyAll
setTraceOption showBlacklists showFilterForm startModal
startProgressBar stopProgressBar toggleGroupLogicClient updateDomainClient
updateFilterClient updateSourceClient updateTermClient useTermClient


Parameters

• parameter PAGENAME = "Basic iKnow Portal";
Optional. This is the display name used for this page. If not provided, the class name is used.

Methods

• method DrawMetadataValue(pTable As %ZEN.Component.tablePane, pName As %String, pSeed As %String) as %Status
• method DrawSource(pSeed As %String) as %Status
• method DrawSummary(pSeed As %String) as %Status
• method GetInfoPaneText() as %String
Returns the text to be displayed in infoPane. To be overridden by the subclass using it.
• method InitPages() as %Status
This method should to be implemented by subclasses using the paging functions, giving all paged components a meaningful initial page value (usually 1).
• method UpdateSummaryLength(length As %Integer) as %Status [ ZenMethod ]
• method buildSummaryClient() [ Language = javascript ]
• method displaySourceClient(sourceId) [ Language = javascript ]
• method onUpdateFilterClient() [ Language = javascript ]
Client-side method subclasses can override to execute additional logic when the user has changed filter criteria.
• method onUpdateSourceClient(source) [ Language = javascript ]
Client-side method subclasses can override to take additional actions upon a change in the current source.
• method onUpdateTermClient() [ Language = javascript ]
Client-side method subclasses can override to take additional actions when the user selects a new term.
• method onlayoutHandler(load) [ Language = javascript ]
This client event, if present, is fired when the page is first loaded or whenever it is resized.
If this is called at load time, then load will be true.
• method setProperSizes() [ Language = javascript ]