dataScroller (Tomahawk 2.0 Core Tag library documentation)

Overview

Library

Tag

Help

FRAMES NO FRAMES

Tomahawk tag library 2.0.
Tag dataScroller

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.

Tag Information
Tag Class	org.apache.myfaces.custom.datascroller.HtmlDataScrollerTag
TagExtraInfo Class	None
Body Content	JSP
Display Name	None

Attributes
Name	Required	Request-time	Type	Description
layout	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	The layout this scroller should render with. Default is 'table', 'list' is implemented as well. Additionally you can use 'singleList' - then the data-scroller will render a list, but not the paginator - same with the value 'singleTable'.
colspan	false	false	`javax.el.ValueExpression` (must evaluate to `int`)	standard html colspan attribute for table cell
onclick	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	HTML: Script to be invoked when the element is clicked.
ondblclick	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	HTML: Script to be invoked when the element is double-clicked.
action	false	false	`javax.el.MethodExpression` (signature must match `java.lang.Object myMethod( )`)	No Description
actionListener	false	false	`javax.el.MethodExpression` (signature must match `void myMethod( javax.faces.event.ActionEvent )`)	MethodBinding pointing at method acception an ActionEvent with return type void.
for	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	The JSF id of a UIData component that this scroller will affect. If this attribute is not present then the datascroller must be a child of a UIData component.
fastStep	false	false	`javax.el.ValueExpression` (must evaluate to `int`)	step (pages) used for fastforward and fastrewind
pageIndexVar	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	A parameter name, under which the actual page index is set in request scope similar to the var parameter.
pageCountVar	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	A parameter name, under which the actual page count is set in request scope similar to the var parameter.
rowsCountVar	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	A parameter name, under which the actual rows count is set in request scope similar to the var parameter.
displayedRowsCountVar	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	A parameter name, under which the actual displayed rows count is set in request scope similar to the var parameter.
firstRowIndexVar	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	A parameter name, under which the actual first displayed row index is set in request scope similar to the var parameter.
lastRowIndexVar	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	A parameter name, under which the actual last displayed row index is set in request scope similar to the var parameter.
paginator	false	false	`javax.el.ValueExpression` (must evaluate to `boolean`)	If set true, then the paginator gets rendered
paginatorMaxPages	false	false	`javax.el.ValueExpression` (must evaluate to `int`)	The maximum amount of pages to be displayed in the paginator.
paginatorTableClass	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	styleclass for pagingator
paginatorTableStyle	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	style for pagingator
paginatorColumnClass	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	styleClass for paginator's column
paginatorColumnStyle	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	style for paginator's column
paginatorActiveColumnClass	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	styleClass for paginator's column with pageIndex = currentPageIndex
paginatorRenderLinkForActive	false	false	`javax.el.ValueExpression` (must evaluate to `boolean`)	'true' - render a link for the paginator's column with pageIndex = currentPageIndex. Default-value is 'true'.
firstStyleClass	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	style-class for data-scroller first-element
lastStyleClass	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	style-class for data-scroller last-element
previousStyleClass	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	style-class for data-scroller previous-element
nextStyleClass	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	style-class for dataScroller next-element
fastfStyleClass	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	style-class for data-scroller fast-forward-element
fastrStyleClass	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	style-class for data-scroller fast-rewind-element
paginatorActiveColumnStyle	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	style for paginator's column with pageIndex = currentPageIndex
renderFacetsIfSinglePage	false	false	`javax.el.ValueExpression` (must evaluate to `boolean`)	If set to false, the facets aren't renderd if all the lines are contained on a single page. Default is true.
immediate	false	false	`javax.el.ValueExpression` (must evaluate to `boolean`)	True means that the default ActionListener should be executed immediately (i.e. during Apply Request Values phase of the request processing lifecycle), rather than waiting until the Invoke Application phase.
disableFacetLinksIfFirstPage	false	false	`javax.el.ValueExpression` (must evaluate to `boolean`)	If the dataScroller is on the first page (index is at 1), links for first, prev and fastprev are disabled. Default is false.
disableFacetLinksIfLastPage	false	false	`javax.el.ValueExpression` (must evaluate to `boolean`)	If the dataScroller is on the last page (index is at pagecount), links for last, next and fastnext are disabled. Default is false.
renderFacetLinksIfFirstPage	false	false	`javax.el.ValueExpression` (must evaluate to `boolean`)	If the dataScroller is on the first page (index is at 1), links for first, prev and fastprev are rendered. Default is true.
renderFacetLinksIfLastPage	false	false	`javax.el.ValueExpression` (must evaluate to `boolean`)	If the dataScroller is on the last page (index is at pagecount), links for last, next and fastnext are rendered. Default is true.
displayValueOnly	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	If true, renders only the value of the component, but no input widget. Default is false.
displayValueOnlyStyle	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Style used when displayValueOnly is true.
displayValueOnlyStyleClass	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Style class used when displayValueOnly is true.
enabledOnUserRole	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	If user is in given role, this component will be rendered normally. If not, no hyperlink is rendered but all nested tags (=body) are rendered.
visibleOnUserRole	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	If user is in given role, this component will be rendered normally. If not, nothing is rendered and the body of this tag will be skipped.
forceId	false	false	`java.lang.String`	If true, this component will force the use of the specified id when rendering.
forceIdIndex	false	false	`java.lang.String`	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.)
dir	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	HTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
lang	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	HTML: The base language of this document.
title	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	HTML: An advisory title for this element. Often used by the user agent as a tooltip.
style	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	HTML: CSS styling instructions.
styleClass	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	The CSS class for this element. Corresponds to the HTML 'class' attribute.
id	false	true	`java.lang.String`	Get a string which uniquely identifies this UIComponent within the scope of the nearest ancestor NamingContainer component. The id is not necessarily unique across all components in the current view.
rendered	false	false	`javax.el.ValueExpression` (must evaluate to `boolean`)	A boolean value that indicates whether this component should be rendered. Default value: true.
binding	false	false	`javax.el.ValueExpression` (must evaluate to `javax.faces.component.UIComponent`)	Identifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.

Variables
No Variables Defined.

Overview

Library

Tag

Help

FRAMES NO FRAMES

Output Generated by Tag Library Documentation Generator. Java, JSP, and JavaServer Pages are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries. Copyright 2002-4 Sun Microsystems, Inc. 4150 Network Circle Santa Clara, CA 95054, U.S.A. All Rights Reserved.

Tomahawk tag library 2.0. Tag dataScroller

Tomahawk tag library 2.0.
Tag dataScroller