Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / %iKnow.UI.KnowledgePortal
Private  Storage   

%iKnow.UI.KnowledgePortal


class %iKnow.UI.KnowledgePortal extends
Styles

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
5 14 47


Summary


This is a Zen Page class. 

Properties
%condition %import %includeFiles %page
%resource align aux backgroundTimerInterval
blacklists cellAlign cellSize cellStyle
cellVAlign children composite containerStyle
cssLevel disabled domain dragAndDrop
dragEnabled drill dropEnabled enableAutocomplete
enclosingClass enclosingStyle error filter
filtermode groupClass groupStyle height
hidden hint hintClass hintStyle
id includeOtherNamespaces index label
labelClass labelDisabledClass labelPosition labelStyle
languageMode layout name onafterdrag
onbeforedrag onclick ondrag ondrop
onhide onrefresh onshow onupdate
pageSize parent showLabel slice
source summaryPct term title
tuple useRepresentationForm useSVG useSoftModals
useStemming valign visible width
window zenPersistentPopup

Methods
%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 %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 %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 ConvertParameter
CreateCustomFilter Decrypt DrawBlacklistsPane DrawButtons
DrawCustomFilterInputs DrawFilterPane DrawPaths DrawRelEntities
DrawSettingsPane DrawSimEntities DrawSourceListModal DrawSourceModal
DrawTopEntities Encrypt ErrorHandler EscapeHTML
EscapeURL GetCustomFilterTypes GetDefaultHighlightSpec GetFilter
HyperEventCall HyperEventHead Include InputTerm
InsertHiddenField InsertHiddenFields IsPrivate Link
NextPage OnHTTPHeader OnPage OnPageError
OnPostHTTP OnPostHyperEvent OnPreHTTP OnPreHyperEvent
Page QuoteJS RemoveFilter ResetPages
RewriteURL ShowError ShowInfo StartTimer
StopTimer ThrowError ToggleFilter TogglePane
UnescapeHTML UnescapeURL XMLDTD XMLExport
XMLExportToStream XMLExportToString XMLNew XMLSchema
XMLSchemaNamespace XMLSchemaType addChild addChildAfter
addChildBefore applyPane cancelPopup childrenMutated
closeInfo correctIELayering createComponent createComponentNS
deleteComponent dragFinishHandler dragHandler dragNotifyHandler
dragStartHandler drillSources dropHandler dropStartHandler
endModal explore exposeComponent findElement
fireOnResizeEvent fireOnUnloadEvent fireOnUpdateEvent firePopupAction
fixHighlighting getChildIndex getComponent getComponentById
getCustomFilterSettings getEnclosingDiv getHidden getHintElement
getLabelElement getOpener getProperty getSettings
getType gotoPage inputTermClient invokeSuper
isOfType launchPopupWindow makeId onCreate
onDelete onDisplayHandler onEndModalHandler onPopupAction
onRefreshContents onSerialize onServerMethodCall onServerMethodError
onServerMethodReturn onStartModalHandler onTermKeyUp ondisabledHandler
onkeydownHandler onkeyupHandler onlayoutHandler onloadHandler
onlogoutHandler onoverlayHandler onresizeHandler onunloadHandler
onupdateHandler openSource popupActionHandler refreshAll
refreshContents removeChild render renderContents
renderSVG resetFilter setComponentId setFilterLocation
setHidden setOverlayMode setProperty setPropertyAll
setTraceOption startModal startProgressBar stopProgressBar
submitFilter summarize toggleBlacklist toggleHighlighting
updateFilter


Parameters


• parameter AUTONS = 1;
If true, auto-switch namespace to whatever $NAMESPACE is passed in.
• parameter CSSINCLUDES = "bootstrap-3-3-5/dist/css/bootstrap.min.css";
Comma-separated list of additional CSS include files for the page. If this page is using CSS3 then the CSS3INCLUDES parameter is used (if defined).
• parameter DOMAIN = "%iKnow";
Localization domain
• parameter JSINCLUDES = "jquery-2.0.3.min.js,bootstrap-3-3-5/dist/js/bootstrap.min.js";
Comma-separated list of additional JS include files for the page.
• parameter RESOURCE = "%Development";
This is a comma-delimited list of system Resources and associated permissions. A user must hold the specified permissions on at least one of the specified resources in order to view this page or invoke any of its server-side methods from the client.
The format of each item in the list should be as follows:
Resource[:Permission]
Permission is optional, and defaults to USE if not supplied. If it is supplied, it should be one of USE, READ or WRITE.

Properties


• property blacklists as %ZEN.Datatype.string(ZENURL="blacklists");
• property domain as %ZEN.Datatype.integer(ZENURL="domain");
• property drill as %ZEN.Datatype.string;
• property enableAutocomplete as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
• property filter as %ZEN.Datatype.string(ZENURL="filter");
• property filtermode as %ZEN.Datatype.integer(ZENURL="filtermode") [ InitialExpression = $$$FILTERALLANDSORT ];
• property includeOtherNamespaces as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
• property languageMode as %ZEN.Datatype.string(VALUELIST=",en,ja",ZENURL="langmode") [ InitialExpression = "en" ];
• property pageSize as %ZEN.Datatype.integer(ZENURL="pagesize") [ InitialExpression = 10 ];
• property source as %ZEN.Datatype.integer(ZENURL="source");
• property summaryPct as %ZEN.Datatype.integer [ InitialExpression = 100 ];
• property term as %ZEN.Datatype.string(ZENURL="term");
• property useRepresentationForm as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
• property useStemming as %ZEN.Datatype.boolean;

Methods


• method %OnAfterCreatePage() as %Status
This callback is called after the server-side page object and all of its children are created.
Subclasses can override this to add, remove, or modify items within the page object model, or to provide values for controls.
• method AddFilter(pString As %String, pLocation As %String = "") as %Status [ ZenMethod ]
• method CreateCustomFilter(pFilterType As %String, pSettings As %String) as %iKnow.Filters.Filter
Subclasses can override this method to instantiate an actual %iKnow.Filters.Filter object based on the supplied settings. pSettings is the string capturing user input, as assembled by getCustomFilterSettings.
• method DrawBlacklistsPane(pSeed As %String) as %Status
• method DrawButtons(pSeed As %String) as %Status
• method DrawCustomFilterInputs(pFilterType As %String, pSettings As %String) as %Status
Subclasses can override this method to draw the input fields specific to a custom filter type added through GetCustomFilterTypes. pSettings is the string capturing user input, as assembled by getCustomFilterSettings.
• method DrawFilterPane(pSeed As %String) as %Status
• method DrawPaths(pSeed As %String) as %Status
• method DrawRelEntities(pSeed As %String) as %Status
• method DrawSettingsPane(pSeed As %String) as %Status
• method DrawSimEntities(pSeed As %String) as %Status
• method DrawSourceListModal(pSeed As %String) as %Status
• method DrawSourceModal(pSeed As %String) as %Status
• method DrawTopEntities(pSeed As %String) as %Status
• method ErrorHandler(pSC As %Status) as %Status
• classmethod GetCustomFilterTypes(Output pCustomFilterTypes) as %Status
Subclasses can override this method to supply custom filter types to be displayed in the filter type dropdown in the following format: pCustomFilterTypes(typeName) = typeLabel
• method GetFilter() as %iKnow.Filters.Filter
• method InputTerm(pBase As %String) as %String [ ZenMethod ]
• method NextPage(pID As %String, pPage As %Integer) as %Status [ ZenMethod ]
• method RemoveFilter(pLocation As %String = "") as %Status [ ZenMethod ]
• method ResetPages() as %Status [ ZenMethod ]
• method ShowInfo() as %Boolean [ ZenMethod ]
• method ToggleFilter(pLocation As %String, pLogic As %String = "", pNegation As %Boolean = -1) as %Status [ ZenMethod ]
• method TogglePane(pID As %String, pPane As %Integer) as %Status [ ZenMethod ]
• method applyPane(pane) [ Language = javascript ]
• method closeInfo() [ Language = javascript ]
• method drillSources(spec) [ Language = javascript ]
• method explore(string, fromField) [ Language = javascript ]
• method fixHighlighting(type) [ Language = javascript ]
• method getCustomFilterSettings(filterType) [ Language = javascript ]
Subclasses can override this method to pick up the values of the input fields specific to a custom filter type as draw in DrawCustomFilterIntputs and concatenate them into a settings string.
• method inputTermClient(text) [ Language = javascript ]
• method onTermKeyUp() [ Language = javascript ]
• method onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
• method openSource(srcID) [ Language = javascript ]
• method refreshAll() [ Language = javascript ]
• method resetFilter() [ Language = javascript ]
• method setFilterLocation(location) [ Language = javascript ]
• method submitFilter() [ Language = javascript ]
• method summarize(pct) [ Language = javascript ]
• method toggleBlacklist(id) [ Language = javascript ]
• method toggleHighlighting(type) [ Language = javascript ]
• method updateFilter(seed) [ Language = javascript ]