org.apache.myfaces.custom.datascroller

Class HtmlDataScroller

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 StringCOMPONENT_FAMILY
static StringCOMPONENT_TYPE
static StringFACET_FAST_FORWARD
static StringFACET_FAST_REWIND
static StringFACET_FIRST
static StringFACET_LAST
static StringFACET_NEXT
static StringFACET_PREVIOUS
Constructor Summary
HtmlDataScroller()
Method Summary
voidaddActionListener(ActionListener listener)
voidbroadcast(FacesEvent event)
protected voidbroadcastToActionListener(ScrollerActionEvent event)
protected UIDatafindUIData()
MethodBindinggetAction()
MethodBindinggetActionListener()
ActionListener[]getActionListeners()
StringgetDisplayedRowsCountVar()
StringgetFamily()
UIComponentgetFastForward()
UIComponentgetFastRewind()
intgetFastStep()
UIComponentgetFirst()
intgetFirstRow()
StringgetFirstRowIndexVar()
StringgetFor()
UIComponentgetLast()
StringgetLastRowIndexVar()
UIComponentgetNext()
intgetPageCount()
StringgetPageCountVar()
intgetPageIndex()
StringgetPageIndexVar()
StringgetPaginatorActiveColumnClass()
StringgetPaginatorActiveColumnStyle()
StringgetPaginatorColumnClass()
StringgetPaginatorColumnStyle()
intgetPaginatorMaxPages()
StringgetPaginatorTableClass()
StringgetPaginatorTableStyle()
UIComponentgetPrevious()
booleangetRendersChildren()
intgetRowCount()
intgetRows()
StringgetRowsCountVar()
StringgetStyle()
StringgetStyleClass()
UIDatagetUIData()
booleanisImmediate()
booleanisPaginator()
booleanisRenderFacetsIfSinglePage()
voidqueueEvent(FacesEvent event)
voidremoveActionListener(ActionListener listener)
voidrestoreState(FacesContext context, Object state)
ObjectsaveState(FacesContext context)
voidsetAction(MethodBinding action)
voidsetActionListener(MethodBinding actionListener)
voidsetDisplayedRowsCountVar(String displayedRowsCountVar)
voidsetFastForward(UIComponent previous)
voidsetFastRewind(UIComponent previous)
voidsetFastStep(int fastStep)
voidsetFirst(UIComponent first)
voidsetFirstRowIndexVar(String firstRowIndexVar)
voidsetFor(String forValue)
voidsetImmediate(boolean immediate)
voidsetLast(UIComponent last)
voidsetLastRowIndexVar(String lastRowIndexVar)
voidsetNext(UIComponent next)
voidsetPageCountVar(String pageCountVar)
voidsetPageIndexVar(String pageIndexVar)
voidsetPaginator(boolean paginator)
voidsetPaginatorActiveColumnClass(String paginatorActiveColumnClass)
voidsetPaginatorActiveColumnStyle(String paginatorActiveColumnStyle)
voidsetPaginatorColumnClass(String paginatorColumnClass)
voidsetPaginatorColumnStyle(String paginatorColumnStyle)
voidsetPaginatorMaxPages(int paginatorMaxPages)
voidsetPaginatorTableClass(String paginatorTableClass)
voidsetPaginatorTableStyle(String paginatorTableStyle)
voidsetPrevious(UIComponent previous)
voidsetRenderFacetsIfSinglePage(boolean renderFacetsIfSinglePage)
voidsetRowsCountVar(String rowsCountVar)
voidsetStyle(String style)
voidsetStyleClass(String styleClass)

Field Detail

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 Detail

HtmlDataScroller

public HtmlDataScroller()

Method Detail

addActionListener

public void addActionListener(ActionListener listener)

See Also: javax.faces.component.ActionSource#addActionListener(javax.faces.event.ActionListener)

broadcast

public void broadcast(FacesEvent event)

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)

saveState

public Object saveState(FacesContext context)

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)