org.icefaces.ace.component.maskedentry.MaskedEntryRenderer Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of icefaces-ace Show documentation
Show all versions of icefaces-ace Show documentation
${icefaces.product.name} ACE Component Library
The newest version!
/*
* Original Code Copyright Prime Technology.
* Subsequent Code Modifications Copyright 2011-2014 ICEsoft Technologies Canada Corp. (c)
*
* 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.
*
* NOTE THIS CODE HAS BEEN MODIFIED FROM ORIGINAL FORM
*
* Subsequent Code Modifications have been made and contributed by ICEsoft Technologies Canada Corp. (c).
*
* Code Modification 1: Integrated with ICEfaces Advanced Component Environment.
* Contributors: ICEsoft Technologies Canada Corp. (c)
*
* Code Modification 2: (ICE-6978) Used JSONBuilder to add the functionality of escaping JS output.
* Contributors: ICEsoft Technologies Canada Corp. (c)
*/
package org.icefaces.ace.component.maskedentry;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
import javax.faces.component.UIComponent;
import javax.faces.context.FacesContext;
import javax.faces.context.ResponseWriter;
import org.icefaces.ace.renderkit.InputRenderer;
import org.icefaces.ace.util.ComponentUtils;
import org.icefaces.ace.util.HTML;
import org.icefaces.ace.util.Utils;
import org.icefaces.ace.util.JSONBuilder;
import org.icefaces.component.PassthroughAttributes;
import org.icefaces.render.MandatoryResourceComponent;
import org.icefaces.util.EnvUtils;
@MandatoryResourceComponent(tagName="maskedEntry", value="org.icefaces.ace.component.maskedentry.MaskedEntry")
public class MaskedEntryRenderer extends InputRenderer {
private final static String[] PASSTHROUGH_ATTRIBUTES = ((PassthroughAttributes) MaskedEntry.class.getAnnotation(PassthroughAttributes.class)).value();
@Override
public void decode(FacesContext context, UIComponent component) {
MaskedEntry maskedEntry = (MaskedEntry) component;
if(maskedEntry.isDisabled() || maskedEntry.isReadonly()) {
return;
}
decodeBehaviors(context, maskedEntry);
String clientId = maskedEntry.getClientId(context) + "_field";
Map requestParameterMap = context.getExternalContext().getRequestParameterMap();
String submittedValue = (String) requestParameterMap.get(clientId);
if (submittedValue == null && requestParameterMap.get(clientId + "_label") != null) {
submittedValue = "";
}
if(submittedValue != null) {
maskedEntry.setSubmittedValue(submittedValue);
}
}
@Override
public void encodeEnd(FacesContext context, UIComponent component) throws IOException {
MaskedEntry maskedEntry = (MaskedEntry) component;
ResponseWriter writer = context.getResponseWriter();
Map labelAttributes = getLabelAttributes(component);
labelAttributes.put("fieldClientId", maskedEntry.getClientId(context) + "_field");
writeLabelAndIndicatorBefore(labelAttributes);
encodeMarkup(context, maskedEntry, labelAttributes);
writeLabelAndIndicatorAfter(labelAttributes);
}
protected void encodeScript(FacesContext context, MaskedEntry maskedEntry, String label, boolean hasLabel, String labelPosition, String indicator, boolean hasIndicator, String indicatorPosition) throws IOException {
ResponseWriter writer = context.getResponseWriter();
String clientId = maskedEntry.getClientId(context);
String inFieldLabel = "";
if (hasLabel && labelPosition.equals("inField")) {
inFieldLabel = label;
if (hasIndicator) {
if (indicatorPosition.equals("labelLeft")) {
inFieldLabel = indicator + inFieldLabel;
} else if (indicatorPosition.equals("labelRight")) {
inFieldLabel = inFieldLabel + indicator;
}
}
}
writer.startElement("script", null);
writer.writeAttribute("type", "text/javascript", null);
String mask = maskedEntry.getMask();
if (mask == null) {
mask = "";
java.util.logging.Logger.getLogger(this.getClass().getName()).warning("Required attribute 'mask' is null in ace:maskedEntry component with id "+maskedEntry.getId()+" in view "+context.getViewRoot().getViewId()+".");
}
JSONBuilder jb = JSONBuilder.create()
.beginFunction("ice.ace.create")
.item("InputMask")
.beginArray()
.item(clientId)
.beginMap()
.entry("mask", mask);
String placeHolder = maskedEntry.getPlaceHolder();
if (placeHolder!=null) {
jb.entry("placeholder", placeHolder);
}
jb.entry("inFieldLabel", inFieldLabel);
jb.entry("inFieldLabelStyleClass", IN_FIELD_LABEL_STYLE_CLASS);
if (isValueBlank(ComponentUtils.getStringValueToRender(context, maskedEntry))) {
jb.entry("labelIsInField", true);
} else {
jb.entry("labelIsInField", false);
}
encodeClientBehaviors(context, maskedEntry, jb);
if (!themeForms()) {
jb.entry("theme", false);
}
jb.endMap().endArray().endFunction();
writer.write(jb.toString());
writer.endElement("script");
}
protected void encodeMarkup(FacesContext context, MaskedEntry maskedEntry, Map labelAttributes) throws IOException {
ResponseWriter writer = context.getResponseWriter();
String clientId = maskedEntry.getClientId(context);
String fieldClientId = clientId + "_field";
String defaultClass = themeForms() ? MaskedEntry.THEME_INPUT_CLASS : MaskedEntry.PLAIN_INPUT_CLASS;
String styleClass = maskedEntry.getStyleClass();
defaultClass += getStateStyleClasses(maskedEntry);
boolean ariaEnabled = EnvUtils.isAriaEnabled(context);
writer.startElement("span", maskedEntry);
writer.writeAttribute("id", clientId, null);
renderResetSettings(context, maskedEntry);
writer.startElement("input", null);
writer.writeAttribute("name", fieldClientId, null);
writer.writeAttribute("type", "text", null);
if (ariaEnabled) {
writer.writeAttribute("role", "textbox", null);
}
String valueToRender = null;
if (maskedEntry.isValid()) {
valueToRender = ComponentUtils.getStringValueToRender(context, maskedEntry);
} else {
valueToRender = (String) maskedEntry.getSubmittedValue();
}
boolean hasLabel = (Boolean) labelAttributes.get("hasLabel");
String labelPosition = (String) labelAttributes.get("labelPosition");
String label = (String) labelAttributes.get("label");
boolean hasIndicator = (Boolean) labelAttributes.get("hasIndicator");
String indicatorPosition = (String) labelAttributes.get("indicatorPosition");
String indicator = (String) labelAttributes.get("indicator");
if (isValueBlank(valueToRender) && hasLabel && labelPosition.equals("inField")) {
valueToRender = label;
if (hasIndicator) {
if (indicatorPosition.equals("labelLeft")) {
valueToRender = indicator + valueToRender;
} else if (indicatorPosition.equals("labelRight")) {
valueToRender = valueToRender + indicator;
}
}
defaultClass += " " + IN_FIELD_LABEL_STYLE_CLASS;
}
if(valueToRender != null) {
writer.writeAttribute("value", valueToRender , null);
}
renderPassThruAttributes(context, maskedEntry, HTML.INPUT_TEXT_ATTRS);
if (ariaEnabled) {
final MaskedEntry compoent = maskedEntry;
Map ariaAttributes = new HashMap() {{
put("readonly", compoent.isReadonly());
put("required", compoent.isRequired());
put("disabled", compoent.isDisabled());
put("invalid", !compoent.isValid());
}};
writeAriaAttributes(ariaAttributes, labelAttributes);
}
if(maskedEntry.isDisabled()) writer.writeAttribute("disabled", "disabled", "disabled");
if(maskedEntry.isReadonly()) writer.writeAttribute("readonly", "readonly", "readonly");
String style = maskedEntry.getStyle();
if(style != null) writer.writeAttribute("style", style, "style");
Utils.writeConcatenatedStyleClasses(writer, defaultClass, styleClass);
ComponentUtils.renderPassThroughAttributes(writer, maskedEntry, PASSTHROUGH_ATTRIBUTES);
ComponentUtils.renderExternalPassThroughAttributes(writer, maskedEntry);
writer.endElement("input");
encodeScript(context, maskedEntry, label, hasLabel, labelPosition, indicator, hasIndicator, indicatorPosition);
writer.endElement("span");
}
protected void renderResetSettings(FacesContext context, UIComponent component) throws IOException {
ResponseWriter writer = context.getResponseWriter();
String clientId = component.getClientId(context) + "_field";
String labelPosition = (String) component.getAttributes().get("labelPosition");
JSONBuilder jb = JSONBuilder.create();
jb.beginArray();
jb.item("InputMask");
jb.beginArray();
jb.item(clientId);
if ("inField".equals(labelPosition)) {
MaskedEntry maskedEntry = (MaskedEntry) component;
String label = (String) component.getAttributes().get("label");
String indicatorPosition = (String) component.getAttributes().get("indicatorPosition");
String optionalIndicator = (String) component.getAttributes().get("optionalIndicator");
String requiredIndicator = (String) component.getAttributes().get("requiredIndicator");
if ("labelLeft".equals(indicatorPosition)) {
if (maskedEntry.isRequired())
label = requiredIndicator + label;
else
label = optionalIndicator + label;
} else if ("labelRight".equals(indicatorPosition)) {
if (maskedEntry.isRequired())
label = label + requiredIndicator;
else
label = label + optionalIndicator;
}
jb.item(label);
jb.item(IN_FIELD_LABEL_STYLE_CLASS);
}
jb.endArray();
jb.endArray();
writer.writeAttribute("data-ice-reset", jb.toString(), null);
}
}