All Downloads are FREE. Search and download functionalities are using the official Maven repository.
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.
com.vaadin.ui.declarative.converters.DesignResourceConverter Maven / Gradle / Ivy
/*
* Copyright (C) 2000-2024 Vaadin Ltd
*
* This program is available under Vaadin Commercial License and Service Terms.
*
* See for the full
* license.
*/
package com.vaadin.ui.declarative.converters;
import java.io.File;
import java.io.Serializable;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Locale;
import java.util.Map;
import java.util.stream.Collectors;
import com.vaadin.data.Converter;
import com.vaadin.data.Result;
import com.vaadin.data.ValueContext;
import com.vaadin.icons.VaadinIcons;
import com.vaadin.server.ExternalResource;
import com.vaadin.server.FileResource;
import com.vaadin.server.FontAwesome;
import com.vaadin.server.FontIcon;
import com.vaadin.server.GenericFontIcon;
import com.vaadin.server.Resource;
import com.vaadin.server.ResourceReference;
import com.vaadin.server.ThemeResource;
import com.vaadin.ui.declarative.DesignAttributeHandler;
/**
* A converter for {@link Resource} implementations supported by
* {@link DesignAttributeHandler}.
*
* @author Vaadin Ltd
* @since 7.4
*/
@SuppressWarnings("serial")
public class DesignResourceConverter implements Converter {
private static final Map CODE_POINTS = Arrays
.stream(VaadinIcons.values())
.collect(Collectors.toMap(VaadinIcons::getCodepoint, icon -> icon));
@Override
public Result convertToModel(String value, ValueContext context) {
if (!value.contains("://")) {
// assume it'is "file://" protocol, one that is used to access a
// file on a given path on the server, this will later be striped
// out anyway
value = "file://" + value;
}
String protocol = value.split("://")[0];
try {
ResourceConverterByProtocol converter = ResourceConverterByProtocol
.valueOf(protocol.toUpperCase(Locale.ROOT));
return Result.ok(converter.parse(value));
} catch (IllegalArgumentException iae) {
return Result.error("Unrecognized protocol: " + protocol);
}
}
@Override
public String convertToPresentation(Resource value, ValueContext context) {
ResourceConverterByProtocol byType = ResourceConverterByProtocol
.byType(value.getClass());
if (byType != null) {
return byType.format(value);
} else {
throw new IllegalArgumentException(
"unknown Resource type - " + value.getClass().getName());
}
}
private static interface ProtocolResourceConverter extends Serializable {
public String format(Resource value);
public Resource parse(String value);
}
private static enum ResourceConverterByProtocol
implements ProtocolResourceConverter {
HTTP, HTTPS, FTP, FTPS, THEME {
@Override
public Resource parse(String value) {
// strip "theme://" from the url, use the rest as the resource
// id
return new ThemeResource(value.substring(8));
}
@Override
public String format(Resource value) {
return new ResourceReference(value, null, null).getURL();
}
},
FONTICON {
@Override
public Resource parse(String value) {
final String address = value.split("://", 2)[1];
final String[] familyAndCode = address.split("/", 2);
final int codepoint = Integer.valueOf(familyAndCode[1], 16);
if (VAADIN_ICONS_NAME.equals(familyAndCode[0])) {
return CODE_POINTS.get(codepoint);
}
if (FontAwesome.FONT_FAMILY.equals(familyAndCode[0])) {
// Left for compatibility
return FontAwesome.fromCodepoint(codepoint);
}
// all vaadin icons should have a codepoint
FontIcon generic = new GenericFontIcon(familyAndCode[0],
codepoint);
return generic;
}
@Override
public String format(Resource value) {
FontIcon icon = (FontIcon) value;
return new ResourceReference(icon, null, null).getURL();
}
},
@Deprecated
FONT {
@Override
public Resource parse(String value) {
// Deprecated, 7.4 syntax is
// font://"+FontAwesome.valueOf(foo) e.g. "font://AMBULANCE"
final String iconName = value.split("://", 2)[1];
return FontAwesome.valueOf(iconName);
}
@Override
public String format(Resource value) {
throw new UnsupportedOperationException("Use "
+ ResourceConverterByProtocol.FONTICON + " instead");
}
},
FILE {
@Override
public Resource parse(String value) {
return new FileResource(new File(value.split("://")[1]));
}
@Override
public String format(Resource value) {
String path = ((FileResource) value).getSourceFile().getPath();
if (File.separatorChar != '/') {
// make sure we use '/' as file separator in templates
return path.replace(File.separatorChar, '/');
} else {
return path;
}
}
};
public static final String VAADIN_ICONS_NAME = VaadinIcons.ABACUS
.getFontFamily();
@Override
public Resource parse(String value) {
// default behavior for HTTP, HTTPS, FTP and FTPS
return new ExternalResource(value);
}
@Override
public String format(Resource value) {
// default behavior for HTTP, HTTPS, FTP and FTPS
return ((ExternalResource) value).getURL();
}
private static final Map, ResourceConverterByProtocol> TYPE_TO_CONVERTER = new HashMap<>();
static {
TYPE_TO_CONVERTER.put(ExternalResource.class, HTTP);
// ^ any of non-specialized would actually work
TYPE_TO_CONVERTER.put(ThemeResource.class, THEME);
TYPE_TO_CONVERTER.put(FontIcon.class, FONTICON);
TYPE_TO_CONVERTER.put(FileResource.class, FILE);
}
public static ResourceConverterByProtocol byType(
Class resourceType) {
for (Class type : TYPE_TO_CONVERTER.keySet()) {
if (type.isAssignableFrom(resourceType)) {
return TYPE_TO_CONVERTER.get(type);
}
}
return null;
}
}
}
