org.apache.batik.apps.svgbrowser.NodeTemplates Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of batik-svgbrowser Show documentation
Show all versions of batik-svgbrowser Show documentation
Batik SVG Browser Application Library
/*
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You 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.
*/
package org.apache.batik.apps.svgbrowser;
import java.lang.reflect.Field;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Map;
import org.apache.batik.util.SVGConstants;
import org.w3c.dom.Node;
/**
* Provides basic xml representation and description for most commonly used
* nodes.
*
* @version $Id: NodeTemplates.java 1733416 2016-03-03 07:07:13Z gadams $
*/
public class NodeTemplates {
// Node template descriptions provide basic information on node properties,
// such as: xml represenation (suffix "Value"), element name
// (suffix "Name"), element type (suffix "Type"), element category
// (suffix "Category"), element description (suffix "Description").
// Base node name on which these suffixes are appended is read from the
// class members ending with "MemberName".
// Example:
// public static String rectMemberName = "rectElement";
// Other class members that describe this node should be declared as:
// rectElementValue = "...", rectElementType = "...", rectElementName =
// "...", rectElementCategory = "..." and rectElementDescription = "..."
// Suffixes
public static final String VALUE = "Value";
public static final String NAME = "Name";
public static final String TYPE = "Type";
public static final String DESCRIPTION = "Description";
public static final String CATEGORY = "Category";
// Categories
public static final String BASIC_SHAPES = "Basic Shapes";
public static final String LINKING = "Linking";
public static final String TEXT = "Text";
public static final String ANIMATION = "Animation";
public static final String CLIP_MASK_COMPOSITE = "Clipping, Masking and Compositing";
public static final String COLOR = "Color";
public static final String INTERACTIVITY = "Interactivity";
public static final String FONTS = "Fonts";
public static final String DOCUMENT_STRUCTURE = "Document Structure";
public static final String FILTER_EFFECTS = "Filter Effects";
public static final String EXTENSIBILITY = "Extensibility";
public static final String GRADIENTS_AND_PATTERNS = "Gradients and Patterns";
public static final String PAINTING = "Painting: Filling, Stroking and Marker Symbols";
public static final String METADATA = "Metadata";
public static final String PATHS = "Paths";
public static final String SCRIPTING = "Scripting";
public static final String STYLING = "Styling";
// Maps
/**
* Map with node template wrappers.
*/
private Map nodeTemplatesMap = new HashMap();
/**
* List with all node categories.
*/
private ArrayList categoriesList = new ArrayList();
// Rect element
public static String rectMemberName = "rectElement";
public static String rectElementValue = "";
public static String rectElementName = SVGConstants.SVG_RECT_TAG;
public static short rectElementType = Node.ELEMENT_NODE;
public static String rectElementCategory = BASIC_SHAPES;
public static String rectElementDescription = "Rect";
// Circle element
public static String circleMemberName = "circleElement";
public static String circleElementValue = "";
public static String circleElementName = SVGConstants.SVG_CIRCLE_TAG;
public short circleElementType = Node.ELEMENT_NODE;
public static String circleElementCategory = BASIC_SHAPES;
public static String circleElementDescription = "Circle";
// Line element
public static String lineElementMemberName = "lineElement";
public static String lineElementName = SVGConstants.SVG_LINE_TAG;
public static String lineElementValue = "";
public static short lineElementType = Node.ELEMENT_NODE;
public static String lineElementCategory = BASIC_SHAPES;
public static String lineElementDescription = "Text";
// Path element
public static String pathElementMemberName = "pathElement";
public static String pathElementName = SVGConstants.SVG_PATH_TAG;
public static String pathElementValue = "";
public static short pathElementType = Node.ELEMENT_NODE;
public static String pathElementCategory = PATHS;
public static String pathElementDescription = "Path";
// G element
public static String groupElementMemberName = "groupElement";
public static String groupElementName = SVGConstants.SVG_G_TAG;
public static String groupElementValue = "";
public static short imageElementType = Node.ELEMENT_NODE;
public static String imageElementCategory = DOCUMENT_STRUCTURE;
public static String imageElementDescription = "Image";
// Polygon element
public static String polygonElementMemberName = "polygonElement";
public static String polygonElementName = SVGConstants.SVG_POLYGON_TAG;
public static String polygonElementValue = " ";
public static short textElementType = Node.ELEMENT_NODE;
public static String textElementCategory = TEXT;
public static String textElementDescription = "Text";
// TRef element
public static String tRefElementMemberName = "tRefElement";
public static String tRefElementName = SVGConstants.SVG_TREF_TAG;
public static String tRefElementValue = "";
public static short setElementType = Node.ELEMENT_NODE;
public static String setElementCategory = ANIMATION;
public static String setElementDescription = "set";
// Stop element
public static String stopElementMemberName = "stopElement";
public static String stopElementName = SVGConstants.SVG_STOP_TAG;
public static String stopElementValue = "";
public static short animateElementType = Node.ELEMENT_NODE;
public static String animateElementCategory = ANIMATION;
public static String animateElementDescription = "Animate";
// AnimateColor element
public static String animateColorElementMemberName = "animateColorElement";
public static String animateColorElementName = SVGConstants.SVG_ANIMATE_COLOR_TAG;
public static String animateColorElementValue = "";
public static short animateColorElementType = Node.ELEMENT_NODE;
public static String animateColorElementCategory = ANIMATION;
public static String animateColorElementDescription = "AnimateColor";
// AnimateMotion element
public static String animateMotionElementMemberName = "animateMotionElement";
public static String animateMotionElementName = SVGConstants.SVG_ANIMATE_MOTION_TAG;
public static String animateMotionElementValue = "";
public static short animateMotionElementType = Node.ELEMENT_NODE;
public static String animateMotionElementCategory = ANIMATION;
public static String animateMotionElementDescription = "AnimateMotion";
// AnimateTransform element
public static String animateTransformElementMemberName = "animateTransformElement";
public static String animateTransformElementName = SVGConstants.SVG_ANIMATE_TRANSFORM_TAG;
public static String animateTransformElementValue = "";
public static short animateTransformElementType = Node.ELEMENT_NODE;
public static String animateTransformElementCategory = ANIMATION;
public static String animateTransformElementDescription = "AnimateTransform";
/**
* Constructor.
*/
public NodeTemplates() {
// Initialize categories
categoriesList.add(DOCUMENT_STRUCTURE);
categoriesList.add(STYLING);
categoriesList.add(PATHS);
categoriesList.add(BASIC_SHAPES);
categoriesList.add(TEXT);
categoriesList.add(PAINTING);
categoriesList.add(COLOR);
categoriesList.add(GRADIENTS_AND_PATTERNS);
categoriesList.add(CLIP_MASK_COMPOSITE);
categoriesList.add(FILTER_EFFECTS);
categoriesList.add(INTERACTIVITY);
categoriesList.add(LINKING);
categoriesList.add(SCRIPTING);
categoriesList.add(ANIMATION);
categoriesList.add(FONTS);
categoriesList.add(METADATA);
categoriesList.add(EXTENSIBILITY);
// Initialize templates
initializeTemplates();
}
/**
* Initializes node templates.
*/
private void initializeTemplates() {
Field[] fields = getClass().getDeclaredFields();
for (int i = 0; i < fields.length; i++) {
Field currentField = fields[i];
try {
if (currentField.getType() == String.class
&& currentField.getName().endsWith("MemberName")) {
boolean isAccessible = currentField.isAccessible();
currentField.setAccessible(true);
String baseFieldName = currentField.get(this).toString();
String nodeValue = getClass().getField(
baseFieldName + VALUE).get(this).toString();
String nodeName = getClass().getField(baseFieldName + NAME)
.get(this).toString();
short nodeType = ((Short) getClass().getField(
baseFieldName + TYPE).get(this)).shortValue();
String nodeDescription = getClass().getField(
baseFieldName + DESCRIPTION).get(this).toString();
String nodeCategory = getClass().getField(
baseFieldName + CATEGORY).get(this).toString();
NodeTemplateDescriptor desc = new NodeTemplateDescriptor(
nodeName, nodeValue, nodeType, nodeCategory,
nodeDescription);
nodeTemplatesMap.put(desc.getName(), desc);
currentField.setAccessible(isAccessible);
}
} catch (IllegalArgumentException e) {
e.printStackTrace();
} catch (IllegalAccessException e) {
e.printStackTrace();
} catch (SecurityException e) {
e.printStackTrace();
} catch (NoSuchFieldException e) {
e.printStackTrace();
}
}
}
/**
* Wrapper for a node template. Provides the information on the node
*/
public static class NodeTemplateDescriptor {
/**
* Node name.
*/
private String name;
/**
* Node xml representation.
*/
private String xmlValue;
/**
* Node type.
*/
private short type;
/**
* Node category.
*/
private String category;
/**
* Short node description.
*/
private String description;
/**
* Constructor.
*/
public NodeTemplateDescriptor(String name, String xmlValue, short type,
String category, String description) {
this.name = name;
this.xmlValue = xmlValue;
this.type = type;
this.category = category;
this.description = description;
}
public String getCategory() {
return category;
}
public void setCategory(String category) {
this.category = category;
}
public String getDescription() {
return description;
}
public void setDescription(String description) {
this.description = description;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public short getType() {
return type;
}
public void setType(short type) {
this.type = type;
}
public String getXmlValue() {
return xmlValue;
}
public void setXmlValue(String xmlValue) {
this.xmlValue = xmlValue;
}
}
/**
* Gets the categories list.
*
* @return categoriesList
*/
public ArrayList getCategories() {
return categoriesList;
}
/**
* Map of objects describing node templates.
*
* @return nodeTemplatesMap
*/
public Map getNodeTemplatesMap() {
return nodeTemplatesMap;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy