org.apache.myfaces.custom.datalist
Class HtmlDataList

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIData
              extended by javax.faces.component.html.HtmlDataTable
                  extended by org.apache.myfaces.component.html.ext.HtmlDataTableHack
                      extended by org.apache.myfaces.custom.datalist.AbstractHtmlDataList
                          extended by org.apache.myfaces.custom.datalist.HtmlDataList
All Implemented Interfaces:
EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.NamingContainer, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.component.UniqueIdVendor, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, UserRoleAware, ExtendedComponentBase

public class HtmlDataList
extends AbstractHtmlDataList


Nested Class Summary
protected static class HtmlDataList.PropertyKeys
           
 
Field Summary
static String COMPONENT_FAMILY
           
static String COMPONENT_TYPE
           
static String DEFAULT_RENDERER_TYPE
           
 
Fields inherited from class javax.faces.component.UIComponent
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, 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
HtmlDataList()
           
 
Method Summary
 void addClientBehavior(String eventName, javax.faces.component.behavior.ClientBehavior behavior)
           
 String getDir()
           
 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 getLang()
           
 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 getOnclick()
           
 String getOndblclick()
           
 String getOnkeydown()
           
 String getOnkeypress()
           
 String getOnkeyup()
           
 String getOnmousedown()
           
 String getOnmousemove()
           
 String getOnmouseout()
           
 String getOnmouseover()
           
 String getOnmouseup()
           
 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 getStyle()
           
 String getStyleClass()
           
 String getTitle()
           
 String getVisibleOnUserRole()
          If user is in given role, this component will be rendered normally.
 void setDir(String dir)
           
 void setEnabledOnUserRole(String enabledOnUserRole)
           
 void setItemOnClick(String itemOnClick)
           
 void setItemStyleClass(String itemStyleClass)
           
 void setLang(String lang)
           
 void setLayout(String layout)
           
 void setOnclick(String onclick)
           
 void setOndblclick(String ondblclick)
           
 void setOnkeydown(String onkeydown)
           
 void setOnkeypress(String onkeypress)
           
 void setOnkeyup(String onkeyup)
           
 void setOnmousedown(String onmousedown)
           
 void setOnmousemove(String onmousemove)
           
 void setOnmouseout(String onmouseout)
           
 void setOnmouseover(String onmouseover)
           
 void setOnmouseup(String onmouseup)
           
 void setRowCountVar(String rowCountVar)
           
 void setRowIndexVar(String rowIndexVar)
           
 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.datalist.AbstractHtmlDataList
getFacesContext, invokeOnComponent, processChildren, processDecodes, processUpdates, processValidators, restoreDescendantComponentStates, restoreFullDescendantComponentDeltaStates, restoreFullDescendantComponentStates, saveDescendantComponentStates, saveDescendantInitialComponentStates, saveFullDescendantComponentStates, setRowIndex, visitTree
 
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, restoreTransientDescendantComponentStates, restoreTransientDescendantComponentStates, saveDescendantComponentStates, saveDescendantInitialComponentStates, saveFullDescendantComponentStates, saveState, saveTransientDescendantComponentStates, saveTransientDescendantComponentStates, setDataModel, setDerivedRowKeyPrefix, setForceId, setForceIdIndex, setPreserveRowComponentState, setPreserveRowStates, setRowKey, setRowStatePreserved, setValue
 
Methods inherited from class javax.faces.component.html.HtmlDataTable
getBgcolor, getBodyrows, getBorder, getCaptionClass, getCaptionStyle, getCellpadding, getCellspacing, getColumnClasses, getEventNames, getFooterClass, getFrame, getHeaderClass, getRowClasses, getRules, getSummary, getWidth, setBgcolor, setBodyrows, setBorder, setCaptionClass, setCaptionStyle, setCellpadding, setCellspacing, setColumnClasses, setFooterClass, setFrame, setHeaderClass, setRowClasses, setRules, setSummary, 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, getTransientStateHelper, getTransientStateHelper, getValueExpression, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, 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, getDefaultEventName
 

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.html.HtmlDataTable

addClientBehavior

public void addClientBehavior(String eventName,
                              javax.faces.component.behavior.ClientBehavior behavior)
Specified by:
addClientBehavior in interface javax.faces.component.behavior.ClientBehaviorHolder
Overrides:
addClientBehavior in class javax.faces.component.html.HtmlDataTable

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 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)

