|
||||||||||
| 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
org.apache.myfaces.custom.datascroller.HtmlDataScroller
public class HtmlDataScroller
| Nested Class Summary | |
|---|---|
protected static class |
HtmlDataScroller.PropertyKeys
|
| Field Summary | |
|---|---|
static String |
COMPONENT_FAMILY
|
static String |
COMPONENT_TYPE
|
static 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 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 | |
|---|---|
HtmlDataScroller()
|
|
| Method Summary | |
|---|---|
void |
addClientBehavior(String eventName,
javax.faces.component.behavior.ClientBehavior behavior)
|
int |
getColspan()
standard html colspan attribute for table cell |
String |
getDefaultEventName()
|
String |
getDir()
HTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left). |
String |
getDisplayedRowsCountVar()
A parameter name, under which the actual displayed rows count is set in request scope similar to the var parameter. |
Boolean |
getDisplayValueOnly()
If true, renders only the value of the component, but no input widget. |
String |
getDisplayValueOnlyStyle()
Style used when displayValueOnly is true. |
String |
getDisplayValueOnlyStyleClass()
Style class used when displayValueOnly is true. |
String |
getEnabledOnUserRole()
If user is in given role, this component will be rendered normally. |
Collection<String> |
getEventNames()
|
String |
getFamily()
|
String |
getFastfStyleClass()
style-class for data-scroller fast-forward-element |
String |
getFastrStyleClass()
style-class for data-scroller fast-rewind-element |
int |
getFastStep()
step (pages) used for fastforward and fastrewind |
String |
getFirstRowIndexVar()
A parameter name, under which the actual first displayed row index is set in request scope similar to the var parameter. |
String |
getFirstStyleClass()
style-class for data-scroller first-element |
String |
getFor()
The JSF id of a UIData component that this scroller will affect. |
String |
getLang()
HTML: The base language of this document. |
String |
getLastRowIndexVar()
A parameter name, under which the actual last displayed row index is set in request scope similar to the var parameter. |
String |
getLastStyleClass()
style-class for data-scroller last-element |
String |
getLayout()
The layout this scroller should render with. |
String |
getNextStyleClass()
style-class for dataScroller next-element |
String |
getOnclick()
HTML: Script to be invoked when the element is clicked. |
String |
getOndblclick()
HTML: Script to be invoked when the element is double-clicked. |
String |
getPageCountVar()
A parameter name, under which the actual page count is set in request scope similar to the var parameter. |
String |
getPageIndexVar()
A parameter name, under which the actual page index is set in request scope similar to the var parameter. |
String |
getPaginatorActiveColumnClass()
styleClass for paginator's column with pageIndex = currentPageIndex |
String |
getPaginatorActiveColumnStyle()
style for paginator's column with pageIndex = currentPageIndex |
String |
getPaginatorColumnClass()
styleClass for paginator's column |
String |
getPaginatorColumnStyle()
style for paginator's column |
int |
getPaginatorMaxPages()
The maximum amount of pages to be displayed in the paginator. |
String |
getPaginatorTableClass()
styleclass for pagingator |
String |
getPaginatorTableStyle()
style for pagingator |
String |
getPreviousStyleClass()
style-class for data-scroller previous-element |
String |
getRowsCountVar()
A parameter name, under which the actual rows count is set in request scope similar to the var parameter. |
String |
getStyle()
HTML: CSS styling instructions. |
String |
getStyleClass()
The CSS class for this element. |
String |
getTitle()
HTML: An advisory title for this element. |
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 |
setColspan(int colspan)
|
void |
setDir(String dir)
|
void |
setDisableFacetLinksIfFirstPage(boolean disableFacetLinksIfFirstPage)
|
void |
setDisableFacetLinksIfLastPage(boolean disableFacetLinksIfLastPage)
|
void |
setDisplayedRowsCountVar(String displayedRowsCountVar)
|
void |
setDisplayValueOnly(Boolean displayValueOnly)
|
void |
setDisplayValueOnlyStyle(String displayValueOnlyStyle)
|
void |
setDisplayValueOnlyStyleClass(String displayValueOnlyStyleClass)
|
void |
setEnabledOnUserRole(String enabledOnUserRole)
|
void |
setFastfStyleClass(String fastfStyleClass)
|
void |
setFastrStyleClass(String fastrStyleClass)
|
void |
setFastStep(int fastStep)
|
void |
setFirstRowIndexVar(String firstRowIndexVar)
|
void |
setFirstStyleClass(String firstStyleClass)
|
void |
setFor(String forParam)
|
void |
setForceId(boolean forceId)
|
void |
setForceIdIndex(boolean forceIdIndex)
|
void |
setImmediate(boolean immediate)
|
void |
setLang(String lang)
|
void |
setLastRowIndexVar(String lastRowIndexVar)
|
void |
setLastStyleClass(String lastStyleClass)
|
void |
setLayout(String layout)
|
void |
setNextStyleClass(String nextStyleClass)
|
void |
setOnclick(String onclick)
|
void |
setOndblclick(String ondblclick)
|
void |
setPageCountVar(String pageCountVar)
|
void |
setPageIndexVar(String pageIndexVar)
|
void |
setPaginator(boolean paginator)
|
void |
setPaginatorActiveColumnClass(String paginatorActiveColumnClass)
|
void |
setPaginatorActiveColumnStyle(String paginatorActiveColumnStyle)
|
void |
setPaginatorColumnClass(String paginatorColumnClass)
|
void |
setPaginatorColumnStyle(String paginatorColumnStyle)
|
void |
setPaginatorMaxPages(int paginatorMaxPages)
|
void |
setPaginatorRenderLinkForActive(boolean paginatorRenderLinkForActive)
|
void |
setPaginatorTableClass(String paginatorTableClass)
|
void |
setPaginatorTableStyle(String paginatorTableStyle)
|
void |
setPreviousStyleClass(String previousStyleClass)
|
void |
setRenderFacetLinksIfFirstPage(boolean renderFacetLinksIfFirstPage)
|
void |
setRenderFacetLinksIfLastPage(boolean renderFacetLinksIfLastPage)
|
void |
setRenderFacetsIfSinglePage(boolean renderFacetsIfSinglePage)
|
void |
setRowsCountVar(String rowsCountVar)
|
void |
setStyle(String style)
|
void |
setStyleClass(String styleClass)
|
void |
setTitle(String title)
|
void |
setValueBinding(String name,
javax.faces.el.ValueBinding binding)
|
void |
setValueExpression(String name,
javax.el.ValueExpression expression)
|
void |
setVisibleOnUserRole(String visibleOnUserRole)
|
| Methods inherited from class org.apache.myfaces.custom.datascroller.AbstractHtmlDataScroller |
|---|
addActionListener, broadcast, broadcastToActionListener, findUIData, getAction, getActionExpression, getActionListener, getActionListeners, getClientId, getFastForward, getFastRewind, getFirst, getFirstRow, getLast, getNext, getPageCount, getPageIndex, getPrevious, getRendersChildren, getRowCount, getRows, getUIData, isDisplayValueOnly, isListLayout, isRendered, isSetDisplayValueOnly, isSingleElementLayout, queueEvent, removeActionListener, restoreState, saveState, setAction, setActionExpression, setActionListener, setDisplayValueOnly, setFastForward, setFastRewind, setFirst, setFirst, setLast, setNext, setPrevious |
| Methods inherited from class javax.faces.component.UIComponentBase |
|---|
addFacesListener, clearInitialState, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, 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, visitTree |
| Methods inherited from class javax.faces.component.UIComponent |
|---|
getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, setInView, 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.behavior.ClientBehaviorHolder |
|---|
getClientBehaviors |
| Field Detail |
|---|
public static final String COMPONENT_FAMILY
public static final String COMPONENT_TYPE
public static final String DEFAULT_RENDERER_TYPE
| Constructor Detail |
|---|
public HtmlDataScroller()
| Method Detail |
|---|
public String getFamily()
getFamily in class javax.faces.component.UIPanelpublic Collection<String> getEventNames()
getEventNames in interface javax.faces.component.behavior.ClientBehaviorHoldergetEventNames in class javax.faces.component.UIComponentBase
public void addClientBehavior(String eventName,
javax.faces.component.behavior.ClientBehavior behavior)
addClientBehavior in interface javax.faces.component.behavior.ClientBehaviorHolderaddClientBehavior in class javax.faces.component.UIComponentBasepublic String getDefaultEventName()
getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHoldergetDefaultEventName in class javax.faces.component.UIComponentBasepublic String getLayout()
AbstractHtmlDataScroller
getLayout in class AbstractHtmlDataScrollerpublic void setLayout(String layout)
public int getColspan()
AbstractHtmlDataScroller
getColspan in class AbstractHtmlDataScrollerpublic void setColspan(int colspan)
public String getOnclick()
AbstractHtmlDataScroller
getOnclick in class AbstractHtmlDataScrollerpublic void setOnclick(String onclick)
public String getOndblclick()
AbstractHtmlDataScroller
getOndblclick in class AbstractHtmlDataScrollerpublic void setOndblclick(String ondblclick)
public String getFor()
AbstractHtmlDataScroller
getFor in class AbstractHtmlDataScrollerpublic void setFor(String forParam)
public int getFastStep()
AbstractHtmlDataScroller
getFastStep in class AbstractHtmlDataScrollerpublic void setFastStep(int fastStep)
public String getPageIndexVar()
AbstractHtmlDataScroller
getPageIndexVar in class AbstractHtmlDataScrollerpublic void setPageIndexVar(String pageIndexVar)
public String getPageCountVar()
AbstractHtmlDataScroller
getPageCountVar in class AbstractHtmlDataScrollerpublic void setPageCountVar(String pageCountVar)
public String getRowsCountVar()
AbstractHtmlDataScroller
getRowsCountVar in class AbstractHtmlDataScrollerpublic void setRowsCountVar(String rowsCountVar)
public String getDisplayedRowsCountVar()
AbstractHtmlDataScroller
getDisplayedRowsCountVar in class AbstractHtmlDataScrollerpublic void setDisplayedRowsCountVar(String displayedRowsCountVar)
public String getFirstRowIndexVar()
AbstractHtmlDataScroller
getFirstRowIndexVar in class AbstractHtmlDataScrollerpublic void setFirstRowIndexVar(String firstRowIndexVar)
public String getLastRowIndexVar()
AbstractHtmlDataScroller
getLastRowIndexVar in class AbstractHtmlDataScrollerpublic void setLastRowIndexVar(String lastRowIndexVar)
public boolean isPaginator()
AbstractHtmlDataScroller
isPaginator in class AbstractHtmlDataScrollerpublic void setPaginator(boolean paginator)
public int getPaginatorMaxPages()
AbstractHtmlDataScroller
getPaginatorMaxPages in class AbstractHtmlDataScrollerpublic void setPaginatorMaxPages(int paginatorMaxPages)
public String getPaginatorTableClass()
AbstractHtmlDataScroller
getPaginatorTableClass in class AbstractHtmlDataScrollerpublic void setPaginatorTableClass(String paginatorTableClass)
public String getPaginatorTableStyle()
AbstractHtmlDataScroller
getPaginatorTableStyle in class AbstractHtmlDataScrollerpublic void setPaginatorTableStyle(String paginatorTableStyle)
public String getPaginatorColumnClass()
AbstractHtmlDataScroller
getPaginatorColumnClass in class AbstractHtmlDataScrollerpublic void setPaginatorColumnClass(String paginatorColumnClass)
public String getPaginatorColumnStyle()
AbstractHtmlDataScroller
getPaginatorColumnStyle in class AbstractHtmlDataScrollerpublic void setPaginatorColumnStyle(String paginatorColumnStyle)
public String getPaginatorActiveColumnClass()
AbstractHtmlDataScroller
getPaginatorActiveColumnClass in class AbstractHtmlDataScrollerpublic void setPaginatorActiveColumnClass(String paginatorActiveColumnClass)
public boolean isPaginatorRenderLinkForActive()
AbstractHtmlDataScroller
isPaginatorRenderLinkForActive in class AbstractHtmlDataScrollerpublic void setPaginatorRenderLinkForActive(boolean paginatorRenderLinkForActive)
public String getFirstStyleClass()
AbstractHtmlDataScroller
getFirstStyleClass in class AbstractHtmlDataScrollerpublic void setFirstStyleClass(String firstStyleClass)
public String getLastStyleClass()
AbstractHtmlDataScroller
getLastStyleClass in class AbstractHtmlDataScrollerpublic void setLastStyleClass(String lastStyleClass)
public String getPreviousStyleClass()
AbstractHtmlDataScroller
getPreviousStyleClass in class AbstractHtmlDataScrollerpublic void setPreviousStyleClass(String previousStyleClass)
public String getNextStyleClass()
AbstractHtmlDataScroller
getNextStyleClass in class AbstractHtmlDataScrollerpublic void setNextStyleClass(String nextStyleClass)
public String getFastfStyleClass()
AbstractHtmlDataScroller
getFastfStyleClass in class AbstractHtmlDataScrollerpublic void setFastfStyleClass(String fastfStyleClass)
public String getFastrStyleClass()
AbstractHtmlDataScroller
getFastrStyleClass in class AbstractHtmlDataScrollerpublic void setFastrStyleClass(String fastrStyleClass)
public String getPaginatorActiveColumnStyle()
AbstractHtmlDataScroller
getPaginatorActiveColumnStyle in class AbstractHtmlDataScrollerpublic void setPaginatorActiveColumnStyle(String paginatorActiveColumnStyle)
public boolean isRenderFacetsIfSinglePage()
AbstractHtmlDataScroller
isRenderFacetsIfSinglePage in class AbstractHtmlDataScrollerpublic void setRenderFacetsIfSinglePage(boolean renderFacetsIfSinglePage)
public boolean isImmediate()
AbstractHtmlDataScroller
isImmediate in interface javax.faces.component.ActionSourceisImmediate in class AbstractHtmlDataScrollerpublic void setImmediate(boolean immediate)
public boolean isDisableFacetLinksIfFirstPage()
AbstractHtmlDataScroller
isDisableFacetLinksIfFirstPage in class AbstractHtmlDataScrollerpublic void setDisableFacetLinksIfFirstPage(boolean disableFacetLinksIfFirstPage)
public boolean isDisableFacetLinksIfLastPage()
AbstractHtmlDataScroller
isDisableFacetLinksIfLastPage in class AbstractHtmlDataScrollerpublic void setDisableFacetLinksIfLastPage(boolean disableFacetLinksIfLastPage)
public boolean isRenderFacetLinksIfFirstPage()
AbstractHtmlDataScroller
isRenderFacetLinksIfFirstPage in class AbstractHtmlDataScrollerpublic void setRenderFacetLinksIfFirstPage(boolean renderFacetLinksIfFirstPage)
public boolean isRenderFacetLinksIfLastPage()
AbstractHtmlDataScroller
isRenderFacetLinksIfLastPage in class AbstractHtmlDataScrollerpublic void setRenderFacetLinksIfLastPage(boolean renderFacetLinksIfLastPage)
public Boolean getDisplayValueOnly()
DisplayValueOnlyAware
public void setDisplayValueOnly(Boolean displayValueOnly)
public String getDisplayValueOnlyStyle()
DisplayValueOnlyAware
public void setDisplayValueOnlyStyle(String displayValueOnlyStyle)
public String getDisplayValueOnlyStyleClass()
DisplayValueOnlyAware
public void setDisplayValueOnlyStyleClass(String displayValueOnlyStyleClass)
public String getEnabledOnUserRole()
UserRoleAware
public void setEnabledOnUserRole(String enabledOnUserRole)
public String getVisibleOnUserRole()
UserRoleAware
public void setVisibleOnUserRole(String visibleOnUserRole)
public boolean isForceId()
ForceIdAware
public void setForceId(boolean forceId)
public boolean isForceIdIndex()
ForceIdAware
public void setForceIdIndex(boolean forceIdIndex)
public String getDir()
UniversalProperties
public void setDir(String dir)
public String getLang()
UniversalProperties
public void setLang(String lang)
public String getTitle()
UniversalProperties
public void setTitle(String title)
public String getStyle()
StyleAware
public void setStyle(String style)
public String getStyleClass()
StyleAware
public void setStyleClass(String styleClass)
public void setValueBinding(String name,
javax.faces.el.ValueBinding binding)
setValueBinding in class javax.faces.component.UIComponentBase
public void setValueExpression(String name,
javax.el.ValueExpression expression)
setValueExpression in class javax.faces.component.UIComponent
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||