org.apache.myfaces.custom.effect.EffectRenderer Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.myfaces.custom.effect;
import java.io.IOException;
import javax.faces.component.UIComponent;
import javax.faces.context.FacesContext;
import javax.faces.context.ResponseWriter;
import org.apache.myfaces.custom.div.Div;
import org.apache.myfaces.custom.dojo.DojoConfig;
import org.apache.myfaces.custom.dojo.DojoUtils;
import org.apache.myfaces.custom.prototype.PrototypeResourceLoader;
import org.apache.myfaces.renderkit.html.util.AddResource;
import org.apache.myfaces.renderkit.html.util.AddResourceFactory;
import org.apache.myfaces.shared_tomahawk.renderkit.JSFAttr;
import org.apache.myfaces.shared_tomahawk.renderkit.RendererUtils;
import org.apache.myfaces.shared_tomahawk.renderkit.html.HTML;
import org.apache.myfaces.shared_tomahawk.renderkit.html.HtmlRenderer;
import org.apache.myfaces.shared_tomahawk.renderkit.html.HtmlRendererUtils;
/**
* Fade field only currently the renderer is implemented and the tag, because we
* do not store any extra functionality over a simple div in here
* For the fade, we only need a simple renderer and a backend javascript
* inclusion so that we can serve it out of the jar
*
* @author Werner Punz [email protected]
* @version $Revision: 472727 $ $Date: 2006-11-09 02:08:46 +0100 (Do, 09 Nov 2006) $
*/
public class EffectRenderer extends HtmlRenderer
{
private static final String DEFAULT_FADE_COLOR = "red";
public static final String RENDERER_TYPE = "org.apache.myfaces.effect.EffectRenderer";
/**
* Encodes any stand-alone javascript functions that are needed. Uses either
* the extension filter, or a user-supplied location for the javascript
* files.
*
* @param context
* FacesContext
* @param component
* UIComponent
*/
private void encodeJavascript(FacesContext context, UIComponent component)
{
// AddResource takes care to add only one reference to the same script
// render javascript function for client-side toggle (it won't be used
// if user has opted for server-side toggle)
String javascriptLocation = (String) component.getAttributes().get(JSFAttr.JAVASCRIPT_LOCATION);
AddResource addResource = AddResourceFactory.getInstance(context);
Boolean fade = (Boolean) component.getAttributes().get(EffectTag.TAG_PARAM_FADE);
try
{
if (javascriptLocation != null)
{
addResource
.addJavaScriptAtPosition(context, AddResource.HEADER_BEGIN, javascriptLocation + "/prototype.js");
addResource.addJavaScriptAtPosition(context, AddResource.HEADER_BEGIN, javascriptLocation + "/effects.js");
addResource.addJavaScriptAtPosition(context, AddResource.HEADER_BEGIN, javascriptLocation + "/fader.js");
if (fade != null && fade.booleanValue())
DojoUtils.addMainInclude(context, component, javascriptLocation, new DojoConfig());
}
else
{
addResource.addJavaScriptAtPosition(context, AddResource.HEADER_BEGIN, PrototypeResourceLoader.class,
"prototype.js");
addResource.addJavaScriptAtPosition(context, AddResource.HEADER_BEGIN, PrototypeResourceLoader.class,
"effects.js");
if (fade != null && fade.booleanValue())
DojoUtils.addMainInclude(context, component, null, new DojoConfig());
if (!DojoUtils.isInlineScriptSet(context, "fader.js"))
addResource.addJavaScriptHere(context, EffectRenderer.class, "fader.js");
}
}
catch (IOException e)
{
e.printStackTrace();
}
}
public boolean getRendersChildren()
{
return true;
}
/**
* We only need an encodeBeing method because the fade control, does not
* have any childs
*
* The fading is done via a styleClass tag according to the FAT specs, for
* now this is more flexible than embedding yet another tag in another tag
* but less flexible for styleClass usage reasons (but you always can use
* x:div for handling this issue in a proper manner)
*
* we have to do a full overload unfortunately because it is altered
* severely
*
*/
public void encodeBegin(FacesContext context, UIComponent component) throws IOException
{
if ((context == null) || (component == null))
{
throw new NullPointerException();
}
Boolean rendered = (Boolean) component.getAttributes().get("rendered");
if ((rendered != null) && (!rendered.booleanValue()))
return;
encodeJavascript(context, component);
super.encodeBegin(context, component);
renderEffectsBegin(context, component);
}
/**
* prepares the styleClasses for the fading renderer
*
* @param component
*/
private String getFadeColor(UIComponent component)
{
Boolean fade = (Boolean) component.getAttributes().get(EffectTag.TAG_PARAM_FADE);
if (fade != null && fade.booleanValue())
{
String fadeColor = (String) component.getAttributes().get(EffectTag.TAG_PARAM_FADECOLOR);
fadeColor = (fadeColor != null) ? fadeColor : DEFAULT_FADE_COLOR;
fadeColor = fadeColor.equals("") ? DEFAULT_FADE_COLOR : fadeColor;
if(fadeColor.trim().matches("^\\\\[(.*\\,)+\\\\]$")) //pattern [col,col,col] roughly
return fadeColor;
else return "\""+fadeColor+"\"";
}
return null;
}
public void renderEffectsBegin(FacesContext context, UIComponent component) throws IOException
{
// dump all the parameters which affect us into we dont set a central
// unchecked here to keep the warning level high
Boolean squish = (Boolean) component.getAttributes().get(EffectTag.TAG_PARAM_SQUISH);
Boolean puff = (Boolean) component.getAttributes().get(EffectTag.TAG_PARAM_PUFF);
Boolean scale = (Boolean) component.getAttributes().get(EffectTag.TAG_PARAM_SCALE);
Boolean pulsate = (Boolean) component.getAttributes().get(EffectTag.TAG_PARAM_PULSATE);
Integer scaleSize = (Integer) component.getAttributes().get(EffectTag.TAG_PARAM_SCALE_SIZE);
Div div = (Div) component;
ResponseWriter writer = context.getResponseWriter();
// if(fade != null && fade.booleanValue())
// ScriptController.renderScriptWithDeps(context, component, writer,
// ScriptController.FAT_VIEW_ID);
if (puff != null && puff.booleanValue())
{
//writer.writeAttribute(HTML.ONCLICK_ATTR, "javascript:new Effect.Puff(this);", null);
writer.startElement(HTML.SCRIPT_ELEM, component);
writer.writeAttribute(HTML.TYPE_ATTR, HTML.SCRIPT_TYPE_TEXT_JAVASCRIPT, null);
writer.write("var "+component.getClientId(context).replaceAll("\\:","_")+"_fader = new org_apache_myfaces_effects_fader('"+component.getClientId(context)+"',300);");
writer.endElement(HTML.SCRIPT_ELEM);
}
writer.startElement(HTML.DIV_ELEM, component);
HtmlRendererUtils.writeIdIfNecessary(writer, component, context);
String styleClass = div.getStyleClass();
String style = div.getStyle();
if (null != styleClass && null != style)
{
throw new IllegalStateException("Only one of style or styleClass can be specified");
}
if (null != styleClass)
{
writer.writeAttribute(HTML.CLASS_ATTR, styleClass, null);
}
if (null != style)
{
writer.writeAttribute(HTML.STYLE_ATTR, style, null);
}
// todo check the existing code for already existent javascript code
// not needed now, but probably in the long run
if (puff != null && puff.booleanValue())
{
writer.writeAttribute(HTML.ONCLICK_ATTR, "javascript:"+component.getClientId(context).replaceAll("\\:","_")+"_fader.fadeOut();", null);
//writer.startElement(HTML.SCRIPT_ELEM, component);
//writer.writeAttribute(HTML.TYPE_ATTR, HTML.SCRIPT_TYPE_TEXT_JAVASCRIPT, null);
///writer.write("var "+component.getClientId(context).replaceAll("\\:","_")+"_fader = new org_apache_myfaces_effects_fader('"+component.getClientId(context)+"',300);");
//writer.endElement(HTML.SCRIPT_ELEM);
}
if (squish != null && squish.booleanValue())
{
writer.writeAttribute(HTML.ONCLICK_ATTR, "javascript:new Effect.Squish(this);", null);
}
if (pulsate != null && pulsate.booleanValue())
{
writer.writeAttribute(HTML.ONCLICK_ATTR, "javascript:new Effect.Pulsate(this);", null);
}
if (scale != null && scale.booleanValue())
{
writer.writeAttribute(HTML.ONMOUSEOVER_ATTR, "javascript:new Effect.Scale(this," + scaleSize.toString()
+ ");", null);
writer.writeAttribute(HTML.ONMOUSEOUT_ATTR, "javascript:new Effect.Scale(this,100);", null);
}
}
/*
* (non-Javadoc)
*
* @see javax.faces.render.Renderer#encodeChildren(javax.faces.context.FacesContext,
* javax.faces.component.UIComponent)
*/
public void encodeChildren(FacesContext facesContext, UIComponent uiComponent) throws IOException
{
RendererUtils.renderChildren(facesContext, uiComponent);
HtmlRendererUtils.writePrettyLineSeparator(facesContext);
}
/**
* Standard encode end
*
*/
public void encodeEnd(FacesContext facesContext, UIComponent component) throws IOException
{
ResponseWriter writer = facesContext.getResponseWriter();
writer.endElement(HTML.DIV_ELEM);
HtmlRendererUtils.writePrettyLineSeparator(facesContext);
super.encodeEnd(facesContext, component);
Boolean rendered = (Boolean) component.getAttributes().get("rendered");
if ((rendered != null) && (!rendered.booleanValue()))
return;
Boolean fade = (Boolean) component.getAttributes().get(EffectTag.TAG_PARAM_FADE);
Integer duration = (Integer) component.getAttributes().get(EffectTag.TAG_PARAM_DURATION);
if (fade != null && fade.booleanValue())
{
DojoUtils.addRequire(facesContext,component, "dojo.lfx.*");
writer.startElement(HTML.SCRIPT_ELEM, component);
writer.writeAttribute(HTML.TYPE_ATTR, HTML.SCRIPT_TYPE_TEXT_JAVASCRIPT, null);
writer.writeAttribute(HTML.SCRIPT_LANGUAGE_ATTR, HTML.SCRIPT_LANGUAGE_JAVASCRIPT, null);
StringBuffer commandBuffer = new StringBuffer(128);
commandBuffer.append("dojo.lfx.html.highlight('");
commandBuffer.append(component.getClientId(facesContext));
commandBuffer.append("',");
commandBuffer.append(getFadeColor(component));
commandBuffer.append(",0).play(" + duration.toString() + ");");
writer.write(commandBuffer.toString());
writer.endElement(HTML.SCRIPT_ELEM);
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy