[jboss-cvs] jboss-seam/ui/src/main/java/org/jboss/seam/ui/util/cdk ...
Peter Muir
peter at bleepbleep.org.uk
Tue Jun 19 17:57:45 EDT 2007
User: pmuir
Date: 07/06/19 17:57:45
Added: ui/src/main/java/org/jboss/seam/ui/util/cdk
RendererBase.java RendererUtils.java
SimpleActionMethodBinding.java
UIComponentTagBase.java
Log:
JBSEAM-1013 - port seam ui to a4j cdk
Revision Changes Path
1.1 date: 2007/06/19 21:57:44; author: pmuir; state: Exp;jboss-seam/ui/src/main/java/org/jboss/seam/ui/util/cdk/RendererBase.java
Index: RendererBase.java
===================================================================
/**
* License Agreement.
*
* Ajax4jsf 1.1 - Natural Ajax for Java Server Faces (JSF)
*
* Copyright (C) 2007 Exadel, Inc.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1 as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
package org.jboss.seam.ui.util.cdk;
import java.io.IOException;
import java.util.Iterator;
import javax.faces.component.UIComponent;
import javax.faces.context.FacesContext;
import javax.faces.context.ResponseWriter;
import javax.faces.render.Renderer;
/**
* Mangled version of Ajax4Jsf's RendererBase without supporting classes
*
* Base Renderer for all chameleon Skin's and components.
* At most, make all common procedures and realise concrete work in "template" methods.
* @author asmirnov at exadel.com (latest modification by $Author: pmuir $)
* @version $Revision: 1.1 $ $Date: 2007/06/19 21:57:44 $
*
*/
public abstract class RendererBase extends Renderer {
/**
* logger for common cases.
*/
protected static final String JAVASCRIPT_NAMESPACE = "JBossSeam";
private static final RendererUtils utils = new RendererUtils();
/* (non-Javadoc)
* @see javax.faces.render.Renderer#decode(javax.faces.context.FacesContext, javax.faces.component.UIComponent)
*/
public void decode(FacesContext context, UIComponent component) {
// Test for correct parameters.
if (context == null) throw new NullPointerException("Context must not be null");
if (component == null) throw new NullPointerException("Component must not be null");
if (! getComponentClass().isInstance(component)) throw new IllegalArgumentException("Component must be of type " + getComponentClass().getName());
preDecode(context,component);
// TODO - create set od common decoders ( UIInput, ActionSource etc. ) for process decoding.
if (component.isRendered()) {
doDecode(context, component);
}
}
protected void preDecode(FacesContext context, UIComponent component) {
}
protected void preEncodeBegin(FacesContext context, UIComponent component) throws IOException {
}
/* (non-Javadoc)
* @see javax.faces.render.Renderer#encodeBegin(javax.faces.context.FacesContext, javax.faces.component.UIComponent)
*/
public void encodeBegin(FacesContext context, UIComponent component) throws IOException {
// Test for correct parameters.
if (context == null) throw new NullPointerException("Context must not be null");
if (component == null) throw new NullPointerException("Component must not be null");
if (! getComponentClass().isInstance(component)) throw new IllegalArgumentException("Component must be of type " + getComponentClass().getName());
preEncodeBegin(context,component);
if (component.isRendered()) {
ResponseWriter writer = context.getResponseWriter();
doEncodeBegin(writer, context, component);
}
}
/* (non-Javadoc)
* @see javax.faces.render.Renderer#encodeChildren(javax.faces.context.FacesContext, javax.faces.component.UIComponent)
*/
public void encodeChildren(FacesContext context, UIComponent component) throws IOException {
// Test for correct parameters.
if (context == null) throw new NullPointerException("Context must not be null");
if (component == null) throw new NullPointerException("Component must not be null");
if (! getComponentClass().isInstance(component)) throw new IllegalArgumentException("Component must be of type " + getComponentClass().getName());
preEncodeBegin(context,component);
if (component.isRendered()) {
ResponseWriter writer = context.getResponseWriter();
doEncodeChildren(writer, context, component);
}
}
/* (non-Javadoc)
* @see javax.faces.render.Renderer#encodeEnd(javax.faces.context.FacesContext, javax.faces.component.UIComponent)
*/
public void encodeEnd(FacesContext context, UIComponent component) throws IOException {
// Test for correct parameters.
if (context == null) throw new NullPointerException("Context must not be null");
if (component == null) throw new NullPointerException("Component must not be null");
if (! getComponentClass().isInstance(component)) throw new IllegalArgumentException("Component must be of type " + getComponentClass().getName());
if (component.isRendered()) {
ResponseWriter writer = context.getResponseWriter();
doEncodeEnd(writer, context, component);
}
}
/**
* Get base component slass , targetted for this renderer. Used for check arguments in decode/encode.
* @return
*/
protected abstract Class getComponentClass();
/**
* Template method for custom decoding of concrete renderer.
* All parameters checking if performed in original {@see decode } method.
* @param context
* @param component
*/
protected void doDecode(FacesContext context, UIComponent component) {
}
/**
* Template method for custom start encoding of concrete renderer.
* All parameters checking and writer is performed in original {@link encodeBegin } method.
* @param writer
* @param context
* @param component
*/
protected void doEncodeBegin(ResponseWriter writer,FacesContext context, UIComponent component) throws IOException {
}
/**
* @param writer
* @param context
* @param component
*/
protected void doEncodeChildren(ResponseWriter writer, FacesContext context, UIComponent component) throws IOException {
// Hook method, must be overriden in renderers with special children processing
}
/**
* Template method for custom finish encoding of concrete renderer.
* All parameters checking and writer is performed in original {@link encodeEnd } method.
* @param writer
* @param context
* @param component
* @throws IOException
*/
protected void doEncodeEnd(ResponseWriter writer, FacesContext context, UIComponent component) throws IOException {
}
/**
* Render all children for given component.
* @param facesContext
* @param component
* @throws IOException
*/
public void renderChildren(FacesContext facesContext,
UIComponent component) throws IOException {
if (component.getChildCount() > 0) {
for (Iterator it = component.getChildren().iterator(); it.hasNext();) {
UIComponent child = (UIComponent) it.next();
renderChild(facesContext, child);
}
}
}
/**
* Render one component and it childrens
* @param facesContext
* @param child
* @throws IOException
*/
public void renderChild(FacesContext facesContext, UIComponent child)
throws IOException {
if (!child.isRendered()) {
return;
}
child.encodeBegin(facesContext);
if (child.getRendersChildren()) {
child.encodeChildren(facesContext);
} else {
renderChildren(facesContext, child);
}
child.encodeEnd(facesContext);
}
public static RendererUtils getUtils()
{
return utils;
}
}
1.1 date: 2007/06/19 21:57:44; author: pmuir; state: Exp;jboss-seam/ui/src/main/java/org/jboss/seam/ui/util/cdk/RendererUtils.java
Index: RendererUtils.java
===================================================================
/**
* License Agreement.
*
* Ajax4jsf 1.1 - Natural Ajax for Java Server Faces (JSF)
*
* Copyright (C) 2007 Exadel, Inc.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1 as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
package org.jboss.seam.ui.util.cdk;
import java.awt.Dimension;
import java.io.IOException;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;
import javax.faces.FacesException;
import javax.faces.application.ViewHandler;
import javax.faces.component.EditableValueHolder;
import javax.faces.component.UIComponent;
import javax.faces.component.UIForm;
import javax.faces.component.UIViewRoot;
import javax.faces.component.ValueHolder;
import javax.faces.context.FacesContext;
import javax.faces.context.ResponseWriter;
import javax.faces.convert.Converter;
/**
* Util class for common render operations - render passthru html attributes,
* iterate over child components etc.
* @author asmirnov at exadel.com (latest modification by $Author: pmuir $)
* @version $Revision: 1.1 $ $Date: 2007/06/19 21:57:44 $
*
*/
public class RendererUtils {
public static final String DUMMY_FORM_ID = ":_form";
/**
* Substitutions for components properies names and HTML attributes names.
*/
private static Map substitutions = new HashMap();
static {
substitutions.put(HTML.class_ATTRIBUTE,"styleClass");
Arrays.sort(HTML.PASS_THRU);
Arrays.sort(HTML.PASS_THRU_BOOLEAN);
Arrays.sort(HTML.PASS_THRU_URI);
}
/**
* Common HTML elements and attributes names.
* @author asmirnov at exadel.com (latest modification by $Author: pmuir $)
* @version $Revision: 1.1 $ $Date: 2007/06/19 21:57:44 $
*
*/
public interface HTML {
// elements
public static final String BUTTON = "button";
// attributes
public static final String id_ATTRIBUTE = "id";
public static final String class_ATTRIBUTE = "class";
// public static final String STYLE_ATTRIBUTE = "style";
// public static final String dir_ATTRIBUTE = "dir";
// public static final String lang_ATTRIBUTE = "lang";
// public static final String title_ATTRIBUTE = "title";
public static final String accesskey_ATTRIBUTE = "accesskey";
public static final String alt_ATTRIBUTE = "alt";
public static final String cols_ATTRIBUTE = "cols";
public static final String height_ATTRIBUTE = "height";
public static final String lang_ATTRIBUTE = "lang";
public static final String longdesc_ATTRIBUTE = "longdesc";
public static final String maxlength_ATTRIBUTE = "maxlength";
public static final String onblur_ATTRIBUTE = "onblur";
public static final String onchange_ATTRIBUTE = "onchange";
public static final String onclick_ATTRIBUTE = "onclick";
public static final String ondblclick_ATTRIBUTE = "ondblclick";
public static final String onfocus_ATTRIBUTE = "onfocus";
public static final String onkeydown_ATTRIBUTE = "onkeydown";
public static final String onkeypress_ATTRIBUTE = "onkeypress";
public static final String onkeyup_ATTRIBUTE = "onkeyup";
public static final String onload_ATTRIBUTE = "onload";
public static final String onmousedown_ATTRIBUTE = "onmousedown";
public static final String onmousemove_ATTRIBUTE = "onmousemove";
public static final String onmouseout_ATTRIBUTE = "onmouseout";
public static final String onmouseover_ATTRIBUTE = "onmouseover";
public static final String onmouseup_ATTRIBUTE = "onmouseup";
public static final String onreset_ATTRIBUTE = "onreset";
public static final String onselect_ATTRIBUTE = "onselect";
// public static final String onsubmit_ATTRIBUTE = "onsubmit";
public static final String onunload_ATTRIBUTE = "onunload";
public static final String rows_ATTRIBUTE = "rows";
public static final String size_ATTRIBUTE = "size";
public static final String tabindex_ATTRIBUTE = "tabindex";
public static final String title_ATTRIBUTE = "title";
public static final String style_ATTRIBUTE = "style";
public static final String align_ATTRIBUTE = "align";
public static final String width_ATTRIBUTE = "width";
public static final String dir_ATTRIBUTE = "dir";
public static final String rules_ATTRIBUTE = "rules";
public static final String frame_ATTRIBUTE = "frame";
public static final String border_ATTRIBUTE = "border";
public static final String cellspacing_ATTRIBUTE = "cellspacing";
public static final String cellpadding_ATTRIBUTE = "cellpadding";
public static final String summary_ATTRIBUTE = "summary";
public static final String bgcolor_ATTRIBUTE = "bgcolor";
public static final String usemap_ATTRIBUTE = "usemap";
public static final String enctype_ATTRIBUTE = "enctype";
public static final String accept_charset_ATTRIBUTE = "accept-charset";
public static final String accept_ATTRIBUTE = "accept";
public static final String target_ATTRIBUTE = "target";
public static final String onsubmit_ATTRIBUTE = "onsubmit";
public static final String readonly_ATTRIBUTE = "readonly";
public static final String nowrap_ATTRIBUTE = "nowrap";
//public static final String onreset_ATTRIBUTE = "onreset";
// attributes sets.
public static final String[] PASS_THRU = {
// DIR_ATTRIBUTE,
// LANG_ATTRIBUTE,
// STYLE_ATTRIBUTE,
// TITLE_ATTRIBUTE
"accesskey",
"alt",
"cols",
"height",
"lang",
"longdesc",
"maxlength",
"onblur",
"onchange",
"onclick",
"ondblclick",
"onfocus",
"onkeydown",
"onkeypress",
"onkeyup",
"onload",
"onmousedown",
"onmousemove",
"onmouseout",
"onmouseover",
"onmouseup",
"onreset",
"onselect",
"onsubmit",
"onunload",
"rows",
"size",
"tabindex",
"title",
"width",
"dir",
"rules",
"frame",
"border",
"cellspacing",
"cellpadding",
"summary",
"bgcolor",
"usemap",
"enctype",
"accept-charset",
"accept",
"target",
"charset",
"coords",
"hreflang",
"rel",
"rev",
"shape",
"disabled",
"readonly",
"ismap"
};
/**
* HTML attributes allowed boolean-values only
*/
public static final String[] PASS_THRU_BOOLEAN = {
"disabled",
"declare",
"readonly",
"compact",
"ismap",
"selected",
"checked",
"nowrap",
"noresize",
"nohref",
"noshade",
"multiple"
};
/**
* all HTML attributes with URI value.
*/
public static final String[] PASS_THRU_URI = {
"usemap",
"background",
"codebase",
"cite",
"data",
"classid",
"href",
"longdesc",
"profile",
"src"
};
public static final String[] PASS_THRU_STYLES = {
"style",
"class",
};
public static final String SPAN_ELEM = "span";
public static final String DIV_ELEM = "div";
public static final String SCRIPT_ELEM = "script";
public static final String STYLE_CLASS_ATTR = "styleClass";
public static final String DISABLED_ATTR = "disabled";
public static final String TYPE_ATTR = "type";
public static final String CHARSET_ATTR = "charset";
public static final String COORDS_ATTR = "coords";
public static final String HREFLANG_ATTR = "hreflang";
public static final String REL_ATTR = "rel";
public static final String REV_ATTR = "rev";
public static final String SHAPE_ATTR = "shape";
public static final String title_ELEM = "title";
public static final String FORM_ELEMENT = "form";
public static final String NAME_ATTRIBUTE = "name";
public static final String METHOD_ATTRIBUTE = "method";
public static final String ACTION_ATTRIBUTE = "action";
public static final String INPUT_ELEM = "input";
public static final Object INPUT_TYPE_HIDDEN = "hidden";
public static final String value_ATTRIBUTE = "value";
public static final String td_ELEM = "td";
public static final String th_ELEM = "th";
public static final String valign_ATTRIBUTE = "valign";
public static final String a_ELEMENT = "a";
public static final String HTML_ELEMENT = "html";
public static final String BODY_ELEMENT = "body";
public static final String TR_ELEMENT = "tr";
public static final String CAPTION_ELEMENT = "caption";
public static final String THEAD_ELEMENT = "thead";
public static final String TFOOT_ELEMENT = "tfoot";
}
/**
* Encode id attribute with clientId component property
* @param context
* @param component
* @throws IOException
*/
public void encodeId(FacesContext context, UIComponent component) throws IOException {
encodeId(context,component,HTML.id_ATTRIBUTE);
}
/**
* Encode clientId to custom attribute ( for example, to control name )
* @param context
* @param component
* @param attribute
* @throws IOException
*/
public void encodeId(FacesContext context,UIComponent component, String attribute) throws IOException {
String clientId = null;
try {
clientId = component.getClientId(context);
} catch(Exception e) {
//just ignore if clientId wasn't inited yet
}
if (null != clientId) {
context.getResponseWriter().writeAttribute(attribute,
clientId,
(String) getComponentAttributeName(attribute));
}
}
/**
* Encode id attribute with clientId component property.
* Encoded only if id not auto generated.
* @param context
* @param component
* @throws IOException
*/
public void encodeCustomId(FacesContext context, UIComponent component) throws IOException {
if(component.getId() != null && !component.getId().startsWith(UIViewRoot.UNIQUE_ID_PREFIX)){
context.getResponseWriter().writeAttribute(HTML.id_ATTRIBUTE,component.getClientId(context),HTML.id_ATTRIBUTE);
}
}
/**
* Encode common pass-thru html attributes.
* @param context
* @param component
* @throws IOException
*/
public void encodePassThru(FacesContext context, UIComponent component) throws IOException {
encodeAttributesFromArray(context,component,HTML.PASS_THRU);
}
/**
* Encode pass-through attributes except specified ones
* @param context
* @param component
* @param exclusions
* @throws IOException
*/
public void encodePassThruWithExclusions(FacesContext context, UIComponent component,String exclusions) throws IOException{
if (null != exclusions) {
String[] exclusionsArray = exclusions.split(",");
encodePassThruWithExclusionsArray(context,component,exclusionsArray);
}
}
public void encodePassThruWithExclusionsArray(FacesContext context, UIComponent component,String[] exclusions) throws IOException {
ResponseWriter writer = context.getResponseWriter();
Map attributes = component.getAttributes();
Arrays.sort(exclusions);
for (int i = 0; i < HTML.PASS_THRU.length; i++) {
String attribute = HTML.PASS_THRU[i];
if(Arrays.binarySearch(exclusions, attribute) < 0){
encodePassThruAttribute(context, attributes, writer, attribute);
}
}
}
/**
* Encode one pass-thru attribute, with plain/boolean/url value, got from properly component attribute.
* @param context
* @param component
* @param writer
* @param attribute
* @throws IOException
*/
public void encodePassThruAttribute(FacesContext context, Map attributes, ResponseWriter writer, String attribute) throws IOException {
Object value = attributeValue(attribute,attributes.get(getComponentAttributeName(attribute)));
if (null != value && shouldRenderAttribute(value)) {
if(Arrays.binarySearch(HTML.PASS_THRU_URI, attribute)>=0){
String url = context.getApplication().getViewHandler().getResourceURL(context, value.toString());
url = context.getExternalContext().encodeResourceURL(url);
writer.writeURIAttribute(attribute,url,attribute);
} else {
writer.writeAttribute(attribute,value,attribute);
}
}
}
public void encodeAttributesFromArray(FacesContext context, UIComponent component,String[] attrs) throws IOException {
ResponseWriter writer = context.getResponseWriter();
Map attributes = component.getAttributes();
for (int i = 0; i < attrs.length; i++) {
String attribute = attrs[i];
encodePassThruAttribute(context, attributes, writer, attribute);
}
}
/**
* Encode attributes given by comma-separated string list.
* @param context current JSF context
* @param component for with render attributes values
* @param attrs comma separated list of attributes
* @throws IOException
*/
public void encodeAttributes(FacesContext context, UIComponent component,String attrs) throws IOException {
if (null != attrs) {
String[] attrsArray = attrs.split(",");
encodeAttributesFromArray(context,component,attrsArray);
}
}
/**
* @param context
* @param component
* @param string
* @param string2
* @throws IOException
*/
public void encodeAttribute(FacesContext context, UIComponent component, Object property, String attributeName) throws IOException {
ResponseWriter writer = context.getResponseWriter();
Object value = component.getAttributes().get(property);
if (shouldRenderAttribute(value)) {
writer.writeAttribute(attributeName,value,property.toString());
}
}
public void encodeAttribute(FacesContext context, UIComponent component,String attribute) throws IOException {
encodeAttribute(context,component,getComponentAttributeName(attribute),attribute);
}
/**
* Write html-attribute
* @param writer
* @param attribute
* @param value
* @throws IOException
*/
public void writeAttribute(ResponseWriter writer, String attribute, Object value ) throws IOException {
if ( shouldRenderAttribute(value) ) {
writer.writeAttribute(attribute, value.toString(), attribute );
}
}
/**
* @return true if and only if the argument
* <code>attributeVal</code> is an instance of a wrapper for a
* primitive type and its value is equal to the default value for
* that type as given in the spec.
*/
public boolean shouldRenderAttribute(Object attributeVal) {
if(null == attributeVal){
return false;
} else if (attributeVal instanceof Boolean &&
((Boolean) attributeVal).booleanValue() ==
Boolean.FALSE.booleanValue()) {
return false;
} else if(attributeVal.toString().length() == 0){
return false;
} else return isValidProperty(attributeVal);
}
/**
* Test for valid value of property. by default, for non-setted properties with Java primitive types of
* JSF component return appropriate MIN_VALUE .
* @param property - value of property returned from {@link UIComponent#getAttributes()}
* @return true for setted property, false otherthise.
*/
public boolean isValidProperty(Object property) {
if (null == property) {
return false;
} else if (property instanceof Integer
&& ((Integer) property).intValue() == Integer.MIN_VALUE) {
return false;
} else if (property instanceof Double
&& ((Double) property).doubleValue() == Double.MIN_VALUE) {
return false;
} else if (property instanceof Character
&& ((Character) property).charValue() == Character.MIN_VALUE) {
return false;
} else if (property instanceof Float
&& ((Float) property).floatValue() == Float.MIN_VALUE) {
return false;
} else if (property instanceof Short
&& ((Short) property).shortValue() == Short.MIN_VALUE) {
return false;
} else if (property instanceof Byte
&& ((Byte) property).byteValue() == Byte.MIN_VALUE) {
return false;
} else if (property instanceof Long
&& ((Long) property).longValue() == Long.MIN_VALUE) {
return false;
}
return true;
}
/**
* Convert HTML attribute name to component property name.
*
* @param key
* @return
*/
protected Object getComponentAttributeName(Object key) {
Object converted = substitutions.get(key);
if (null==converted) {
return key;
} else {
return converted;
}
}
/**
* Convert attribute value to proper object. For known html boolean attributes return name
* for true value, otherthise - null. For non-boolean attributes return same value.
* @param name attribute name.
* @param value
* @return
*/
protected Object attributeValue(String name, Object value){
if (null != value && Arrays.binarySearch(HTML.PASS_THRU_BOOLEAN,name)>=0) {
boolean checked = false;
if (value instanceof Boolean) {
checked = ((Boolean) value).booleanValue();
} else {
if( ! (value instanceof String) ){
value = value.toString();
}
checked = (new Boolean((String) value)).booleanValue();
}
return checked?name:null;
} else {
return value;
}
}
/**
* Get boolean value of logical attribute
* @param component
* @param name attribute name
* @return true if attribute is equals Boolean.TRUE or String "true" , false otherwise.
*/
public boolean isBooleanAttribute(UIComponent component, String name){
Object attrValue = component.getAttributes().get(name);
boolean result = false;
if(null != attrValue){
if(attrValue instanceof String ){
result = "true".equalsIgnoreCase((String) attrValue);
} else {
result = Boolean.TRUE.equals(attrValue);
}
}
return result;
}
/**
* Return converted value for {@link javax.faces.component.ValueHolder} as String,
* perform nessesary convertions.
* @param context
* @param component
* @return
*/
public String getValueAsString(FacesContext context, UIComponent component) {
// First - get submitted value for input components
if (component instanceof EditableValueHolder) {
EditableValueHolder input = (EditableValueHolder) component;
String submittedValue = (String) input.getSubmittedValue();
if(null != submittedValue) {
return submittedValue;
}
}
// If no submitted value presented - convert same for UIInput/UIOutput
if (component instanceof ValueHolder) {
return formatValue(context, component, ((ValueHolder) component).getValue() );
} else {
throw new IllegalArgumentException();
}
}
/**
* Convert any object value to string. If component instance of {@link ValueHolder } got {@link Converter} for formatting.
* If not, attempt to use converter based on value type.
* @param context
* @param component
* @return
*/
public String formatValue(FacesContext context, UIComponent component,Object value) {
if(value instanceof String) {
return (String) value;
}
Converter converter = null;
if (component instanceof ValueHolder) {
ValueHolder holder = (ValueHolder) component;
converter = holder.getConverter();
}
if(null == converter && null != value ) {
try {
converter = context.getApplication().createConverter(
value.getClass());
} catch (FacesException e) {
// TODO - log converter exception.
}
}
if(null == converter) {
if(null != value) {
return value.toString();
}
} else {
return converter.getAsString(context, component, value);
}
return "";
}
/**
* Find nested form for given component
* @param component
* @return nested <code>UIForm</code> component, or <code>null</code>
*/
public UIForm getNestingForm(FacesContext context,UIComponent component)
{
UIComponent parent = component.getParent();
while (parent != null && !(parent instanceof UIForm))
{
parent = parent.getParent();
}
UIForm nestingForm = null;
if (parent != null)
{
//link is nested inside a form
nestingForm = (UIForm) parent;
}
return nestingForm;
}
/**
* @param context
* @param component
* @return
* @throws IOException
*/
public void encodeBeginFormIfNessesary(FacesContext context, UIComponent component) throws IOException {
UIForm form = getNestingForm(context, component);
if(null == form) {
ResponseWriter writer = context.getResponseWriter();
String clientId = component.getClientId(context)+DUMMY_FORM_ID;
encodeBeginForm(context, component, writer, clientId);
// writer.writeAttribute(HTML.style_ATTRIBUTE, "margin:0; padding:0;", null);
}
}
/**
* @param context
* @param component
* @param writer
* @param clientId
* @throws IOException
*/
public void encodeBeginForm(FacesContext context, UIComponent component, ResponseWriter writer, String clientId) throws IOException {
String actionURL = getActionUrl(context);
String encodeActionURL = context.getExternalContext().encodeActionURL(actionURL);
writer.startElement(HTML.FORM_ELEMENT, component);
writer.writeAttribute(HTML.id_ATTRIBUTE, clientId, null);
writer.writeAttribute(HTML.NAME_ATTRIBUTE, clientId, null);
writer.writeAttribute(HTML.METHOD_ATTRIBUTE, "post", null);
writer.writeAttribute(HTML.style_ATTRIBUTE, "margin:0; padding:0;", null);
writer.writeURIAttribute(HTML.ACTION_ATTRIBUTE,
encodeActionURL,
"action");
}
/**
* @param context
* @param component
* @throws IOException
*/
public void encodeEndFormIfNessesary(FacesContext context, UIComponent component) throws IOException {
UIForm form = getNestingForm(context, component);
if(null == form) {
ResponseWriter writer = context.getResponseWriter();
// TODO - hidden form parameters ?
encodeEndForm(context, writer);
}
}
/**
* @param context
* @param writer
* @throws IOException
*/
public void encodeEndForm(FacesContext context, ResponseWriter writer) throws IOException {
writer.endElement(HTML.FORM_ELEMENT);
}
/**
* @param facesContext
* @return String A String representing the action URL
*/
public String getActionUrl(FacesContext facesContext)
{
ViewHandler viewHandler = facesContext.getApplication().getViewHandler();
String viewId = facesContext.getViewRoot().getViewId();
return viewHandler.getActionURL(facesContext, viewId);
}
/**
* Simplified version of {@link encodeId}
* @param context
* @param component
* @return client id of current component
*/
public String clientId(FacesContext context, UIComponent component){
String clientId = "";
try {
clientId = component.getClientId(context);
} catch (Exception e) {
//just ignore
}
return clientId;
}
/**
* Wtrie JavaScript with start/end elements and type.
* @param context
* @param tab
* @param string
*/
public void writeScript(FacesContext context, UIComponent component, Object script) throws IOException {
ResponseWriter writer = context.getResponseWriter();
writer.startElement(HTML.SCRIPT_ELEM,component);
writer.writeAttribute(HTML.TYPE_ATTR,"text/javascript","type");
writer.writeText(script,null);
writer.endElement(HTML.SCRIPT_ELEM);
}
}
1.1 date: 2007/06/19 21:57:44; author: pmuir; state: Exp;jboss-seam/ui/src/main/java/org/jboss/seam/ui/util/cdk/SimpleActionMethodBinding.java
Index: SimpleActionMethodBinding.java
===================================================================
package org.jboss.seam.ui.util.cdk;
/**
* License Agreement.
*
* Ajax4jsf 1.1 - Natural Ajax for Java Server Faces (JSF)
*
* Copyright (C) 2007 Exadel, Inc.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1 as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
import javax.faces.component.StateHolder;
import javax.faces.context.FacesContext;
import javax.faces.el.EvaluationException;
import javax.faces.el.MethodBinding;
import javax.faces.el.MethodNotFoundException;
/**
* @author shura (latest modification by $Author: pmuir $)
* @version $Revision: 1.1 $ $Date: 2007/06/19 21:57:44 $
*
*/
/**
* Simple method binding for constant action outcome.
* @author asmirnov at exadel.com (latest modification by $Author: pmuir $)
* @version $Revision: 1.1 $ $Date: 2007/06/19 21:57:44 $
*
*/
public class SimpleActionMethodBinding extends MethodBinding implements StateHolder {
// private static final Log log =
// LogFactory.getLog(SimpleActionMethodBinding.class);
private String _outcome;
public SimpleActionMethodBinding(String outcome) {
_outcome = outcome;
}
public Object invoke(FacesContext facescontext, Object aobj[])
throws EvaluationException, MethodNotFoundException {
return _outcome;
}
public Class getType(FacesContext facescontext)
throws MethodNotFoundException {
return String.class;
}
// ~ StateHolder support
// ----------------------------------------------------------------------------
private boolean _transient = false;
/**
* Empty constructor, so that new instances can be created when restoring
* state.
*/
public SimpleActionMethodBinding() {
_outcome = null;
}
public Object saveState(FacesContext facescontext) {
return _outcome;
}
public void restoreState(FacesContext facescontext, Object obj) {
_outcome = (String) obj;
}
public boolean isTransient() {
return _transient;
}
public void setTransient(boolean flag) {
_transient = flag;
}
public String toString() {
return _outcome;
}
}
1.1 date: 2007/06/19 21:57:44; author: pmuir; state: Exp;jboss-seam/ui/src/main/java/org/jboss/seam/ui/util/cdk/UIComponentTagBase.java
Index: UIComponentTagBase.java
===================================================================
/**
* License Agreement.
*
* Ajax4jsf 1.1 - Natural Ajax for Java Server Faces (JSF)
*
* Copyright (C) 2007 Exadel, Inc.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1 as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
package org.jboss.seam.ui.util.cdk;
import javax.faces.component.ActionSource;
import javax.faces.component.EditableValueHolder;
import javax.faces.component.UICommand;
import javax.faces.component.UIComponent;
import javax.faces.component.UIGraphic;
import javax.faces.component.UIParameter;
import javax.faces.component.UISelectBoolean;
import javax.faces.component.ValueHolder;
import javax.faces.context.FacesContext;
import javax.faces.convert.Converter;
import javax.faces.el.MethodBinding;
import javax.faces.el.ValueBinding;
import javax.faces.event.ActionEvent;
import javax.faces.event.ValueChangeEvent;
import javax.faces.webapp.UIComponentTag;
/**
* Base class with utility functions for all JSF tags. Get from apache MyFaces
* @author asmirnov at exadel.com (latest modification by $Author: pmuir $)
* @version $Revision: 1.1 $ $Date: 2007/06/19 21:57:44 $
*
*/
public abstract class UIComponentTagBase extends UIComponentTag {
//Special UIComponent attributes (ValueHolder, ConvertibleValueHolder)
private String _value;
private String _converter;
//attributes id, rendered and binding are handled by UIComponentTag
/**
* @param converter The converter to set.
*/
public void setConverter(String converter) {
_converter = converter;
}
/**
* @param value The value to set.
*/
public void setValue(String value) {
_value = value;
}
public void release() {
super.release();
_value=null;
_converter=null;
}
protected void setProperties(UIComponent component)
{
super.setProperties(component);
//rendererType already handled by UIComponentTag
setValueProperty(component, _value);
setConverterProperty(component, _converter);
}
private static final Class[] VALIDATOR_ARGS = {FacesContext.class,
UIComponent.class,
Object.class};
private static final Class[] ACTION_LISTENER_ARGS = {ActionEvent.class};
private static final Class[] VALUE_LISTENER_ARGS = {ValueChangeEvent.class};
protected void setCharterProperty(UIComponent component, String propName, String value)
{
if (value != null)
{
if (isValueReference(value))
{
ValueBinding vb = getFacesContext().getApplication().createValueBinding(value);
component.setValueBinding(propName, vb);
}
else
{
//FIXME: should use converter maybe?
component.getAttributes().put(propName, new Character(value.charAt(0)));
}
}
}
protected void setIntegerProperty(UIComponent component, String propName, String value)
{
if (value != null)
{
if (isValueReference(value))
{
ValueBinding vb = getFacesContext().getApplication().createValueBinding(value);
component.setValueBinding(propName, vb);
}
else
{
//FIXME: should use converter maybe?
component.getAttributes().put(propName, Integer.valueOf(value));
}
}
}
protected void setLongProperty(UIComponent component, String propName, String value)
{
if (value != null)
{
if (isValueReference(value))
{
ValueBinding vb = getFacesContext().getApplication().createValueBinding(value);
component.setValueBinding(propName, vb);
}
else
{
//FIXME: should use converter maybe?
component.getAttributes().put(propName, Long.valueOf(value));
}
}
}
protected void setFloatProperty(UIComponent component, String propName, String value)
{
if (value != null)
{
if (isValueReference(value))
{
ValueBinding vb = getFacesContext().getApplication().createValueBinding(value);
component.setValueBinding(propName, vb);
}
else
{
//FIXME: should use converter maybe?
component.getAttributes().put(propName, Float.valueOf(value));
}
}
}
protected void setDoubleProperty(UIComponent component, String propName, String value)
{
if (value != null)
{
if (isValueReference(value))
{
ValueBinding vb = getFacesContext().getApplication().createValueBinding(value);
component.setValueBinding(propName, vb);
}
else
{
//FIXME: should use converter maybe?
component.getAttributes().put(propName, Double.valueOf(value));
}
}
}
protected void setStringProperty(UIComponent component, String propName, String value)
{
if (value != null)
{
if (isValueReference(value))
{
ValueBinding vb = getFacesContext().getApplication().createValueBinding(value);
component.setValueBinding(propName, vb);
}
else
{
//TODO: Warning if component has no such property (with reflection)
component.getAttributes().put(propName, value);
}
}
}
protected void setBooleanProperty(UIComponent component, String propName, String value)
{
if (value != null)
{
if (isValueReference(value))
{
ValueBinding vb = getFacesContext().getApplication().createValueBinding(value);
component.setValueBinding(propName, vb);
}
else
{
//TODO: More sophisticated way to convert boolean value (yes/no, 1/0, on/off, etc.)
component.getAttributes().put(propName, Boolean.valueOf(value));
}
}
}
protected void setValueProperty(UIComponent component, String value)
{
if (value != null)
{
if (isValueReference(value))
{
ValueBinding vb = getFacesContext().getApplication().createValueBinding(value);
component.setValueBinding("value", vb);
}
else if (component instanceof UICommand)
{
((UICommand)component).setValue(value);
}
else if (component instanceof UIParameter)
{
((UIParameter)component).setValue(value);
}
else if (component instanceof UISelectBoolean)
{
((UISelectBoolean)component).setValue(Boolean.valueOf(value));
}
else if (component instanceof UIGraphic)
{
((UIGraphic)component).setValue(value);
}
//Since many input components are ValueHolders the special components
//must come first, ValueHolder is the last resort.
else if (component instanceof ValueHolder)
{
((ValueHolder)component).setValue(value);
}
else
{
component.getAttributes().put("value", value);
}
}
}
protected void setConverterProperty(UIComponent component, String value)
{
if (value != null)
{
if (component instanceof ValueHolder)
{
if (isValueReference(value))
{
ValueBinding vb = getFacesContext().getApplication().createValueBinding(value);
component.setValueBinding("converter", vb);
}
else
{
FacesContext facesContext = FacesContext.getCurrentInstance();
Converter converter = facesContext.getApplication().createConverter(value);
((ValueHolder)component).setConverter(converter);
}
}
}
}
protected void setValidatorProperty(UIComponent component, String validator)
{
if (validator != null)
{
if (!(component instanceof EditableValueHolder))
{
throw new IllegalArgumentException();
}
if (isValueReference(validator))
{
MethodBinding mb = getFacesContext().getApplication().createMethodBinding(validator,
VALIDATOR_ARGS);
((EditableValueHolder)component).setValidator(mb);
}
}
}
protected void setActionProperty(UIComponent component, String action)
{
if (action != null)
{
if (!(component instanceof ActionSource))
{
throw new IllegalArgumentException();
}
MethodBinding mb;
if (isValueReference(action))
{
mb = getFacesContext().getApplication().createMethodBinding(action, null);
}
else
{
mb = new SimpleActionMethodBinding(action);
}
((ActionSource)component).setAction(mb);
}
}
protected void setActionListenerProperty(UIComponent component, String actionListener)
{
if (actionListener != null)
{
if (!(component instanceof ActionSource))
{
throw new IllegalArgumentException();
}
if (isValueReference(actionListener))
{
MethodBinding mb = getFacesContext().getApplication().createMethodBinding(actionListener,
ACTION_LISTENER_ARGS);
((ActionSource)component).setActionListener(mb);
}
}
}
protected void setValueChangedListenerProperty(UIComponent component, String valueChangedListener)
{
if (valueChangedListener != null)
{
if (!(component instanceof EditableValueHolder))
{
throw new IllegalArgumentException();
}
if (isValueReference(valueChangedListener))
{
MethodBinding mb = getFacesContext().getApplication().createMethodBinding(valueChangedListener,
VALUE_LISTENER_ARGS);
((EditableValueHolder)component).setValueChangeListener(mb);
}
}
}
protected void setValueBinding(UIComponent component,
String propName,
String value)
{
if (value != null)
{
if (isValueReference(value))
{
ValueBinding vb = getFacesContext().getApplication().createValueBinding(value);
component.setValueBinding(propName, vb);
}
}
}
}
More information about the jboss-cvs-commits
mailing list