CListPager

CDbHttpSession

previous page next page
Yii Framework v1.1.10 类参考

CListPager

包 system.web.widgets.pagers
继承 class CListPager » CBasePager » CWidget » CBaseController » CComponent
源自 1.0
版本 $Id: CListPager.php 2799 2011-01-01 19:31:13Z qiang.xue $
源码 framework/web/widgets/pagers/CListPager.php
CListPager显示一个下拉列表，其中包含导致不同目标页的选项。

公共属性

隐藏继承属性

属性类型描述定义在
actionPrefix string actions的ID的前缀。 当微件在CController::actions中声明了 动作提供者，可以为其动作的ID指定前缀以区别 于别的微件或控制器。当微件用于控制器 的视图中时，必须配置同样的前缀。 CWidget
controller CController 返回此微件所属的控制器。 CWidget
currentPage integer 当前页的索引（从0开始）。缺省为0。 CBasePager
htmlOptions array 关闭‘div’标签的HTML属性。 CListPager
id string 返回此微件的ID。如果需要的话，将生产一个新的ID并将其返回。 CWidget
itemCount integer 项目的总量。 CBasePager
owner CBaseController 返回此微件的所有者或创建者。 CWidget
pageCount integer 页数 CBasePager
pageSize integer 每页包含项目的数量。 CBasePager
pageTextFormat string 用于生成分页列表的格式化字符串。 使用sprintf函数执行格式化。 CListPager
pages CPagination 返回此pager所用的分页信息。 CBasePager
promptText string 作为下拉菜单列表的提示文字，默认为空，表示不提示。 CListPager
skin mixed 微件使用的皮肤的名称。默认为“default”。 如果此属性设置为false，微件将不会有皮肤被使用。 CWidget
viewPath string 返回包含此微件所需的视图文件的路径。 CWidget

公共方法

隐藏继承方法

方法描述定义在
__call() 如果类中没有调的方法名，则调用这个方法。 CComponent
__construct() 构造器。 CWidget
__get() 返回一个属性值、一个事件处理程序列表或一个行为名称。 CComponent
__isset() 检查一个属性是否为null。 CComponent
__set() 设置一个组件的属性值。 CComponent
__unset() 设置一个组件的属性为null。 CComponent
actions() 返回此widget使用的动作的列表。 CWidget
asa() 返回这个名字的行为对象。 CComponent
attachBehavior() 附加一个行为到组件。 CComponent
attachBehaviors() 附加一个行为列表到组件。 CComponent
attachEventHandler() 为事件附加一个事件处理程序。 CComponent
beginCache() Begins fragment caching. CBaseController
beginClip() Begins recording a clip. CBaseController
beginContent() Begins the rendering of content that is to be decorated by the specified view. CBaseController
beginWidget() Creates a widget and executes it. CBaseController
canGetProperty() 确定属性是否可读。 CComponent
canSetProperty() 确定属性是否可写。 CComponent
createWidget() Creates a widget and initializes it. CBaseController
detachBehavior() 从组件中分离一个行为。 CComponent
detachBehaviors() 从组件中分离所有行为。 CComponent
detachEventHandler() 分离一个存在的事件处理程序。 CComponent
disableBehavior() 禁用一个附加行为。 CComponent
disableBehaviors() 禁用组件附加的所有行为。 CComponent
enableBehavior() 启用一个附加行为。 CComponent
enableBehaviors() 启用组件附加的所有行为。 CComponent
endCache() Ends fragment caching. CBaseController
endClip() Ends recording a clip. CBaseController
endContent() Ends the rendering of content. CBaseController
endWidget() Ends the execution of the named widget. CBaseController
evaluateExpression() 计算一个PHP表达式，或根据组件上下文执行回调。 CComponent
getController() 返回此微件所属的控制器。 CWidget
getCurrentPage() 返回当前页的索引（从0开始）。缺省为0。 CBasePager
getEventHandlers() 返回一个事件的附加处理程序列表。 CComponent
getId() 返回此微件的ID。如果需要的话，将生产一个新的ID并将其返回。 CWidget
getItemCount() 返回项目的总量。 CBasePager
getOwner() 返回此微件的所有者或创建者。 CWidget
getPageCount() 返回页数 CBasePager
getPageSize() 返回每页包含项目的数量。 CBasePager
getPages() 返回此pager所用的分页信息。 CBasePager
getViewFile() 根据视图名查找视图文件。 CWidget
getViewPath() 返回包含此微件所需的视图文件的路径。 CWidget
hasEvent() 确定一个事件是否定义。 CComponent
hasEventHandler() 检查事件是否有附加的处理程序。 CComponent
hasProperty() 确定属性是否被定义。 CComponent
init() 通过设置一些默认值初始化分页。 CListPager
raiseEvent() 发起一个事件。 CComponent
render() 渲染一个视图。 CWidget
renderFile() Renders a view file. CBaseController
renderInternal() Renders a view file. CBaseController
run() 执行挂件。 CListPager
setCurrentPage() 设置当前页的索引（从0开始）。 CBasePager
setId() 设置此微件的ID。 CWidget
setItemCount() 设置项目的总量。 CBasePager
setPageSize() 设置每页包含的项目的数量 CBasePager
setPages() 设置此pager所用的分页信息。 CBasePager
widget() Creates a widget and executes it. CBaseController

