org.apache.myfaces.custom.datalist
Class HtmlDataList

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
                          org.apache.myfaces.custom.datalist.HtmlDataList

All Implemented Interfaces:

javax.faces.component.NamingContainer, javax.faces.component.StateHolder, UserRoleAware, ExtendedComponentBase

public class HtmlDataList
extends AbstractHtmlDataList

Field Summary

static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE
static String	DEFAULT_RENDERER_TYPE

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

HtmlDataList()

Method Summary

String	getEnabledOnUserRole() If user is in given role, this component will be rendered normally.
String	getFamily()
String	getItemOnClick() OnClick handler to be applied to individual items in the list
String	getItemStyleClass() CSS class to be applied to individual items in the list
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
String	getRowCountVar() A parameter name, under which the rowCount is set in request scope similar to the var parameter.
String	getRowIndexVar() A parameter name, under which the current rowIndex is set in request scope similar to the var parameter.
String	getVisibleOnUserRole() If user is in given role, this component will be rendered normally.
void	restoreState(javax.faces.context.FacesContext facesContext, Object state)
Object	saveState(javax.faces.context.FacesContext facesContext)
void	setEnabledOnUserRole(String enabledOnUserRole)
void	setItemOnClick(String itemOnClick)
void	setItemStyleClass(String itemStyleClass)
void	setLayout(String layout)
void	setRowCountVar(String rowCountVar)
void	setRowIndexVar(String rowIndexVar)
void	setVisibleOnUserRole(String visibleOnUserRole)

Methods inherited from class org.apache.myfaces.custom.datalist.AbstractHtmlDataList

processChildren, processDecodes, processUpdates, processValidators, restoreDescendantComponentStates, saveDescendantComponentStates, setRowIndex

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

checkUpdateModelError, clearRowStates, createDataModel, deleteRowStateForRow, encodeBegin, encodeEnd, getClientId, getDataModel, getDerivedRowKeyPrefix, getDerivedSubClientId, getRowCount, getRowData, getRowIndex, getRowKey, hasErrorMessages, isForceId, isForceIdIndex, isPreserveRowStates, isRowAvailable, restoreDescendantComponentStates, saveDescendantComponentStates, setDataModel, setDerivedRowKeyPrefix, setForceId, setForceIdIndex, setPreserveRowStates, setRowKey, setValue, setValueBinding

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

getBgcolor, getBorder, getCellpadding, getCellspacing, getColumnClasses, getDir, getFooterClass, getFrame, getHeaderClass, getLang, getOnclick, getOndblclick, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getRowClasses, getRules, getStyle, getStyleClass, getSummary, getTitle, getWidth, setBgcolor, setBorder, 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, getFirst, getFooter, getHeader, getRows, getValue, getVar, queueEvent, setFirst, setFooter, setHeader, setRows, setVar

Methods inherited from class javax.faces.component.UIComponentBase

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

DEFAULT_RENDERER_TYPE

public static final String DEFAULT_RENDERER_TYPE

See Also:

Constant Field Values

Constructor Detail

HtmlDataList

public HtmlDataList()

Method Detail

getFamily

public String getFamily()

Overrides:

getFamily in class javax.faces.component.UIData

getRowCountVar

public String getRowCountVar()

Description copied from class: AbstractHtmlDataList

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

Specified by:

getRowCountVar in class AbstractHtmlDataList

setRowCountVar

public void setRowCountVar(String rowCountVar)

getRowIndexVar

public String getRowIndexVar()

Description copied from class: AbstractHtmlDataList

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

Specified by:

getRowIndexVar in class AbstractHtmlDataList

setRowIndexVar

public void setRowIndexVar(String rowIndexVar)

getLayout

public String getLayout()

Description copied from class: AbstractHtmlDataList

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

Specified by:

getLayout in class AbstractHtmlDataList

setLayout

public void setLayout(String layout)

getItemStyleClass

public String getItemStyleClass()

Description copied from class: AbstractHtmlDataList

CSS class to be applied to individual items in the list

Specified by:

getItemStyleClass in class AbstractHtmlDataList

setItemStyleClass

public void setItemStyleClass(String itemStyleClass)

getItemOnClick

public String getItemOnClick()

Description copied from class: AbstractHtmlDataList

OnClick handler to be applied to individual items in the list

Specified by:

getItemOnClick in class AbstractHtmlDataList

setItemOnClick

public void setItemOnClick(String itemOnClick)

getEnabledOnUserRole

public String getEnabledOnUserRole()

Description copied from interface: UserRoleAware

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.

Returns:

setEnabledOnUserRole

public void setEnabledOnUserRole(String enabledOnUserRole)

getVisibleOnUserRole

public String getVisibleOnUserRole()

Description copied from interface: UserRoleAware

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.

Returns:

setVisibleOnUserRole

public void setVisibleOnUserRole(String visibleOnUserRole)

saveState

public Object saveState(javax.faces.context.FacesContext facesContext)

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class HtmlDataTableHack

restoreState

public void restoreState(javax.faces.context.FacesContext facesContext,
                         Object state)

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class HtmlDataTableHack