Home > Class Reference > ENSLIB namespace > %ZEN.Component.tableNavigatorBar
Private  Storage   

%ZEN.Component.tableNavigatorBar


class %ZEN.Component.tableNavigatorBar extends component

This composite component displays a navigation bar (paging information and links to pages) for a %ZEN.Component.tablePane.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
2 22 11


Summary


Properties
%condition %import %includeFiles %page
%resource align aux composite
containerStyle dragEnabled dropEnabled enclosingClass
enclosingStyle error height hidden
hint hintClass hintStyle id
index label labelClass labelDisabledClass
labelStyle maxButtons maxPageSize maxRows
msgFilter msgFirstPage msgFound msgLastPage
msgMaxRows msgNextPage msgOf msgPage
msgPageSize msgPreviousPage name navmaxRows
onMaxRowsChange onPageSizeChange onafterdrag onbeforedrag
ondrag ondrop onfilterChange onhide
onrefresh onshow onupdate parent
saveSizeMax showFilter showLabel showMaxRows
showPageSize slice tablePaneId title
tuple valign visible width
window

Methods
%AddToSaveSet %Attr %BindExport %ClassIsLatestVersion
%ClassName %ConstructClone %DispatchClassMethod %DispatchGetModified
%DispatchGetProperty %DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%DispatchSetProperty %DrawComponentHTML %DrawHTML %DrawJSStrings
%EnclosingDivId %Eval %EvalC %Extends
%ForceClientRender %GetEventHandlers %GetParameter %GetXMLName
%IsA %IsModified %MakeId %New
%NormalizeObject %ObjectModified %OnAddToPageAfter %OnAddToPageBefore
%OnDrawEnclosingDiv %OnDrawObjectProperties %OnObjectSynch %OnZENDeserialize
%OriginalNamespace %PackageName %QuoteValue %QuoteValueL10N
%RemoveFromSaveSet %Self %SerializeObject %SetModified
%ValidateObject XMLDTD XMLExport XMLExportToStream
XMLExportToString XMLNew XMLSchema XMLSchemaNamespace
XMLSchemaType connect dragFinishHandler dragHandler
dragNotifyHandler dragStartHandler dropHandler dropStartHandler
exposeComponent findElement fireOnUpdateEvent getEnclosingDiv
getHidden getHintElement getLabelElement getProperty
getSettings getType gotoPage invokeSuper
isOfType makeId onCreate onDelete
onDisplayHandler onEndModalHandler onPopupAction onRefreshContents
onSerialize onStartModalHandler onfilterHandler onloadHandler
onmaxRowsHandler onpageSizeHandler onunloadHandler onupdateHandler
refreshContents render renderButtons renderContents
renderSVG setHidden setOverlayMode setProperty
startProgressBar stopProgressBar updateState

Subclasses
%CSP.UI.Component.tableNavBar

Parameters


• parameter DOMAIN = "%ZEN";
Localization domain
• parameter SYSMODULE = "table";
If set, this indicates that this system component should be placed in the given "module". A module is a grouping of components within the same class package that share common include (js or css) files. Note that certain root classes are implicitly placed within the "core" module.
Classes outside of the Zen library should not set this, they should use the MODULE instead.

Properties


• property maxButtons as %ZEN.Datatype.integer [ InitialExpression = 5 ];
This is the maximum number of page number "buttons" to display within the navigator. The default is 5.
If set to less than 1, then 1 is used.
• property maxPageSize as %ZEN.Datatype.integer [ InitialExpression = 1000 ];
This is the maximum page size that a user can enter within the navigator. The default is 1000.
• property maxRows as %ZEN.Datatype.integer [ InitialExpression = 1000 ];
This is the maximum rows that the associated table can load. Value can be changed from the "Max rows" field. The default is 1000.
• property msgFilter as %ZEN.Datatype.caption;
Localized "Filter" message.
• property msgFirstPage as %ZEN.Datatype.caption;
Localized "first page" message.
• property msgFound as %ZEN.Datatype.caption;
Localized "Results" message.
• property msgLastPage as %ZEN.Datatype.caption;
Localized "last page" message.
• property msgMaxRows as %ZEN.Datatype.caption;
Localized "max rows" message.
• property msgNextPage as %ZEN.Datatype.caption;
Localized "next page" message.
• property msgOf as %ZEN.Datatype.caption;
Localized "of" found message.
• property msgPage as %ZEN.Datatype.caption;
Localized "Page" message.
• property msgPageSize as %ZEN.Datatype.caption;
Localized "page size" message.
• property msgPreviousPage as %ZEN.Datatype.caption;
Localized "previous page" message.
• property navmaxRows as %ZEN.Datatype.integer [ InitialExpression = 100000 ];
This is the maximum rows that a user can enter within the navigator. The default is 100000. Designer may override this, but end user's entry cannot be greater than this number.
• property onMaxRowsChange as %ZEN.Datatype.eventHandler;
onMaxRowsChange event handler: This event is fired when user changes the value in the "Max rows" box displayed by this navigator. value is passed to this callback and is the current value of the "Max rows" control.
• property onPageSizeChange as %ZEN.Datatype.eventHandler;
onPageSizeCghange event handler: This event is fired when user changes the value in the "Page size" box displayed by this navigator. value is passed to this callback and is the current value of the "Page size" control.
• property onfilterChange as %ZEN.Datatype.eventHandler;
onfilterChange event handler: This event is fired when the user changes the value in the filter box displayed by this navigator. value is passed to this callback and is the current value of the filter control.
• property saveSizeMax as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, it will invoke user function to save pageSize and maxRows and designer should provide call backs for onPageSizeChange and onMaxRowsChange.
• property showFilter as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, show a filter input box as part of the navigator. This filter box does not do anything on its own, you need to assign an onfilterChange event to make this happen.
• property showMaxRows as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, let users control the maximum rows of the table pane using the navigator.
• property showPageSize as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, let users control the page size of the table pane using the navigator.
• property tablePaneId as %ZEN.Datatype.id(COMPONENTTYPE="tablePane");
id of %ZEN.Component.tablePane component this navigator is associated with.
Note: if this component is placed within a composite element, then the tablePane must be within the same composite element.

Methods


• method %DrawHTML()
Static HTML display method: draw the BODY of this component as HTML.
Subclasses implement this in order to render the static HTML contents of a component.
• method connect() [ Language = javascript ]
Connect to table pane.
• method gotoPage(where) [ Language = javascript ]
Move to the specified page in the associated tablePane. where can be 'first','last','next','prev' or a page number.
• method onfilterHandler(value) [ Language = javascript ]
Event handler for filter box. This method is called when the value of the filter box changes.
• method onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
• method onmaxRowsHandler(ctrl) [ Language = javascript ]
Event handler for maxRows box. This method is called when the value of the maxRows box changes.
• method onpageSizeHandler(ctrl) [ Language = javascript ]
Event handler for page size box. This method is called when the value of the page size box changes.
• method renderButtons() [ Language = javascript ]
Render HTML for paging buttons.
• method renderContents() [ Language = javascript ]
Client-side method to render this control.
• method setProperty(property, value, value2) [ Language = javascript ]
Set the value of a named property.
• method updateState() [ Language = javascript ]
This method is called from the associated tablePane when it changes state. The navigator responds by updating the state of its controls.