CLinkPager
| 包 | system.web.widgets.pagers |
|---|---|
| 继承 | class CLinkPager » CBasePager » CWidget » CBaseController » CComponent |
| 可用自 | 1.0 |
| 版本 | $Id$ |
CLinkPager displays a list of hyperlinks that lead to different pages of target.
公共属性
| 属性 | 类型 | 描述 | 被定义在 |
|---|---|---|---|
| actionPrefix | string | the prefix to the IDs of the actions. | CWidget |
| controller | CController | the controller that this widget belongs to. | CWidget |
| cssFile | mixed | the CSS file used for the widget. | CLinkPager |
| currentPage | integer | the zero-based index of the current page. | CBasePager |
| firstPageLabel | string | the text label for the first page button. | CLinkPager |
| footer | string | the text shown after page buttons. | CLinkPager |
| header | string | the text shown before page buttons. | CLinkPager |
| htmlOptions | array | HTML attributes for the pager container tag. | CLinkPager |
| id | string | id of the widget. | CWidget |
| itemCount | integer | total number of items. | CBasePager |
| lastPageLabel | string | the text label for the last page button. | CLinkPager |
| maxButtonCount | integer | maximum number of page buttons that can be displayed. | CLinkPager |
| nextPageLabel | string | the text label for the next page button. | CLinkPager |
| 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 |
| prevPageLabel | string | the text label for the previous page button. | CLinkPager |
| viewPath | string | Returns the directory containing the view files for this widget. | CWidget |
受保护的属性
| 属性 | 类型 | 描述 | 被定义在 |
|---|---|---|---|
| pageRange | array | the begin and end pages that need to be displayed. | CLinkPager |
公共方法
| 方法 | 描述 | 被定义在 |
|---|---|---|
| __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 |
| registerClientScript() | Registers the needed client scripts (mainly CSS file). | CLinkPager |
| registerCssFile() | Registers the needed CSS file. | CLinkPager |
| render() | Renders a view. | CWidget |
| renderFile() | Renders a view file. | CBaseController |
| renderInternal() | Renders a view file. | CBaseController |
| run() | Executes the widget. | CLinkPager |
| 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 |
受保护的方法
| 方法 | 描述 | 被定义在 |
|---|---|---|
| createPageButton() | Creates a page button. | CLinkPager |
| createPageButtons() | Creates the page buttons. | CLinkPager |
| createPageUrl() | Creates the URL suitable for pagination. | CBasePager |
| createPages() | Creates the default pagination. | CBasePager |
| getPageRange() | CLinkPager |
属性详情
cssFile
属性
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.
firstPageLabel
属性
public string $firstPageLabel;
the text label for the first page button. Defaults to '<< First'.
public string $footer;
the text shown after page buttons.
header
属性
public string $header;
the text shown before page buttons. Defaults to 'Go to page: '.
htmlOptions
属性
public array $htmlOptions;
HTML attributes for the pager container tag.
lastPageLabel
属性
public string $lastPageLabel;
the text label for the last page button. Defaults to 'Last >>'.
maxButtonCount
属性
public integer $maxButtonCount;
maximum number of page buttons that can be displayed. Defaults to 10.
nextPageLabel
属性
public string $nextPageLabel;
the text label for the next page button. Defaults to 'Next >'.
pageRange
属性
只读
protected array getPageRange()
the begin and end pages that need to be displayed.
prevPageLabel
属性
public string $prevPageLabel;
the text label for the previous page button. Defaults to '< Previous'.
方法详情
createPageButton()
方法
|
protected string createPageButton(string $label, integer $page, string $class, boolean $hidden, boolean $selected)
| ||
| $label | string | the text label for the button |
| $page | integer | the page number |
| $class | string | the CSS class for the page button. This could be 'page', 'first', 'last', 'next' or 'previous'. |
| $hidden | boolean | whether this page button is visible |
| $selected | boolean | whether this page button is selected |
| {return} | string | the generated button |
Creates a page button. You may override this method to customize the page buttons.
createPageButtons()
方法
|
protected array createPageButtons()
| ||
| {return} | array | a list of page buttons (in HTML code). |
Creates the page buttons.
getPageRange()
方法
|
protected array getPageRange()
| ||
| {return} | array | the begin and end pages that need to be displayed. |
registerClientScript()
方法
|
public void registerClientScript()
|
Registers the needed client scripts (mainly CSS file).
registerCssFile()
方法
（自版本 v1.0.2 可用）
|
public static void registerCssFile(string $url=NULL)
| ||
| $url | string | the CSS URL. If null, a default CSS URL will be used. |
Registers the needed CSS file.
run()
方法
|
public void run()
|
Executes the widget. This overrides the parent implementation by displaying the generated page buttons.