com.liferay.faces.alloy.component.paginator
Class PaginatorBase

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          com.liferay.faces.alloy.component.paginator.PaginatorBase

All Implemented Interfaces:

com.liferay.faces.util.component.Styleable, EventListener, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder

Direct Known Subclasses:

Paginator

@Generated(value="com.liferay.alloy.tools.builder.FacesBuilder")
public abstract class PaginatorBase
extends javax.faces.component.UIComponentBase
implements com.liferay.faces.util.component.Styleable

Author:

Bruno Basto, Kyle Stiemann

Nested Class Summary

protected static class

PaginatorBase.PaginatorPropertyKeys

Field Summary

static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE
static String	RENDERER_TYPE

Fields inherited from class javax.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Fields inherited from interface com.liferay.faces.util.component.Styleable

STYLE, STYLE_CLASS

Constructor Summary

PaginatorBase()

Method Summary

String	getExecute() execute attribute description:
String	getFamily()
int	getFirstPage() firstPage attribute description:
String	getFirstPageLabel() firstPageLabel attribute description:
String	getFor() for attribute description:
String	getLastPageLabel() lastPageLabel attribute description:
int	getMaxPageNumberControls() maxPageNumberControls attribute description:
String	getNextPageLabel() nextPageLabel attribute description:
String	getPreviousPageLabel() previousPageLabel attribute description:
String	getProcess() process attribute description:
String	getRender() render attribute description:
String	getStyle() style attribute description:
String	getStyleClass() styleClass attribute description:
String	getSummaryPosition() summaryPosition attribute description:
String	getUpdate() update attribute description:
boolean	isAjax() ajax attribute description:
boolean	isShowFirstPageControl() showFirstPageControl attribute description:
boolean	isShowLastPageControl() showLastPageControl attribute description:
boolean	isShowNextPageControl() showNextPageControl attribute description:
boolean	isShowPageNumberControls() showPageNumberControls attribute description:
boolean	isShowPreviousPageControl() showPreviousPageControl attribute description:
void	setAjax(boolean ajax) ajax attribute description:
void	setExecute(String execute) execute attribute description:
void	setFirstPage(int firstPage) firstPage attribute description:
void	setFirstPageLabel(String firstPageLabel) firstPageLabel attribute description:
void	setFor(String for_) for attribute description:
void	setLastPageLabel(String lastPageLabel) lastPageLabel attribute description:
void	setMaxPageNumberControls(int maxPageNumberControls) maxPageNumberControls attribute description:
void	setNextPageLabel(String nextPageLabel) nextPageLabel attribute description:
void	setPreviousPageLabel(String previousPageLabel) previousPageLabel attribute description:
void	setProcess(String process) process attribute description:
void	setRender(String render) render attribute description:
void	setShowFirstPageControl(boolean showFirstPageControl) showFirstPageControl attribute description:
void	setShowLastPageControl(boolean showLastPageControl) showLastPageControl attribute description:
void	setShowNextPageControl(boolean showNextPageControl) showNextPageControl attribute description:
void	setShowPageNumberControls(boolean showPageNumberControls) showPageNumberControls attribute description:
void	setShowPreviousPageControl(boolean showPreviousPageControl) showPreviousPageControl attribute description:
void	setStyle(String style) style attribute description:
void	setStyleClass(String styleClass) styleClass attribute description:
void	setSummaryPosition(String summaryPosition) summaryPosition attribute description:
void	setUpdate(String update) update attribute description:

Methods inherited from class javax.faces.component.UIComponentBase

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, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

RENDERER_TYPE

public static final String RENDERER_TYPE

See Also:

Constant Field Values

Constructor Detail

PaginatorBase

public PaginatorBase()

Method Detail

getFamily

public String getFamily()

Specified by:

getFamily in class javax.faces.component.UIComponent

isAjax

public boolean isAjax()

ajax attribute description:

When this flag is true, clicking on the button will cause the form to be submitted via XmlHttpRequest.

setAjax

public 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.

getExecute

public 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. 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).

setExecute

public 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. 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).

getFirstPage

public int getFirstPage()

firstPage attribute description:

Integer representing the first page number that is to be displayed in the list of page number controls.

setFirstPage

public 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.

getFirstPageLabel

public String getFirstPageLabel()

firstPageLabel attribute description:

The label of the control that causes the first page to be displayed. The default value is the "«" character code.

setFirstPageLabel

