CBasePager
| 包 | system.web.widgets.pagers |
|---|---|
| 继承 | abstract class CBasePager » CWidget » CBaseController » CComponent |
| 子类 | CLinkPager, CListPager |
| 可用自 | 1.0 |
| 版本 | $Id$ |
CBasePager is the base class for all pagers.
It provides the calculation of page count and maintains the current page.
It provides the calculation of page count and maintains the current page.
公共属性
| 属性 | 类型 | 描述 | 被定义在 |
|---|---|---|---|
| actionPrefix | string | the prefix to the IDs of the actions. | CWidget |
| controller | CController | the controller that this widget belongs to. | CWidget |
| currentPage | integer | the zero-based index of the current page. | CBasePager |
| id | string | id of the widget. | CWidget |
| itemCount | integer | total number of items. | CBasePager |
| owner | CBaseController | owner/creator of this widget. | CWidget |
| pageCount | integer | number of pages | CBasePager |
| pageSize | integer | number of items in each page. | CBasePager |
| pages | CPagination | Returns the pagination information used by this pager. | CBasePager |
| viewPath | string | Returns the directory containing the view files for this widget. | CWidget |
公共方法
| 方法 | 描述 | 被定义在 |
|---|---|---|
| __call() | Calls the named method which is not a class method. | CComponent |
| __construct() | Constructor. | CWidget |
| __get() | Returns a property value, an event handler list or a behavior based on its name. | CComponent |
| __isset() | Checks if a property value is null. | CComponent |
| __set() | Sets value of a component property. | CComponent |
| __unset() | Sets a component property to be null. | CComponent |
| actions() | Returns a list of actions that are used by this widget. | CWidget |
| asa() | Returns the named behavior object. | CComponent |
| attachBehavior() | Attaches a behavior to this component. | CComponent |
| attachBehaviors() | Attaches a list of behaviors to the component. | CComponent |
| attachEventHandler() | Attaches an event handler to an event. | 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() | Determines whether a property can be read. | CComponent |
| canSetProperty() | Determines whether a property can be set. | CComponent |
| createWidget() | Creates a widget and initializes it. | CBaseController |
| detachBehavior() | Detaches a behavior from the component. | CComponent |
| detachBehaviors() | Detaches all behaviors from the component. | CComponent |
| detachEventHandler() | Detaches an existing event handler. | CComponent |
| disableBehavior() | Disables an attached behavior. | CComponent |
| disableBehaviors() | Disables all behaviors attached to this component. | CComponent |
| enableBehavior() | Enables an attached behavior. | CComponent |
| enableBehaviors() | Enables all behaviors attached to this component. | 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 |
| getController() | CWidget | |
| getCurrentPage() | CBasePager | |
| getEventHandlers() | Returns the list of attached event handlers for an event. | CComponent |
| getId() | CWidget | |
| getItemCount() | CBasePager | |
| getOwner() | CWidget | |
| getPageCount() | CBasePager | |
| getPageSize() | CBasePager | |
| getPages() | Returns the pagination information used by this pager. | CBasePager |
| getViewFile() | Looks for the view script file according to the view name. | CWidget |
| getViewPath() | Returns the directory containing the view files for this widget. | CWidget |
| hasEvent() | Determines whether an event is defined. | CComponent |
| hasEventHandler() | Checks whether the named event has attached handlers. | CComponent |
| hasProperty() | Determines whether a property is defined. | CComponent |
| init() | Initializes the widget. | CWidget |
| raiseEvent() | Raises an event. | CComponent |
| render() | Renders a view. | CWidget |
| renderFile() | Renders a view file. | CBaseController |
| renderInternal() | Renders a view file. | CBaseController |
| run() | Executes the widget. | CWidget |
| setCurrentPage() | CBasePager | |
| setId() | CWidget | |
| setItemCount() | CBasePager | |
| setPageSize() | CBasePager | |
| setPages() | Sets the pagination information used by this pager. | CBasePager |
| widget() | Creates a widget and executes it. | CBaseController |
受保护的方法
| 方法 | 描述 | 被定义在 |
|---|---|---|
| createPageUrl() | Creates the URL suitable for pagination. | CBasePager |
| createPages() | Creates the default pagination. | CBasePager |
属性详情
currentPage
属性
the zero-based index of the current page. Defaults to 0.
itemCount
属性
total number of items.
pageCount
属性
只读
public integer getPageCount()
number of pages
pageSize
属性
number of items in each page.
pages
属性
Returns the pagination information used by this pager.
方法详情
createPageUrl()
方法
|
protected string createPageUrl(integer $page)
| ||
| $page | integer | the page that the URL should point to. |
| {return} | string | the created URL |
Creates the URL suitable for pagination.
createPages()
方法
|
protected CPagination createPages()
| ||
| {return} | CPagination | the default pagination instance. |
Creates the default pagination. This is called by getPages when the pagination is not set before.
getCurrentPage()
方法
|
public integer getCurrentPage(boolean $recalculate=true)
| ||
| $recalculate | boolean | whether to recalculate the current page based on the page size and item count. |
| {return} | integer | the zero-based index of the current page. Defaults to 0. |
getItemCount()
方法
|
public integer getItemCount()
| ||
| {return} | integer | total number of items. |
getPageCount()
方法
|
public integer getPageCount()
| ||
| {return} | integer | number of pages |
getPageSize()
方法
|
public integer getPageSize()
| ||
| {return} | integer | number of items in each page. |
getPages()
方法
|
public CPagination getPages()
| ||
| {return} | CPagination | the pagination information |
Returns the pagination information used by this pager.
setCurrentPage()
方法
|
public void setCurrentPage(integer $value)
| ||
| $value | integer | the zero-based index of the current page. |
setItemCount()
方法
|
public void setItemCount(integer $value)
| ||
| $value | integer | total number of items. |
setPageSize()
方法
|
public void setPageSize(integer $value)
| ||
| $value | integer | number of items in each page |
setPages()
方法
|
public void setPages(CPagination $pages)
| ||
| $pages | CPagination | the pagination information |
Sets the pagination information used by this pager.