|
ICEfaces ICE Components 3.3.0 Java API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UIPanel
javax.faces.component.html.HtmlPanelGroup
com.icesoft.faces.component.datapaginator.DataPaginator
public class DataPaginator
Nested Class Summary |
---|
Nested classes/interfaces inherited from class javax.faces.component.html.HtmlPanelGroup |
---|
javax.faces.component.html.HtmlPanelGroup.PropertyKeys |
Field Summary | |
---|---|
static java.lang.String |
COMPONENT_FAMILY
|
static java.lang.String |
COMPONENT_TYPE
|
static java.lang.String |
FACET_FAST_FORWARD
|
static java.lang.String |
FACET_FAST_REWIND
|
static java.lang.String |
FACET_FIRST
|
static java.lang.String |
FACET_LAST
|
static java.lang.String |
FACET_NEXT
|
static java.lang.String |
FACET_PREVIOUS
|
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 | |
---|---|
DataPaginator()
|
Method Summary | |
---|---|
void |
addActionListener(javax.faces.event.ActionListener listener)
|
void |
broadcast(javax.faces.event.FacesEvent event)
|
protected void |
broadcastToActionListener(PaginatorActionEvent event)
|
void |
decode(javax.faces.context.FacesContext context)
|
protected javax.faces.component.UIData |
findUIData()
Return the instance of UIData associated to this
component. |
javax.faces.el.MethodBinding |
getAction()
|
javax.faces.el.MethodBinding |
getActionListener()
|
javax.faces.event.ActionListener[] |
getActionListeners()
|
java.lang.String |
getBaseStyleClass()
|
java.lang.String |
getComponentType()
|
java.lang.String |
getDisplayedRowsCountVar()
Return the value of the displayedRowsCountVar
property. |
java.lang.String |
getEnabledOnUserRole()
Return the value of the enabledOnUserRole property. |
java.lang.String |
getFamily()
|
javax.faces.component.UIComponent |
getFastForward()
Return the value of the fast forward facet of this
component. |
javax.faces.component.UIComponent |
getFastRewind()
Return the value of the fast rewind facet of this
component. |
int |
getFastStep()
Return the value of the fastStep property. |
javax.faces.component.UIComponent |
getFirst()
Return the value of the first facet of this
component. |
int |
getFirstRow()
Return the value of the first property. |
java.lang.String |
getFirstRowIndexVar()
Return the value of the firstRowIndexVar property. |
java.lang.String |
getFor()
Return the value of the for property. |
javax.faces.component.UIComponent |
getLast()
Return the value of the last facet of this
component. |
java.lang.String |
getLastRowIndexVar()
Return the value of the lastRowIndexVar property. |
javax.faces.component.UIComponent |
getNext()
Return the value of the next facet of this
component. |
int |
getPageCount()
Return the value of the pageCount property. |
java.lang.String |
getPageCountVar()
Return the value of the pageCountVar property. |
int |
getPageIndex()
Return the value of the pageIndex property. |
java.lang.String |
getPageIndexVar()
Return the value of the pageIndexVar property. |
java.lang.String |
getPaginatorActiveColumnClass()
Return the value of the paginatorActiveColumnClass
property. |
java.lang.String |
getPaginatorColumnClass()
Return the value of the paginatorColumnClass
property. |
int |
getPaginatorMaxPages()
Return the value of the paginatorMaxPages property. |
java.lang.String |
getPaginatorTableClass()
Return the value of the paginatorTableClass
property. |
javax.faces.component.UIComponent |
getPrevious()
Return the value of the previous facet of this
component. |
java.lang.String |
getRenderedOnUserRole()
Return the value of the renderedOnUserRole property. |
java.lang.String |
getRendererType()
|
boolean |
getRendersChildren()
Return a flag indicating whether this component is responsible for rendering its child components. |
int |
getRowCount()
Return the value of the rowCount property. |
int |
getRows()
Return the value of the rows property. |
java.lang.String |
getRowsCountVar()
Return the value of the rowsCountVar property. |
java.lang.String |
getscrollButtonCellClass()
Return the value of the scrollButtonCellClass
property. |
java.lang.String |
getStyle()
Return the value of the style property. |
java.lang.String |
getStyleClass()
Return the value of the styleClass property. |
int |
getTabindex()
Return the value of the fastStep property. |
javax.faces.component.UIData |
getUIData()
Return the instance of the UIData associated to this
component. |
void |
gotoFastForward()
Sets the dataPaginator to the (n) number of pages forward, defined by the fastStep property |
void |
gotoFastRewind()
Sets the dataPaginator to the (n) number of pages back, defined by the fastStep property |
void |
gotoFirstPage()
Sets the dataPaginator to the first page |
void |
gotoLastPage()
Sets the dataPaginator to the last page |
void |
gotoNextPage()
Sets the dataPaginator to the next page |
void |
gotoPreviousPage()
Sets the dataPaginator to the previous page |
boolean |
isDisabled()
Return the value of the disabled property. |
boolean |
isImmediate()
Return the value of the immediate property. |
boolean |
isKeyboardNavigationEnabled()
|
boolean |
isLastPage()
Return a boolean value, whether current page is the last page |
boolean |
isModelResultSet()
|
boolean |
isPaginator()
Return the value of the paginator property. |
boolean |
isRendered()
Return the value of the rendered property. |
boolean |
isRenderFacetsIfSinglePage()
Return the value of the renderFacetsIfSinglePage
property. |
boolean |
isVertical()
Return the value of the vertical property. |
void |
queueEvent(javax.faces.event.FacesEvent event)
|
void |
removeActionListener(javax.faces.event.ActionListener listener)
|
void |
restoreState(javax.faces.context.FacesContext context,
java.lang.Object state)
Perform any processing required to restore the state from the entries in the state Object. |
java.lang.Object |
saveState(javax.faces.context.FacesContext context)
Gets the state of the instance as a Serializable
Object. |
void |
setAction(javax.faces.el.MethodBinding action)
|
void |
setActionListener(javax.faces.el.MethodBinding actionListener)
|
void |
setDisabled(boolean disabled)
Set the value of the disabled property. |
void |
setDisplayedRowsCountVar(java.lang.String displayedRowsCountVar)
Set the value of the displayedRowsCountVar property. |
void |
setEnabledOnUserRole(java.lang.String enabledOnUserRole)
Set the value of the enabledOnUserRole property. |
void |
setFastForward(javax.faces.component.UIComponent previous)
Set the value of the fast forward facet for this
component. |
void |
setFastRewind(javax.faces.component.UIComponent previous)
Set the value of the fast rewind facet for this
component. |
void |
setFastStep(int fastStep)
Set the value of the fastStep property. |
void |
setFirst(javax.faces.component.UIComponent first)
Set the value of the first facet for this component. |
void |
setFirstRowIndexVar(java.lang.String firstRowIndexVar)
Set the value of the firstRowIndexVar property. |
void |
setFor(java.lang.String forValue)
Set the value of the for property. |
void |
setImmediate(boolean immediate)
Set the value of the immediate property. |
void |
setKeyboardNavigationEnabled(boolean keyboardNavigationEnabled)
|
void |
setLast(javax.faces.component.UIComponent last)
Set the value of the last facet for this component. |
void |
setLastRowIndexVar(java.lang.String lastRowIndexVar)
Set the value of the lastRowIndexVar property. |
void |
setNext(javax.faces.component.UIComponent next)
Set the value of the next facet for this component. |
void |
setPageCountVar(java.lang.String pageCountVar)
Set the value of the pageCountVar property. |
void |
setPageIndexVar(java.lang.String pageIndexVar)
Set the value of the pageIndexVar property. |
void |
setPaginator(boolean paginator)
Set the value of the paginator property. |
void |
setPaginatorMaxPages(int paginatorMaxPages)
Set the value of the paginatorMaxPages property. |
void |
setPrevious(javax.faces.component.UIComponent previous)
Set the value of the previous facet for this
component. |
void |
setRenderedOnUserRole(java.lang.String renderedOnUserRole)
Set the value of the renderedOnUserRole property. |
void |
setRenderFacetsIfSinglePage(boolean renderFacetsIfSinglePage)
Set the value of the renderFacetsIfSinglePage
property. |
void |
setRowsCountVar(java.lang.String rowsCountVar)
Set the value of the rowsCountVar property. |
void |
setStyle(java.lang.String style)
Set the value of the style property. |
void |
setStyleClass(java.lang.String styleClass)
Set the value of the styleClass property. |
void |
setTabindex(int tabindex)
Set the value of the tabindex property. |
void |
setUIData(javax.faces.component.UIData uiData)
|
void |
setVertical(boolean vertical)
Set the value of the vertical property. |
Methods inherited from class javax.faces.component.html.HtmlPanelGroup |
---|
getLayout, setLayout |
Methods inherited from class javax.faces.component.UIComponentBase |
---|
addClientBehavior, addFacesListener, clearInitialState, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getRenderer, getValueBinding, invokeOnComponent, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent |
Methods inherited from class javax.faces.component.UIComponent |
---|
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, 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 java.lang.String COMPONENT_TYPE
public static final java.lang.String COMPONENT_FAMILY
public static final java.lang.String FACET_FIRST
public static final java.lang.String FACET_PREVIOUS
public static final java.lang.String FACET_NEXT
public static final java.lang.String FACET_LAST
public static final java.lang.String FACET_FAST_FORWARD
public static final java.lang.String FACET_FAST_REWIND
Constructor Detail |
---|
public DataPaginator()
Method Detail |
---|
public java.lang.String getComponentType()
public java.lang.String getRendererType()
getRendererType
in class javax.faces.component.UIComponentBase
UIComponent.getRendererType()
public void setDisabled(boolean disabled)
Set the value of the disabled
property.
public boolean isDisabled()
Return the value of the disabled
property.
public void queueEvent(javax.faces.event.FacesEvent event)
queueEvent
in class javax.faces.component.UIComponentBase
UIComponentBase.queueEvent(javax.faces.event.FacesEvent)
public void broadcast(javax.faces.event.FacesEvent event) throws javax.faces.event.AbortProcessingException
broadcast
in class javax.faces.component.UIComponentBase
javax.faces.event.AbortProcessingException
UIComponentBase.broadcast(javax.faces.event.FacesEvent)
protected void broadcastToActionListener(PaginatorActionEvent event)
public javax.faces.component.UIData getUIData()
Return the instance of the UIData
associated to this
component.
public void setUIData(javax.faces.component.UIData uiData)
public int getPageIndex()
Return the value of the pageIndex
property.
public int getPageCount()
Return the value of the pageCount
property.
public int getRowCount()
Return the value of the rowCount
property.
public int getRows()
Return the value of the rows
property.
public int getFirstRow()
Return the value of the first
property.
protected javax.faces.component.UIData findUIData()
Return the instance of UIData
associated to this
component.
public void setFirst(javax.faces.component.UIComponent first)
Set the value of the first
facet for this component.
public javax.faces.component.UIComponent getFirst()
Return the value of the first
facet of this
component.
public void setLast(javax.faces.component.UIComponent last)
Set the value of the last
facet for this component.
public javax.faces.component.UIComponent getLast()
Return the value of the last
facet of this
component.
public void setNext(javax.faces.component.UIComponent next)
Set the value of the next
facet for this component.
public javax.faces.component.UIComponent getNext()
Return the value of the next
facet of this
component.
public void setFastForward(javax.faces.component.UIComponent previous)
Set the value of the fast forward
facet for this
component.
public javax.faces.component.UIComponent getFastForward()
Return the value of the fast forward
facet of this
component.
public void setFastRewind(javax.faces.component.UIComponent previous)
Set the value of the fast rewind
facet for this
component.
public javax.faces.component.UIComponent getFastRewind()
Return the value of the fast rewind
facet of this
component.
public void setPrevious(javax.faces.component.UIComponent previous)
Set the value of the previous
facet for this
component.
public javax.faces.component.UIComponent getPrevious()
Return the value of the previous
facet of this
component.
public boolean getRendersChildren()
Return a flag indicating whether this component is responsible for rendering its child components.
getRendersChildren
in class javax.faces.component.UIComponentBase
public javax.faces.el.MethodBinding getAction()
getAction
in interface javax.faces.component.ActionSource
ActionSource.getAction()
public void setAction(javax.faces.el.MethodBinding action)
setAction
in interface javax.faces.component.ActionSource
ActionSource.setAction(javax.faces.el.MethodBinding)
public void setActionListener(javax.faces.el.MethodBinding actionListener)
setActionListener
in interface javax.faces.component.ActionSource
ActionSource.setActionListener(javax.faces.el.MethodBinding)
public javax.faces.el.MethodBinding getActionListener()
getActionListener
in interface javax.faces.component.ActionSource
ActionSource.getActionListener()
public void addActionListener(javax.faces.event.ActionListener listener)
addActionListener
in interface javax.faces.component.ActionSource
ActionSource.addActionListener(javax.faces.event.ActionListener)
public javax.faces.event.ActionListener[] getActionListeners()
getActionListeners
in interface javax.faces.component.ActionSource
ActionSource.getActionListeners()
public void removeActionListener(javax.faces.event.ActionListener listener)
removeActionListener
in interface javax.faces.component.ActionSource
ActionSource.removeActionListener(javax.faces.event.ActionListener)
public java.lang.String getFamily()
getFamily
in class javax.faces.component.UIPanel
public void setFor(java.lang.String forValue)
Set the value of the for
property.
public java.lang.String getFor()
Return the value of the for
property.
public void setFastStep(int fastStep)
Set the value of the fastStep
property.
public int getFastStep()
Return the value of the fastStep
property.
public void setPageIndexVar(java.lang.String pageIndexVar)
Set the value of the pageIndexVar
property.
public java.lang.String getPageIndexVar()
Return the value of the pageIndexVar
property.
public void setPageCountVar(java.lang.String pageCountVar)
Set the value of the pageCountVar
property.
public java.lang.String getPageCountVar()
Return the value of the pageCountVar
property.
public void setRowsCountVar(java.lang.String rowsCountVar)
Set the value of the rowsCountVar
property.
public java.lang.String getRowsCountVar()
Return the value of the rowsCountVar
property.
public void setDisplayedRowsCountVar(java.lang.String displayedRowsCountVar)
Set the value of the displayedRowsCountVar
property.
public java.lang.String getDisplayedRowsCountVar()
Return the value of the displayedRowsCountVar
property.
public void setFirstRowIndexVar(java.lang.String firstRowIndexVar)
Set the value of the firstRowIndexVar
property.
public java.lang.String getFirstRowIndexVar()
Return the value of the firstRowIndexVar
property.
public void setLastRowIndexVar(java.lang.String lastRowIndexVar)
Set the value of the lastRowIndexVar
property.
public java.lang.String getLastRowIndexVar()
Return the value of the lastRowIndexVar
property.
public void setStyle(java.lang.String style)
Set the value of the style
property.
setStyle
in class javax.faces.component.html.HtmlPanelGroup
public java.lang.String getStyle()
Return the value of the style
property.
getStyle
in class javax.faces.component.html.HtmlPanelGroup
public void setStyleClass(java.lang.String styleClass)
Set the value of the styleClass
property.
setStyleClass
in class javax.faces.component.html.HtmlPanelGroup
public java.lang.String getStyleClass()
Return the value of the styleClass
property.
getStyleClass
in class javax.faces.component.html.HtmlPanelGroup
public java.lang.String getBaseStyleClass()
public void setPaginator(boolean paginator)
Set the value of the paginator
property.
public boolean isPaginator()
Return the value of the paginator
property.
public void setPaginatorMaxPages(int paginatorMaxPages)
Set the value of the paginatorMaxPages
property.
public int getPaginatorMaxPages()
Return the value of the paginatorMaxPages
property.
public java.lang.String getPaginatorTableClass()
Return the value of the paginatorTableClass
property.
public java.lang.String getPaginatorColumnClass()
Return the value of the paginatorColumnClass
property.
public java.lang.String getscrollButtonCellClass()
Return the value of the scrollButtonCellClass
property.
public java.lang.String getPaginatorActiveColumnClass()
Return the value of the paginatorActiveColumnClass
property.
public void setRenderFacetsIfSinglePage(boolean renderFacetsIfSinglePage)
Set the value of the renderFacetsIfSinglePage
property.
public boolean isRenderFacetsIfSinglePage()
Return the value of the renderFacetsIfSinglePage
property.
public void setImmediate(boolean immediate)
Set the value of the immediate
property.
setImmediate
in interface javax.faces.component.ActionSource
public boolean isImmediate()
Return the value of the immediate
property.
isImmediate
in interface javax.faces.component.ActionSource
public void setVertical(boolean vertical)
Set the value of the vertical
property.
public boolean isVertical()
Return the value of the vertical
property.
public boolean isRendered()
Return the value of the rendered
property.
isRendered
in class javax.faces.component.UIComponentBase
public java.lang.Object saveState(javax.faces.context.FacesContext context)
Gets the state of the instance as a Serializable
Object.
saveState
in interface javax.faces.component.StateHolder
saveState
in class javax.faces.component.UIComponentBase
public void restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
Perform any processing required to restore the state from the entries in the state Object.
restoreState
in interface javax.faces.component.StateHolder
restoreState
in class javax.faces.component.UIComponentBase
public void gotoFirstPage()
public void gotoPreviousPage()
public void gotoNextPage()
public void gotoFastForward()
public void gotoFastRewind()
public void gotoLastPage()
public boolean isLastPage()
public void setEnabledOnUserRole(java.lang.String enabledOnUserRole)
Set the value of the enabledOnUserRole
property.
public java.lang.String getEnabledOnUserRole()
Return the value of the enabledOnUserRole
property.
public void setRenderedOnUserRole(java.lang.String renderedOnUserRole)
Set the value of the renderedOnUserRole
property.
public java.lang.String getRenderedOnUserRole()
Return the value of the renderedOnUserRole
property.
public boolean isModelResultSet()
public boolean isKeyboardNavigationEnabled()
public void setKeyboardNavigationEnabled(boolean keyboardNavigationEnabled)
public void decode(javax.faces.context.FacesContext context)
decode
in class javax.faces.component.UIComponentBase
public void setTabindex(int tabindex)
Set the value of the tabindex
property.
public int getTabindex()
Return the value of the fastStep
property.
|
ICEfaces ICE Components 3.3.0 Java API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |