|
||||||||||
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
org.apache.myfaces.custom.datascroller.AbstractHtmlDataScroller
@JSFComponent(name="t:dataScroller", clazz="org.apache.myfaces.custom.datascroller.HtmlDataScroller", tagClass="org.apache.myfaces.custom.datascroller.HtmlDataScrollerTag", defaultEventName="action") public abstract class AbstractHtmlDataScroller
Scroller for UIData components eg. dataTable Must be nested inside footer facet of dataTable OR for attribute must be given so that corresponding uiData can be found. Unless otherwise specified, all attributes accept static values or EL expressions. A component which works together with a UIData component to allow a user to view a large list of data one "page" at a time, and navigate between pages.
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 |
---|
BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY |
Fields inherited from interface org.apache.myfaces.component.UserRoleAware |
---|
ENABLED_ON_USER_ROLE_ATTR, VISIBLE_ON_USER_ROLE_ATTR |
Fields inherited from interface org.apache.myfaces.shared_tomahawk.component.DisplayValueOnlyCapable |
---|
DISPLAY_VALUE_ONLY_ATTR, DISPLAY_VALUE_ONLY_STYLE_ATTR, DISPLAY_VALUE_ONLY_STYLE_CLASS_ATTR |
Constructor Summary | |
---|---|
AbstractHtmlDataScroller()
|
Method Summary | |
---|---|
void |
addActionListener(javax.faces.event.ActionListener listener)
|
void |
broadcast(javax.faces.event.FacesEvent event)
Invoke any action listeners attached to this class. |
protected void |
broadcastToActionListener(ScrollerActionEvent event)
|
protected javax.faces.component.UIData |
findUIData()
Find the UIData component associated with this scroller. |
javax.faces.el.MethodBinding |
getAction()
|
javax.el.MethodExpression |
getActionExpression()
|
javax.faces.el.MethodBinding |
getActionListener()
MethodBinding pointing at method acception an ActionEvent with return type void. |
javax.faces.event.ActionListener[] |
getActionListeners()
|
java.lang.String |
getClientId(javax.faces.context.FacesContext context)
|
abstract int |
getColspan()
standard html colspan attribute for table cell |
abstract java.lang.String |
getDisplayedRowsCountVar()
A parameter name, under which the actual displayed rows count is set in request scope similar to the var parameter. |
javax.faces.component.UIComponent |
getFastForward()
|
abstract java.lang.String |
getFastfStyleClass()
style-class for data-scroller fast-forward-element |
javax.faces.component.UIComponent |
getFastRewind()
|
abstract java.lang.String |
getFastrStyleClass()
style-class for data-scroller fast-rewind-element |
abstract int |
getFastStep()
step (pages) used for fastforward and fastrewind |
javax.faces.component.UIComponent |
getFirst()
|
int |
getFirstRow()
|
abstract java.lang.String |
getFirstRowIndexVar()
A parameter name, under which the actual first displayed row index is set in request scope similar to the var parameter. |
abstract java.lang.String |
getFirstStyleClass()
style-class for data-scroller first-element |
abstract java.lang.String |
getFor()
The JSF id of a UIData component that this scroller will affect. |
javax.faces.component.UIComponent |
getLast()
|
abstract java.lang.String |
getLastRowIndexVar()
A parameter name, under which the actual last displayed row index is set in request scope similar to the var parameter. |
abstract java.lang.String |
getLastStyleClass()
style-class for data-scroller last-element |
abstract java.lang.String |
getLayout()
The layout this scroller should render with. |
javax.faces.component.UIComponent |
getNext()
|
abstract java.lang.String |
getNextStyleClass()
style-class for dataScroller next-element |
abstract java.lang.String |
getOnclick()
HTML: Script to be invoked when the element is clicked. |
abstract java.lang.String |
getOndblclick()
HTML: Script to be invoked when the element is double-clicked. |
int |
getPageCount()
|
abstract java.lang.String |
getPageCountVar()
A parameter name, under which the actual page count is set in request scope similar to the var parameter. |
int |
getPageIndex()
|
abstract java.lang.String |
getPageIndexVar()
A parameter name, under which the actual page index is set in request scope similar to the var parameter. |
abstract java.lang.String |
getPaginatorActiveColumnClass()
styleClass for paginator's column with pageIndex = currentPageIndex |
abstract java.lang.String |
getPaginatorActiveColumnStyle()
style for paginator's column with pageIndex = currentPageIndex |
abstract java.lang.String |
getPaginatorColumnClass()
styleClass for paginator's column |
abstract java.lang.String |
getPaginatorColumnStyle()
style for paginator's column |
abstract int |
getPaginatorMaxPages()
The maximum amount of pages to be displayed in the paginator. |
abstract java.lang.String |
getPaginatorTableClass()
styleclass for pagingator |
abstract java.lang.String |
getPaginatorTableStyle()
style for pagingator |
javax.faces.component.UIComponent |
getPrevious()
|
abstract java.lang.String |
getPreviousStyleClass()
style-class for data-scroller previous-element |
boolean |
getRendersChildren()
|
int |
getRowCount()
|
int |
getRows()
|
abstract java.lang.String |
getRowsCountVar()
A parameter name, under which the actual rows count is set in request scope similar to the var parameter. |
javax.faces.component.UIData |
getUIData()
|
abstract boolean |
isDisableFacetLinksIfFirstPage()
If the dataScroller is on the first page (index is at 1), links for first, prev and fastprev are disabled. |
abstract boolean |
isDisableFacetLinksIfLastPage()
If the dataScroller is on the last page (index is at pagecount), links for last, next and fastnext are disabled. |
boolean |
isDisplayValueOnly()
|
abstract boolean |
isImmediate()
True means that the default ActionListener should be executed immediately (i.e. |
boolean |
isListLayout()
|
abstract boolean |
isPaginator()
If set true, then the paginator gets rendered |
abstract boolean |
isPaginatorRenderLinkForActive()
'true' - render a link for the paginator's column with pageIndex = currentPageIndex. |
boolean |
isRendered()
|
abstract boolean |
isRenderFacetLinksIfFirstPage()
If the dataScroller is on the first page (index is at 1), links for first, prev and fastprev are rendered. |
abstract boolean |
isRenderFacetLinksIfLastPage()
If the dataScroller is on the last page (index is at pagecount), links for last, next and fastnext are rendered. |
abstract boolean |
isRenderFacetsIfSinglePage()
If set to false, the facets aren't renderd if all the lines are contained on a single page. |
boolean |
isSetDisplayValueOnly()
|
boolean |
isSingleElementLayout()
|
void |
queueEvent(javax.faces.event.FacesEvent event)
Catch any attempts to queue events for this component, and ensure the event's phase is set appropriately. |
void |
removeActionListener(javax.faces.event.ActionListener listener)
|
void |
restoreState(javax.faces.context.FacesContext facesContext,
java.lang.Object state)
|
java.lang.Object |
saveState(javax.faces.context.FacesContext facesContext)
|
void |
setAction(javax.faces.el.MethodBinding action)
|
void |
setActionExpression(javax.el.MethodExpression action)
|
void |
setActionListener(javax.faces.el.MethodBinding actionListener)
|
void |
setDisplayValueOnly(boolean displayValueOnly)
|
void |
setFastForward(javax.faces.component.UIComponent previous)
|
void |
setFastRewind(javax.faces.component.UIComponent previous)
|
void |
setFirst(javax.faces.component.UIComponent first)
|
protected void |
setFirst(javax.faces.component.UIData uiData,
int value)
|
void |
setLast(javax.faces.component.UIComponent last)
|
void |
setNext(javax.faces.component.UIComponent next)
|
void |
setPrevious(javax.faces.component.UIComponent previous)
|
Methods inherited from class javax.faces.component.UIPanel |
---|
getFamily |
Methods inherited from class javax.faces.component.UIComponentBase |
---|
addClientBehavior, addFacesListener, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getValueBinding, initialStateMarked, invokeOnComponent, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, visitTree |
Methods inherited from class javax.faces.component.UIComponent |
---|
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface javax.faces.component.ActionSource |
---|
setImmediate |
Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder |
---|
addClientBehavior, getClientBehaviors, getDefaultEventName, getEventNames |
Methods inherited from interface org.apache.myfaces.component.UserRoleAware |
---|
getEnabledOnUserRole, getVisibleOnUserRole, setEnabledOnUserRole, setVisibleOnUserRole |
Methods inherited from interface org.apache.myfaces.shared_tomahawk.component.DisplayValueOnlyCapable |
---|
getDisplayValueOnlyStyle, getDisplayValueOnlyStyleClass, setDisplayValueOnlyStyle, setDisplayValueOnlyStyleClass |
Methods inherited from interface org.apache.myfaces.component.DisplayValueOnlyAware |
---|
getDisplayValueOnly, getDisplayValueOnlyStyle, getDisplayValueOnlyStyleClass, setDisplayValueOnly, setDisplayValueOnlyStyle, setDisplayValueOnlyStyleClass |
Methods inherited from interface org.apache.myfaces.component.ForceIdAware |
---|
isForceId, isForceIdIndex, setForceId, setForceIdIndex |
Methods inherited from interface org.apache.myfaces.component.UniversalProperties |
---|
getDir, getLang, getTitle |
Methods inherited from interface org.apache.myfaces.component.StyleAware |
---|
getStyle, getStyleClass |
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 AbstractHtmlDataScroller()
Method Detail |
---|
public java.lang.String getClientId(javax.faces.context.FacesContext context)
getClientId
in class javax.faces.component.UIComponentBase
public boolean isRendered()
isRendered
in class javax.faces.component.UIComponentBase
public boolean isSetDisplayValueOnly()
isSetDisplayValueOnly
in interface DisplayValueOnlyCapable
public boolean isDisplayValueOnly()
isDisplayValueOnly
in interface DisplayValueOnlyCapable
public void setDisplayValueOnly(boolean displayValueOnly)
setDisplayValueOnly
in interface DisplayValueOnlyCapable
@JSFProperty(defaultValue="table") public abstract java.lang.String getLayout()
@JSFProperty(defaultValue="Integer.MIN_VALUE") public abstract int getColspan()
@JSFProperty(clientEvent="click") public abstract java.lang.String getOnclick()
@JSFProperty(clientEvent="dblclick") public abstract java.lang.String getOndblclick()
public boolean isListLayout()
public boolean isSingleElementLayout()
public void queueEvent(javax.faces.event.FacesEvent event)
When this component is marked "immediate", any ActionEvent will be marked to fire in the "apply request values" phase. When this component is not immediate the event will fire during the "invoke application" phase instead.
queueEvent
in class javax.faces.component.UIComponentBase
public void broadcast(javax.faces.event.FacesEvent event) throws javax.faces.event.AbortProcessingException
After listener invocation, the associated UIData's properties get updated:
broadcast
in class javax.faces.component.UIComponentBase
javax.faces.event.AbortProcessingException
protected void setFirst(javax.faces.component.UIData uiData, int value)
protected void broadcastToActionListener(ScrollerActionEvent event)
event
- public javax.faces.component.UIData getUIData()
public int getPageIndex()
public int getPageCount()
public int getRowCount()
public int getRows()
public int getFirstRow()
protected javax.faces.component.UIData findUIData()
If the "for" attribute is not null then that value is used to find the specified component by id. Both "relative" and "absolute" ids are allowed; see method UIComponent.findComponent for details.
If the "for" attribute is not defined, then this component is expected to be a child of a UIData component.
java.lang.IllegalArgumentException
- if an associated UIData component
cannot be found.public void setFirst(javax.faces.component.UIComponent first)
@JSFFacet public javax.faces.component.UIComponent getFirst()
public void setLast(javax.faces.component.UIComponent last)
@JSFFacet public javax.faces.component.UIComponent getLast()
public void setNext(javax.faces.component.UIComponent next)
@JSFFacet public javax.faces.component.UIComponent getNext()
public void setFastForward(javax.faces.component.UIComponent previous)
@JSFFacet public javax.faces.component.UIComponent getFastForward()
public void setFastRewind(javax.faces.component.UIComponent previous)
@JSFFacet public javax.faces.component.UIComponent getFastRewind()
public void setPrevious(javax.faces.component.UIComponent previous)
@JSFFacet public javax.faces.component.UIComponent getPrevious()
public boolean getRendersChildren()
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)
@JSFProperty(stateHolder=true, returnSignature="java.lang.Object", jspName="action", clientEvent="action") public javax.el.MethodExpression getActionExpression()
getActionExpression
in interface javax.faces.component.ActionSource2
public void setActionExpression(javax.el.MethodExpression action)
setActionExpression
in interface javax.faces.component.ActionSource2
public void setActionListener(javax.faces.el.MethodBinding actionListener)
setActionListener
in interface javax.faces.component.ActionSource
ActionSource.setActionListener(javax.faces.el.MethodBinding)
@JSFProperty(returnSignature="void", methodSignature="javax.faces.event.ActionEvent") 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.Object saveState(javax.faces.context.FacesContext facesContext)
saveState
in interface javax.faces.component.StateHolder
saveState
in class javax.faces.component.UIComponentBase
public void restoreState(javax.faces.context.FacesContext facesContext, java.lang.Object state)
restoreState
in interface javax.faces.component.StateHolder
restoreState
in class javax.faces.component.UIComponentBase
@JSFProperty public abstract java.lang.String getFor()
@JSFProperty(defaultValue="Integer.MIN_VALUE") public abstract int getFastStep()
@JSFProperty public abstract java.lang.String getPageIndexVar()
@JSFProperty public abstract java.lang.String getPageCountVar()
public abstract java.lang.String getRowsCountVar()
@JSFProperty public abstract java.lang.String getDisplayedRowsCountVar()
@JSFProperty public abstract java.lang.String getFirstRowIndexVar()
@JSFProperty public abstract java.lang.String getLastRowIndexVar()
@JSFProperty(defaultValue="false") public abstract boolean isPaginator()
@JSFProperty(defaultValue="Integer.MIN_VALUE") public abstract int getPaginatorMaxPages()
@JSFProperty public abstract java.lang.String getPaginatorTableClass()
@JSFProperty public abstract java.lang.String getPaginatorTableStyle()
@JSFProperty public abstract java.lang.String getPaginatorColumnClass()
@JSFProperty public abstract java.lang.String getPaginatorColumnStyle()
@JSFProperty public abstract java.lang.String getPaginatorActiveColumnClass()
@JSFProperty(defaultValue="true") public abstract boolean isPaginatorRenderLinkForActive()
@JSFProperty public abstract java.lang.String getFirstStyleClass()
@JSFProperty public abstract java.lang.String getLastStyleClass()
@JSFProperty public abstract java.lang.String getPreviousStyleClass()
@JSFProperty public abstract java.lang.String getNextStyleClass()
@JSFProperty public abstract java.lang.String getFastfStyleClass()
@JSFProperty public abstract java.lang.String getFastrStyleClass()
@JSFProperty public abstract java.lang.String getPaginatorActiveColumnStyle()
@JSFProperty(defaultValue="true") public abstract boolean isRenderFacetsIfSinglePage()
@JSFProperty(defaultValue="false") public abstract boolean isImmediate()
isImmediate
in interface javax.faces.component.ActionSource
@JSFProperty(defaultValue="false") public abstract boolean isDisableFacetLinksIfFirstPage()
@JSFProperty(defaultValue="false") public abstract boolean isDisableFacetLinksIfLastPage()
@JSFProperty(defaultValue="true") public abstract boolean isRenderFacetLinksIfFirstPage()
@JSFProperty(defaultValue="true") public abstract boolean isRenderFacetLinksIfLastPage()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |