Source Code Cross Referenced for Radiogroup.java in  » Ajax » zk » org » zkoss » jsf » zul » Java Source Code / Java DocumentationJava Source Code and Java Documentation

001:        /* Radiogroup.java
002:
003:        {{IS_NOTE
004:        	Purpose:
005:        		
006:        	Description:
007:        		
008:        	History:
009:        		2007/08/16  18:10:17 , Created by Dennis.Chen
010:        }}IS_NOTE
011:
012:        Copyright (C) 2007 Potix Corporation. All Rights Reserved.
013:
014:        {{IS_RIGHT
015:        	This program is distributed under GPL Version 2.0 in the hope that
016:        	it will be useful, but WITHOUT ANY WARRANTY.
017:        }}IS_RIGHT
018:         */
019:        package org.zkoss.jsf.zul;
020:
021:        import org.zkoss.jsf.zul.impl.BaseRadiogroup;
022:        import org.zkoss.zk.ui.Component;
023:
024:        /**
025:         * Radiogroup is a JSF component implementation for {@link org.zkoss.zul.Radiogroup}, 
026:         * This class also implements {@link javax.faces.component.EditableValueHolder}.
027:         * That means you can use bidirectional value binding, immediate, required, converter, validator, valueChangeListener features on this component.
028:         * <br/>
029:         * To use those features, you must declare a namespace of "http://java.sun.com/jsf/core" 
030:         * with a prefix (say 'f' in below example), add attribute of those feature with this namespace 
031:         * (for example f:required="true")in you jsf page. 
032:         * For more detail of EditableValueHolder features of JSF, you can refer to <a href="http://java.sun.com/products/jsp/">http://java.sun.com/products/jsp/</a>
033:         * 
034:         * <p/>
035:         * You must assign a value on each radio, so that, after user click radio and submitting,
036:         * radiogroup will decode the request parameter and set back the submitted value to your bean.
037:         * <p/>
038:         * The default binding value of this component is {@link java.lang.String}
039:         * 
040:         * <p/>
041:         * Example of use bidirectional value binding:<br/>
042:         * <pre>
043:         * &lt;z:radiogroup id=&quot;r2&quot; f:value=&quot;#{ConverterTestBean.value}&quot; &gt;
044:         * 	 &lt;z:radio value=&quot;A&quot; /&gt;
045:         * 	 &lt;z:radio value=&quot;B&quot; /&gt;
046:         * 	 &lt;z:radio value=&quot;C&quot; /&gt;
047:         * &lt;/z:radiogroup&gt;
048:         * </pre>
049:         * 
050:         * 
051:         * <p/>
052:         * Example of using immediate:<br/>
053:         * <pre>
054:         * &lt;z:radiogroup f:immediate=&quot;true&quot; /&gt;
055:         * </pre>
056:         * 
057:         * <p/>
058:         * Example of using required:<br/>
059:         * <pre>
060:         * &lt;z:radiogroup f:required=&quot;true&quot; /&gt;
061:         * </pre>
062:         * <p/>
063:         * Example of using converter:<br/>
064:         * <pre>
065:         * &lt;z:radiogroup f:converter=&quot;yourBean.convertMethod&quot;/&gt;
066:         * or
067:         * &lt;z:radiogroup &gt;
068:         * 	&lt;f:converter converterId=&quot;yourConverterId&quot;/&gt;
069:         * &lt;/z:radiogroup&gt;
070:         * </pre>
071:         * <p/>
072:         * Example of using validator:<br/>
073:         * <pre>
074:         * &lt;z:radiogroup f:validator=&quot;yourBean.validateMethod&quot;/&gt;
075:         * or
076:         * &lt;z:radiogroup &gt;
077:         * 	&lt;f:validator validatorId=&quot;yourValidatorId&quot;/&gt;
078:         * &lt;/z:radiogroup&gt;
079:         *  </pre>
080:         * <p/>
081:         * Example of using converter:<br/>
082:         * <pre>
083:         * &lt;z:radiogroup &gt;
084:         * 	&lt;f:valueChangeListener type=&quot;your.ValueChangeListener&quot;/&gt;
085:         * &lt;/z:radiogroup&gt
086:         * </pre>
087:         * <p/>
088:         * In some application server which doesn't support attribute namespace you can use attribute prefix 'f_' to replace attribute namespace
089:         * <br/>
090:         * For example, 
091:         * <pre>
092:         * &lt;z:radiogroup f_value=&quot;#{yourBean.value}&quot; /&gt;
093:         * </pre>
094:         * 
095:         * <p/>
096:         * This component should be declared nested under {@link org.zkoss.jsf.zul.Page}.
097:         * 
098:         * <p/>To know more ZK component features you can refer to <a href="http://www.zkoss.org/">http://www.zkoss.org/</a>
099:         *    
100:         * @author Dennis.Chen
101:         * @see org.zkoss.zul.Radiogroup
102:         * @see javax.faces.component.EditableValueHolder
103:         */
104:        public class Radiogroup extends BaseRadiogroup {
105:
106:        }