Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* The MIT License
*
* Copyright (c) 2009-2023 PrimeTek Informatics
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package org.primefaces.util;
import java.io.IOException;
import java.util.Map;
import javax.faces.component.UIComponent;
import javax.faces.context.FacesContext;
import javax.faces.context.ResponseWriter;
import org.primefaces.component.api.Widget;
import org.primefaces.config.PrimeConfiguration;
import org.primefaces.renderkit.RendererUtils;
/**
* Helper to generate scripts for widgets.
*/
public class WidgetBuilder {
protected boolean endFunction;
protected FacesContext context;
protected PrimeConfiguration configuration;
public WidgetBuilder(FacesContext context, PrimeConfiguration configuration) {
this.context = context;
this.configuration = configuration;
}
/**
*
* @param widgetClass Constructor name of the widget
* @param widgetVar Name of the client side widget
* @param id Client id of the component
* @param endFunction If the init script is wrapped by a method and if the endFunction parentheses should be rendered.
* @throws IOException if any IO exception occurs
* @return The current instance.
*/
protected WidgetBuilder init(String widgetClass, String widgetVar, String id, boolean endFunction) throws IOException {
this.endFunction = endFunction;
ResponseWriter rw = context.getResponseWriter();
rw.write("PrimeFaces.cw(\"");
rw.write(widgetClass);
rw.write("\",\"");
rw.write(widgetVar);
rw.write("\",{id:\"");
rw.write(id);
rw.write("\"");
return this;
}
public WidgetBuilder init(String widgetClass, T widget)
throws IOException {
return init(widgetClass, widget.resolveWidgetVar(context), widget.getClientId(context))
.renderLifecycleCallbacks(widget);
}
/**
* @deprecated Use {@link WidgetBuilder#init(String, UIComponent)} instead
*/
@Deprecated
public WidgetBuilder init(String widgetClass, String widgetVar, String id) throws IOException {
this.renderScriptBlock(id);
// AJAX case: since jQuery 3 document ready ($(function() {})) are executed async
// this would mean that our oncomplete handlers are probably called before the scripts in the update nodes
// or
// we can also skip it when MOVE_SCRIPTS_TO_BOTTOM is enabled as the scripts are already executed when everything is ready
if ((context.isPostback() && context.getPartialViewContext().isAjaxRequest()) || configuration.isMoveScriptsToBottom()) {
this.init(widgetClass, widgetVar, id, false);
}
else {
context.getResponseWriter().write("$(function(){");
this.init(widgetClass, widgetVar, id, true);
}
return this;
}
public WidgetBuilder initWithWindowLoad(String widgetClass, T widget)
throws IOException {
return initWithWindowLoad(widgetClass, widget.resolveWidgetVar(context), widget.getClientId(context))
.renderLifecycleCallbacks(widget);
}
public WidgetBuilder initWithWindowLoad(String widgetClass, String widgetVar, String id)
throws IOException {
this.renderScriptBlock(id);
context.getResponseWriter().write("$(window).on(\"load\",function(){");
this.init(widgetClass, widgetVar, id, true);
return this;
}
public WidgetBuilder initWithComponentLoad(String widgetClass, T widget, String targetId)
throws IOException {
return initWithComponentLoad(widgetClass, widget.resolveWidgetVar(context), widget.getClientId(context), targetId)
.renderLifecycleCallbacks(widget);
}
public WidgetBuilder initWithComponentLoad(String widgetClass, String widgetVar, String id, String targetId)
throws IOException {
this.renderScriptBlock(id);
context.getResponseWriter().write("PrimeFaces.onElementLoad($(PrimeFaces.escapeClientId(\"" + targetId + "\")),function(){");
this.init(widgetClass, widgetVar, id, true);
return this;
}
protected void renderScriptBlock(String id) throws IOException {
ResponseWriter rw = context.getResponseWriter();
rw.startElement("script", null);
rw.writeAttribute("id", id + "_s", null);
RendererUtils.encodeScriptTypeIfNecessary(context);
}
protected WidgetBuilder renderLifecycleCallbacks(UIComponent component) throws IOException {
Map attributes = component.getAttributes();
Object postConstruct = attributes.get(Widget.CALLBACK_POST_CONSTRUCT);
if (postConstruct != null) {
callback("postConstruct", "function(widget)", postConstruct.toString());
}
Object postRefresh = attributes.get(Widget.CALLBACK_POST_REFRESH);
if (postRefresh != null) {
callback("postRefresh", "function(widget)", postRefresh.toString());
}
Object preDestroy = attributes.get(Widget.CALLBACK_PRE_DESTROY);
if (preDestroy != null) {
callback("preDestroy", "function(widget)", preDestroy.toString());
}
return this;
}
/**
* This should only be used internally if the selector is directly used by jQuery on the client.
* If PFS is used and specified by the user, {@link #attr(java.lang.String, java.lang.String)} should be used
* as the users have to escape colons like @(myForm\:myId).
*
* @param name of the attribute
* @param value of the selector
* @return the WidgetBuilder
* @throws IOException if any error occurs
*/
public WidgetBuilder selectorAttr(String name, String value) throws IOException {
if (value != null) {
ResponseWriter rw = context.getResponseWriter();
rw.write(",");
rw.write(name);
rw.write(":\"");
rw.write(ComponentUtils.escapeSelector(value));
rw.write("\"");
}
return this;
}
public WidgetBuilder attr(String name, String value) throws IOException {
if (value != null) {
ResponseWriter rw = context.getResponseWriter();
rw.write(",");
rw.write(name);
rw.write(":\"");
rw.write(EscapeUtils.forJavaScript(value));
rw.write("\"");
}
return this;
}
public WidgetBuilder nativeAttr(String name, String value) throws IOException {
if (value != null) {
ResponseWriter rw = context.getResponseWriter();
rw.write(",");
rw.write(name);
rw.write(":");
rw.write(value);
}
return this;
}
public WidgetBuilder nativeAttr(String name, String value, String defaultValue) throws IOException {
if (value != null && !value.equals(defaultValue)) {
ResponseWriter rw = context.getResponseWriter();
rw.write(",");
rw.write(name);
rw.write(":");
rw.write(value);
}
return this;
}
public WidgetBuilder attr(String name, Boolean value) throws IOException {
if (value != null) {
ResponseWriter rw = context.getResponseWriter();
rw.write(",");
rw.write(name);
rw.write(":");
rw.write(Boolean.toString(value));
}
return this;
}
public WidgetBuilder attr(String name, Number value) throws IOException {
if (value != null) {
ResponseWriter rw = context.getResponseWriter();
rw.write(",");
rw.write(name);
rw.write(":");
rw.write(value.toString());
}
return this;
}
public WidgetBuilder attr(String name, String value, String defaultValue) throws IOException {
if (value != null && !value.equals(defaultValue)) {
ResponseWriter rw = context.getResponseWriter();
rw.write(",");
rw.write(name);
rw.write(":\"");
rw.write(EscapeUtils.forJavaScript(value));
rw.write("\"");
}
return this;
}
public WidgetBuilder attr(String name, double value, double defaultValue) throws IOException {
if (value != defaultValue) {
ResponseWriter rw = context.getResponseWriter();
rw.write(",");
rw.write(name);
rw.write(":");
rw.write(Double.toString(value));
}
return this;
}
public WidgetBuilder attr(String name, int value, int defaultValue) throws IOException {
if (value != defaultValue) {
ResponseWriter rw = context.getResponseWriter();
rw.write(",");
rw.write(name);
rw.write(":");
rw.write(Integer.toString(value));
}
return this;
}
public WidgetBuilder attr(String name, boolean value, boolean defaultValue) throws IOException {
if (value != defaultValue) {
ResponseWriter rw = context.getResponseWriter();
rw.write(",");
rw.write(name);
rw.write(":");
rw.write(Boolean.toString(value));
}
return this;
}
public WidgetBuilder callback(String name, String signature, String callback) throws IOException {
if (callback != null) {
ResponseWriter rw = context.getResponseWriter();
rw.write(",");
rw.write(name);
rw.write(":");
rw.write(signature);
rw.write("{");
rw.write(callback);
rw.write("}");
}
return this;
}
public WidgetBuilder returnCallback(String name, String signature, String callback) throws IOException {
if (callback != null) {
ResponseWriter rw = context.getResponseWriter();
rw.write(",");
rw.write(name);
rw.write(":");
rw.write(signature);
rw.write("{return ");
rw.write(callback);
rw.write("}");
}
return this;
}
public WidgetBuilder callback(String name, String callback) throws IOException {
if (callback != null) {
ResponseWriter rw = context.getResponseWriter();
rw.write(",");
rw.write(name);
rw.write(":");
rw.write(callback);
}
return this;
}
public WidgetBuilder append(String str) throws IOException {
context.getResponseWriter().write(str);
return this;
}
public WidgetBuilder append(char chr) throws IOException {
context.getResponseWriter().write(chr);
return this;
}
public WidgetBuilder append(Number number) throws IOException {
context.getResponseWriter().write(number.toString());
return this;
}
public void finish() throws IOException {
ResponseWriter rw = context.getResponseWriter();
rw.write("});");
if (endFunction) {
rw.write("});");
}
rw.endElement("script");
}
}
