Class CLinkPager

CLinkPager displays a list of hyperlinks that lead to different pages of target.

CComponent

CBaseController

CWidget

CBasePager

CLinkPager

Direct known subclasses

MobileRecordIndexPager, MobileTopicsPager

Package: system\web\widgets\pagers
Copyright: 2008-2013 Yii Software LLC
License: http://www.yiiframework.com/license/
Author: Qiang Xue <qiang.xue@gmail.com>
Since: 1.0
Located at x2engine/framework/web/widgets/pagers/CLinkPager.php

Methods summary
`public`	# `init( )` Initializes the pager by setting some default property values. Initializes the pager by setting some default property values. Overrides `CWidget::init()`
`public`	# `run( )` Executes the widget. This overrides the parent implementation by displaying the generated page buttons. Executes the widget. This overrides the parent implementation by displaying the generated page buttons. Overrides `CWidget::run()`
`protected array`	# `createPageButtons( )` Creates the page buttons. Creates the page buttons. Returns `array` a list of page buttons (in HTML code).
`protected string`	# `createPageButton( string $label, integer $page, string $class, boolean $hidden, boolean $selected )` Creates a page button. You may override this method to customize the page buttons. Creates a page button. You may override this method to customize the page buttons. Parameters `$label` `string` $label the text label for the button `$page` `integer` $page the page number `$class` `string` $class the CSS class for the page button. `$hidden` `boolean` $hidden whether this page button is visible `$selected` `boolean` $selected whether this page button is selected Returns `string` the generated button
`protected array`	# `getPageRange( )` Returns `array` the begin and end pages that need to be displayed.
`public`	# `registerClientScript( )` Registers the needed client scripts (mainly CSS file). Registers the needed client scripts (mainly CSS file).
`public static`	# `registerCssFile( string $url = null )` Registers the needed CSS file. Registers the needed CSS file. Parameters `$url` `string` $url the CSS URL. If null, a default CSS URL will be used.

Methods inherited from CBasePager
`createPageUrl(), createPages(), getCurrentPage(), getItemCount(), getPageCount(), getPageSize(), getPages(), setCurrentPage(), setItemCount(), setPageSize(), setPages()`

Methods inherited from CWidget
`__construct(), actions(), getController(), getId(), getOwner(), getViewFile(), getViewPath(), render(), setId()`

Methods inherited from CBaseController
`beginCache(), beginClip(), beginContent(), beginWidget(), createWidget(), endCache(), endClip(), endContent(), endWidget(), renderFile(), renderInternal(), widget()`

Methods inherited from CComponent
`__call(), __get(), __isset(), __set(), __unset(), asa(), attachBehavior(), attachBehaviors(), attachEventHandler(), canGetProperty(), canSetProperty(), detachBehavior(), detachBehaviors(), detachEventHandler(), disableBehavior(), disableBehaviors(), enableBehavior(), enableBehaviors(), evaluateExpression(), getEventHandlers(), hasEvent(), hasEventHandler(), hasProperty(), raiseEvent()`

Constants summary
`string`	`CSS_FIRST_PAGE`	`'first'`	#
`string`	`CSS_LAST_PAGE`	`'last'`	#
`string`	`CSS_PREVIOUS_PAGE`	`'previous'`	#
`string`	`CSS_NEXT_PAGE`	`'next'`	#
`string`	`CSS_INTERNAL_PAGE`	`'page'`	#
`string`	`CSS_HIDDEN_PAGE`	`'hidden'`	#
`string`	`CSS_SELECTED_PAGE`	`'selected'`	#

Properties summary
`public string`	`$firstPageCssClass`	`CLinkPager::CSS_FIRST_PAGE`	# the CSS class for the first page button. Defaults to 'first'. the CSS class for the first page button. Defaults to 'first'. Since 1.1.11
`public string`	`$lastPageCssClass`	`CLinkPager::CSS_LAST_PAGE`	# the CSS class for the last page button. Defaults to 'last'. the CSS class for the last page button. Defaults to 'last'. Since 1.1.11
`public string`	`$previousPageCssClass`	`CLinkPager::CSS_PREVIOUS_PAGE`	# the CSS class for the previous page button. Defaults to 'previous'. the CSS class for the previous page button. Defaults to 'previous'. Since 1.1.11
`public string`	`$nextPageCssClass`	`CLinkPager::CSS_NEXT_PAGE`	# the CSS class for the next page button. Defaults to 'next'. the CSS class for the next page button. Defaults to 'next'. Since 1.1.11
`public string`	`$internalPageCssClass`	`CLinkPager::CSS_INTERNAL_PAGE`	# the CSS class for the internal page buttons. Defaults to 'page'. the CSS class for the internal page buttons. Defaults to 'page'. Since 1.1.11
`public string`	`$hiddenPageCssClass`	`CLinkPager::CSS_HIDDEN_PAGE`	# the CSS class for the hidden page buttons. Defaults to 'hidden'. the CSS class for the hidden page buttons. Defaults to 'hidden'. Since 1.1.11
`public string`	`$selectedPageCssClass`	`CLinkPager::CSS_SELECTED_PAGE`	# the CSS class for the selected page buttons. Defaults to 'selected'. the CSS class for the selected page buttons. Defaults to 'selected'. Since 1.1.11
`public integer`	`$maxButtonCount`	`10`	# maximum number of page buttons that can be displayed. Defaults to 10. maximum number of page buttons that can be displayed. Defaults to 10.
`public string`	`$nextPageLabel`		# the text label for the next page button. Defaults to 'Next >'. Setting this to false will disable this button. the text label for the next page button. Defaults to 'Next >'. Setting this to false will disable this button.
`public string`	`$prevPageLabel`		# the text label for the previous page button. Defaults to '< Previous'. Setting this to false will disable this button. the text label for the previous page button. Defaults to '< Previous'. Setting this to false will disable this button.
`public string`	`$firstPageLabel`		# the text label for the first page button. Defaults to '<< First'. Setting this to false will disable this button. the text label for the first page button. Defaults to '<< First'. Setting this to false will disable this button.
`public string`	`$lastPageLabel`		# the text label for the last page button. Defaults to 'Last >>'. Setting this to false will disable this button. the text label for the last page button. Defaults to 'Last >>'. Setting this to false will disable this button.
`public string`	`$header`		# the text shown before page buttons. Defaults to 'Go to page: '. the text shown before page buttons. Defaults to 'Go to page: '.
`public string`	`$footer`	`''`	# the text shown after page buttons. the text shown after page buttons.
`public mixed`	`$cssFile`		# the CSS file used for the widget. Defaults to null, meaning using the default CSS file included together with the widget. If false, no CSS file will be used. Otherwise, the specified CSS file will be included when using this widget. the CSS file used for the widget. Defaults to null, meaning using the default CSS file included together with the widget. If false, no CSS file will be used. Otherwise, the specified CSS file will be included when using this widget.
`public array`	`$htmlOptions`	`array()`	# HTML attributes for the pager container tag. HTML attributes for the pager container tag.

Properties inherited from CWidget
`$actionPrefix, $skin`

Magic properties inherited from CBasePager
`$currentPage, $itemCount, $pageCount, $pageSize, $pages`

Magic properties inherited from CWidget
`$controller, $id, $owner, $viewPath`

Packages

Classes

Class CLinkPager

Direct known subclasses

Overrides

Overrides

Returns

Parameters

Returns

Returns

Parameters

Since

Since

Since

Since

Since

Since

Since