org.apache.myfaces.custom.datascroller
Class ScrollerActionEvent
java.lang.Object
java.util.EventObject
javax.faces.event.FacesEvent
javax.faces.event.ActionEvent
org.apache.myfaces.custom.datascroller.ScrollerActionEvent
- All Implemented Interfaces:
- java.io.Serializable
public class ScrollerActionEvent
- extends javax.faces.event.ActionEvent
An event representing a click on some scroller control to
change the currently displayed table rows.
- Version:
- $Revision$ $Date$
- Author:
- Mathias Broekelmann (latest modification by $Author$)
- See Also:
- Serialized Form
Fields inherited from class java.util.EventObject |
source |
Constructor Summary |
ScrollerActionEvent(javax.faces.component.UIComponent component,
int pageIndex)
An event representing a user's choice to jump straight to page
#pageIndex of the available pages of data. |
ScrollerActionEvent(javax.faces.component.UIComponent component,
java.lang.String scrollerfacet)
An event representing a user's choice of navigation option
except jumping to a specific page. |
Method Summary |
int |
getPageIndex()
Return the page of data the user wants to see, or -1 if the
user didn't choose a page# navigation option. |
java.lang.String |
getScrollerfacet()
Returns a string which matches one of the HtmlDataScroller.FACET_*
public constants, or null if the user chose a page# navigation option. |
Methods inherited from class javax.faces.event.ActionEvent |
isAppropriateListener, processListener |
Methods inherited from class javax.faces.event.FacesEvent |
getComponent, getPhaseId, queue, setPhaseId |
Methods inherited from class java.util.EventObject |
getSource, toString |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
ScrollerActionEvent
public ScrollerActionEvent(javax.faces.component.UIComponent component,
java.lang.String scrollerfacet)
- An event representing a user's choice of navigation option
except jumping to a specific page.
Param scrollerFacet contains the name of the operation performed,
which matches one of the public HtmlDataScroller.FACET_* constants.
ScrollerActionEvent
public ScrollerActionEvent(javax.faces.component.UIComponent component,
int pageIndex)
- An event representing a user's choice to jump straight to page
#pageIndex of the available pages of data.
- Parameters:
component
- is the DataScroller componentpageIndex
- is in the range 0..(nPages-1), where nPages
is (rowsOfDataAvailable/rowsPerPage).
getScrollerfacet
public java.lang.String getScrollerfacet()
- Returns a string which matches one of the HtmlDataScroller.FACET_*
public constants, or null if the user chose a page# navigation option.
getPageIndex
public int getPageIndex()
- Return the page of data the user wants to see, or -1 if the
user didn't choose a page# navigation option.
Copyright © 2011 The Apache Software Foundation. All Rights Reserved.