org.richfaces.component

Class AbstractDataScroller

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

org.richfaces.component.AbstractDataScroller

All Implemented Interfaces:

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, IterationStateHolder, AjaxActivatorProps, AjaxProps, CoreProps, DataScrollSource

Direct Known Subclasses:

UIDataScroller

public abstract class AbstractDataScroller
extends javax.faces.component.UIComponentBase
implements DataScrollSource, IterationStateHolder, AjaxProps, CoreProps

The <rich:dataScroller> component is used for navigating through multiple pages of tables or grids.

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE
static String	CONTROLS_SEPARATOR_FACET_NAME
static String	FAST_FORWARD_DISABLED_FACET_NAME
static String	FAST_FORWARD_FACET_NAME
static String	FAST_REWIND_DISABLED_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_DISABLED_FACET_NAME
static String	NEXT_FACET_NAME
static String	PAGEMODE_FULL
static String	PAGEMODE_SHORT
static String	PAGES_FACET_NAME
static String	PREVIOUS_DISABLED_FACET_NAME
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

Constructors

Constructor and Description
AbstractDataScroller()

Method Summary

Methods

Modifier and Type	Method and Description
void	addScrollListener(DataScrollListener listener) Adds a DataScrollListener to this DataScrollSource.
void	broadcast(javax.faces.event.FacesEvent event)
abstract 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 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() Get component state for a current iteration.
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()
int	getRowCount()
int	getRowCount(javax.faces.component.UIComponent data)
int	getRows(javax.faces.component.UIComponent data)
abstract javax.el.MethodExpression	getScrollListener()
DataScrollListener[]	getScrollListeners() Returns all ScrollListeners for this DataScrollSource.
abstract 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(DataScrollListener listener) Removes a DataFilterSliderListener from this DataScrollSource.
void	resetLocalPage()
void	setFor(String forId)
void	setIterationState(Object state) Set component state for the next iteration.
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, 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, getFamily, 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

Methods inherited from interface org.richfaces.component.attribute.AjaxProps

getExecute, getOnbegin, getStatus

Methods inherited from interface org.richfaces.component.attribute.AjaxActivatorProps

getData, getOnbeforedomupdate, getOncomplete, getRender, isLimitRender, isResetValues

Methods inherited from interface org.richfaces.component.attribute.CoreProps

getStyle, getStyleClass, getTitle

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

Constant Field Values

SCROLLER_STATE_ATTRIBUTE

public static final String SCROLLER_STATE_ATTRIBUTE

See Also:

Constant Field Values

FIRST_FACET_NAME

public static final String FIRST_FACET_NAME

See Also:

Constant Field Values

LAST_FACET_NAME

public static final String LAST_FACET_NAME

See Also:

Constant Field Values

NEXT_FACET_NAME

public static final String NEXT_FACET_NAME

See Also:

Constant Field Values

PREVIOUS_FACET_NAME

public static final String PREVIOUS_FACET_NAME

See Also:

Constant Field Values

FAST_FORWARD_FACET_NAME

public static final String FAST_FORWARD_FACET_NAME

See Also:

Constant Field Values

FAST_REWIND_FACET_NAME

public static final String FAST_REWIND_FACET_NAME

See Also:

Constant Field Values

FIRST_DISABLED_FACET_NAME

public static final String FIRST_DISABLED_FACET_NAME

See Also:

Constant Field Values

LAST_DISABLED_FACET_NAME

public static final String LAST_DISABLED_FACET_NAME

See Also:

Constant Field Values

NEXT_DISABLED_FACET_NAME

public static final String NEXT_DISABLED_FACET_NAME

See Also:

Constant Field Values

PREVIOUS_DISABLED_FACET_NAME

public static final String PREVIOUS_DISABLED_FACET_NAME

See Also:

Constant Field Values

FAST_FORWARD_DISABLED_FACET_NAME

public static final String FAST_FORWARD_DISABLED_FACET_NAME

See Also:

Constant Field Values

FAST_REWIND_DISABLED_FACET_NAME

public static final String FAST_REWIND_DISABLED_FACET_NAME

See Also:

Constant Field Values

CONTROLS_SEPARATOR_FACET_NAME

public static final String CONTROLS_SEPARATOR_FACET_NAME

See Also:

Constant Field Values

PAGES_FACET_NAME

public static final String PAGES_FACET_NAME

See Also:

Constant Field Values

PAGEMODE_FULL

public static final String PAGEMODE_FULL

See Also:

Constant Field Values

PAGEMODE_SHORT

public static final String PAGEMODE_SHORT

See Also:

Constant Field Values

Constructor Detail

AbstractDataScroller

public AbstractDataScroller()

