Sorry, your browser does not support JavaScript or JavaScript is disabled. Please enable JavaScript or use another browser to have a better experience.

%CSP.UI.Portal.UtilsNav

abstract class %CSP.UI.Portal.UtilsNav

This class contains Properties and Methods in support of component tableNavBar in SMP.
The purpose is to remember the last Page size and Maximum rows of the tableNavBar If you want to remember these, then do the following:

Extend your page to this class and add to the :
(1) saveSizeMax="true"
(2) onPageSizeChange="zenPage.navPageSizeChanged(value);" if you want to remember page size
(3) onMaxRowsChange="zenPage.navMaxRowsChanged(value);" if you want to remember max rows
In %OnAfterCreatePage() of your page, add: Do ..%GetNavTableState()

Example pages:
- use %CSP.UI.Portal.Utils as super class: %CSP.UI.Portal.Processes, %CSP.UI.Portal.ClassList
- use %CSP.UI.Portal.Template as super class: %CSP.UI.Portal.Namespaces, %CSP.UI.Portal.Users (with Filter=true)

Method Inventory

%GetNavTableState()
UpdateTableNavState()
navMaxRowsChanged()
navPageSizeChanged()

Properties

property Filter as %ZEN.Datatype.string [ InitialExpression = "*" ];

Filter value user entered into the "Filter" field in the table navigator. This value is saved and reloaded for this page.

Property methods: FilterDisplayToLogical(), FilterGet(), FilterIsValid(), FilterLogicalToDisplay(), FilterLogicalToOdbc(), FilterNormalize(), FilterSet()

property TableMaxRows as %Integer [ InitialExpression = "1000" ];

Max rows value user entered into the "Max rows" field in the table navigator. This value is saved and reloaded for this page.

Property methods: TableMaxRowsDisplayToLogical(), TableMaxRowsGet(), TableMaxRowsIsValid(), TableMaxRowsLogicalToDisplay(), TableMaxRowsNormalize(), TableMaxRowsSet()

property TablePageSize as %Integer [ InitialExpression = "0" ];

Page size value user entered into the "Page size" field in the table navigator. This value is saved and reloaded for this page.

Property methods: TablePageSizeDisplayToLogical(), TablePageSizeGet(), TablePageSizeIsValid(), TablePageSizeLogicalToDisplay(), TablePageSizeNormalize(), TablePageSizeSet()

Methods

method %GetNavTableState(pPageName As %String = "") as %Status

Call this method from %OnAfterCreatePage to load the last saved values for tableNavBar.
Pass in a special name you used for this page if differ from ..%GetPageName.
For example Mappings is used for Global/Routine/Package Mappings, so the name used for save has MapType in it to distinguish. If tableId is not "table" then pass it in as the second piece delimited by "^" (example: %CSP.UI.Portal.SQL.TuneTable).

classmethod UpdateTableNavState(pFilter As %String, pPageSize As %Integer, pMaxRows As %Integer) [ ZenMethod ]

Used to Save TableNavigatorBar Values.

clientmethod navMaxRowsChanged(value) [ Language = javascript ]

Maybe overriden by subclass.

clientmethod navPageSizeChanged(value) [ Language = javascript ]

Maybe overriden by subclass.

Subclasses

Feedback