Home > Class Reference > ENSLIB namespace > %iKnow.UI.BasicPortal

%iKnow.UI.BasicPortal

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.

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

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

Properties (Including Private)

property summaryLength as %ZEN.Datatype.integer (ZENURL = "summaryLength") [ InitialExpression = 10 ];
Property methods: summaryLengthDisplayToLogical(), summaryLengthGet(), summaryLengthIsValid(), summaryLengthLogicalToDisplay(), summaryLengthLogicalToOdbc(), summaryLengthNormalize(), summaryLengthSet()

Methods (Including Private)

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
Inherited description: Returns the text to be displayed in infoPane. To be overridden by the subclass using it.
method InitPages() as %Status
Inherited description: This method should to be implemented by subclasses using the paging functions, giving all paged components a meaningful initial page value (usually 1).
method OnChangeLanguageMode() as %Status
Inherited description: This method is called whenever the language mode changes, as part of UpdateSource() or %OnAfterCreatePage()
method UpdateSummaryLength(length As %Integer) as %Status [ ZenMethod ]
clientmethod buildSummaryClient() [ Language = javascript ]
clientmethod displaySourceClient(sourceId) [ Language = javascript ]
clientmethod onUpdateFilterClient() [ Language = javascript ]
Inherited description: Client-side method subclasses can override to execute additional logic when the user has changed filter criteria.
clientmethod onUpdateSourceClient(source) [ Language = javascript ]
Inherited description: Client-side method subclasses can override to take additional actions upon a change in the current source.
clientmethod onUpdateTermClient(term As %Library.String) [ Language = javascript ]
Inherited description: Client-side method subclasses can override to take additional actions when the user selects a new term.
clientmethod onlayoutHandler(load) [ Language = javascript ]
Inherited description: 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.
clientmethod setProperSizes() [ Language = javascript ]

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)