getStyle

public String getStyle()
Overrides:
getStyle in class javax.faces.component.html.HtmlDataTable

setStyle

public void setStyle(String style)
Overrides:
setStyle in class javax.faces.component.html.HtmlDataTable

getStyleClass

public String getStyleClass()
Overrides:
getStyleClass in class javax.faces.component.html.HtmlDataTable

setStyleClass

public void setStyleClass(String styleClass)
Overrides:
setStyleClass in class javax.faces.component.html.HtmlDataTable

getOnclick

public String getOnclick()
Overrides:
getOnclick in class javax.faces.component.html.HtmlDataTable

setOnclick

public void setOnclick(String onclick)
Overrides:
setOnclick in class javax.faces.component.html.HtmlDataTable

getOndblclick

public String getOndblclick()
Overrides:
getOndblclick in class javax.faces.component.html.HtmlDataTable

setOndblclick

public void setOndblclick(String ondblclick)
Overrides:
setOndblclick in class javax.faces.component.html.HtmlDataTable

getOnkeydown

public String getOnkeydown()
Overrides:
getOnkeydown in class javax.faces.component.html.HtmlDataTable

setOnkeydown

public void setOnkeydown(String onkeydown)
Overrides:
setOnkeydown in class javax.faces.component.html.HtmlDataTable

getOnkeypress

public String getOnkeypress()
Overrides:
getOnkeypress in class javax.faces.component.html.HtmlDataTable

setOnkeypress

public void setOnkeypress(String onkeypress)
Overrides:
setOnkeypress in class javax.faces.component.html.HtmlDataTable

getOnkeyup

public String getOnkeyup()
Overrides:
getOnkeyup in class javax.faces.component.html.HtmlDataTable

setOnkeyup

public void setOnkeyup(String onkeyup)
Overrides:
setOnkeyup in class javax.faces.component.html.HtmlDataTable

getOnmousedown

public String getOnmousedown()
Overrides:
getOnmousedown in class javax.faces.component.html.HtmlDataTable

setOnmousedown

public void setOnmousedown(String onmousedown)
Overrides:
setOnmousedown in class javax.faces.component.html.HtmlDataTable

getOnmousemove

public String getOnmousemove()
Overrides:
getOnmousemove in class javax.faces.component.html.HtmlDataTable

setOnmousemove

public void setOnmousemove(String onmousemove)
Overrides:
setOnmousemove in class javax.faces.component.html.HtmlDataTable

getOnmouseout

public String getOnmouseout()
Overrides:
getOnmouseout in class javax.faces.component.html.HtmlDataTable

setOnmouseout

public void setOnmouseout(String onmouseout)
Overrides:
setOnmouseout in class javax.faces.component.html.HtmlDataTable

getOnmouseover

public String getOnmouseover()
Overrides:
getOnmouseover in class javax.faces.component.html.HtmlDataTable

setOnmouseover

public void setOnmouseover(String onmouseover)
Overrides:
setOnmouseover in class javax.faces.component.html.HtmlDataTable

getOnmouseup

public String getOnmouseup()
Overrides:
getOnmouseup in class javax.faces.component.html.HtmlDataTable

setOnmouseup

public void setOnmouseup(String onmouseup)
Overrides:
setOnmouseup in class javax.faces.component.html.HtmlDataTable

getDir

public String getDir()
Overrides:
getDir in class javax.faces.component.html.HtmlDataTable

setDir

public void setDir(String dir)
Overrides:
setDir in class javax.faces.component.html.HtmlDataTable

getLang

public String getLang()
Overrides:
getLang in class javax.faces.component.html.HtmlDataTable

setLang

public void setLang(String lang)
Overrides:
setLang in class javax.faces.component.html.HtmlDataTable

getTitle

public String getTitle()
Overrides:
getTitle in class javax.faces.component.html.HtmlDataTable

setTitle

public void setTitle(String title)
Overrides:
setTitle in class javax.faces.component.html.HtmlDataTable

setValueBinding

public void setValueBinding(String name,
                            javax.faces.el.ValueBinding binding)
Overrides:
setValueBinding in class HtmlDataTableHack

setValueExpression

public void setValueExpression(String name,
                               javax.el.ValueExpression expression)
Overrides:
setValueExpression in class HtmlDataTableHack


Copyright © 2012 The Apache Software Foundation. All Rights Reserved.