paginator (Liferay Faces Alloy View Description Language Documentation (VDLDoc))

Description:

Paginator is a UIComponent that renders pagination controls and can be used in conjunction with alloy:dataTable in order to paginate tabular data.

Since:

2.0.0

Example usage of this component can be found at:

http://www.liferayfaces.org/web/guest/alloy-showcase/-/alloy-tag/alloy/paginator/general

Component Information
Info	Value
Component Type	`com.liferay.faces.alloy.component.paginator.Paginator`
Handler Class	None
Renderer Type	`com.liferay.faces.alloy.component.paginator.PaginatorRenderer`
Description	None

Attributes
Name	Required	Type	Description
`ajax`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	When this flag is true, clicking on the button will cause the form to be submitted via XmlHttpRequest. The default value is `true`.
`binding`	`false`	`javax.el.ValueExpression` (must evaluate to `javax.faces.component.UIComponent`)	An EL expression that binds the Java reference to this component in the component tree to a bean property.
`execute`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Space-delimited list of component ids that are to participate in the APPLY_REQUEST_VALUES, PROCESS_VALIDATIONS, UPDATE_MODEL_VALUES, and INVOKE_APPLICATION phases of the JSF lifecycle. The following keywords may also appear in the list: `@this`, `@form`, `@all`, `@none`. The default value is `@this @for` (meaning, the paginator itself and the associated alloy:dataTable).
`firstPage`	`false`	`javax.el.ValueExpression` (must evaluate to `int`)	Integer representing the first page number that is to be displayed in the list of page number controls. The default value is `1`.
`firstPageLabel`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	The label of the control that causes the first page to be displayed. The default value is the `"«"` character code.
`for`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	The id of the UIData component that is to be paginated.
`id`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	A unique identifier for this component.
`lastPageLabel`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	The label of the control that causes the last page to be displayed. The default value is the `"»"` character code.
`maxPageNumberControls`	`false`	`javax.el.ValueExpression` (must evaluate to `int`)	Integer representing the maximum number of page number controls that will be displayed. The default value is `10`.
`nextPageLabel`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	The label of the control that causes the next page to be displayed. The default value is the `"&rsaquo;"` character code.
`previousPageLabel`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	The label of the control that causes the previous page to be displayed. The default value is the `"&lsaquo;"` character code.
`process`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Synonym for the `execute` attribute. The default value is `"@all"`.
`render`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Space-delimited list of component ids that are to participate in the RENDER_RESPONSE phase of the JSF lifecycle and be re-rendered in the DOM after the response is received from the XmlHttpRequest. The following keywords may also appear in the list: `@this`, `@form`, `@all`, `@none`, `@for`. The default value is `@this @for` (meaning, the paginator itself and the associated alloy:dataTable).
`rendered`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	When this flag is true, this component will be rendered to there response. When false, it will not be rendered to the response. The default value is `true`.
`showFirstPageControl`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	When true, a control will be rendered that will cause the associated UIData component to display the first page. The default value is `true`.
`showLastPageControl`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	When true, a control will be rendered that will cause the associated UIData component to display the last page. The default value is `true`.
`showNextPageControl`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	When true, a control will be rendered that will cause the associated UIData component to display the next page. The default value is `true`.
`showPageNumberControls`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	When true, controls will be rendered for each page number (limited by the maxPageNumberControls attribute). The default value is `true`.
`showPreviousPageControl`	`false`	`javax.el.ValueExpression` (must evaluate to `boolean`)	When true, a control will be rendered that will cause the associated UIData component to display the previous page. The default value is `true`.
`style`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	HTML passthrough attribute specifying the css style of the element.
`styleClass`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	List of CSS class names (separated by spaces) that are to be rendered within the class attribute. Valid values are `pagination-large`, `pagination-small`, and `pagination-mini`.
`summaryPosition`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Specifies the position of the row summary. The row summary will be displayed based on the `results-x-x-of-x-page-x-of-x` internationalized language key, for example: "Page 1 of 7." The default value is `"bottom"`.
`update`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Synonym for the `render` attribute. The default value is `"@none"`.
`value`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Object`)	The value of this component, which is typically bound via EL to a model bean property.

alloy

Tag paginator