Overview

Packages

  • application
    • commands
    • components
      • actions
      • filters
      • leftWidget
      • permissions
      • sortableWidget
      • util
      • webupdater
      • x2flow
        • actions
        • triggers
      • X2GridView
      • X2Settings
    • controllers
    • models
      • embedded
    • modules
      • accounts
        • controllers
        • models
      • actions
        • controllers
        • models
      • calendar
        • controllers
        • models
      • charts
        • models
      • contacts
        • controllers
        • models
      • docs
        • components
        • controllers
        • models
      • groups
        • controllers
        • models
      • marketing
        • components
        • controllers
        • models
      • media
        • controllers
        • models
      • mobile
        • components
      • opportunities
        • controllers
        • models
      • products
        • controllers
        • models
      • quotes
        • controllers
        • models
      • services
        • controllers
        • models
      • template
        • models
      • users
        • controllers
        • models
      • workflow
        • controllers
        • models
      • x2Leads
        • controllers
        • models
  • Net
  • None
  • PHP
  • system
    • base
    • caching
      • dependencies
    • collections
    • console
    • db
      • ar
      • schema
        • cubrid
        • mssql
        • mysql
        • oci
        • pgsql
        • sqlite
    • i18n
      • gettext
    • logging
    • test
    • utils
    • validators
    • web
      • actions
      • auth
      • filters
      • form
      • helpers
      • renderers
      • services
      • widgets
        • captcha
        • pagers
  • Text
    • Highlighter
  • zii
    • behaviors
    • widgets
      • grid
      • jui

Classes

  • CBasePager
  • CLinkPager
  • CListPager
  • MobileRecordIndexPager
  • MobileTopicsPager
  • Overview
  • Package
  • Class
  • Tree

Class CListPager

CListPager displays a dropdown list that contains options leading to different pages of target.

CComponent
Extended by CBaseController
Extended by CWidget
Extended by CBasePager
Extended by CListPager
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/CListPager.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 string
# generatePageText( integer $page )

Generates the list option for the specified page number. You may override this method to customize the option display.

Generates the list option for the specified page number. You may override this method to customize the option display.

Parameters

$page
integer
$page zero-based page number

Returns

string
the list option for the page number
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()
Properties summary
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 string $promptText
#

the text displayed as a prompt option in the dropdown list. Defaults to null, meaning no prompt.

the text displayed as a prompt option in the dropdown list. Defaults to null, meaning no prompt.

public string $pageTextFormat
#

the format string used to generate page selection text. The sprintf function will be used to perform the formatting.

the format string used to generate page selection text. The sprintf function will be used to perform the formatting.

public array $htmlOptions array()
#

HTML attributes for the enclosing 'div' tag.

HTML attributes for the enclosing 'div' 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
API documentation generated by ApiGen 2.8.0