|
RichFaces UI Components UI 4.2.2.Final | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object javax.faces.component.UIComponent javax.faces.component.UIComponentBase org.richfaces.component.AbstractDataScroller
public abstract class AbstractDataScroller
The <rich:dataScroller> component is used for navigating through multiple pages of tables or grids.
Field Summary | |
---|---|
static String |
COMPONENT_FAMILY
|
static String |
COMPONENT_TYPE
|
static String |
FAST_FORWARD_FACET_NAME
|
static String |
FAST_REWIND_FACET_NAME
|
static String |
FIRST_DISABLED_FACET_NAME
|
static String |
FIRST_FACET_NAME
|
static String |
LAST_DISABLED_FACET_NAME
|
static String |
LAST_FACET_NAME
|
static String |
NEXT_FACET_NAME
|
static String |
PAGEMODE_FULL
|
static String |
PAGEMODE_SHORT
|
static String |
PREVIOUS_FACET_NAME
|
static String |
SCROLLER_STATE_ATTRIBUTE
|
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 |
Constructor Summary | |
---|---|
AbstractDataScroller()
|
Method Summary | |
---|---|
void |
addScrollListener(org.richfaces.event.DataScrollListener listener)
|
void |
broadcast(javax.faces.event.FacesEvent event)
|
abstract org.richfaces.component.DataScrollerControlsMode |
getBoundaryControls()
The attribute specifies the visibility of boundaryControls. |
javax.faces.component.UIComponent |
getDataTable()
Finds the dataTable which id is mapped to the "for" property |
abstract org.richfaces.component.DataScrollerControlsMode |
getFastControls()
The attribute specifies the visibility of fastControls. |
abstract javax.faces.component.UIComponent |
getFastForward()
|
abstract javax.faces.component.UIComponent |
getFastRewind()
|
abstract int |
getFastStep()
The attribute indicates pages quantity to switch onto when fast scrolling is used. |
int |
getFastStepOrDefault()
|
javax.faces.component.UIComponent |
getFirst()
|
String |
getFor()
Component ID of the table whose data is scrolled |
Object |
getIterationState()
|
abstract javax.faces.component.UIComponent |
getLast()
|
abstract String |
getLastPageMode()
The attribute to control whether last page of datascroller shows "rows" number of items or just the rest. |
abstract int |
getMaxPages()
Maximum quantity of pages. |
int |
getMaxPagesOrDefault()
|
abstract javax.faces.component.UIComponent |
getNext()
|
int |
getPage()
If page >= 1 then it's a page number to show |
int |
getPageCount()
|
int |
getPageCount(javax.faces.component.UIComponent data)
|
int |
getPageCount(javax.faces.component.UIComponent data,
int rowCount,
int rows)
|
int |
getPageForFacet(String facetName)
|
abstract javax.faces.component.UIComponent |
getPrevious()
|
abstract Object |
getRender()
|
int |
getRowCount()
|
int |
getRowCount(javax.faces.component.UIComponent data)
|
int |
getRows(javax.faces.component.UIComponent data)
|
abstract javax.el.MethodExpression |
getScrollListener()
|
org.richfaces.event.DataScrollListener[] |
getScrollListeners()
|
abstract org.richfaces.component.DataScrollerControlsMode |
getStepControls()
The attribute specifies the visibility of stepControls. |
boolean |
isLocalPageSet()
|
abstract boolean |
isRenderIfSinglePage()
If renderIfSinglePage is "true" then datascroller is displayed on condition that the data hold on one page. |
void |
removeScrollListener(org.richfaces.event.DataScrollListener listener)
|
void |
resetLocalPage()
|
void |
setFor(String forId)
|
void |
setIterationState(Object state)
|
void |
setPage(int newPage)
|
Methods inherited from class javax.faces.component.UIComponentBase |
---|
addClientBehavior, addFacesListener, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, 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, getFamily, getNamingContainer, 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 |
---|
public static final String COMPONENT_TYPE
public static final String COMPONENT_FAMILY
public static final String SCROLLER_STATE_ATTRIBUTE
public static final String FIRST_FACET_NAME
public static final String LAST_FACET_NAME
public static final String NEXT_FACET_NAME
public static final String PREVIOUS_FACET_NAME
public static final String FAST_FORWARD_FACET_NAME
public static final String FAST_REWIND_FACET_NAME
public static final String FIRST_DISABLED_FACET_NAME
public static final String LAST_DISABLED_FACET_NAME
public static final String PAGEMODE_FULL
public static final String PAGEMODE_SHORT
Constructor Detail |
---|
public AbstractDataScroller()
Method Detail |
---|
public abstract boolean isRenderIfSinglePage()
public abstract String getLastPageMode()
public abstract Object getRender()
public abstract int getMaxPages()
public int getMaxPagesOrDefault()
public abstract org.richfaces.component.DataScrollerControlsMode getBoundaryControls()
public abstract org.richfaces.component.DataScrollerControlsMode getFastControls()
public abstract org.richfaces.component.DataScrollerControlsMode getStepControls()
public abstract int getFastStep()
public int getFastStepOrDefault()
public String getFor()
public void setFor(String forId)
public abstract javax.el.MethodExpression getScrollListener()
public void addScrollListener(org.richfaces.event.DataScrollListener listener)
addScrollListener
in interface org.richfaces.event.DataScrollSource
public org.richfaces.event.DataScrollListener[] getScrollListeners()
getScrollListeners
in interface org.richfaces.event.DataScrollSource
public void removeScrollListener(org.richfaces.event.DataScrollListener listener)
removeScrollListener
in interface org.richfaces.event.DataScrollSource
public void broadcast(javax.faces.event.FacesEvent event) throws javax.faces.event.AbortProcessingException
broadcast
in class javax.faces.component.UIComponentBase
javax.faces.event.AbortProcessingException
public javax.faces.component.UIComponent getDataTable()
public int getPageForFacet(String facetName)
public int getPageCount(javax.faces.component.UIComponent data)
public int getPageCount(javax.faces.component.UIComponent data, int rowCount, int rows)
public int getPageCount()
public int getRowCount(javax.faces.component.UIComponent data)
public int getRowCount()
public int getRows(javax.faces.component.UIComponent data)
public javax.faces.component.UIComponent getFirst()
public abstract javax.faces.component.UIComponent getLast()
public abstract javax.faces.component.UIComponent getNext()
public abstract javax.faces.component.UIComponent getPrevious()
public abstract javax.faces.component.UIComponent getFastForward()
public abstract javax.faces.component.UIComponent getFastRewind()
public void setPage(int newPage)
public int getPage()
public boolean isLocalPageSet()
public void resetLocalPage()
public Object getIterationState()
getIterationState
in interface org.ajax4jsf.component.IterationStateHolder
public void setIterationState(Object state)
setIterationState
in interface org.ajax4jsf.component.IterationStateHolder
|
RichFaces UI Components UI 4.2.2.Final | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |