org.apache.myfaces.custom.datascroller

Class HtmlDataScroller

Implemented Interfaces:
ActionSource, DisplayValueOnlyCapable, UserRoleAware

public class HtmlDataScroller
extends HtmlPanelGroup
implements ActionSource

Version:
$Revision: 226982 $ $Date: 2005-08-02 12:05:18 +0200 (Tue, 02 Aug 2005) $
Author:
Thomas Spiegl (latest modification by $Author: mbr $)

Field Summary

static String
COMPONENT_FAMILY
static String
COMPONENT_TYPE
static String
FACET_FAST_FORWARD
static String
FACET_FAST_REWIND
static String
FACET_FIRST
static String
FACET_LAST
static String
FACET_NEXT
static String
FACET_PREVIOUS

Fields inherited from class org.apache.myfaces.component.html.ext.HtmlPanelGroup

COMPONENT_TYPE

Fields inherited from interface org.apache.myfaces.component.DisplayValueOnlyCapable

DISPLAY_VALUE_ONLY_ATTR, DISPLAY_VALUE_ONLY_STYLE_ATTR, DISPLAY_VALUE_ONLY_STYLE_CLASS_ATTR

Fields inherited from interface org.apache.myfaces.component.UserRoleAware

ENABLED_ON_USER_ROLE_ATTR, VISIBLE_ON_USER_ROLE_ATTR

Constructor Summary

HtmlDataScroller()

Method Summary

void
addActionListener(ActionListener listener)
void
broadcast(FacesEvent event)
protected void
broadcastToActionListener(ScrollerActionEvent event)
protected UIData
findUIData()
MethodBinding
getAction()
MethodBinding
getActionListener()
ActionListener[]
getActionListeners()
String
getDisplayedRowsCountVar()
String
getFamily()
UIComponent
getFastForward()
UIComponent
getFastRewind()
int
getFastStep()
UIComponent
getFirst()
int
getFirstRow()
String
getFirstRowIndexVar()
String
getFor()
UIComponent
getLast()
String
getLastRowIndexVar()
UIComponent
getNext()
int
getPageCount()
String
getPageCountVar()
int
getPageIndex()
String
getPageIndexVar()
String
getPaginatorActiveColumnClass()
String
getPaginatorActiveColumnStyle()
String
getPaginatorColumnClass()
String
getPaginatorColumnStyle()
int
getPaginatorMaxPages()
String
getPaginatorTableClass()
String
getPaginatorTableStyle()
UIComponent
getPrevious()
boolean
getRendersChildren()
int
getRowCount()
int
getRows()
String
getRowsCountVar()
String
getStyle()
String
getStyleClass()
UIData
getUIData()
boolean
isImmediate()
boolean
isPaginator()
boolean
isRenderFacetsIfSinglePage()
void
queueEvent(FacesEvent event)
void
removeActionListener(ActionListener listener)
void
restoreState(FacesContext context, Object state)
Object
saveState(FacesContext context)
void
setAction(MethodBinding action)
void
setActionListener(MethodBinding actionListener)
void
setDisplayedRowsCountVar(String displayedRowsCountVar)
void
setFastForward(UIComponent previous)
void
setFastRewind(UIComponent previous)
void
setFastStep(int fastStep)
void
setFirst(UIComponent first)
void
setFirstRowIndexVar(String firstRowIndexVar)
void
setFor(String forValue)
void
setImmediate(boolean immediate)
void
setLast(UIComponent last)
void
setLastRowIndexVar(String lastRowIndexVar)
void
setNext(UIComponent next)
void
setPageCountVar(String pageCountVar)
void
setPageIndexVar(String pageIndexVar)
void
setPaginator(boolean paginator)
void
setPaginatorActiveColumnClass(String paginatorActiveColumnClass)
void
setPaginatorActiveColumnStyle(String paginatorActiveColumnStyle)
void
setPaginatorColumnClass(String paginatorColumnClass)
void
setPaginatorColumnStyle(String paginatorColumnStyle)
void
setPaginatorMaxPages(int paginatorMaxPages)
void
setPaginatorTableClass(String paginatorTableClass)
void
setPaginatorTableStyle(String paginatorTableStyle)
void
setPrevious(UIComponent previous)
void
setRenderFacetsIfSinglePage(boolean renderFacetsIfSinglePage)
void
setRowsCountVar(String rowsCountVar)
void
setStyle(String style)
void
setStyleClass(String styleClass)

Methods inherited from class org.apache.myfaces.component.html.ext.HtmlPanelGroup

getClientId, getDisplayValueOnlyStyle, getDisplayValueOnlyStyleClass, getEnabledOnUserRole, getVisibleOnUserRole, isDisplayValueOnly, isRendered, isSetDisplayValueOnly, restoreState, saveState, setDisplayValueOnly, setDisplayValueOnlyStyle, setDisplayValueOnlyStyleClass, setEnabledOnUserRole, setVisibleOnUserRole

Field Details

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

COMPONENT_TYPE

public static final String COMPONENT_TYPE

FACET_FAST_FORWARD

public static final String FACET_FAST_FORWARD

FACET_FAST_REWIND

public static final String FACET_FAST_REWIND

FACET_FIRST

public static final String FACET_FIRST

FACET_LAST

public static final String FACET_LAST

FACET_NEXT

public static final String FACET_NEXT

FACET_PREVIOUS

public static final String FACET_PREVIOUS

Constructor Details

HtmlDataScroller

public HtmlDataScroller()

Method Details

addActionListener

