Provides pagination control over the results of a db, ftsearch, or view tag. The body is evaluated once and is expected to contain a header followed by a viewloop tag (when in the context of a view) or docloop tag (in all contexts). Navigating from page to page is done using the pagefirst, pagelast, pagenext, pageprev, and pagebar tags.

Contexts

Valid in:

db, view, ftsearch, responses

docloop, viewloop, pagebar, pagenext, pageprev, pagefirst, pagelast, novalues

<domino:page
id="name of object variable"
start="page number to start at"
rows="number of entries rendered per page"
direction="ASC|DSC|Ascending|Descending"
max="maximum number of pages to display"
evaluateonnorows="true|false"
viewasdocuments="true|false"
name="name of page parameter storing current page number"
debug="true|false"
onfailure="inline|exception"
time="true|false">

The following attributes are optional:

direction

Indicates the direction of iteration through the result. Must be one of the following:

ASC, DSC, Ascending, Descending

Default is Ascending.

Indicates if the body should be evaluated when no rows are present in the result. This allows the page tag to be used with a novalues tag to prevent headers from being displayed when there are no rows to display. Default is true.

If you specify an id name, creates a variable that contains the associated lotus.domino.taglib.PageInfo object. The variable created is only available within the body of the page tag. If not specified, no programmatic access to the PageInfo object is available.

Maximum number of pages to display. If more pages are necessary to display all the entries, you cannot view those entries that fall on the extra pages; you cannot navigate to more than the maximum number of pages specified. By default, displays all pages.

Name of the page parameter that stores the current page number. If you want to include more than one page tag on the same JSP, the second and subsequent page tags must specify this attribute or an exception is thrown.

Note This value must be specified in the name attribute of the preserve tag before the first page tag is encountered or the page number will not be preserved correctly. If multiple page tags are present on a JSP, the JSP engine tests to see if a preserve tag exists for each page tag and throws an exception if it encounters a missing one. You can use the same name in this name attribute for more than one page if you want to preserve more than one page tag using a single preserve tag.

The default name is "page."

Number of entries to render per page. Default is 10. Passing -1 to this attribute displays all remaining objects.

Forces the page number to start at. Default is 1.

Note This attribute overrides the page navigation tags.

Boolean value that determines whether a page being used in the context of a view tag should loop over documents or view entries. This must be determined before the docloop or viewloop tags are displayed so that the proper page numbers can be determined. This attribute is ignored if the page tag is being used in a context other than in the view tag. Default is false; each row is treated as a ViewEntry object.

Interface

You can use the following interface to determine the current state of a JSP page:

public interface PageInfo {

   // Get the current page being processed.

   public abstract int getPage();

   // Returns the total number of pages for this collection

   // (not expensive)

   public abstract int getPageCount();

   // Returns TRUE if the current page is the first page

   public abstract boolean isFirstPage();

   // Returns TRUE if the current page is the last page

   public abstract boolean isLastPage();

   // Returns TRUE if the current page is the only page

   public abstract boolean isOnlyPage();

   // Returns TRUE if the current page is blank

   // (isFirstPage() should be TRUE)

   public abstract boolean isEmptyPage();

}

The Domtags tag library

Glossary