org.apache.struts2.components
Class ListUIBean

java.lang.Object
  extended by org.apache.struts2.components.Component
      extended by org.apache.struts2.components.UIBean
          extended by org.apache.struts2.components.ListUIBean
Direct Known Subclasses:
CheckboxList, DoubleListUIBean, Radio, Select

public abstract class ListUIBean
extends UIBean

DoubleListUIBean is the standard superclass of all Struts 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.


Field Summary
protected  java.lang.Object list
           
protected  java.lang.String listKey
           
protected  java.lang.String listValue
           
protected  boolean throwExceptionOnNullValueAttribute
           
 
Fields inherited from class org.apache.struts2.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 org.apache.struts2.components.Component
COMPONENT_STACK, id, parameters, stack
 
Constructor Summary
protected ListUIBean(com.opensymphony.xwork2.util.ValueStack stack, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 
Method Summary
 boolean contains(java.lang.Object obj1, java.lang.Object obj2)
           
 void evaluateExtraParams()
           
protected  java.lang.Class getValueClassType()
           
 void setList(java.lang.Object list)
          Iterable source to populate from.
 void setListKey(java.lang.String listKey)
          Property of list objects to get field value from
 void setListValue(java.lang.String listValue)
          Property of list objects to get field content from
 void setThrowExceptionOnNullValueAttribute(boolean throwExceptionOnNullValueAttribute)
           
 
Methods inherited from class org.apache.struts2.components.UIBean
addFormParameter, buildTemplateName, enableAncestorFormCustomOnsubmit, end, escape, evaluateNameValue, evaluateParams, getDefaultTemplate, getTemplate, getTemplateDir, getTheme, getTooltipConfig, mergeTemplate, populateComponentHtmlId, setAccesskey, setCssClass, setCssStyle, setDisabled, setLabel, 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 org.apache.struts2.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 java.lang.Object list

listKey

protected java.lang.String listKey

listValue

protected java.lang.String listValue

throwExceptionOnNullValueAttribute

protected boolean throwExceptionOnNullValueAttribute
Constructor Detail

ListUIBean

protected ListUIBean(com.opensymphony.xwork2.util.ValueStack stack,
                     javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
Method Detail

evaluateExtraParams

public void evaluateExtraParams()
Overrides:
evaluateExtraParams in class UIBean

contains

public boolean contains(java.lang.Object obj1,
                        java.lang.Object obj2)

getValueClassType

protected java.lang.Class getValueClassType()
Overrides:
getValueClassType in class UIBean

setList

public void setList(java.lang.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(java.lang.String listKey)
Property of list objects to get field value from


setListValue

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


setThrowExceptionOnNullValueAttribute

public void setThrowExceptionOnNullValueAttribute(boolean throwExceptionOnNullValueAttribute)


Copyright © 2000-2006 Apache Software Foundation. All Rights Reserved.