@Generated(value="com.liferay.alloy.tools.builder.FacesBuilder") public abstract class PaginatorBase extends javax.faces.component.UIComponentBase implements com.liferay.faces.util.component.Styleable
| Modifier and Type | Class and Description |
|---|---|
protected static class |
PaginatorBase.PaginatorPropertyKeys |
| Modifier and Type | Field and Description |
|---|---|
static String |
COMPONENT_FAMILY |
static String |
COMPONENT_TYPE |
static String |
RENDERER_TYPE |
| Constructor and Description |
|---|
PaginatorBase() |
| Modifier and Type | Method and Description |
|---|---|
String |
getExecute()
execute attribute description:
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. |
String |
getFamily() |
int |
getFirstPage()
firstPage attribute description:
Integer representing the first page number that is to be displayed in the list of page number controls. |
String |
getFirstPageLabel()
firstPageLabel attribute description:
The label of the control that causes the first page to be displayed. |
String |
getFor()
for attribute description:
The id of the UIData component that is to be paginated. |
String |
getLastPageLabel()
lastPageLabel attribute description:
The label of the control that causes the last page to be displayed. |
int |
getMaxPageNumberControls()
maxPageNumberControls attribute description:
Integer representing the maximum number of page number controls that will be displayed. |
String |
getNextPageLabel()
nextPageLabel attribute description:
The label of the control that causes the next page to be displayed. |
String |
getPreviousPageLabel()
previousPageLabel attribute description:
The label of the control that causes the previous page to be displayed. |
String |
getProcess()
process attribute description:
Synonym for the execute attribute. |
String |
getRender()
render attribute description:
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. |
String |
getStyle()
style attribute description:
HTML passthrough attribute specifying the css style of the element. |
String |
getStyleClass()
styleClass attribute description:
List of CSS class names (separated by spaces) that are to be rendered within the class attribute. |
String |
getSummaryPosition()
summaryPosition attribute description:
Specifies the position of the row summary. |
String |
getUpdate()
update attribute description:
Synonym for the render attribute. |
boolean |
isAjax()
ajax attribute description:
When this flag is true, clicking on the button will cause the form to be submitted via XmlHttpRequest. |
boolean |
isShowFirstPageControl()
showFirstPageControl attribute description:
When true, a control will be rendered that will cause the associated UIData component to display the first page. |
boolean |
isShowLastPageControl()
showLastPageControl attribute description:
When true, a control will be rendered that will cause the associated UIData component to display the last page. |
boolean |
isShowNextPageControl()
showNextPageControl attribute description:
When true, a control will be rendered that will cause the associated UIData component to display the next page. |
boolean |
isShowPageNumberControls()
showPageNumberControls attribute description:
When true, controls will be rendered for each page number (limited by the maxPageNumberControls attribute). |
boolean |
isShowPreviousPageControl()
showPreviousPageControl attribute description:
When true, a control will be rendered that will cause the associated UIData component to display the previous page. |
void |
setAjax(boolean ajax)
ajax attribute description:
When this flag is true, clicking on the button will cause the form to be submitted via XmlHttpRequest. |
void |
setExecute(String execute)
execute attribute description:
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. |
void |
setFirstPage(int firstPage)
firstPage attribute description:
Integer representing the first page number that is to be displayed in the list of page number controls. |
void |
setFirstPageLabel(String firstPageLabel)
firstPageLabel attribute description:
The label of the control that causes the first page to be displayed. |
void |
setFor(String for_)
for attribute description:
The id of the UIData component that is to be paginated. |
void |
setLastPageLabel(String lastPageLabel)
lastPageLabel attribute description:
The label of the control that causes the last page to be displayed. |
void |
setMaxPageNumberControls(int maxPageNumberControls)
maxPageNumberControls attribute description:
Integer representing the maximum number of page number controls that will be displayed. |
void |
setNextPageLabel(String nextPageLabel)
nextPageLabel attribute description:
The label of the control that causes the next page to be displayed. |
void |
setPreviousPageLabel(String previousPageLabel)
previousPageLabel attribute description:
The label of the control that causes the previous page to be displayed. |
void |
setProcess(String process)
process attribute description:
Synonym for the execute attribute. |
void |
setRender(String render)
render attribute description:
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. |
void |
setShowFirstPageControl(boolean showFirstPageControl)
showFirstPageControl attribute description:
When true, a control will be rendered that will cause the associated UIData component to display the first page. |
void |
setShowLastPageControl(boolean showLastPageControl)
showLastPageControl attribute description:
When true, a control will be rendered that will cause the associated UIData component to display the last page. |
void |
setShowNextPageControl(boolean showNextPageControl)
showNextPageControl attribute description:
When true, a control will be rendered that will cause the associated UIData component to display the next page. |
void |
setShowPageNumberControls(boolean showPageNumberControls)
showPageNumberControls attribute description:
When true, controls will be rendered for each page number (limited by the maxPageNumberControls attribute). |
void |
setShowPreviousPageControl(boolean showPreviousPageControl)
showPreviousPageControl attribute description:
When true, a control will be rendered that will cause the associated UIData component to display the previous page. |
void |
setStyle(String style)
style attribute description:
HTML passthrough attribute specifying the css style of the element. |
void |
setStyleClass(String styleClass)
styleClass attribute description:
List of CSS class names (separated by spaces) that are to be rendered within the class attribute. |
void |
setSummaryPosition(String summaryPosition)
summaryPosition attribute description:
Specifies the position of the row summary. |
void |
setUpdate(String update)
update attribute description:
Synonym for the render attribute. |
addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEventencodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTreepublic static final String COMPONENT_FAMILY
public static final String COMPONENT_TYPE
public static final String RENDERER_TYPE
public String getFamily()
getFamily in class javax.faces.component.UIComponentpublic boolean isAjax()
ajax attribute description:
public void setAjax(boolean ajax)
ajax attribute description:
public String getExecute()
execute attribute description:
@this, @form, @all, @none. The default value is @this @for (meaning, the paginator itself and the associated alloy:dataTable).public void setExecute(String execute)
execute attribute description:
@this, @form, @all, @none. The default value is @this @for (meaning, the paginator itself and the associated alloy:dataTable).public int getFirstPage()
firstPage attribute description:
public void setFirstPage(int firstPage)
firstPage attribute description:
public String getFirstPageLabel()
firstPageLabel attribute description:
"«" character code.public void setFirstPageLabel(String firstPageLabel)
firstPageLabel attribute description:
"«" character code.public String getFor()
for attribute description:
public void setFor(String for_)
for attribute description:
public String getLastPageLabel()
lastPageLabel attribute description:
"»" character code.public void setLastPageLabel(String lastPageLabel)
lastPageLabel attribute description:
"»" character code.public int getMaxPageNumberControls()
maxPageNumberControls attribute description:
public void setMaxPageNumberControls(int maxPageNumberControls)
maxPageNumberControls attribute description:
public String getNextPageLabel()
nextPageLabel attribute description:
"›" character code.public void setNextPageLabel(String nextPageLabel)
nextPageLabel attribute description:
"›" character code.public String getPreviousPageLabel()
previousPageLabel attribute description:
"‹" character code.public void setPreviousPageLabel(String previousPageLabel)
previousPageLabel attribute description:
"‹" character code.public String getProcess()
process attribute description:
execute attribute. The default value is "@all".public void setProcess(String process)
process attribute description:
execute attribute. The default value is "@all".public String getRender()
render attribute description:
@this, @form, @all, @none, @for. The default value is @this @for (meaning, the paginator itself and the associated alloy:dataTable).public void setRender(String render)
render attribute description:
@this, @form, @all, @none, @for. The default value is @this @for (meaning, the paginator itself and the associated alloy:dataTable).public boolean isShowFirstPageControl()
showFirstPageControl attribute description:
public void setShowFirstPageControl(boolean showFirstPageControl)
showFirstPageControl attribute description:
public boolean isShowLastPageControl()
showLastPageControl attribute description:
public void setShowLastPageControl(boolean showLastPageControl)
showLastPageControl attribute description:
public boolean isShowNextPageControl()
showNextPageControl attribute description:
public void setShowNextPageControl(boolean showNextPageControl)
showNextPageControl attribute description:
public boolean isShowPageNumberControls()
showPageNumberControls attribute description:
public void setShowPageNumberControls(boolean showPageNumberControls)
showPageNumberControls attribute description:
public boolean isShowPreviousPageControl()
showPreviousPageControl attribute description:
public void setShowPreviousPageControl(boolean showPreviousPageControl)
showPreviousPageControl attribute description:
public String getStyle()
style attribute description:
getStyle in interface com.liferay.faces.util.component.Styleablepublic void setStyle(String style)
style attribute description:
setStyle in interface com.liferay.faces.util.component.Styleablepublic String getStyleClass()
styleClass attribute description:
pagination-large, pagination-small, and pagination-mini.getStyleClass in interface com.liferay.faces.util.component.Styleablepublic void setStyleClass(String styleClass)
styleClass attribute description:
pagination-large, pagination-small, and pagination-mini.setStyleClass in interface com.liferay.faces.util.component.Styleablepublic String getSummaryPosition()
summaryPosition attribute description:
results-x-x-of-x-page-x-of-x internationalized language key, for example: "Page 1 of 7."public void setSummaryPosition(String summaryPosition)
summaryPosition attribute description:
results-x-x-of-x-page-x-of-x internationalized language key, for example: "Page 1 of 7."public String getUpdate()
update attribute description:
render attribute. The default value is "@none".public void setUpdate(String update)
update attribute description:
render attribute. The default value is "@none".Copyright © 2016 Liferay, Inc.. All rights reserved.