Class: PageNavigatorComponent

Source Location: /framework/template/components/page/pager.inc.php

http://wact.sourceforge.net/index.php/PageNavigatorComponent

Class Overview

Component
   |
   --PageNavigatorComponent

Represents a page navigator at runtime.

Variables

Methods

Inherited Variables

Class: Component

Component::$children
Component::$id
Component::$IsDynamicallyRendered
Component::$parent

Inherited Methods

Class: Component

Component::addChild(): Adds a reference to a child component to this component, using it's ID attribute as the child array key
Component::findChild(): Returns a child component given it's ID.
Component::findChildByClass(): Returns the first child component matching the supplied WACT_TEMPLATE Component PHP class name
Component::findParentByClass(): Recursively searches through parents of this component searching for a given WACT_TEMPLATE component PHP class name
Component::getChild(): Same as find child, except raises error if child is not found
Component::getServerId(): Returns the ID of the component, as defined in the template tags ID attribute
Component::render(): Outputs the component, rendering any child components as well This method will only ever be called on components that support Dynamic rendering.
Component::setChildDataSource(): set the data source of a child component, or raise an error if the child is not found.

Class Details

Represents a page navigator at runtime.

The total number of items in the list to be paged must be known before the navigator can be displayed.

access:	public
see:	http://wact.sourceforge.net/index.php/PageNavigatorComponent

Class Variables

$AnchorSize = 3

The Number of page numbers anchored at each side of the page list.

access:

protected

Type:

integer

$baseUrl =

The Url used to display individual pages of the list.

access:

protected

Type:

mixed

$CurrentPage =

The page number of the current page in the list.

access:

protected

Type:

integer

$ElipsesCount =

Used while displaying a page number list to determine when an elipses should be displayed

access:

protected

Type:

integer

$Items = 20

Number of items to display on each page of the list.

This is set via the items attribute of the page:navigator tag.

access:

protected

Type:

integer

$LastPage =

The page number of the last page in the list.

access:

protected

Type:

integer

$page =

Used while displaying a page number list to the page number being displayed

access:

protected

Type:

integer

$PagedDataSet =

A paged dataset reference.

Used for determining the total number of items the pager should navagate across.

access:

protected

Type:

mixed

$pageVariable = page

The variable used to carry the current page in the URL.

access:

protected

Type:

mixed

$ShowSeparator =

Used while displaying a page number list to determine when a separator should be shown between two page numbers

access:

protected

Type:

boolean

$TotalItems =

The total number of items in this list.

access:

protected

Type:

integer

$WindowSize = 3

Number of pages around the current one to display.

(must be odd number)

access:

protected

Type:

integer

Class Methods

constructor PageNavigatorComponent

Initialize this class

PageNavigatorComponent PageNavigatorComponent(
)

API Tags:

access:

public

method getCurrentPageNumber

void getCurrentPageNumber(
)

method getCurrentPageUri

The URI of the page that is being displayed in the page number list This is called automatically from the compiled template and should not be called directly.

string getCurrentPageUri(
)

API Tags:

access:

protected

method getFirstPageUri

Return the URI to the first page in the list.

string getFirstPageUri(
)

API Tags:

access:

public

method getItemsPerPage

Get the item number of the first item in the list.

Usually called by the PagedDataSet to determine how many items are on a page.

integer getItemsPerPage(
)

API Tags:

access:

public

method getLastPageNumber

void getLastPageNumber(
)

method getLastPageUri

Return the URI to the last page in the list.

string getLastPageUri(
)

API Tags:

access:

public

method getNextPageUri

Return the URI to the next page in the list.

string getNextPageUri(
)

API Tags:

access:

public

method getPageNumber

Get the page number of the page being displayed in the page number list.

This is called automatically from the compiled template and should not be called directly.

integer getPageNumber(
)

API Tags:

access:

protected

method getPageUri

Return the URI to a specific page in the list.

string getPageUri(
mixed
$page)

API Tags:

access:

public

method getPrevPageUri

Return the URI to the previous page in the list.

string getPrevPageUri(
)

API Tags:

access:

public

method getStartingItem

Get the item number of the first item in the list.

Usually called by the PagedDataSet to determine where to begin query.

integer getStartingItem(
)

API Tags:

access:

public

method hasNext

Is there a page available to display after the current page being displayed?

boolean hasNext(
)

API Tags:

access:

public

method hasPrev

Is there a page available to display before the current page being displayed?

boolean hasPrev(
)

API Tags:

access:

public

method isCurrentPage

Is the page number of the page being displayed in the page number list

the current page being displayed in the browser? This is called automatically from the compiled template and should not be called directly.

boolean isCurrentPage(
)

API Tags:

access:

protected

method isDisplayPage

Should the current page in the page number list be displayed? This is called automatically from the compiled template and should not be called directly.

boolean isDisplayPage(
)

API Tags:

access:

protected

method IsFirst

Is the current page being displayed the first page in the page list?

boolean IsFirst(
)

API Tags:

access:

public

method IsLast

Is the current page being displayed the last page in the page list?

boolean IsLast(
)

API Tags:

access:

public

method next

Advance the page list cursor to the next page.

This is called automatically from the compiled template and should not be called directly.

boolean next(
)

API Tags:

return:	FALSE if there are no more pages.
access:	protected

method prepare

Initialize values used by this component.

This is called automatically from the compiled template.

void prepare(
)

API Tags:

access:

protected

method setPagedDataSet

Set the database which this pager controls.

void setPagedDataSet(
object
&$dataset)

API Tags:

access:

public

Parameters:

object

&$dataset

dataset

method setTotalItems

Set the total number of items in the list.

void setTotalItems(
mixed
$items)

API Tags:

access:

protected

Documentation generated on Sun, 28 Nov 2004 19:48:56 -0800 by phpDocumentor 1.2.3