Esri Geoportal Server
1.0

com.esri.gpt.framework.jsf.components
Class UIPagination

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by com.esri.gpt.framework.jsf.components.UIPagination
All Implemented Interfaces:
EventListener, PartialStateHolder, StateHolder, ComponentSystemEventListener, FacesListener, SystemEventListenerHolder

public class UIPagination
extends UIComponentBase

The Class UIPagination. JSF Component class that outputs a pagination control


Nested Class Summary
static class UIPagination.ComponentMapKeys
          The Enum ComponentMapKeys.
static class UIPagination.Label
          The Label.
static class UIPagination.PageEvents
          The Page Events.
 
Field Summary
static String COMPONENT_FAMILY
          The JSF Component family.
static String COMPONENT_TYPE
          The JSF Component type.
 
Fields inherited from class javax.faces.component.UIComponent
BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY
 
Constructor Summary
UIPagination()
           
 
Method Summary
 void decode(FacesContext context)
          Deals with interpretating the incoming prameters to fill in pagination details
 void encodeBegin(FacesContext context)
          Encode begin.
 void encodeEnd(FacesContext context)
          Encode end.
 String getFamily()
          Gets the family.
 String getIdPrefix()
          Gets the id prefix.
 String getPropertyPrefix()
          Gets the property prefix.
 boolean getRenderFirstPageLink()
          Gets the render first page link.
 boolean getRenderLastPageLink()
          Gets the render last page link.
 void renderPageNumbers()
          Render numbers that represent pages.
 void restoreState(FacesContext context, Object state)
          Restore state.
 Object saveState(FacesContext context)
          Save state.
 void setIdPrefix(String idPrefix)
          Sets the id prefix.
 
Methods inherited from class javax.faces.component.UIComponentBase
addClientBehavior, addFacesListener, broadcast, clearInitialState, encodeChildren, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent, visitTree
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE
The JSF Component type.

See Also:
Constant Field Values

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY
The JSF Component family.

See Also:
Constant Field Values
Constructor Detail

UIPagination

public UIPagination()
Method Detail

setIdPrefix

public void setIdPrefix(String idPrefix)
Sets the id prefix.

Parameters:
idPrefix - the new id prefix

getIdPrefix

public String getIdPrefix()
Gets the id prefix.

Returns:
the id prefix

renderPageNumbers

public void renderPageNumbers()
Render numbers that represent pages.


encodeBegin

public void encodeBegin(FacesContext context)
                 throws IOException
Encode begin.

Overrides:
encodeBegin in class UIComponentBase
Parameters:
context - the context
Throws:
IOException - Signals that an I/O exception has occurred.
See Also:
UIComponentBase.encodeBegin(javax.faces.context.FacesContext)

encodeEnd

public void encodeEnd(FacesContext context)
               throws IOException
Encode end.

Overrides:
encodeEnd in class UIComponentBase
Parameters:
context - the context
Throws:
IOException - Signals that an I/O exception has occurred.
See Also:
UIComponentBase.encodeEnd(javax.faces.context.FacesContext)

restoreState

public void restoreState(FacesContext context,
                         Object state)
Restore state.

Specified by:
restoreState in interface StateHolder
Overrides:
restoreState in class UIComponentBase
Parameters:
context - the context
state - the state
See Also:
UIComponentBase.restoreState(javax.faces.context.FacesContext, java.lang.Object)

saveState

public Object saveState(FacesContext context)
Save state.

Specified by:
saveState in interface StateHolder
Overrides:
saveState in class UIComponentBase
Parameters:
context - the context
Returns:
the object
See Also:
UIComponentBase.saveState(javax.faces.context.FacesContext)

getFamily

public String getFamily()
Gets the family.

Specified by:
getFamily in class UIComponent
Returns:
The family the object belongs to.

getRenderFirstPageLink

public boolean getRenderFirstPageLink()
Gets the render first page link.

Returns:
the render first page link (default true)

getRenderLastPageLink

public boolean getRenderLastPageLink()
Gets the render last page link.

Returns:
the render last page link

getPropertyPrefix

public String getPropertyPrefix()
Gets the property prefix.

Returns:
the property prefix (trimmed, never null)

decode

public void decode(FacesContext context)
Deals with interpretating the incoming prameters to fill in pagination details

Overrides:
decode in class UIComponentBase
Parameters:
context -

Esri Geoportal Server
1.0

Copyright 2011 Environmental Systems Research Institute. All rights reserved. Use is subject to license terms.