public void addActionListener(ActionListener listener)
See Also:
javax.faces.component.ActionSource.addActionListener(javax.faces.event.ActionListener)

broadcast

public void broadcast(FacesEvent event)
            throws AbortProcessingException
See Also:
javax.faces.component.UIComponentBase.broadcast(javax.faces.event.FacesEvent)

broadcastToActionListener

protected void broadcastToActionListener(ScrollerActionEvent event)
Parameters:
event -

findUIData

protected UIData findUIData()

getAction

public MethodBinding getAction()
See Also:
javax.faces.component.ActionSource.getAction()

getActionListener

public MethodBinding getActionListener()
See Also:
javax.faces.component.ActionSource.getActionListener()

getActionListeners

public ActionListener[] getActionListeners()
See Also:
javax.faces.component.ActionSource.getActionListeners()

getDisplayedRowsCountVar

public String getDisplayedRowsCountVar()

getFamily

public String getFamily()

getFastForward

public UIComponent getFastForward()

getFastRewind

public UIComponent getFastRewind()

getFastStep

public int getFastStep()

getFirst

public UIComponent getFirst()

getFirstRow

public int getFirstRow()
Returns:
int

getFirstRowIndexVar

public String getFirstRowIndexVar()

getFor

public String getFor()

getLast

public UIComponent getLast()

getLastRowIndexVar

public String getLastRowIndexVar()

getNext

public UIComponent getNext()

getPageCount

public int getPageCount()
Returns:
the page count of the uidata

getPageCountVar

public String getPageCountVar()

getPageIndex

public int getPageIndex()
Returns:
the page index of the uidata

getPageIndexVar

public String getPageIndexVar()

getPaginatorActiveColumnClass

public String getPaginatorActiveColumnClass()

getPaginatorActiveColumnStyle

public String getPaginatorActiveColumnStyle()

getPaginatorColumnClass

public String getPaginatorColumnClass()

getPaginatorColumnStyle

public String getPaginatorColumnStyle()

getPaginatorMaxPages

public int getPaginatorMaxPages()

getPaginatorTableClass

public String getPaginatorTableClass()

getPaginatorTableStyle

public String getPaginatorTableStyle()

getPrevious

public UIComponent getPrevious()

getRendersChildren

public boolean getRendersChildren()

getRowCount

public int getRowCount()
Returns:
int

getRows

public int getRows()
Returns:
int

getRowsCountVar

public String getRowsCountVar()

getStyle

public String getStyle()

getStyleClass

public String getStyleClass()

getUIData

public UIData getUIData()
Returns:
int

isImmediate

public boolean isImmediate()

isPaginator

public boolean isPaginator()

isRenderFacetsIfSinglePage

public boolean isRenderFacetsIfSinglePage()

queueEvent

public void queueEvent(FacesEvent event)
See Also:
javax.faces.component.UIComponentBase.queueEvent(javax.faces.event.FacesEvent)

removeActionListener

public void removeActionListener(ActionListener listener)
See Also:
javax.faces.component.ActionSource.removeActionListener(javax.faces.event.ActionListener)

restoreState

public void restoreState(FacesContext context,
                         Object state)
Overrides:
restoreState in interface HtmlPanelGroup

saveState

public Object saveState(FacesContext context)
Overrides:
saveState in interface HtmlPanelGroup

setAction

public void setAction(MethodBinding action)
See Also:
javax.faces.component.ActionSource.setAction(javax.faces.el.MethodBinding)

setActionListener

public void setActionListener(MethodBinding actionListener)
See Also:
javax.faces.component.ActionSource.setActionListener(javax.faces.el.MethodBinding)

setDisplayedRowsCountVar

public void setDisplayedRowsCountVar(String displayedRowsCountVar)

setFastForward

public void setFastForward(UIComponent previous)

setFastRewind

public void setFastRewind(UIComponent previous)

setFastStep

public void setFastStep(int fastStep)

setFirst

public void setFirst(UIComponent first)

setFirstRowIndexVar

public void setFirstRowIndexVar(String firstRowIndexVar)

setFor

public void setFor(String forValue)

setImmediate

public void setImmediate(boolean immediate)

setLast

public void setLast(UIComponent last)

setLastRowIndexVar

public void setLastRowIndexVar(String lastRowIndexVar)

setNext

public void setNext(UIComponent next)

setPageCountVar

public void setPageCountVar(String pageCountVar)

setPageIndexVar

public void setPageIndexVar(String pageIndexVar)

setPaginator

public void setPaginator(boolean paginator)

setPaginatorActiveColumnClass

public void setPaginatorActiveColumnClass(String paginatorActiveColumnClass)

setPaginatorActiveColumnStyle

public void setPaginatorActiveColumnStyle(String paginatorActiveColumnStyle)

setPaginatorColumnClass

public void setPaginatorColumnClass(String paginatorColumnClass)

setPaginatorColumnStyle

public void setPaginatorColumnStyle(String paginatorColumnStyle)

setPaginatorMaxPages

public void setPaginatorMaxPages(int paginatorMaxPages)

setPaginatorTableClass

public void setPaginatorTableClass(String paginatorTableClass)

setPaginatorTableStyle

public void setPaginatorTableStyle(String paginatorTableStyle)

setPrevious

public void setPrevious(UIComponent previous)

setRenderFacetsIfSinglePage

public void setRenderFacetsIfSinglePage(boolean renderFacetsIfSinglePage)

setRowsCountVar

public void setRowsCountVar(String rowsCountVar)

setStyle

public void setStyle(String style)

setStyleClass

public void setStyleClass(String styleClass)