public void setFirstPageLabel(String firstPageLabel)

firstPageLabel attribute description:

The label of the control that causes the first page to be displayed. The default value is the "«" character code.

getFor

public String getFor()

for attribute description:

The id of the UIData component that is to be paginated.

setFor

public void setFor(String for_)

for attribute description:

The id of the UIData component that is to be paginated.

getLastPageLabel

public String getLastPageLabel()

lastPageLabel attribute description:

The label of the control that causes the last page to be displayed. The default value is the "»" character code.

setLastPageLabel

public void setLastPageLabel(String lastPageLabel)

lastPageLabel attribute description:

The label of the control that causes the last page to be displayed. The default value is the "»" character code.

getMaxPageNumberControls

public int getMaxPageNumberControls()

maxPageNumberControls attribute description:

Integer representing the maximum number of page number controls that will be displayed.

setMaxPageNumberControls

public void setMaxPageNumberControls(int maxPageNumberControls)

maxPageNumberControls attribute description:

Integer representing the maximum number of page number controls that will be displayed.

getNextPageLabel

public String getNextPageLabel()

nextPageLabel attribute description:

The label of the control that causes the next page to be displayed. The default value is the "›" character code.

setNextPageLabel

public void setNextPageLabel(String nextPageLabel)

nextPageLabel attribute description:

The label of the control that causes the next page to be displayed. The default value is the "›" character code.

getPreviousPageLabel

public String getPreviousPageLabel()

previousPageLabel attribute description:

The label of the control that causes the previous page to be displayed. The default value is the "‹" character code.

setPreviousPageLabel

public void setPreviousPageLabel(String previousPageLabel)

previousPageLabel attribute description:

The label of the control that causes the previous page to be displayed. The default value is the "‹" character code.

getProcess

public String getProcess()

process attribute description:

Synonym for the execute attribute. The default value is "@all".

setProcess

public void setProcess(String process)

process attribute description:

Synonym for the execute attribute. The default value is "@all".

getRender

public 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. 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).

setRender

public 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. 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).

isShowFirstPageControl

public boolean isShowFirstPageControl()

showFirstPageControl attribute description:

When true, a control will be rendered that will cause the associated UIData component to display the first page.

setShowFirstPageControl

public 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.

isShowLastPageControl

public boolean isShowLastPageControl()

showLastPageControl attribute description:

When true, a control will be rendered that will cause the associated UIData component to display the last page.

setShowLastPageControl

public 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.

isShowNextPageControl

public boolean isShowNextPageControl()

showNextPageControl attribute description:

When true, a control will be rendered that will cause the associated UIData component to display the next page.

setShowNextPageControl

public 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.

isShowPageNumberControls

public boolean isShowPageNumberControls()

showPageNumberControls attribute description:

When true, controls will be rendered for each page number (limited by the maxPageNumberControls attribute).

setShowPageNumberControls

public void setShowPageNumberControls(boolean showPageNumberControls)

showPageNumberControls attribute description:

When true, controls will be rendered for each page number (limited by the maxPageNumberControls attribute).

isShowPreviousPageControl

public boolean isShowPreviousPageControl()

showPreviousPageControl attribute description:

When true, a control will be rendered that will cause the associated UIData component to display the previous page.

setShowPreviousPageControl

public 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.

getStyle

public String getStyle()

style attribute description:

HTML passthrough attribute specifying the css style of the element.

Specified by:

getStyle in interface com.liferay.faces.util.component.Styleable

setStyle

public void setStyle(String style)

style attribute description:

HTML passthrough attribute specifying the css style of the element.

Specified by:

setStyle in interface com.liferay.faces.util.component.Styleable

getStyleClass

public String getStyleClass()

styleClass attribute description:

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.

Specified by:

getStyleClass in interface com.liferay.faces.util.component.Styleable

setStyleClass

public void setStyleClass(String styleClass)

styleClass attribute description:

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.

Specified by:

setStyleClass in interface com.liferay.faces.util.component.Styleable

getSummaryPosition

public String getSummaryPosition()

summaryPosition attribute description:

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."

setSummaryPosition

public void setSummaryPosition(String summaryPosition)

summaryPosition attribute description:

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."

getUpdate

public String getUpdate()

update attribute description:

Synonym for the render attribute. The default value is "@none".

setUpdate

public void setUpdate(String update)

update attribute description:

Synonym for the render attribute. The default value is "@none".