org.primefaces.util.ResourceUtils Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of primefaces Show documentation
Show all versions of primefaces Show documentation
PrimeFaces is one of the most popular UI libraries in Java EE Ecosystem and widely used by software companies, world renowned brands, banks, financial institutions, insurance companies, universities and more.
/**
* The MIT License
*
* Copyright (c) 2009-2019 PrimeTek
*
* 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.Serializable;
import java.util.ArrayList;
import java.util.List;
import javax.faces.FacesException;
import javax.faces.application.Application;
import javax.faces.application.Resource;
import javax.faces.application.ResourceHandler;
import javax.faces.component.UIComponent;
import javax.faces.component.UIOutput;
import javax.faces.context.FacesContext;
public class ResourceUtils {
public static final String RENDERER_SCRIPT = "javax.faces.resource.Script";
public static final String RENDERER_STYLESHEET = "javax.faces.resource.Stylesheet";
private ResourceUtils() {
}
public static String getResourceURL(FacesContext context, String value) {
if (LangUtils.isValueBlank(value)) {
return Constants.EMPTY_STRING;
}
else if (value.contains(ResourceHandler.RESOURCE_IDENTIFIER)) {
return value;
}
else {
String url = context.getApplication().getViewHandler().getResourceURL(context, value);
return context.getExternalContext().encodeResourceURL(url);
}
}
public static String getResourceRequestPath(FacesContext context, String resourceName) {
Resource resource = context.getApplication().getResourceHandler().createResource(resourceName, "primefaces");
return resource.getRequestPath();
}
public static void addComponentResource(FacesContext context, String name, String library, String target) {
Application application = context.getApplication();
UIComponent componentResource = application.createComponent(UIOutput.COMPONENT_TYPE);
componentResource.setRendererType(application.getResourceHandler().getRendererTypeForResourceName(name));
componentResource.getAttributes().put("name", name);
componentResource.getAttributes().put("library", library);
componentResource.getAttributes().put("target", target);
context.getViewRoot().addComponentResource(context, componentResource, target);
}
public static void addComponentResource(FacesContext context, String name, String library) {
addComponentResource(context, name, library, "head");
}
public static void addComponentResource(FacesContext context, String name) {
addComponentResource(context, name, Constants.LIBRARY, "head");
}
public static boolean isScript(UIComponent component) {
return RENDERER_SCRIPT.equals(component.getRendererType());
}
public static boolean isStylesheet(UIComponent component) {
return RENDERER_STYLESHEET.equals(component.getRendererType());
}
public static List getComponentResources(FacesContext context) {
List resourceInfos = new ArrayList<>();
List resources = context.getViewRoot().getComponentResources(context, "head");
if (resources != null) {
for (int i = 0; i < resources.size(); i++) {
UIComponent resource = resources.get(i);
ResourceUtils.ResourceInfo resourceInfo = newResourceInfo(resource);
if (resourceInfo != null && !resourceInfos.contains(resourceInfo)) {
resourceInfos.add(resourceInfo);
}
}
}
return resourceInfos;
}
public static boolean isInline(ResourceInfo resourceInfo) {
if (resourceInfo != null) {
return LangUtils.isValueBlank(resourceInfo.getLibrary()) && LangUtils.isValueBlank(resourceInfo.getName());
}
return false;
}
public static ResourceInfo newResourceInfo(UIComponent component) {
if (!(component instanceof UIOutput)) {
return null;
}
String library = (String) component.getAttributes().get("library");
String name = (String) component.getAttributes().get("name");
return new ResourceInfo(library, name, component);
}
public static Resource newResource(ResourceInfo resourceInfo, FacesContext context) {
Resource resource = context.getApplication().getResourceHandler().createResource(resourceInfo.getName(), resourceInfo.getLibrary());
if (resource == null) {
throw new FacesException("Resource '" + resourceInfo.getName() + "' in library '" + resourceInfo.getLibrary() + "' not found!");
}
return resource;
}
public static class ResourceInfo implements Serializable {
private static final long serialVersionUID = 1L;
private String library;
private String name;
private UIComponent resource;
public ResourceInfo(String library, String name, UIComponent resource) {
this.library = library;
this.name = name;
this.resource = resource;
}
public String getLibrary() {
return library;
}
public void setLibrary(String library) {
this.library = library;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public UIComponent getResource() {
return resource;
}
public void setResource(UIComponent resource) {
this.resource = resource;
}
@Override
public int hashCode() {
int hash = 7;
hash = 41 * hash + (this.library != null ? this.library.hashCode() : 0);
hash = 41 * hash + (this.name != null ? this.name.hashCode() : 0);
return hash;
}
@Override
public boolean equals(Object obj) {
if (obj == null) {
return false;
}
if (getClass() != obj.getClass()) {
return false;
}
final ResourceInfo other = (ResourceInfo) obj;
if ((this.library == null) ? (other.library != null) : !this.library.equals(other.library)) {
return false;
}
if ((this.name == null) ? (other.name != null) : !this.name.equals(other.name)) {
return false;
}
return true;
}
}
}