org.apache.myfaces.custom.datalist
Class AbstractHtmlDataList

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIData
              javax.faces.component.html.HtmlDataTable
                  org.apache.myfaces.component.html.ext.HtmlDataTableHack
                      org.apache.myfaces.custom.datalist.AbstractHtmlDataList

All Implemented Interfaces:

EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.NamingContainer, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.UniqueIdVendor, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, org.apache.myfaces.component.UserRoleAware, org.apache.myfaces.custom.ExtendedComponentBase

public abstract class AbstractHtmlDataList
extends HtmlDataTableHack
implements org.apache.myfaces.component.UserRoleAware

Similar to dataTable, but does not render a table. Instead the layout attribute controls how each dataRow is rendered. Unless otherwise specified, all attributes accept static values or EL expressions.

Since:

1.1.7

Version:

$Revision: 940152 $ $Date: 2010-05-01 21:03:39 -0500 (Sáb, 01 May 2010) $

Author:

Manfred Geiler (latest modification by $Author: lu4242 $)

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.myfaces.component.html.ext.HtmlDataTableHack

HtmlDataTableHack.PropertyKeys

Field Summary

static String

COMPONENT_TYPE

Fields inherited from class javax.faces.component.html.HtmlDataTable

COMPONENT_FAMILY

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 javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

AbstractHtmlDataList()

Method Summary

protected javax.faces.context.FacesContext	getFacesContext()
abstract String	getItemOnClick() OnClick handler to be applied to individual items in the list
abstract String	getItemStyleClass() CSS class to be applied to individual items in the list
abstract String	getLayout() simple|unorderedList|orderedList simple = for each dataRow all children are simply rendered unorderedList = the list is rendered as HTML unordered list (= bullet list) orderedList = the list is rendered as HTML ordered list Default: simple
abstract String	getRowCountVar() A parameter name, under which the rowCount is set in request scope similar to the var parameter.
abstract String	getRowIndexVar() A parameter name, under which the current rowIndex is set in request scope similar to the var parameter.
boolean	invokeOnComponent(javax.faces.context.FacesContext context, String clientId, javax.faces.component.ContextCallback callback)
void	processChildren(javax.faces.context.FacesContext context, int processAction) Iterates over all children, processes each according to the specified process action if the child is rendered.
void	processDecodes(javax.faces.context.FacesContext context) Throws NullPointerException if context is null.
void	processUpdates(javax.faces.context.FacesContext context)
void	processValidators(javax.faces.context.FacesContext context)
protected void	restoreDescendantComponentStates(Object state)
protected void	restoreFullDescendantComponentDeltaStates(javax.faces.context.FacesContext facesContext, Map<String,Object> rowState, Object initialState)
protected void	restoreFullDescendantComponentStates(javax.faces.context.FacesContext facesContext, Object initialState)
protected Object	saveDescendantComponentStates()
protected Collection<Object[]>	saveDescendantInitialComponentStates(javax.faces.context.FacesContext facesContext)
protected Map<String,Object>	saveFullDescendantComponentStates(javax.faces.context.FacesContext facesContext)
void	setRowIndex(int rowIndex)
boolean	visitTree(javax.faces.component.visit.VisitContext context, javax.faces.component.visit.VisitCallback callback)

Methods inherited from class org.apache.myfaces.component.html.ext.HtmlDataTableHack

checkUpdateModelError, clearRowStates, createDataModel, deleteRowStateForRow, encodeBegin, encodeEnd, getClientId, getContainerClientId, getDataModel, getDerivedRowKeyPrefix, getDerivedSubClientId, getRowCount, getRowData, getRowIndex, getRowKey, hasErrorMessages, isForceId, isForceIdIndex, isPreserveRowComponentState, isPreserveRowStates, isRowAvailable, isRowStatePreserved, markInitialState, restoreDescendantComponentStates, restoreFullDescendantComponentDeltaStates, restoreFullDescendantComponentStates, restoreState, saveDescendantComponentStates, saveDescendantInitialComponentStates, saveFullDescendantComponentStates, saveState, setDataModel, setDerivedRowKeyPrefix, setForceId, setForceIdIndex, setPreserveRowComponentState, setPreserveRowStates, setRowKey, setRowStatePreserved, setValue, setValueBinding, setValueExpression

Methods inherited from class javax.faces.component.html.HtmlDataTable

addClientBehavior, getBgcolor, getBodyrows, getBorder, getCaptionClass, getCaptionStyle, getCellpadding, getCellspacing, getColumnClasses, getDir, getEventNames, getFamily, getFooterClass, getFrame, getHeaderClass, getLang, getOnclick, getOndblclick, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getRowClasses, getRules, getStyle, getStyleClass, getSummary, getTitle, getWidth, setBgcolor, setBodyrows, setBorder, setCaptionClass, setCaptionStyle, setCellpadding, setCellspacing, setColumnClasses, setDir, setFooterClass, setFrame, setHeaderClass, setLang, setOnclick, setOndblclick, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setRowClasses, setRules, setStyle, setStyleClass, setSummary, setTitle, setWidth

Methods inherited from class javax.faces.component.UIData

broadcast, createUniqueId, getFirst, getFooter, getHeader, getRows, getValue, getVar, queueEvent, setFirst, setFooter, setHeader, setRows, setVar

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, clearInitialState, decode, encodeAll, encodeChildren, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getDefaultEventName, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, initialStateMarked, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient

Methods inherited from class javax.faces.component.UIComponent

getClientId, getCompositeComponentParent, 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 org.apache.myfaces.component.UserRoleAware

getEnabledOnUserRole, getVisibleOnUserRole, setEnabledOnUserRole, setVisibleOnUserRole

Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder

getClientBehaviors, getDefaultEventName

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

Constructor Detail

AbstractHtmlDataList

public AbstractHtmlDataList()

Method Detail

processDecodes

public void processDecodes(javax.faces.context.FacesContext context)

Throws NullPointerException if context is null. Sets row index to -1, calls processChildren, sets row index to -1.

Overrides:

processDecodes in class javax.faces.component.UIData

processUpdates

public void processUpdates(javax.faces.context.FacesContext context)

Overrides:

processUpdates in class HtmlDataTableHack

See Also:

UIData.processUpdates(javax.faces.context.FacesContext)

processValidators

public void processValidators(javax.faces.context.FacesContext context)

Overrides:

processValidators in class HtmlDataTableHack

See Also:

UIData.processValidators(javax.faces.context.FacesContext)

processChildren

public void processChildren(javax.faces.context.FacesContext context,
                            int processAction)

Iterates over all children, processes each according to the specified process action if the child is rendered.

setRowIndex

public void setRowIndex(int rowIndex)

Overrides:

setRowIndex in class HtmlDataTableHack

restoreDescendantComponentStates

protected void restoreDescendantComponentStates(Object state)

Overrides:

restoreDescendantComponentStates in class HtmlDataTableHack

saveDescendantComponentStates

protected Object saveDescendantComponentStates()

Overrides:

saveDescendantComponentStates in class HtmlDataTableHack

saveFullDescendantComponentStates

protected Map<String,Object> saveFullDescendantComponentStates(javax.faces.context.FacesContext facesContext)

Overrides:

saveFullDescendantComponentStates in class HtmlDataTableHack

restoreFullDescendantComponentStates

protected void restoreFullDescendantComponentStates(javax.faces.context.FacesContext facesContext,
                                                    Object initialState)

Overrides:

restoreFullDescendantComponentStates in class HtmlDataTableHack

restoreFullDescendantComponentDeltaStates

protected void restoreFullDescendantComponentDeltaStates(javax.faces.context.FacesContext facesContext,
                                                         Map<String,Object> rowState,
                                                         Object initialState)

Overrides:

restoreFullDescendantComponentDeltaStates in class HtmlDataTableHack

saveDescendantInitialComponentStates

protected Collection<Object[]> saveDescendantInitialComponentStates(javax.faces.context.FacesContext facesContext)

Overrides:

saveDescendantInitialComponentStates in class HtmlDataTableHack

invokeOnComponent

public boolean invokeOnComponent(javax.faces.context.FacesContext context,
                                 String clientId,
                                 javax.faces.component.ContextCallback callback)
                          throws javax.faces.FacesException

Overrides:

invokeOnComponent in class javax.faces.component.UIData

Throws:

javax.faces.FacesException

visitTree

public boolean visitTree(javax.faces.component.visit.VisitContext context,
                         javax.faces.component.visit.VisitCallback callback)

Overrides:

visitTree in class javax.faces.component.UIData

getFacesContext

protected javax.faces.context.FacesContext getFacesContext()

Overrides:

getFacesContext in class javax.faces.component.UIComponentBase

getRowCountVar

public abstract String getRowCountVar()

A parameter name, under which the rowCount is set in request scope similar to the var parameter.

getRowIndexVar

public abstract String getRowIndexVar()

A parameter name, under which the current rowIndex is set in request scope similar to the var parameter.

getLayout

public abstract String getLayout()

simple|unorderedList|orderedList

• simple = for each dataRow all children are simply rendered
• unorderedList = the list is rendered as HTML unordered list (= bullet list)
• orderedList = the list is rendered as HTML ordered list

Default: simple

getItemStyleClass

public abstract String getItemStyleClass()

CSS class to be applied to individual items in the list

getItemOnClick

public abstract String getItemOnClick()

OnClick handler to be applied to individual items in the list