Author: alexsmirnov Date: 2009-11-20 18:36:08 -0500 (Fri, 20 Nov 2009) New Revision: 15950 Added: root/cdk/trunk/plugins/maven-cdk-plugin/src/it/annotated-component/src/main/java/org/ajax4jsf/ root/cdk/trunk/plugins/maven-cdk-plugin/src/it/annotated-component/src/main/java/org/ajax4jsf/renderkit/ root/cdk/trunk/plugins/maven-cdk-plugin/src/it/annotated-component/src/main/java/org/ajax4jsf/renderkit/RendererUtils.java root/cdk/trunk/plugins/maven-cdk-plugin/src/it/xml-configured-component/src/main/java/org/ root/cdk/trunk/plugins/maven-cdk-plugin/src/it/xml-configured-component/src/main/java/org/ajax4jsf/ root/cdk/trunk/plugins/maven-cdk-plugin/src/it/xml-configured-component/src/main/java/org/ajax4jsf/renderkit/ root/cdk/trunk/plugins/maven-cdk-plugin/src/it/xml-configured-component/src/main/java/org/ajax4jsf/renderkit/RendererUtils.java Modified: root/cdk/trunk/plugins/maven-cdk-plugin/src/it/annotated-component/pom.xml root/cdk/trunk/plugins/maven-cdk-plugin/src/it/xml-configured-component/pom.xml Log: fix integration test builds Modified: root/cdk/trunk/plugins/maven-cdk-plugin/src/it/annotated-component/pom.xml =================================================================== --- root/cdk/trunk/plugins/maven-cdk-plugin/src/it/annotated-component/pom.xml 2009-11-20 17:15:37 UTC (rev 15949) +++ root/cdk/trunk/plugins/maven-cdk-plugin/src/it/annotated-component/pom.xml 2009-11-20 23:36:08 UTC (rev 15950) @@ -30,8 +30,8 @@ <artifactId>maven-compiler-plugin</artifactId> <configuration> <!-- http://maven.apache.org/plugins/maven-compiler-plugin/ --> - <source>1.5</source> - <target>1.5</target> + <source>1.6</source> + <target>1.6</target> </configuration> </plugin> </plugins> Added: root/cdk/trunk/plugins/maven-cdk-plugin/src/it/annotated-component/src/main/java/org/ajax4jsf/renderkit/RendererUtils.java =================================================================== --- root/cdk/trunk/plugins/maven-cdk-plugin/src/it/annotated-component/src/main/java/org/ajax4jsf/renderkit/RendererUtils.java (rev 0) +++ root/cdk/trunk/plugins/maven-cdk-plugin/src/it/annotated-component/src/main/java/org/ajax4jsf/renderkit/RendererUtils.java 2009-11-20 23:36:08 UTC (rev 15950) @@ -0,0 +1,988 @@ +/** + * License Agreement. + * + * Rich Faces - 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.ajax4jsf.renderkit; + + +import java.io.IOException; + +import java.lang.reflect.Array; + +import java.util.Arrays; +import java.util.Collection; +import java.util.HashMap; +import java.util.HashSet; +import java.util.Iterator; +import java.util.LinkedHashMap; +import java.util.LinkedHashSet; +import java.util.Map; +import java.util.Set; + +import javax.faces.FacesException; +import javax.faces.application.ViewHandler; +import javax.faces.component.EditableValueHolder; +import javax.faces.component.NamingContainer; +import javax.faces.component.UIComponent; +import javax.faces.component.UIForm; +import javax.faces.component.UIParameter; +import javax.faces.component.UIViewRoot; +import javax.faces.component.ValueHolder; +import javax.faces.component.behavior.ClientBehaviorContext.Parameter; +import javax.faces.component.behavior.ClientBehaviorHolder; +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(a)exadel.com (latest modification by $Author: alexsmirnov $) + * @version $Revision: 1.1.2.6 $ $Date: 2007/02/08 19:07:16 $ + * + */ +public class RendererUtils { + public static final String DUMMY_FORM_ID = ":_form"; + + // we'd better use this instance multithreadly quickly + private static final RendererUtils INSTANCE = new RendererUtils(); + + /** + * Substitutions for components properies names and HTML attributes names. + */ + private static Map<String, String> substitutions = new HashMap<String, String>(); + private static Set<String> requiredAttributes = new HashSet<String>(); + + static { + substitutions.put(HTML.CLASS_ATTRIBUTE, "styleClass"); + requiredAttributes.add(HTML.ALT_ATTRIBUTE); + Arrays.sort(HTML.PASS_THRU); + Arrays.sort(HTML.PASS_THRU_EVENTS); + Arrays.sort(HTML.PASS_THRU_BOOLEAN); + Arrays.sort(HTML.PASS_THRU_URI); + } + + // can be created by subclasses; + // administratively restricted to be created by package members ;) + protected RendererUtils() { + super(); + } + + /** + * Use this method to get singleton instance of RendererUtils + * @return singleton instance + */ + public static RendererUtils getInstance() { + return INSTANCE; + } + + /** + * 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); + } + } + + public Map<String, Object> createParametersMap(FacesContext context, UIComponent component) { + Map<String, Object> parameters = new LinkedHashMap<String, Object>(); + + + return parameters; + } + + private void encodeBehaviors(FacesContext context, ClientBehaviorHolder behaviorHolder, + String defaultHtmlEventName, String[] attributesExclusions) + throws IOException { + + } + + /** + * Encode common pass-thru html attributes. + * + * @param context + * @param component + * @throws IOException + */ + public void encodePassThru(FacesContext context, UIComponent component, String defaultHtmlEvent) + throws IOException { + + encodeAttributesFromArray(context, component, HTML.PASS_THRU); + + if (component instanceof ClientBehaviorHolder) { + ClientBehaviorHolder clientBehaviorHolder = (ClientBehaviorHolder) component; + + encodeBehaviors(context, clientBehaviorHolder, defaultHtmlEvent, null); + } else { + encodeAttributesFromArray(context, component, HTML.PASS_THRU_EVENTS); + } + } + + /** + * Encode pass-through attributes except specified ones + * + * @param context + * @param component + * @param exclusions + * @throws IOException + */ + public void encodePassThruWithExclusions(FacesContext context, UIComponent component, String exclusions, + String defaultHtmlEvent) throws IOException { + + if (null != exclusions) { + String[] exclusionsArray = exclusions.split(","); + + encodePassThruWithExclusionsArray(context, component, exclusionsArray, defaultHtmlEvent); + } + } + + public void encodePassThruWithExclusionsArray(FacesContext context, UIComponent component, String[] exclusions, + String defaultHtmlEvent) throws IOException { + + ResponseWriter writer = context.getResponseWriter(); + Map<String, Object> 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); + } + } + + if (component instanceof ClientBehaviorHolder) { + ClientBehaviorHolder clientBehaviorHolder = (ClientBehaviorHolder) component; + + encodeBehaviors(context, clientBehaviorHolder, defaultHtmlEvent, exclusions); + } else { + for (int i = 0; i < HTML.PASS_THRU_EVENTS.length; i++) { + String attribute = HTML.PASS_THRU_EVENTS[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 writer + * @param attribute + * @throws IOException + */ + public void encodePassThruAttribute(FacesContext context, Map<String, Object> attributes, ResponseWriter writer, + String attribute) throws IOException { + + Object value = attributeValue(attribute, attributes.get(getComponentAttributeName(attribute))); + + if ((null != value) && shouldRenderAttribute(attribute, 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<String, Object> 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 property + * @param attributeName + * + * @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(attributeName, value)) { + writer.writeAttribute(attributeName, value, property.toString()); + } + } + + public void encodeAttribute(FacesContext context, UIComponent component, String attribute) throws IOException { + encodeAttribute(context, component, getComponentAttributeName(attribute), attribute); + } + + public void writeText(ResponseWriter writer, Object value, String property) throws IOException { + if (value != null) { + writer.writeText(value, property); + } + } + + /** + * Write html-attribute + * + * @param writer + * @param attribute + * @param value + * @throws IOException + */ + public void writeAttribute(ResponseWriter writer, String attribute, Object value) throws IOException { + if (shouldRenderAttribute(attribute, 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); + } + } + + public boolean shouldRenderAttribute(String attributeName, Object attributeVal) { + if (!requiredAttributes.contains(attributeName)) { + return shouldRenderAttribute(attributeVal); + } else { + if (null == attributeVal) { + return false; + } + } + + return true; + } + + /** + * 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; + } + + /** + * Checks if the argument passed in is empty or not. + * Object is empty if it is: <br /> + * - <code>null<code><br /> + * - zero-length string<br /> + * - empty collection<br /> + * - empty map<br /> + * - zero-length array<br /> + * + * @param o object to check for emptiness + * @since 3.3.2 + * @return <code>true</code> if the argument is empty, <code>false</code> otherwise + */ + public boolean isEmpty(Object o) { + if (null == o) { + return true; + } + + if (o instanceof String) { + return 0 == ((String) o).length(); + } + + if (o instanceof Collection<?>) { + return ((Collection<?>) o).isEmpty(); + } + + if (o instanceof Map<?, ?>) { + return ((Map<?, ?>) o).isEmpty(); + } + + if (o.getClass().isArray()) { + return Array.getLength(o) == 0; + } + + return false; + } + + /** + * 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) { + return value; + } + + boolean checked; + + if (value instanceof Boolean) { + checked = ((Boolean) value).booleanValue(); + } else { + checked = Boolean.parseBoolean(value.toString()); + } + + return checked ? name : null; + } + + /** + * 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 ""; + } + + public String encodePx(String value) { + return null; + } + + /** + * formats given value to + * + * @param value + * + * @return + */ + public String encodePctOrPx(String value) { + if (value.indexOf('%') > 0) { + return value; + } else { + return encodePx(value); + } + } + + /** + * 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; display: inline;", 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 { + } + + /** + * @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 component + * @param script + */ + 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); + } + + /** + * @param ids + * @param keyword + * @since 4.0 + * + * @return + */ + private static boolean checkKeyword(Collection<String> ids, String keyword) { + if (ids.contains(keyword)) { + if (ids.size() != 1) { + //TODO log + } + + return true; + } + + return false; + } + + /** + * @param context + * @param component + * @param shortIds + * @since 4.0 + * @return + */ + public Collection<String> findComponentsFor(FacesContext context, UIComponent component, + Collection<String> shortIds) { + + // TODO - implement + // TODO add support for @* + Set<String> result = new LinkedHashSet<String>(shortIds.size()); + + + return result; + } + + public UIComponent findComponentFor(FacesContext context, UIComponent component, String id) { + return findComponentFor(component, id); + } + + /** + * @param component + * @param id + * @return + */ + public UIComponent findComponentFor(UIComponent component, String id) { + if (id == null) { + throw new NullPointerException("id is null!"); + } + + if (id.length() == 0) { + return null; + } + + UIComponent target = null; + UIComponent parent = component; + UIComponent root = component; + + while ((null == target) && (null != parent)) { + target = parent.findComponent(id); + root = parent; + parent = parent.getParent(); + } + + if (null == target) { + target = findUIComponentBelow(root, id); + } + + return target; + } + + /** + * If target component contains generated id and for doesn't, correct for id + * @param forAttr + * @param component + * + */ + public String correctForIdReference(String forAttr, UIComponent component) { + int contains = forAttr.indexOf(UIViewRoot.UNIQUE_ID_PREFIX); + + if (contains <= 0) { + String id = component.getId(); + int pos = id.indexOf(UIViewRoot.UNIQUE_ID_PREFIX); + + if (pos > 0) { + return forAttr.concat(id.substring(pos)); + } + } + + return forAttr; + } + + private UIComponent findUIComponentBelow(UIComponent root, String id) { + UIComponent target = null; + + for (Iterator<UIComponent> iter = root.getFacetsAndChildren(); iter.hasNext(); ) { + UIComponent child = (UIComponent) iter.next(); + + if (child instanceof NamingContainer) { + try { + target = child.findComponent(id); + } catch (IllegalArgumentException iae) { + continue; + } + } + + if (target == null) { + if ((child.getChildCount() > 0) || (child.getFacetCount() > 0)) { + target = findUIComponentBelow(child, id); + } + } + + if (target != null) { + break; + } + } + + return target; + } + + public static void writeEventHandlerFunction(FacesContext context, UIComponent component, String eventName) + throws IOException { + + } + + /** + * Common HTML elements and attributes names. + * + * @author asmirnov(a)exadel.com (latest modification by $Author: alexsmirnov $) + * @version $Revision: 1.1.2.6 $ $Date: 2007/02/08 19:07:16 $ + * + */ + public interface HTML { + public static final String ACCEPT_ATTRIBUTE = "accept"; + public static final String ACCEPT_CHARSET_ATTRIBUTE = "accept-charset"; + public static final String ACCESSKEY_ATTRIBUTE = "accesskey"; + public static final String ACTION_ATTRIBUTE = "action"; + public static final String ALIGN_ATTRIBUTE = "align"; + public static final String ALT_ATTRIBUTE = "alt"; + public static final String AUTOCOMPLETE_ATTRIBUTE = "autocomplete"; + public static final String A_ELEMENT = "a"; + public static final String BGCOLOR_ATTRIBUTE = "bgcolor"; + public static final String BODY_ELEMENT = "body"; + public static final String BORDER_ATTRIBUTE = "border"; + + // elements + public static final String BUTTON = "button"; + public static final String CAPTION_ELEMENT = "caption"; + public static final String CELLPADDING_ATTRIBUTE = "cellpadding"; + public static final String CELLSPACING_ATTRIBUTE = "cellspacing"; + public static final String CHARSET_ATTR = "charset"; + public static final String CLASS_ATTRIBUTE = "class"; + public static final String COLS_ATTRIBUTE = "cols"; + public static final String COORDS_ATTR = "coords"; + public static final String DIR_ATTRIBUTE = "dir"; + public static final String DISABLED_ATTR = "disabled"; + public static final String DIV_ELEM = "div"; + public static final String DL_ELEMENT = "dl"; + public static final String DT_ELEMENT = "dt"; + public static final String ENCTYPE_ATTRIBUTE = "enctype"; + public static final String FORM_ELEMENT = "form"; + public static final String FRAME_ATTRIBUTE = "frame"; + public static final String HEAD_ELEMENT = "head"; + public static final String HEIGHT_ATTRIBUTE = "height"; + public static final String HREFLANG_ATTR = "hreflang"; + public static final String HREF_ATTR = "href"; + public static final String HTML_ELEMENT = "html"; + + // attributes + public static final String ID_ATTRIBUTE = "id"; + public static final String IMG_ELEMENT = "img"; + public static final String INPUT_ELEM = "input"; + public static final Object INPUT_TYPE_HIDDEN = "hidden"; + public static final String LANG_ATTRIBUTE = "lang"; + public static final String LINK_ELEMENT = "link"; + public static final String LONGDESC_ATTRIBUTE = "longdesc"; + public static final String MAXLENGTH_ATTRIBUTE = "maxlength"; + public static final String MEDIA_ATTRIBUTE = "media"; + public static final String METHOD_ATTRIBUTE = "method"; + public static final String NAME_ATTRIBUTE = "name"; + public static final String NOWRAP_ATTRIBUTE = "nowrap"; + 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 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", "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", "align" + }; + + /** + * 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" + }; + public static final String[] PASS_THRU_EVENTS = { + "onblur", "onchange", "onclick", "ondblclick", "onfocus", "onkeydown", "onkeypress", "onkeyup", "onload", + "onmousedown", "onmousemove", "onmouseout", "onmouseover", "onmouseup", "onreset", "onselect", "onsubmit", + "onunload" + }; + public static final String[] PASS_THRU_STYLES = {"style", "class", }; + + /** + * 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 READONLY_ATTRIBUTE = "readonly"; + public static final String REL_ATTR = "rel"; + public static final String REV_ATTR = "rev"; + public static final String ROWS_ATTRIBUTE = "rows"; + public static final String RULES_ATTRIBUTE = "rules"; + public static final String SCRIPT_ELEM = "script"; + public static final String SHAPE_ATTR = "shape"; + public static final String SIZE_ATTRIBUTE = "size"; + public static final String SPAN_ELEM = "span"; + public static final String SRC_ATTRIBUTE = "src"; + public static final String STYLE_ATTRIBUTE = "style"; + public static final String STYLE_CLASS_ATTR = "styleClass"; + public static final String SUMMARY_ATTRIBUTE = "summary"; + public static final String TABINDEX_ATTRIBUTE = "tabindex"; + public static final String TABLE_ELEMENT = "table"; + public static final String TARGET_ATTRIBUTE = "target"; + public static final String TBOBY_ELEMENT = "tbody"; + public static final String TD_ELEM = "td"; + public static final String TEXT_JAVASCRIPT_TYPE = "text/javascript"; + public static final String TFOOT_ELEMENT = "tfoot"; + public static final String THEAD_ELEMENT = "thead"; + public static final String TH_ELEM = "th"; + public static final String TITLE_ATTRIBUTE = "title"; + public static final String TITLE_ELEM = "title"; + public static final String TR_ELEMENT = "tr"; + public static final String TYPE_ATTR = "type"; + public static final String USEMAP_ATTRIBUTE = "usemap"; + public static final String VALIGN_ATTRIBUTE = "valign"; + public static final String VALUE_ATTRIBUTE = "value"; + public static final String WIDTH_ATTRIBUTE = "width"; + } +} Modified: root/cdk/trunk/plugins/maven-cdk-plugin/src/it/xml-configured-component/pom.xml =================================================================== --- root/cdk/trunk/plugins/maven-cdk-plugin/src/it/xml-configured-component/pom.xml 2009-11-20 17:15:37 UTC (rev 15949) +++ root/cdk/trunk/plugins/maven-cdk-plugin/src/it/xml-configured-component/pom.xml 2009-11-20 23:36:08 UTC (rev 15950) @@ -31,8 +31,8 @@ <artifactId>maven-compiler-plugin</artifactId> <configuration> <!-- http://maven.apache.org/plugins/maven-compiler-plugin/ --> - <source>1.5</source> - <target>1.5</target> + <source>1.6</source> + <target>1.6</target> </configuration> </plugin> </plugins> Added: root/cdk/trunk/plugins/maven-cdk-plugin/src/it/xml-configured-component/src/main/java/org/ajax4jsf/renderkit/RendererUtils.java =================================================================== --- root/cdk/trunk/plugins/maven-cdk-plugin/src/it/xml-configured-component/src/main/java/org/ajax4jsf/renderkit/RendererUtils.java (rev 0) +++ root/cdk/trunk/plugins/maven-cdk-plugin/src/it/xml-configured-component/src/main/java/org/ajax4jsf/renderkit/RendererUtils.java 2009-11-20 23:36:08 UTC (rev 15950) @@ -0,0 +1,988 @@ +/** + * License Agreement. + * + * Rich Faces - 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.ajax4jsf.renderkit; + + +import java.io.IOException; + +import java.lang.reflect.Array; + +import java.util.Arrays; +import java.util.Collection; +import java.util.HashMap; +import java.util.HashSet; +import java.util.Iterator; +import java.util.LinkedHashMap; +import java.util.LinkedHashSet; +import java.util.Map; +import java.util.Set; + +import javax.faces.FacesException; +import javax.faces.application.ViewHandler; +import javax.faces.component.EditableValueHolder; +import javax.faces.component.NamingContainer; +import javax.faces.component.UIComponent; +import javax.faces.component.UIForm; +import javax.faces.component.UIParameter; +import javax.faces.component.UIViewRoot; +import javax.faces.component.ValueHolder; +import javax.faces.component.behavior.ClientBehaviorContext.Parameter; +import javax.faces.component.behavior.ClientBehaviorHolder; +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(a)exadel.com (latest modification by $Author: alexsmirnov $) + * @version $Revision: 1.1.2.6 $ $Date: 2007/02/08 19:07:16 $ + * + */ +public class RendererUtils { + public static final String DUMMY_FORM_ID = ":_form"; + + // we'd better use this instance multithreadly quickly + private static final RendererUtils INSTANCE = new RendererUtils(); + + /** + * Substitutions for components properies names and HTML attributes names. + */ + private static Map<String, String> substitutions = new HashMap<String, String>(); + private static Set<String> requiredAttributes = new HashSet<String>(); + + static { + substitutions.put(HTML.CLASS_ATTRIBUTE, "styleClass"); + requiredAttributes.add(HTML.ALT_ATTRIBUTE); + Arrays.sort(HTML.PASS_THRU); + Arrays.sort(HTML.PASS_THRU_EVENTS); + Arrays.sort(HTML.PASS_THRU_BOOLEAN); + Arrays.sort(HTML.PASS_THRU_URI); + } + + // can be created by subclasses; + // administratively restricted to be created by package members ;) + protected RendererUtils() { + super(); + } + + /** + * Use this method to get singleton instance of RendererUtils + * @return singleton instance + */ + public static RendererUtils getInstance() { + return INSTANCE; + } + + /** + * 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); + } + } + + public Map<String, Object> createParametersMap(FacesContext context, UIComponent component) { + Map<String, Object> parameters = new LinkedHashMap<String, Object>(); + + + return parameters; + } + + private void encodeBehaviors(FacesContext context, ClientBehaviorHolder behaviorHolder, + String defaultHtmlEventName, String[] attributesExclusions) + throws IOException { + + } + + /** + * Encode common pass-thru html attributes. + * + * @param context + * @param component + * @throws IOException + */ + public void encodePassThru(FacesContext context, UIComponent component, String defaultHtmlEvent) + throws IOException { + + encodeAttributesFromArray(context, component, HTML.PASS_THRU); + + if (component instanceof ClientBehaviorHolder) { + ClientBehaviorHolder clientBehaviorHolder = (ClientBehaviorHolder) component; + + encodeBehaviors(context, clientBehaviorHolder, defaultHtmlEvent, null); + } else { + encodeAttributesFromArray(context, component, HTML.PASS_THRU_EVENTS); + } + } + + /** + * Encode pass-through attributes except specified ones + * + * @param context + * @param component + * @param exclusions + * @throws IOException + */ + public void encodePassThruWithExclusions(FacesContext context, UIComponent component, String exclusions, + String defaultHtmlEvent) throws IOException { + + if (null != exclusions) { + String[] exclusionsArray = exclusions.split(","); + + encodePassThruWithExclusionsArray(context, component, exclusionsArray, defaultHtmlEvent); + } + } + + public void encodePassThruWithExclusionsArray(FacesContext context, UIComponent component, String[] exclusions, + String defaultHtmlEvent) throws IOException { + + ResponseWriter writer = context.getResponseWriter(); + Map<String, Object> 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); + } + } + + if (component instanceof ClientBehaviorHolder) { + ClientBehaviorHolder clientBehaviorHolder = (ClientBehaviorHolder) component; + + encodeBehaviors(context, clientBehaviorHolder, defaultHtmlEvent, exclusions); + } else { + for (int i = 0; i < HTML.PASS_THRU_EVENTS.length; i++) { + String attribute = HTML.PASS_THRU_EVENTS[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 writer + * @param attribute + * @throws IOException + */ + public void encodePassThruAttribute(FacesContext context, Map<String, Object> attributes, ResponseWriter writer, + String attribute) throws IOException { + + Object value = attributeValue(attribute, attributes.get(getComponentAttributeName(attribute))); + + if ((null != value) && shouldRenderAttribute(attribute, 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<String, Object> 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 property + * @param attributeName + * + * @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(attributeName, value)) { + writer.writeAttribute(attributeName, value, property.toString()); + } + } + + public void encodeAttribute(FacesContext context, UIComponent component, String attribute) throws IOException { + encodeAttribute(context, component, getComponentAttributeName(attribute), attribute); + } + + public void writeText(ResponseWriter writer, Object value, String property) throws IOException { + if (value != null) { + writer.writeText(value, property); + } + } + + /** + * Write html-attribute + * + * @param writer + * @param attribute + * @param value + * @throws IOException + */ + public void writeAttribute(ResponseWriter writer, String attribute, Object value) throws IOException { + if (shouldRenderAttribute(attribute, 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); + } + } + + public boolean shouldRenderAttribute(String attributeName, Object attributeVal) { + if (!requiredAttributes.contains(attributeName)) { + return shouldRenderAttribute(attributeVal); + } else { + if (null == attributeVal) { + return false; + } + } + + return true; + } + + /** + * 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; + } + + /** + * Checks if the argument passed in is empty or not. + * Object is empty if it is: <br /> + * - <code>null<code><br /> + * - zero-length string<br /> + * - empty collection<br /> + * - empty map<br /> + * - zero-length array<br /> + * + * @param o object to check for emptiness + * @since 3.3.2 + * @return <code>true</code> if the argument is empty, <code>false</code> otherwise + */ + public boolean isEmpty(Object o) { + if (null == o) { + return true; + } + + if (o instanceof String) { + return 0 == ((String) o).length(); + } + + if (o instanceof Collection<?>) { + return ((Collection<?>) o).isEmpty(); + } + + if (o instanceof Map<?, ?>) { + return ((Map<?, ?>) o).isEmpty(); + } + + if (o.getClass().isArray()) { + return Array.getLength(o) == 0; + } + + return false; + } + + /** + * 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) { + return value; + } + + boolean checked; + + if (value instanceof Boolean) { + checked = ((Boolean) value).booleanValue(); + } else { + checked = Boolean.parseBoolean(value.toString()); + } + + return checked ? name : null; + } + + /** + * 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 ""; + } + + public String encodePx(String value) { + return null; + } + + /** + * formats given value to + * + * @param value + * + * @return + */ + public String encodePctOrPx(String value) { + if (value.indexOf('%') > 0) { + return value; + } else { + return encodePx(value); + } + } + + /** + * 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; display: inline;", 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 { + } + + /** + * @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 component + * @param script + */ + 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); + } + + /** + * @param ids + * @param keyword + * @since 4.0 + * + * @return + */ + private static boolean checkKeyword(Collection<String> ids, String keyword) { + if (ids.contains(keyword)) { + if (ids.size() != 1) { + //TODO log + } + + return true; + } + + return false; + } + + /** + * @param context + * @param component + * @param shortIds + * @since 4.0 + * @return + */ + public Collection<String> findComponentsFor(FacesContext context, UIComponent component, + Collection<String> shortIds) { + + // TODO - implement + // TODO add support for @* + Set<String> result = new LinkedHashSet<String>(shortIds.size()); + + + return result; + } + + public UIComponent findComponentFor(FacesContext context, UIComponent component, String id) { + return findComponentFor(component, id); + } + + /** + * @param component + * @param id + * @return + */ + public UIComponent findComponentFor(UIComponent component, String id) { + if (id == null) { + throw new NullPointerException("id is null!"); + } + + if (id.length() == 0) { + return null; + } + + UIComponent target = null; + UIComponent parent = component; + UIComponent root = component; + + while ((null == target) && (null != parent)) { + target = parent.findComponent(id); + root = parent; + parent = parent.getParent(); + } + + if (null == target) { + target = findUIComponentBelow(root, id); + } + + return target; + } + + /** + * If target component contains generated id and for doesn't, correct for id + * @param forAttr + * @param component + * + */ + public String correctForIdReference(String forAttr, UIComponent component) { + int contains = forAttr.indexOf(UIViewRoot.UNIQUE_ID_PREFIX); + + if (contains <= 0) { + String id = component.getId(); + int pos = id.indexOf(UIViewRoot.UNIQUE_ID_PREFIX); + + if (pos > 0) { + return forAttr.concat(id.substring(pos)); + } + } + + return forAttr; + } + + private UIComponent findUIComponentBelow(UIComponent root, String id) { + UIComponent target = null; + + for (Iterator<UIComponent> iter = root.getFacetsAndChildren(); iter.hasNext(); ) { + UIComponent child = (UIComponent) iter.next(); + + if (child instanceof NamingContainer) { + try { + target = child.findComponent(id); + } catch (IllegalArgumentException iae) { + continue; + } + } + + if (target == null) { + if ((child.getChildCount() > 0) || (child.getFacetCount() > 0)) { + target = findUIComponentBelow(child, id); + } + } + + if (target != null) { + break; + } + } + + return target; + } + + public static void writeEventHandlerFunction(FacesContext context, UIComponent component, String eventName) + throws IOException { + + } + + /** + * Common HTML elements and attributes names. + * + * @author asmirnov(a)exadel.com (latest modification by $Author: alexsmirnov $) + * @version $Revision: 1.1.2.6 $ $Date: 2007/02/08 19:07:16 $ + * + */ + public interface HTML { + public static final String ACCEPT_ATTRIBUTE = "accept"; + public static final String ACCEPT_CHARSET_ATTRIBUTE = "accept-charset"; + public static final String ACCESSKEY_ATTRIBUTE = "accesskey"; + public static final String ACTION_ATTRIBUTE = "action"; + public static final String ALIGN_ATTRIBUTE = "align"; + public static final String ALT_ATTRIBUTE = "alt"; + public static final String AUTOCOMPLETE_ATTRIBUTE = "autocomplete"; + public static final String A_ELEMENT = "a"; + public static final String BGCOLOR_ATTRIBUTE = "bgcolor"; + public static final String BODY_ELEMENT = "body"; + public static final String BORDER_ATTRIBUTE = "border"; + + // elements + public static final String BUTTON = "button"; + public static final String CAPTION_ELEMENT = "caption"; + public static final String CELLPADDING_ATTRIBUTE = "cellpadding"; + public static final String CELLSPACING_ATTRIBUTE = "cellspacing"; + public static final String CHARSET_ATTR = "charset"; + public static final String CLASS_ATTRIBUTE = "class"; + public static final String COLS_ATTRIBUTE = "cols"; + public static final String COORDS_ATTR = "coords"; + public static final String DIR_ATTRIBUTE = "dir"; + public static final String DISABLED_ATTR = "disabled"; + public static final String DIV_ELEM = "div"; + public static final String DL_ELEMENT = "dl"; + public static final String DT_ELEMENT = "dt"; + public static final String ENCTYPE_ATTRIBUTE = "enctype"; + public static final String FORM_ELEMENT = "form"; + public static final String FRAME_ATTRIBUTE = "frame"; + public static final String HEAD_ELEMENT = "head"; + public static final String HEIGHT_ATTRIBUTE = "height"; + public static final String HREFLANG_ATTR = "hreflang"; + public static final String HREF_ATTR = "href"; + public static final String HTML_ELEMENT = "html"; + + // attributes + public static final String ID_ATTRIBUTE = "id"; + public static final String IMG_ELEMENT = "img"; + public static final String INPUT_ELEM = "input"; + public static final Object INPUT_TYPE_HIDDEN = "hidden"; + public static final String LANG_ATTRIBUTE = "lang"; + public static final String LINK_ELEMENT = "link"; + public static final String LONGDESC_ATTRIBUTE = "longdesc"; + public static final String MAXLENGTH_ATTRIBUTE = "maxlength"; + public static final String MEDIA_ATTRIBUTE = "media"; + public static final String METHOD_ATTRIBUTE = "method"; + public static final String NAME_ATTRIBUTE = "name"; + public static final String NOWRAP_ATTRIBUTE = "nowrap"; + 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 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", "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", "align" + }; + + /** + * 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" + }; + public static final String[] PASS_THRU_EVENTS = { + "onblur", "onchange", "onclick", "ondblclick", "onfocus", "onkeydown", "onkeypress", "onkeyup", "onload", + "onmousedown", "onmousemove", "onmouseout", "onmouseover", "onmouseup", "onreset", "onselect", "onsubmit", + "onunload" + }; + public static final String[] PASS_THRU_STYLES = {"style", "class", }; + + /** + * 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 READONLY_ATTRIBUTE = "readonly"; + public static final String REL_ATTR = "rel"; + public static final String REV_ATTR = "rev"; + public static final String ROWS_ATTRIBUTE = "rows"; + public static final String RULES_ATTRIBUTE = "rules"; + public static final String SCRIPT_ELEM = "script"; + public static final String SHAPE_ATTR = "shape"; + public static final String SIZE_ATTRIBUTE = "size"; + public static final String SPAN_ELEM = "span"; + public static final String SRC_ATTRIBUTE = "src"; + public static final String STYLE_ATTRIBUTE = "style"; + public static final String STYLE_CLASS_ATTR = "styleClass"; + public static final String SUMMARY_ATTRIBUTE = "summary"; + public static final String TABINDEX_ATTRIBUTE = "tabindex"; + public static final String TABLE_ELEMENT = "table"; + public static final String TARGET_ATTRIBUTE = "target"; + public static final String TBOBY_ELEMENT = "tbody"; + public static final String TD_ELEM = "td"; + public static final String TEXT_JAVASCRIPT_TYPE = "text/javascript"; + public static final String TFOOT_ELEMENT = "tfoot"; + public static final String THEAD_ELEMENT = "thead"; + public static final String TH_ELEM = "th"; + public static final String TITLE_ATTRIBUTE = "title"; + public static final String TITLE_ELEM = "title"; + public static final String TR_ELEMENT = "tr"; + public static final String TYPE_ATTR = "type"; + public static final String USEMAP_ATTRIBUTE = "usemap"; + public static final String VALIGN_ATTRIBUTE = "valign"; + public static final String VALUE_ATTRIBUTE = "value"; + public static final String WIDTH_ATTRIBUTE = "width"; + } +}