Method Detail

isRenderIfSinglePage

public abstract boolean isRenderIfSinglePage()

If renderIfSinglePage is "true" then datascroller is displayed on condition that the data hold on one page. Default value is "true".

getLastPageMode

public abstract String getLastPageMode()

The attribute to control whether last page of datascroller shows "rows" number of items or just the rest. Possible values are "full" and "short". Default value is "short".

getMaxPages

public abstract int getMaxPages()

Maximum quantity of pages. Default value is "10".

getMaxPagesOrDefault

public int getMaxPagesOrDefault()

getBoundaryControls

public abstract DataScrollerControlsMode getBoundaryControls()

The attribute specifies the visibility of boundaryControls. Possible values are: "show" (controls are always visible ). "hide" (controls are hidden. "auto" (unnecessary controls are hidden). Default value is "show".

getFastControls

public abstract DataScrollerControlsMode getFastControls()

The attribute specifies the visibility of fastControls. Possible values are: "show" (controls are always visible ). "hide" (controls are hidden. "auto" (unnecessary controls are hidden). Default value is "show".

getStepControls

public abstract DataScrollerControlsMode getStepControls()

The attribute specifies the visibility of stepControls. Possible values are: "show" (controls are always visible ). "hide" (controls are hidden. "auto" (unnecessary controls are hidden). Default value is "show".

getFastStep

public abstract int getFastStep()

The attribute indicates pages quantity to switch onto when fast scrolling is used. Default value is "1".

Returns:

getFastStepOrDefault

public int getFastStepOrDefault()

getFor

public String getFor()

Component ID of the table whose data is scrolled

setFor

public void setFor(String forId)

getScrollListener

public abstract javax.el.MethodExpression getScrollListener()

addScrollListener

public void addScrollListener(DataScrollListener listener)

Description copied from interface: DataScrollSource

Adds a DataScrollListener to this DataScrollSource.

Specified by:

addScrollListener in interface DataScrollSource

Parameters:

listener - the Scroll listener to be added

getScrollListeners

public DataScrollListener[] getScrollListeners()

Description copied from interface: DataScrollSource

Returns all ScrollListeners for this DataScrollSource.

Specified by:

getScrollListeners in interface DataScrollSource

Returns:

the Scroll listener array

removeScrollListener

public void removeScrollListener(DataScrollListener listener)

Description copied from interface: DataScrollSource

Removes a DataFilterSliderListener from this DataScrollSource.

Specified by:

removeScrollListener in interface DataScrollSource

Parameters:

listener - the Scroll listener to be removed

broadcast

public void broadcast(javax.faces.event.FacesEvent event)
               throws javax.faces.event.AbortProcessingException

Overrides:

broadcast in class javax.faces.component.UIComponentBase

Throws:

javax.faces.event.AbortProcessingException

getDataTable

public javax.faces.component.UIComponent getDataTable()

Finds the dataTable which id is mapped to the "for" property

Returns:

the dataTable component

getPageForFacet

public int getPageForFacet(String facetName)

getPageCount

public int getPageCount(javax.faces.component.UIComponent data)

getPageCount

public int getPageCount(javax.faces.component.UIComponent data,
               int rowCount,
               int rows)

getPageCount

public int getPageCount()

Returns:

the page count of the uidata

getRowCount

public int getRowCount(javax.faces.component.UIComponent data)

getRowCount

public int getRowCount()

Returns:

int

getRows

public int getRows(javax.faces.component.UIComponent data)

getFirst

public javax.faces.component.UIComponent getFirst()

getLast

public abstract javax.faces.component.UIComponent getLast()

getNext

public abstract javax.faces.component.UIComponent getNext()

getPrevious

public abstract javax.faces.component.UIComponent getPrevious()

getFastForward

public abstract javax.faces.component.UIComponent getFastForward()

getFastRewind

public abstract javax.faces.component.UIComponent getFastRewind()

setPage

public void setPage(int newPage)

getPage

public int getPage()

If page >= 1 then it's a page number to show

isLocalPageSet

public boolean isLocalPageSet()

resetLocalPage

public void resetLocalPage()

getIterationState

public Object getIterationState()

Description copied from interface: IterationStateHolder

Get component state for a current iteration.

Specified by:

getIterationState in interface IterationStateHolder

Returns:

request-scope component state. Details are subject for a component implementation

setIterationState

public void setIterationState(Object state)

Description copied from interface: IterationStateHolder

Set component state for the next iteration. State can be either previously saved iteration state or null value. In the second case component should reset its state to the initial.

Specified by:

setIterationState in interface IterationStateHolder

Parameters:

state - request-scope component state or null. Details are subject for a component implementation