org.icefaces.ace.component.dialog.DialogRenderer 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
/*
* 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.dialog;
import java.io.IOException;
import javax.faces.component.UIComponent;
import javax.faces.component.UIInput;
import javax.faces.context.FacesContext;
import javax.faces.context.ResponseWriter;
import javax.faces.FacesException;
import org.icefaces.ace.renderkit.CoreRenderer;
import org.icefaces.ace.util.ComponentUtils;
import org.icefaces.ace.util.JSONBuilder;
import org.icefaces.component.Focusable;
import org.icefaces.impl.component.FocusManager;
import org.icefaces.render.MandatoryResourceComponent;
import org.icefaces.util.EnvUtils;
import org.icefaces.util.CoreComponentUtils;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
@MandatoryResourceComponent(tagName="dialog", value="org.icefaces.ace.component.dialog.Dialog")
public class DialogRenderer extends CoreRenderer {
@Override
public void decode(FacesContext context, UIComponent component) {
super.decodeBehaviors(context, component);
}
@Override
public void encodeEnd(FacesContext context, UIComponent component) throws IOException {
ResponseWriter writer = context.getResponseWriter();
Dialog dialog = (Dialog) component;
String clientId = dialog.getClientId(context);
writer.startElement("div", component);
writer.writeAttribute("id", clientId, null);
ComponentUtils.enableOnElementUpdateNotify(writer, clientId);
encodeMarkup(context, dialog);
encodeScript(context, dialog);
writer.endElement("div");
}
protected void encodeScript(FacesContext context, Dialog dialog) throws IOException {
ResponseWriter writer = context.getResponseWriter();
String clientId = dialog.getClientId(context);
boolean ariaEnabled = EnvUtils.isAriaEnabled(context);
String setFocusID = "";
//set focus on the specified component
String focusFor = dialog.getSetFocus();
if ("none".equalsIgnoreCase(focusFor)) {
setFocusID = "**none";
} else if (focusFor != null && !"".equals(focusFor)) {
UIComponent c = findComponent(dialog, focusFor);
if (c instanceof UIInput) {
setFocusID = c.getClientId(context);
}
if (c instanceof Focusable) {
setFocusID = ((Focusable) c).getFocusedElementId();
}
}
writer.startElement("script", null);
writer.writeAttribute("type", "text/javascript", null);
JSONBuilder jb = JSONBuilder.create();
jb.beginFunction("ice.ace.lazy")
.item("Dialog")
.beginArray()
.item(clientId)
.beginMap()
.entry("isVisible", dialog.isVisible())
.entry("minHeight", dialog.getMinHeight())
.entry("setFocus", setFocusID);
String baseclass = dialog.HIDE_CLASS;
if (dialog.isVisible()){
baseclass = dialog.SHOW_CLASS;
}
String styleClass = baseclass;
String style = dialog.getStyle();
String showEffect = dialog.getShowEffect();
String hideEffect = dialog.getHideEffect();
String headerText = dialog.getHeader();
String position = dialog.getPosition();
String dialogPosition = dialog.getDialogPosition();
String relativePosition = dialog.getRelativePosition();
String relativeTo = dialog.getRelativeTo();
int width = dialog.getWidth();
int height = dialog.getHeight();
int zIndex = dialog.getZindex();
int minWidth = dialog.getMinWidth();
String onShow = dialog.getOnShow();
String onHide = dialog.getOnHide();
boolean hasHeaderFacet = dialog.getFacet("header") != null;
String handle = dialog.getDragHandle();
if (styleClass != null) jb.entry("dialogClass", styleClass);
if (style != null) jb.entry("dialogStyle", style);
if (width > 0) jb.entry("width", width);
if (height > 0) jb.entry("height", height);
if (!dialog.isDraggable()) jb.entry("draggable", false);
if (dialog.isModal()) jb.entry("modal", true);
if (zIndex != 1000) jb.entry("zIndex", zIndex);
if (!dialog.isResizable()) jb.entry("resizable", false);
if (minWidth != 150) jb.entry("minWidth", minWidth);
if (showEffect != null) jb.entry("show", showEffect);
if (hideEffect != null) jb.entry("hide", hideEffect);
if (!dialog.isCloseOnEscape()) jb.entry("closeOnEscape", false);
if (!dialog.isClosable()) jb.entry("closable", false);
if (dialog.isMaximizableRestorable()) jb.entry("maximizableRestorable", true);
if (!dialog.isShowHeader() || hasHeaderFacet) jb.entry("showHeader", false);
if (onShow != null) jb.entry("onShow", "function(event, ui) {" + onShow + "}", true);
if (onHide != null) jb.entry("onHide", "function(event, ui) {" + onHide + "}", true);
if (hasHeaderFacet) jb.entry("headerFacet", true);
if (handle != null) jb.entry("handle", handle);
//Position
if (position != null) {
if (position.contains(",")) {
jb.entry("position", "[" + position + "]", true);
} else {
jb.entry("position", position);
}
}
if (relativeTo != null) { // overrides position attribute above
UIComponent relativeToComponent = dialog.findComponent(relativeTo);
if(relativeToComponent == null) {
relativeToComponent = CoreComponentUtils.findComponentInView(context.getViewRoot(), relativeTo);
}
if(relativeToComponent != null) {
jb.entry("relativeTo", relativeToComponent.getClientId(context));
jb.entry("dialogPosition", dialogPosition);
jb.entry("relativePosition", relativePosition);
} else {
throw new FacesException("ace:dialog - Cannot find component \"" + relativeTo + "\" in view.");
}
}
if (!hasHeaderFacet) jb.entryNonNullValue("title", headerText);
jb.entry("ariaEnabled", ariaEnabled);
//Behaviors
encodeClientBehaviors(context, dialog, jb);
jb.endMap().endArray();
jb.item(clientId); // root id
jb.endFunction();
writer.write("ice.ace.lazy.registry['"+clientId+"'] = function(){ return "+jb.toString()+"};");
if (dialog.isVisible()) writer.write("ice.ace.instance('"+clientId+"').show();");
writer.endElement("script");
}
protected void encodeMarkup(FacesContext facesContext, Dialog dialog) throws IOException {
ResponseWriter writer = facesContext.getResponseWriter();
String clientId = dialog.getClientId(facesContext);
String headerText = dialog.getHeader();
String baseclass = dialog.HIDE_CLASS;
if (dialog.isVisible()){
baseclass = dialog.SHOW_CLASS;
}
writer.startElement("div", null);
writer.writeAttribute("id", clientId + "_main", null);
if (dialog.getStyleClass() !=null && dialog.getStyleClass().trim().length()>0){
baseclass += dialog.getStyleClass();
}
writer.writeAttribute("class", baseclass, null);
UIComponent headerFacet = (UIComponent) dialog.getFacet("header");
if (headerFacet != null) {
writer.startElement("div", null);
writer.writeAttribute("class", "ui-dialog-titlebar", null);
org.icefaces.ace.component.menu.BaseMenuRenderer.encodeParentAndChildren(facesContext, headerFacet);
writer.endElement("div");
}
renderChildren(facesContext, dialog);
writer.endElement("div");
}
@Override
public void encodeChildren(FacesContext facesContext, UIComponent component) throws IOException {
//Rendering happens on encodeEnd
}
@Override
public boolean getRendersChildren() {
return true;
}
private static UIComponent findComponent(UIComponent base, String id) {
if (id.equals(base.getId()))
return base;
UIComponent kid;
UIComponent result = null;
Iterator kids = base.getFacetsAndChildren();
while (kids.hasNext() && (result == null)) {
kid = kids.next();
if (id.equals(kid.getId())) {
result = kid;
break;
}
result = findComponent(kid, id);
if (result != null) {
break;
}
}
return result;
}
}