|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object javax.faces.component.UIComponent javax.faces.component.UIComponentBase javax.faces.component.UIPanel org.apache.myfaces.custom.datascroller.AbstractHtmlDataScroller org.apache.myfaces.custom.datascroller.HtmlDataScroller
public class HtmlDataScroller
Field Summary | |
---|---|
static java.lang.String |
COMPONENT_FAMILY
|
static java.lang.String |
COMPONENT_TYPE
|
static java.lang.String |
DEFAULT_RENDERER_TYPE
|
Fields inherited from class org.apache.myfaces.custom.datascroller.AbstractHtmlDataScroller |
---|
FACET_FAST_FORWARD, FACET_FAST_REWIND, FACET_FIRST, FACET_LAST, FACET_NEXT, FACET_PREVIOUS |
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 | |
---|---|
HtmlDataScroller()
|
Method Summary | |
---|---|
int |
getColspan()
standard html colspan attribute for table cell |
java.lang.String |
getDir()
HTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left). |
java.lang.String |
getDisplayedRowsCountVar()
A parameter name, under which the actual displayed rows count is set in request scope similar to the var parameter. |
java.lang.Boolean |
getDisplayValueOnly()
If true, renders only the value of the component, but no input widget. |
java.lang.String |
getDisplayValueOnlyStyle()
Style used when displayValueOnly is true. |
java.lang.String |
getDisplayValueOnlyStyleClass()
Style class used when displayValueOnly is true. |
java.lang.String |
getEnabledOnUserRole()
If user is in given role, this component will be rendered normally. |
java.lang.String |
getFamily()
|
java.lang.String |
getFastfStyleClass()
style-class for data-scroller fast-forward-element |
java.lang.String |
getFastrStyleClass()
style-class for data-scroller fast-rewind-element |
int |
getFastStep()
step (pages) used for fastforward and fastrewind |
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. |
java.lang.String |
getFirstStyleClass()
style-class for data-scroller first-element |
java.lang.String |
getFor()
The JSF id of a UIData component that this scroller will affect. |
java.lang.String |
getLang()
HTML: The base language of this document. |
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. |
java.lang.String |
getLastStyleClass()
style-class for data-scroller last-element |
java.lang.String |
getLayout()
The layout this scroller should render with. |
java.lang.String |
getNextStyleClass()
style-class for dataScroller next-element |
java.lang.String |
getOnclick()
HTML: Script to be invoked when the element is clicked. |
java.lang.String |
getOndblclick()
HTML: Script to be invoked when the element is double-clicked. |
java.lang.String |
getPageCountVar()
A parameter name, under which the actual page count is set in request scope similar to the var parameter. |
java.lang.String |
getPageIndexVar()
A parameter name, under which the actual page index is set in request scope similar to the var parameter. |
java.lang.String |
getPaginatorActiveColumnClass()
styleClass for paginator's column with pageIndex = currentPageIndex |
java.lang.String |
getPaginatorActiveColumnStyle()
style for paginator's column with pageIndex = currentPageIndex |
java.lang.String |
getPaginatorColumnClass()
styleClass for paginator's column |
java.lang.String |
getPaginatorColumnStyle()
style for paginator's column |
int |
getPaginatorMaxPages()
The maximum amount of pages to be displayed in the paginator. |
java.lang.String |
getPaginatorTableClass()
styleclass for pagingator |
java.lang.String |
getPaginatorTableStyle()
style for pagingator |
java.lang.String |
getPreviousStyleClass()
style-class for data-scroller previous-element |
java.lang.String |
getRowsCountVar()
A parameter name, under which the actual rows count is set in request scope similar to the var parameter. |
java.lang.String |
getStyle()
HTML: CSS styling instructions. |
java.lang.String |
getStyleClass()
The CSS class for this element. |
java.lang.String |
getTitle()
HTML: An advisory title for this element. |
java.lang.String |
getVisibleOnUserRole()
If user is in given role, this component will be rendered normally. |
boolean |
isDisableFacetLinksIfFirstPage()
If the dataScroller is on the first page (index is at 1), links for first, prev and fastprev are disabled. |
boolean |
isDisableFacetLinksIfLastPage()
If the dataScroller is on the last page (index is at pagecount), links for last, next and fastnext are disabled. |
boolean |
isForceId()
If true, this component will force the use of the specified id when rendering. |
boolean |
isForceIdIndex()
If false, this component will not append a '[n]' suffix (where 'n' is the row index) to components that are contained within a "list." This value will be true by default and the value will be ignored if the value of forceId is false (or not specified.) |
boolean |
isImmediate()
True means that the default ActionListener should be executed immediately (i.e. |
boolean |
isPaginator()
If set true, then the paginator gets rendered |
boolean |
isPaginatorRenderLinkForActive()
'true' - render a link for the paginator's column with pageIndex = currentPageIndex. |
boolean |
isRenderFacetLinksIfFirstPage()
If the dataScroller is on the first page (index is at 1), links for first, prev and fastprev are rendered. |
boolean |
isRenderFacetLinksIfLastPage()
If the dataScroller is on the last page (index is at pagecount), links for last, next and fastnext are rendered. |
boolean |
isRenderFacetsIfSinglePage()
If set to false, the facets aren't renderd if all the lines are contained on a single page. |
void |
restoreState(javax.faces.context.FacesContext facesContext,
java.lang.Object state)
|
java.lang.Object |
saveState(javax.faces.context.FacesContext facesContext)
|
void |
setColspan(int colspan)
|
void |
setDir(java.lang.String dir)
|
void |
setDisableFacetLinksIfFirstPage(boolean disableFacetLinksIfFirstPage)
|
void |
setDisableFacetLinksIfLastPage(boolean disableFacetLinksIfLastPage)
|
void |
setDisplayedRowsCountVar(java.lang.String displayedRowsCountVar)
|
void |
setDisplayValueOnly(java.lang.Boolean displayValueOnly)
|
void |
setDisplayValueOnlyStyle(java.lang.String displayValueOnlyStyle)
|
void |
setDisplayValueOnlyStyleClass(java.lang.String displayValueOnlyStyleClass)
|
void |
setEnabledOnUserRole(java.lang.String enabledOnUserRole)
|
void |
setFastfStyleClass(java.lang.String fastfStyleClass)
|
void |
setFastrStyleClass(java.lang.String fastrStyleClass)
|
void |
setFastStep(int fastStep)
|
void |
setFirstRowIndexVar(java.lang.String firstRowIndexVar)
|
void |
setFirstStyleClass(java.lang.String firstStyleClass)
|
void |
setFor(java.lang.String forParam)
|
void |
setForceId(boolean forceId)
|
void |
setForceIdIndex(boolean forceIdIndex)
|
void |
setImmediate(boolean immediate)
|
void |
setLang(java.lang.String lang)
|
void |
setLastRowIndexVar(java.lang.String lastRowIndexVar)
|
void |
setLastStyleClass(java.lang.String lastStyleClass)
|
void |
setLayout(java.lang.String layout)
|
void |
setNextStyleClass(java.lang.String nextStyleClass)
|
void |
setOnclick(java.lang.String onclick)
|
void |
setOndblclick(java.lang.String ondblclick)
|
void |
setPageCountVar(java.lang.String pageCountVar)
|
void |
setPageIndexVar(java.lang.String pageIndexVar)
|
void |
setPaginator(boolean paginator)
|
void |
setPaginatorActiveColumnClass(java.lang.String paginatorActiveColumnClass)
|
void |
setPaginatorActiveColumnStyle(java.lang.String paginatorActiveColumnStyle)
|
void |
setPaginatorColumnClass(java.lang.String paginatorColumnClass)
|
void |
setPaginatorColumnStyle(java.lang.String paginatorColumnStyle)
|
void |
setPaginatorMaxPages(int paginatorMaxPages)
|
void |
setPaginatorRenderLinkForActive(boolean paginatorRenderLinkForActive)
|
void |
setPaginatorTableClass(java.lang.String paginatorTableClass)
|
void |
setPaginatorTableStyle(java.lang.String paginatorTableStyle)
|
void |
setPreviousStyleClass(java.lang.String previousStyleClass)
|
void |
setRenderFacetLinksIfFirstPage(boolean renderFacetLinksIfFirstPage)
|
void |
setRenderFacetLinksIfLastPage(boolean renderFacetLinksIfLastPage)
|
void |
setRenderFacetsIfSinglePage(boolean renderFacetsIfSinglePage)
|
void |
setRowsCountVar(java.lang.String rowsCountVar)
|
void |
setStyle(java.lang.String style)
|
void |
setStyleClass(java.lang.String styleClass)
|
void |
setTitle(java.lang.String title)
|
void |
setVisibleOnUserRole(java.lang.String visibleOnUserRole)
|
Methods inherited from class org.apache.myfaces.custom.datascroller.AbstractHtmlDataScroller |
---|
addActionListener, broadcast, broadcastToActionListener, findUIData, getAction, getActionListener, getActionListeners, getClientId, getFastForward, getFastRewind, getFirst, getFirstRow, getLast, getNext, getPageCount, getPageIndex, getPrevious, getRendersChildren, getRowCount, getRows, getUIData, isDisplayValueOnly, isListLayout, isRendered, isSetDisplayValueOnly, isSingleElementLayout, queueEvent, removeActionListener, setAction, setActionListener, setDisplayValueOnly, setFastForward, setFastRewind, setFirst, setFirst, setLast, setNext, setPrevious |
Methods inherited from class javax.faces.component.UIComponentBase |
---|
addFacesListener, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getValueBinding, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding |
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_FAMILY
public static final java.lang.String COMPONENT_TYPE
public static final java.lang.String DEFAULT_RENDERER_TYPE
Constructor Detail |
---|
public HtmlDataScroller()
Method Detail |
---|
public java.lang.String getFamily()
getFamily
in class javax.faces.component.UIPanel
public java.lang.String getLayout()
AbstractHtmlDataScroller
getLayout
in class AbstractHtmlDataScroller
public void setLayout(java.lang.String layout)
public int getColspan()
AbstractHtmlDataScroller
getColspan
in class AbstractHtmlDataScroller
public void setColspan(int colspan)
public java.lang.String getOnclick()
AbstractHtmlDataScroller
getOnclick
in class AbstractHtmlDataScroller
public void setOnclick(java.lang.String onclick)
public java.lang.String getOndblclick()
AbstractHtmlDataScroller
getOndblclick
in class AbstractHtmlDataScroller
public void setOndblclick(java.lang.String ondblclick)
public java.lang.String getFor()
AbstractHtmlDataScroller
getFor
in class AbstractHtmlDataScroller
public void setFor(java.lang.String forParam)
public int getFastStep()
AbstractHtmlDataScroller
getFastStep
in class AbstractHtmlDataScroller
public void setFastStep(int fastStep)
public java.lang.String getPageIndexVar()
AbstractHtmlDataScroller
getPageIndexVar
in class AbstractHtmlDataScroller
public void setPageIndexVar(java.lang.String pageIndexVar)
public java.lang.String getPageCountVar()
AbstractHtmlDataScroller
getPageCountVar
in class AbstractHtmlDataScroller
public void setPageCountVar(java.lang.String pageCountVar)
public java.lang.String getRowsCountVar()
AbstractHtmlDataScroller
getRowsCountVar
in class AbstractHtmlDataScroller
public void setRowsCountVar(java.lang.String rowsCountVar)
public java.lang.String getDisplayedRowsCountVar()
AbstractHtmlDataScroller
getDisplayedRowsCountVar
in class AbstractHtmlDataScroller
public void setDisplayedRowsCountVar(java.lang.String displayedRowsCountVar)
public java.lang.String getFirstRowIndexVar()
AbstractHtmlDataScroller
getFirstRowIndexVar
in class AbstractHtmlDataScroller
public void setFirstRowIndexVar(java.lang.String firstRowIndexVar)
public java.lang.String getLastRowIndexVar()
AbstractHtmlDataScroller
getLastRowIndexVar
in class AbstractHtmlDataScroller
public void setLastRowIndexVar(java.lang.String lastRowIndexVar)
public boolean isPaginator()
AbstractHtmlDataScroller
isPaginator
in class AbstractHtmlDataScroller
public void setPaginator(boolean paginator)
public int getPaginatorMaxPages()
AbstractHtmlDataScroller
getPaginatorMaxPages
in class AbstractHtmlDataScroller
public void setPaginatorMaxPages(int paginatorMaxPages)
public java.lang.String getPaginatorTableClass()
AbstractHtmlDataScroller
getPaginatorTableClass
in class AbstractHtmlDataScroller
public void setPaginatorTableClass(java.lang.String paginatorTableClass)
public java.lang.String getPaginatorTableStyle()
AbstractHtmlDataScroller
getPaginatorTableStyle
in class AbstractHtmlDataScroller
public void setPaginatorTableStyle(java.lang.String paginatorTableStyle)
public java.lang.String getPaginatorColumnClass()
AbstractHtmlDataScroller
getPaginatorColumnClass
in class AbstractHtmlDataScroller
public void setPaginatorColumnClass(java.lang.String paginatorColumnClass)
public java.lang.String getPaginatorColumnStyle()
AbstractHtmlDataScroller
getPaginatorColumnStyle
in class AbstractHtmlDataScroller
public void setPaginatorColumnStyle(java.lang.String paginatorColumnStyle)
public java.lang.String getPaginatorActiveColumnClass()
AbstractHtmlDataScroller
getPaginatorActiveColumnClass
in class AbstractHtmlDataScroller
public void setPaginatorActiveColumnClass(java.lang.String paginatorActiveColumnClass)
public boolean isPaginatorRenderLinkForActive()
AbstractHtmlDataScroller
isPaginatorRenderLinkForActive
in class AbstractHtmlDataScroller
public void setPaginatorRenderLinkForActive(boolean paginatorRenderLinkForActive)
public java.lang.String getFirstStyleClass()
AbstractHtmlDataScroller
getFirstStyleClass
in class AbstractHtmlDataScroller
public void setFirstStyleClass(java.lang.String firstStyleClass)
public java.lang.String getLastStyleClass()
AbstractHtmlDataScroller
getLastStyleClass
in class AbstractHtmlDataScroller
public void setLastStyleClass(java.lang.String lastStyleClass)
public java.lang.String getPreviousStyleClass()
AbstractHtmlDataScroller
getPreviousStyleClass
in class AbstractHtmlDataScroller
public void setPreviousStyleClass(java.lang.String previousStyleClass)
public java.lang.String getNextStyleClass()
AbstractHtmlDataScroller
getNextStyleClass
in class AbstractHtmlDataScroller
public void setNextStyleClass(java.lang.String nextStyleClass)
public java.lang.String getFastfStyleClass()
AbstractHtmlDataScroller
getFastfStyleClass
in class AbstractHtmlDataScroller
public void setFastfStyleClass(java.lang.String fastfStyleClass)
public java.lang.String getFastrStyleClass()
AbstractHtmlDataScroller
getFastrStyleClass
in class AbstractHtmlDataScroller
public void setFastrStyleClass(java.lang.String fastrStyleClass)
public java.lang.String getPaginatorActiveColumnStyle()
AbstractHtmlDataScroller
getPaginatorActiveColumnStyle
in class AbstractHtmlDataScroller
public void setPaginatorActiveColumnStyle(java.lang.String paginatorActiveColumnStyle)
public boolean isRenderFacetsIfSinglePage()
AbstractHtmlDataScroller
isRenderFacetsIfSinglePage
in class AbstractHtmlDataScroller
public void setRenderFacetsIfSinglePage(boolean renderFacetsIfSinglePage)
public boolean isImmediate()
AbstractHtmlDataScroller
isImmediate
in interface javax.faces.component.ActionSource
isImmediate
in class AbstractHtmlDataScroller
public void setImmediate(boolean immediate)
public boolean isDisableFacetLinksIfFirstPage()
AbstractHtmlDataScroller
isDisableFacetLinksIfFirstPage
in class AbstractHtmlDataScroller
public void setDisableFacetLinksIfFirstPage(boolean disableFacetLinksIfFirstPage)
public boolean isDisableFacetLinksIfLastPage()
AbstractHtmlDataScroller
isDisableFacetLinksIfLastPage
in class AbstractHtmlDataScroller
public void setDisableFacetLinksIfLastPage(boolean disableFacetLinksIfLastPage)
public boolean isRenderFacetLinksIfFirstPage()
AbstractHtmlDataScroller
isRenderFacetLinksIfFirstPage
in class AbstractHtmlDataScroller
public void setRenderFacetLinksIfFirstPage(boolean renderFacetLinksIfFirstPage)
public boolean isRenderFacetLinksIfLastPage()
AbstractHtmlDataScroller
isRenderFacetLinksIfLastPage
in class AbstractHtmlDataScroller
public void setRenderFacetLinksIfLastPage(boolean renderFacetLinksIfLastPage)
public java.lang.Boolean getDisplayValueOnly()
DisplayValueOnlyAware
public void setDisplayValueOnly(java.lang.Boolean displayValueOnly)
public java.lang.String getDisplayValueOnlyStyle()
DisplayValueOnlyAware
public void setDisplayValueOnlyStyle(java.lang.String displayValueOnlyStyle)
public java.lang.String getDisplayValueOnlyStyleClass()
DisplayValueOnlyAware
public void setDisplayValueOnlyStyleClass(java.lang.String displayValueOnlyStyleClass)
public java.lang.String getEnabledOnUserRole()
UserRoleAware
public void setEnabledOnUserRole(java.lang.String enabledOnUserRole)
public java.lang.String getVisibleOnUserRole()
UserRoleAware
public void setVisibleOnUserRole(java.lang.String visibleOnUserRole)
public boolean isForceId()
ForceIdAware
public void setForceId(boolean forceId)
public boolean isForceIdIndex()
ForceIdAware
public void setForceIdIndex(boolean forceIdIndex)
public java.lang.String getDir()
UniversalProperties
public void setDir(java.lang.String dir)
public java.lang.String getLang()
UniversalProperties
public void setLang(java.lang.String lang)
public java.lang.String getTitle()
UniversalProperties
public void setTitle(java.lang.String title)
public java.lang.String getStyle()
StyleAware
public void setStyle(java.lang.String style)
public java.lang.String getStyleClass()
StyleAware
public void setStyleClass(java.lang.String styleClass)
public java.lang.Object saveState(javax.faces.context.FacesContext facesContext)
saveState
in interface javax.faces.component.StateHolder
saveState
in class AbstractHtmlDataScroller
public void restoreState(javax.faces.context.FacesContext facesContext, java.lang.Object state)
restoreState
in interface javax.faces.component.StateHolder
restoreState
in class AbstractHtmlDataScroller
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |