com.icesoft.faces.context.effects.LocalEffectEncoder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of icefaces-compat Show documentation
Show all versions of icefaces-compat Show documentation
${icefaces.product.name} Compat Component Library
The newest version!
/*
* Copyright 2004-2013 ICEsoft Technologies Canada Corp.
*
* Licensed 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 com.icesoft.faces.context.effects;
import com.icesoft.faces.renderkit.dom_html_basic.DomBasicRenderer;
import org.w3c.dom.Element;
import javax.faces.component.UIComponent;
import javax.faces.context.FacesContext;
import javax.faces.context.ResponseWriter;
import java.util.List;
import java.util.Map;
import java.util.logging.Level;
import java.util.logging.Logger;
/**
* Encode an effect call to an javascript event
*/
public class LocalEffectEncoder {
private static final String[] ALL_EVENTS = {
"onblur", // No corresponding effect
"onchange",
"onclick",
"oncontextmenu", // No corresponding effect
"ondblclick",
"onfocus", // No corresponding effect
"onkeydown",
"onkeypress",
"onkeyup",
"onmousedown",
"onmousemove",
"onmouseover",
"onmouseup",
"onmouseout",
"onreset",
"onselect", // No corresponding effect
"onsubmit"
};
private static final String[] ALL_EFFECTS = {
null,
"onchangeeffect",
"onclickeffect",
null,
"ondblclickeffect",
null,
"onkeydowneffect",
"onkeypresseffect",
"onkeyupeffect",
"onmousedowneffect",
"onmousemoveeffect",
"onmouseovereffect",
"onmouseupeffect",
"onmouseouteffect",
"onreseteffect",
null,
"onsubmiteffect"
};
private static final String[] EVENTS = {
"click", "dblclick", "mousedown",
"mouseup", "mousemove", "mouseover", "mouseout",
"change", "reset", "submit",
"keypress", "keydown", "keyup"
};
private static String[] ATTRIBUTES = new String[EVENTS.length];
private static final String ATTRIBUTE_PREFIX = "on";
private static String[] EFFECTS = new String[EVENTS.length];
private static final String EFFECT_SUFFIX = "effect";
static {
for (int index = 0; index < EVENTS.length; index++) {
ATTRIBUTES[index] = ATTRIBUTE_PREFIX + EVENTS[index];
EFFECTS[index] = ATTRIBUTES[index] + EFFECT_SUFFIX;
}
}
private static Logger log = Logger.getLogger("com.icesoft.faces.compat");
/**
* We only want to try processing the events that are relevant to each
* specific component, so we want the intersection of the complete event
* list, and the component's pass-through attributes. So that the indexes
* still match up, we just null out the undesired entries that we return.
*
* @param passthruAttributes Appropriate attributes from ExtendedAttributeConstants
* @return The intersection of the complete event list and passthruAttributes. Whatever's in both lists.
*/
public static String[] maskEvents(String[] passthruAttributes) {
int len = ALL_EVENTS.length;
String[] events = new String[len];
for (int i = 0; i < len; i++) {
String curr = ALL_EVENTS[i];
for (int j = passthruAttributes.length - 1; j >= 0; j--) {
if (curr.equals(passthruAttributes[j])) {
events[i] = curr;
break;
}
}
}
return events;
}
/**
* For every javascript event in the events parameter, combine the
* effect javascript if it's appropriate , the application javascript
* from the passthrough attribute, and the component renderers value
* from the rendererValues parameter, in that sequence, and output it
* to the DOM Element or the ResponseWriter, whichever is appropriate.
*
* @param facesContext
* @param comp
* @param events The result of calling maskEvents(String[])
* @param rendererValues Map where they keys are entries in ALL_EVENTS, and the values are the javascript that the component renderer wishes to emit
* @param rootNode
* @param writer
*/
public static void encode(FacesContext facesContext, UIComponent comp,
String[] events, Map rendererValues,
Element rootNode, ResponseWriter writer) {
Map atts = comp.getAttributes();
try {
for (int i = 0; i < events.length; i++) {
String currentEvent = events[i];
if (currentEvent == null)
continue;
String effectValue = null;
// If there can be a corresponding effect for this event
if (ALL_EFFECTS[i] != null) {
Effect fx = (Effect) atts.get(ALL_EFFECTS[i]);
if (fx == null) {
// in some cases the value binding can be null on the
// initial render but contain an effect later. This
// makes a place holder for that effect once it arrives.
if (comp.getValueBinding(ALL_EFFECTS[i]) != null) {
fx = new BlankEffect();
}
}
if (fx != null) {
effectValue = JavascriptContext.applyEffect(
fx,
comp.getClientId(facesContext),
facesContext);
}
}
String applicationValue = (String) atts.get(currentEvent);
String rendererValue = rendererValues == null ? null : (String) rendererValues.get(currentEvent);
String value = DomBasicRenderer.combinedPassThru(
DomBasicRenderer.combinedPassThru(
effectValue,
applicationValue),
rendererValue);
if (value != null) {
if (rootNode != null) {
rootNode.setAttribute(currentEvent, value);
} else if (writer != null) {
writer.writeAttribute(currentEvent, value, null);
}
}
}
} catch (Exception e) {
if (log.isLoggable(Level.SEVERE)) {
log.log(Level.SEVERE, e.getMessage(), e);
}
}
}
public static void encodeLocalEffects(
UIComponent comp, Element rootNode, FacesContext facesContext,
ResponseWriter writer, boolean attribTracking,
List attributesThatAreSet) {
if (attribTracking &&
(attributesThatAreSet == null ||
attributesThatAreSet.size() == 0)) {
return;
}
Map atts = comp.getAttributes();
try {
for (int i = 0; i < EVENTS.length; i++) {
if (attribTracking &&
(attributesThatAreSet == null ||
!attributesThatAreSet.contains(EFFECTS[i]))) {
continue;
}
Effect fx = (Effect) atts.get(EFFECTS[i]);
if (fx == null) {
// in some cases the value binding can be null on the initial render
// but contain an effect later. This makes a place holder for that effect
// once it arrives.
if (comp.getValueBinding(EFFECTS[i]) != null) {
fx = new BlankEffect();
}
}
if (fx != null) {
String value = JavascriptContext.applyEffect(fx,
comp.getClientId(
facesContext),
facesContext);
String original;
if (attribTracking &&
(attributesThatAreSet == null ||
!attributesThatAreSet.contains(ATTRIBUTES[i]))) {
original = null;
} else {
original = (String) atts.get(ATTRIBUTES[i]);
}
String together = DomBasicRenderer.combinedPassThru(value, original);
if (together != null) {
if (rootNode != null) {
rootNode.setAttribute(ATTRIBUTES[i], together);
} else if (writer != null) {
writer.writeAttribute(ATTRIBUTES[i], together, null);
}
}
}
}
} catch (Exception e) {
if (log.isLoggable(Level.SEVERE)) {
log.log(Level.SEVERE, e.getMessage(), e);
}
}
}
public static void encodeLocalEffects(UIComponent comp, Element rootNode,
FacesContext facesContext) {
encodeLocalEffects(comp, rootNode, facesContext, null, false, null);
}
public static void encodeLocalEffects(UIComponent comp, ResponseWriter writer,
FacesContext facesContext) {
encodeLocalEffects(comp, null, facesContext, writer, false, null);
}
public static void encodeLocalEffect(String id, Effect fx, String event, FacesContext facesContext) {
String value = JavascriptContext.applyEffect(fx, id, facesContext);
//TODO: refactor so that is dosen't clobber an existing effect
String js = "Ice.Prototype.$('" + id + "').on" + event + "=function(){" + value + "};";
JavascriptContext.addJavascriptCall(facesContext, js);
}
}