deprecatedclass %iKnow.UI.KnowledgePortal
extends Styles
This is a Zen Page class.
• parameter AUTONS = 1;
If true, auto-switch namespace to whatever $NAMESPACE is passed in.
• parameter CSSINCLUDES = "bootstrap-4-4-1/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-3.5.1.min.js,bootstrap-4-4-1/dist/js/bootstrap.bundle.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.
• 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 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 DrawLegend(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 DrawSkiplistsPane(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 toggleHighlighting(type)
[ Language = javascript ]
• method toggleSkiplist(id)
[ Language = javascript ]
• method updateFilter(seed)
[ Language = javascript ]