受保护方法

隐藏继承方法

方法描述定义在
createPageUrl() 创建分页适用的URL。 CBasePager
createPages() 创建缺省分页。 CBasePager
generatePageText() 生成页码的列表选项。 CListPager

属性详细

public string $footer;

分页按钮后面显示的文字。

header 属性
public string $header;

分页按钮前面显示的文字。默认为‘Go to page: ’。

htmlOptions 属性
public array $htmlOptions;

关闭‘div’标签的HTML属性。

pageTextFormat 属性
public string $pageTextFormat;

用于生成分页列表的格式化字符串。 使用sprintf函数执行格式化。

promptText 属性
public string $promptText;

作为下拉菜单列表的提示文字，默认为空，表示不提示。

方法详细

generatePageText() 方法
protected string generatePageText(integer $page)
$page integer zero-based page number
{return} string the list option for the page number
源码： framework/web/widgets/pagers/CListPager.php#82 (显示)
protected function generatePageText($page)
{
    if($this->pageTextFormat!==null)
        return sprintf($this->pageTextFormat,$page+1);
    else
        return $page+1;
}

生成页码的列表选项。 可以重写该方法，自定义想要的显示。

init() 方法
public void init()
源码： framework/web/widgets/pagers/CListPager.php#47 (显示)
public function init()
{
    if($this->header===null)
        $this->header=Yii::t('yii','Go to page: ');
    if(!isset($this->htmlOptions['id']))
        $this->htmlOptions['id']=$this->getId();
    if($this->promptText!==null)
        $this->htmlOptions['prompt']=$this->promptText;
    if(!isset($this->htmlOptions['onchange']))
        $this->htmlOptions['onchange']="if(this.value!='') {window.location=this.value;};";
}

通过设置一些默认值初始化分页。

run() 方法
public void run()
源码： framework/web/widgets/pagers/CListPager.php#63 (显示)
public function run()
{
    if(($pageCount=$this->getPageCount())<=1)
        return;
    $pages=array();
    for($i=0;$i<$pageCount;++$i)
        $pages[$this->createPageUrl($i)]=$this->generatePageText($i);
    $selection=$this->createPageUrl($this->getCurrentPage());
    echo $this->header;
    echo CHtml::dropDownList($this->getId(),$selection,$pages,$this->htmlOptions);
    echo $this->footer;
}

执行挂件。 这个方法重写了显示页码按钮的父类方法。

Copyright © 2008-2011 by Yii Software LLC
All Rights Reserved.
previous page start next page