com.opensymphony.webwork.components
Class ListUIBean

java.lang.Object
  extended by com.opensymphony.webwork.components.Component
      extended by com.opensymphony.webwork.components.UIBean
          extended by com.opensymphony.webwork.components.ListUIBean
Direct Known Subclasses:
CheckboxList, DoubleListUIBean, Radio, Select

public abstract class ListUIBean
extends UIBean

DoubleListUIBean is the standard superclass of all webwork list handling components.

Note that the listkey and listvalue attribute will default to "key" and "value" respectively only when the list attribute is evaluated to a Map or its decendant. Other thing else, will result in listkey and listvalue to be null and not used.

Since:
2.2
Version:
$Revision: 2699 $
Author:
Patrick Lightbody, Rene Gielen

Field Summary
protected  Object list
           
protected  String listKey
           
protected  String listValue
           
protected  boolean throwExceptionOnNullValueAttribute
           
 
Fields inherited from class com.opensymphony.webwork.components.UIBean
accesskey, cssClass, cssStyle, disabled, label, labelPosition, name, onblur, onchange, onclick, ondblclick, onfocus, onkeydown, onkeypress, onkeyup, onmousedown, onmousemove, onmouseout, onmouseover, onmouseup, onselect, request, required, requiredposition, response, tabindex, template, templateDir, templateSuffix, theme, title, tooltip, tooltipConfig, value
 
Fields inherited from class com.opensymphony.webwork.components.Component
COMPONENT_STACK, id, parameters, stack
 
Constructor Summary
protected ListUIBean(OgnlValueStack stack, HttpServletRequest request, HttpServletResponse response)
           
 
Method Summary
 boolean contains(Object obj1, Object obj2)
           
 void evaluateExtraParams()
           
protected  Class getValueClassType()
           
 void setList(Object list)
          Iterable source to populate from.
 void setListKey(String listKey)
          Property of list objects to get field value from
 void setListValue(String listValue)
          Property of list objects to get field content from
 void setThrowExceptionOnNullValueAttribute(boolean throwExceptionOnNullValueAttribute)
           
 
Methods inherited from class com.opensymphony.webwork.components.UIBean
addFormParameter, buildTemplateName, enableAncestorFormCustomOnsubmit, end, escape, evaluateNameValue, evaluateParams, getDefaultTemplate, getTemplate, getTemplateDir, getTheme, getTooltipConfig, mergeTemplate, populateComponentHtmlId, setAccesskey, setCssClass, setCssStyle, setDisabled, setLabel, setLabelposition, setLabelPosition, setName, setOnblur, setOnchange, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnselect, setRequired, setRequiredposition, setTabindex, setTemplate, setTemplateDir, setTheme, setTitle, setTooltip, setTooltipConfig, setValue
 
Methods inherited from class com.opensymphony.webwork.components.Component
addAllParameters, addParameter, altSyntax, copyParams, determineActionURL, determineNamespace, end, fieldError, findAncestor, findString, findString, findValue, findValue, findValue, getComponentStack, getId, getParameters, getStack, popComponentStack, setId, start, toString, usesBody
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

list

protected Object list

listKey

protected String listKey

listValue

protected String listValue

throwExceptionOnNullValueAttribute

protected boolean throwExceptionOnNullValueAttribute
Constructor Detail

ListUIBean

protected ListUIBean(OgnlValueStack stack,
                     HttpServletRequest request,
                     HttpServletResponse response)
Method Detail

evaluateExtraParams

public void evaluateExtraParams()
Overrides:
evaluateExtraParams in class UIBean

contains

public boolean contains(Object obj1,
                        Object obj2)

getValueClassType

protected Class getValueClassType()
Overrides:
getValueClassType in class UIBean

setList

public void setList(Object list)
Iterable source to populate from. If the list is a Map (key, value), the Map key will become the option "value" parameter and the Map value will become the option body.


setListKey

public void setListKey(String listKey)
Property of list objects to get field value from


setListValue

public void setListValue(String listValue)
Property of list objects to get field content from


setThrowExceptionOnNullValueAttribute

public void setThrowExceptionOnNullValueAttribute(boolean throwExceptionOnNullValueAttribute)

WebWork Project Page