Class UIPaginatorPage
java.lang.Object
jakarta.faces.component.UIComponent
jakarta.faces.component.UIComponentBase
jakarta.faces.component.UIOutput
org.apache.myfaces.tobago.internal.component.AbstractUIPaginator
org.apache.myfaces.tobago.internal.component.AbstractUIPaginatorPage
org.apache.myfaces.tobago.component.UIPaginatorPage
- All Implemented Interfaces:
jakarta.faces.component.PartialStateHolder
,jakarta.faces.component.StateHolder
,jakarta.faces.component.TransientStateHolder
,jakarta.faces.component.ValueHolder
,jakarta.faces.event.ComponentSystemEventListener
,jakarta.faces.event.FacesListener
,jakarta.faces.event.SystemEventListenerHolder
,EventListener
,SupportFieldId
,Visual
Renders a paginator to show and change the page number.
UIComponent class, generated from template
component.stg
with class
PaginatorPageTagDeclaration
.-
Field Summary
FieldsFields inherited from class jakarta.faces.component.UIComponent
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, FACETS_KEY, VIEW_LOCATION_KEY
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionShow arrows at this control.Sets a CSS class in its parent, if the parent supports it.getFor()
Id of the component, this is related to.getMax()
Show this amount of links, if available.getTip()
Text value to display as tooltip.boolean
Flag indicating that the control show should be displayed in call cases, whether it is necessary or not (if there are a low number of rows).void
restoreState
(jakarta.faces.context.FacesContext context, Object state) void
setAlwaysVisible
(boolean alwaysVisible) void
void
setCustomClass
(CustomClass customClass) void
void
void
void
Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIPaginator
getFieldId, getPageable
Methods inherited from class jakarta.faces.component.UIOutput
clearInitialState, getConverter, getLocalValue, getValue, markInitialState, resetValue, saveState, setConverter, setValue
Methods inherited from class jakarta.faces.component.UIComponentBase
addClientBehavior, addFacesListener, broadcast, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, visitTree
Methods inherited from class jakarta.faces.component.UIComponent
getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.apache.myfaces.tobago.component.Visual
getRendererType, isPlain
-
Field Details
-
COMPONENT_TYPE
-
COMPONENT_FAMILY
- See Also:
-
-
Constructor Details
-
UIPaginatorPage
public UIPaginatorPage()
-
-
Method Details
-
getFamily
- Overrides:
getFamily
in classjakarta.faces.component.UIOutput
-
getMarkup
-
setMarkup
-
getMax
Show this amount of links, if available. -
setMax
-
isAlwaysVisible
public boolean isAlwaysVisible()Flag indicating that the control show should be displayed in call cases, whether it is necessary or not (if there are a low number of rows).
Default:false
- Specified by:
isAlwaysVisible
in classAbstractUIPaginator
-
setAlwaysVisible
public void setAlwaysVisible(boolean alwaysVisible) -
getArrows
Show arrows at this control.
Default:auto
Allowed Values:auto,show,hide
-
setArrows
-
getFor
Id of the component, this is related to.- Specified by:
getFor
in classAbstractUIPaginator
-
setFor
-
getCustomClass
Sets a CSS class in its parent, if the parent supports it. Which this feature it is possible to put a CSS class name into a component with the <tc:style> tag. Example:<tc:in> <tc:style customClass="my-emphasized"/> </tc:in>
One capability is, to used external CSS libs.
This feature should not be used imprudent. Because it might be unstable against changes in the renderered HTML code. -
setCustomClass
-
getTip
Text value to display as tooltip. -
setTip
-
restoreState
- Specified by:
restoreState
in interfacejakarta.faces.component.StateHolder
- Overrides:
restoreState
in classjakarta.faces.component.UIOutput
-