• Home
• com.globalmentor
• globalmentor-swing
• 0.5.0
• source code
• XMLStyles.java

×

Project download

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.globalmentor.swing.text.xml.XMLStyles Maven / Gradle / Ivy

/*
 * Copyright © 1996-2009 GlobalMentor, Inc. 
 *
 * 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.
 */

package com.globalmentor.swing.text.xml;

import java.net.URI;
import java.net.URISyntaxException;
import javax.swing.text.AttributeSet;
import javax.swing.text.Element;
import javax.swing.text.MutableAttributeSet;

import static com.globalmentor.java.Objects.*;
import static com.globalmentor.swing.text.Styles.*;

import com.globalmentor.java.Objects;
import com.globalmentor.model.NameValuePair;
import com.globalmentor.net.ContentType;
import com.globalmentor.rdf.RDFResource;
import com.globalmentor.swing.text.Styles;
import com.globalmentor.w3c.spec.XML;

/**
 * A collection of utilities for working with XML values used Swing style.
 * 

 * These routines store XML attributes in the Swing attributes as an {@link XMLAttribute} object, keyed to the attribute name prefixed by the namespace URI and
 * '$', if the attribute has a non-null namespace.
 * 
 * 

 * XML-specific attributes besides the XML attributes themselves are stored keyed to names beginning with '$'.
 * 
 * @author Garret Wilson
 * @see com.globalmentor.swing.text.xml.XMLAttribute
 */
public class XMLStyles {

	/** The default font size. */
	//TODO should this go elsewhere?
	public static final int DEFAULT_FONT_SIZE = 12;

	/** The default line height (line spacing). */
	//TODO should this go elsewhere?
	public static final float DEFAULT_LINE_HEIGHT = 1.0f;

	/** The default text indent. */
	//TODO should this go elsewhere?
	public static final int DEFAULT_TEXT_INDENT = 0;

	/**
	 * Whether or not a component should get a page-break view. Overrides the paragraph view and block/inline attributes.
	 * @see #PARAGRAPH_VIEW_ATTRIBUTE_NAME
	 */
	public static final String PAGE_BREAK_VIEW_ATTRIBUTE_NAME = Styles.SWING_ATTRIBUTE_START + "pageBreakView";

	/**
	 * The public ID of the document type of the document, the root element of which this set of attributes represents.
	 */
	public static final String XML_DOCTYPE_PUBLIC_ID = Styles.SWING_ATTRIBUTE_START + "xmlDocTypePublicID";

	/**
	 * The system ID of the document type of the document, the root element of which this set of attributes represents.
	 */
	public static final String XML_DOCTYPE_SYSTEM_ID = Styles.SWING_ATTRIBUTE_START + "xmlDocTypeSystemID";

	/** The local name of the XML element this set of attributes represents. */
	public static final String XML_ELEMENT_LOCAL_NAME_ATTRIBUTE_NAME = Styles.SWING_ATTRIBUTE_START + "xmlElementLocalName";

	/** The name of the XML element this set of attributes represents. */
	public static final String XML_ELEMENT_NAME_ATTRIBUTE_NAME = Styles.SWING_ATTRIBUTE_START + "xmlElementName";

	/** The name of elements that are anonymously created. */
	public static final String ANONYMOUS_XML_ELEMENT_NAME = Styles.SWING_ATTRIBUTE_START + "anonymous";

	/** The namespace URI of the XML element this set of attributes represents. */
	public static final String XML_ELEMENT_NAMESPACE_URI_ATTRIBUTE_NAME = Styles.SWING_ATTRIBUTE_START + "xmlElementNamespaceURI";

	/**
	 * A Boolean specifying whether the XML element this set of attributes represents is an empty element.
	 */
	public static final String XML_EMPTY_ELEMENT = Styles.SWING_ATTRIBUTE_START + "xmlEmptyElement";

	/** The array of processing instructions this document contains. */
	public static final String XML_PROCESSING_INSTRUCTIONS_ATTRIBUTE_NAME = Styles.SWING_ATTRIBUTE_START + "xmlProcessingInstructions";

	/** The name of the attribute representing the base URI. */
	public static final String BASE_URI_ATTRIBUTE_NAME = Styles.SWING_ATTRIBUTE_START + "baseURI";

	/** The name of the attribute representing the media type. */
	public static final String MEDIA_TYPE_ATTRIBUTE_NAME = Styles.SWING_ATTRIBUTE_START + "mediaType";

	/**
	 * The name of the attribute representing the full XLink target ID URI, including for example the ID as a relative path.
	 */
	public static final String TARGET_URI_ATTRIBUTE_NAME = Styles.SWING_ATTRIBUTE_START + "targetURI";

	/** The RDF resource description of the document hierarchy this set of attributes represents. */
	public static final String DOCUMENT_DESCRIPTION_ATTRIBUTE_NAME = Styles.SWING_ATTRIBUTE_START + "documentDescription";

	/** Whether or not text in this view or any child views should be antialiased. */
	public static final String ANTIALIAS_ATTRIBUTE_NAME = Styles.SWING_ATTRIBUTE_START + "antialias";

	/**
	 * An empty array of name/value pairs to return when, for example, no processing instructions are available.
	 */
	protected static final NameValuePair[] EMPTY_NAME_VALUE_PAIR_ARRAY = new NameValuePair[] {};

	/** The delimiter used for forming combined namespaceURI+localName names for XML attributes. */
	protected static final char ATTRIBUTE_NAMESPACE_DELIMITER = '$';

	/**
	 * Searches up the element hierarchy for an element with the given namespace URI and local name. The given element itself is not checked.
	 * @param element The element the ancestors of which should be checked.
	 * @param namespaceURI The XML namespace of the element to find, or null if the element is not in a namespace.
	 * @param localName The XML local name of the element to find.
	 * @return The ancestor element with the given XML local name, or null if there is no such ancestor element.
	 */
	public static Element getAncestorElement(final Element element, final String namespaceURI, final String localName) {
		Element parentElement = element.getParentElement(); //get the element's parent
		while(parentElement != null) { //keep looking up the hierarchy until we run out of parents
			final AttributeSet attributeSet = parentElement.getAttributes(); //get the parent element's attribute set
			if(isXMLElement(attributeSet, namespaceURI, localName)) { //if this attribute set matches
				break; //we've found the correct ancestor; stop looking
			}
			parentElement = parentElement.getParentElement(); //look at this element's parent
		}
		return parentElement; //return the parent element, which will be null if we didn't find a match
	}

	/**
	 * Searches for a direct child element with the given namespace URI and local name.
	 * @param element The element the children of which should be checked.
	 * @param localName The XML local name of the element to find.
	 * @param namespaceURI The XML namespace of the element to find, or null if the element is not in a namespace.
	 * @return The first child element with the given XML local name, or null if there is no such child element.
	 */
	public static Element getChildElement(final Element element, final String namespaceURI, final String localName) {
		final int childElementCount = element.getElementCount(); //find out how many child elements there are
		for(int i = 0; i < childElementCount; ++i) { //look at each child element
			final Element childElement = element.getElement(i); //get a reference to this child element
			final AttributeSet childAttributeSet = childElement.getAttributes(); //get the child element's attribute set
			if(isXMLElement(childAttributeSet, namespaceURI, localName)) { //if this attribute set matches
				return childElement; //return the child element we found
			}
		}
		return null; //show that we couldn't find a matching child element
	}

	/**
	 * Determines if the given attribute set represents an XML element with the given namespace URI and local name.
	 * @param namespaceURI The XML namespace, or null if the element is not in a namespace.
	 * @param localName The XML local name.
	 * @return true if the given attribute set represents an XML element with the given namespace and local name.
	 */
	public static boolean isXMLElement(final AttributeSet attributeSet, final String namespaceURI, final String localName) {
		final String elementNamespaceURI = getXMLElementNamespaceURI(attributeSet); //get the namespace
		if(Objects.equals(namespaceURI, elementNamespaceURI)) { //if the namespace URI matches (or they are both null)
			final String elementLocalName = getXMLElementLocalName(attributeSet); //get the local name of this element
			if(localName.equals(elementLocalName)) { //if this element has the correct local name
				return true; //show that this attribute set represents the requested XML element
			}
		}
		return false; //indicate that either the namespace URI or local name was incorrect
	}

	/** The name of the map of XML attributes. */
	//TODO fix	public static final String XMLAttributesAttributeName="XMLAttributes";

	/**
	 * Returns an XML attribute with the given namespace and local name from the attribute set. The attribute is resolved by searching the parent attribute set
	 * hierarchy.
	 * @param attributeSet The attribute set, which may be null.
	 * @param attributeNamespaceURI The namespace URI of the XML attribute.
	 * @param attributeLocalName The local name of the XML attribute.
	 * @return The attribute if the attribute is defined up the hierarchy, else null.
	 */
	/*TODO del if not needed
		public static Object getDefinedAttribute(AttributeSet attributeSet, final String attributeNamespaceURI, final String attributeLocalName)
		{
			return attributeSet!=null ? //make sure there is an attributeset
				(attributeSet.isDefined(attributeName) ? attributeSet.getAttribute(attributeName) : null) :
				null;	//return the attribute if it is defined, or null if it isn't
		}
	*/

	/**
	 * Determines the name to use in Swing for an XML attribute namespace and local name. This name is calculated by prepending the local name with the namespace
	 * plus a delimiter if a namespace is present.
	 * @param attributeNamespaceURI The namespace URI of the XML attribute.
	 * @param attributeLocalName The local name of the XML attribute.
	 * @return A string suitable for a Swing attribute name to represent an XML attribute.
	 * @see #ATTRIBUTE_NAMESPACE_DELIMITER
	 */
	protected static String getSwingXMLAttributeName(final String attributeNamespaceURI, final String attributeLocalName) {
		//if there is a namespace URI, append it to the local name separated by the delimiter
		return attributeNamespaceURI != null ? attributeNamespaceURI + ATTRIBUTE_NAMESPACE_DELIMITER + attributeLocalName : attributeLocalName;
	}

	/**
	 * Checks to see if an XML attribute with the given namespace and local name exists in the given attribute set. The attribute is not resolved by searching the
	 * parent attribute set hierarchy.
	 * @param attributeSet The attribute set, which may be null.
	 * @param attributeNamespaceURI The namespace URI of the XML attribute.
	 * @param attributeLocalName The local name of the XML attribute.
	 * @return true if the XML attribute exists in this attribute set, else null.
	 */
	public static boolean isXMLAttributeDefined(final AttributeSet attributeSet, final String attributeNamespaceURI, final String attributeLocalName) {
		//see if an attribute with the XML name appears in the attribute set
		return attributeSet.isDefined(getSwingXMLAttributeName(attributeNamespaceURI, attributeLocalName));
	}

	/**
	 * Returns an XML attribute with the given namespace and local name from the attribute set. The attribute is not resolved by searching the parent attribute
	 * set hierarchy.
	 * @param attributeSet The attribute set, which may be null.
	 * @param attributeNamespaceURI The namespace URI of the XML attribute.
	 * @param attributeLocalName The local name of the XML attribute.
	 * @return The attribute if the attribute is defined in this attribute set, else null.
	 */
	public static XMLAttribute getXMLAttribute(final AttributeSet attributeSet, final String attributeNamespaceURI, final String attributeLocalName) {
		//see if an attribute with the XML name appears in the attribute set
		return (XMLAttribute)getDefinedAttribute(attributeSet, getSwingXMLAttributeName(attributeNamespaceURI, attributeLocalName));
	}

	/**
	 * Returns an XML attribute with the given namespace and local name from the attribute set. The attribute is not resolved by searching the parent attribute
	 * set hierarchy.
	 * @param attributeSet The attribute set, which may be null.
	 * @param attributeNamespaceURI The namespace URI of the XML attribute.
	 * @param attributeLocalName The local name of the XML attribute.
	 * @return The attribute if the attribute is defined in this attribute set, else null.
	 */
	public static String getXMLAttributeValue(final AttributeSet attributeSet, final String attributeNamespaceURI, final String attributeLocalName) {
		final XMLAttribute xmlAttribute = getXMLAttribute(attributeSet, attributeNamespaceURI, attributeLocalName); //get this attribute, if there is one
		return xmlAttribute != null ? xmlAttribute.getValue() : null; //return the value of the XML attribute, if there is such an attribute
	}

	/**
	 * Adds an XML attribute with the given namespace and qualified name the attribute set.
	 * @param attributeSet The attribute set.
	 * @param attributeNamespaceURI The namespace URI of the XML attribute.
	 * @param attributeQualifiedName The qualified name of the XML attribute.
	 * @param attributeValue The value of the XML attribute to add.
	 */
	public static void addXMLAttribute(final MutableAttributeSet attributeSet, final String attributeNamespaceURI, final String attributeQualifiedName,
			final String attributeValue) {
		//create an object to represent this XML attribute and value
		final XMLAttribute xmlAttribute = new XMLAttribute(attributeNamespaceURI, attributeQualifiedName, attributeValue);
		//add attribute object to the attribute set using the appropriate URI+localName Swing key
		attributeSet.addAttribute(getSwingXMLAttributeName(attributeNamespaceURI, XML.getLocalName(attributeQualifiedName)), xmlAttribute);
	}

	/**
	 * Gets the namespace of an attribute (encoded in another attribute) without resolving up the attribute set hierarchy.
	 * @param attributeSet The attribute set.
	 * @param attributeLocalName
	 * @return The target URI of the element, or null if the element has no target URI defined.
	 */
	/*TODO fix
		public static String getAttributeNamespace(final AttributeSet attributeSet)
		{
			return (URI)getDefinedAttribute(attributeSet, TARGET_URI_ATTRIBUTE_NAME);	//get the target URI if one is defined
		}
	*/

	/**
	 * Sets the target URI of the element.
	 * @param attributeSet The attribute set.
	 * @param uri The element target URI, such as would be the target of a hypertext reference.
	 */
	/*TODO fix
		public static void setTargetURI(final MutableAttributeSet attributeSet, final URI uri)
		{
			attributeSet.addAttribute(TARGET_URI_ATTRIBUTE_NAME, uri);	//add the attribute to the attribute set
		}
	*/

	/**
	 * Checks to see if the given attribute set represents an anonymous element.
	 * @param attributeSet The attribute set.
	 * @return true if the attribute set represents an anonymous element.
	 */
	public static boolean isAnonymous(final AttributeSet attributeSet) {
		return ANONYMOUS_XML_ELEMENT_NAME.equals(getXMLElementName(attributeSet)); //see if the attribute set has the anonymous name 
	}

	/**
	 * Gives the attribute set the anonymous name.
	 * @param attributeSet The attribute set.
	 */
	public static void setAnonymous(final MutableAttributeSet attributeSet) {
		setXMLElementName(attributeSet, ANONYMOUS_XML_ELEMENT_NAME); //show by its name that this is an anonymous element
	}

	/**
	 * Checks to see if the page break view attribute is set. The attribute is not resolved through the parent attribute set hierarchy.
	 * @param a The attribute set.
	 * @return true if the page break view attribute is set, else false.
	 */
	public static boolean isPageBreakView(AttributeSet a) {
		final Boolean pageBreakView = (Boolean)getDefinedAttribute(a, PAGE_BREAK_VIEW_ATTRIBUTE_NAME); //get the page break view attribute
		return pageBreakView != null ? pageBreakView.booleanValue() : false; //if there is a page break view attribute, return its value, else return false
	}

	/**
	 * Sets the page break view attribute.
	 * @param a The attribute set
	 * @param b Whether or not the associated element should have a page break view.
	 */
	public static void setPageBreakView(final MutableAttributeSet a, final boolean b) {
		a.addAttribute(PAGE_BREAK_VIEW_ATTRIBUTE_NAME, new Boolean(b)); //add the attribute to the attribute set
	}

	/**
	 * Checks to see if the paragraphView attribute is set. The attribute is not resolved through the parent attribute set hierarchy.
	 * @param a The attribute set.
	 * @return true if the paragraphView is set, else false.
	 */
	/*TODO del
		public static boolean isParagraphView(AttributeSet a)
		{
			final Boolean paragraphView=(Boolean)getDefinedAttribute(a, PARAGRAPH_VIEW_ATTRIBUTE_NAME);	//get the paragraph view attribute
			return paragraphView!=null ? paragraphView.booleanValue() : false;	//if there is a paragraph view attribute, return its value, else return false
		}
	*/

	/**
	 * Sets the paragraph view attribute.
	 * @param a The attribute set.
	 * @param b Whether or not the associated element should have a paragraph view.
	 */
	/*TODO del
		public static void setParagraphView(final MutableAttributeSet a, final boolean b)
		{
			a.addAttribute(PARAGRAPH_VIEW_ATTRIBUTE_NAME, new Boolean(b));	//add the attribute to the attribute set
		}
	*/

	/**
	 * Checks to see if the view or any above it wants antialiased text.
	 * @param a The attribute set.
	 * @return true if the resolved antialiased attribute is set, else false.
	 */
	public static boolean isAntialias(AttributeSet a) { //TODO delete these methods if not used
		final Object antialias = a.getAttribute(ANTIALIAS_ATTRIBUTE_NAME); //get the antialias attribute, resolving up the hierarchy if needed
		return antialias instanceof Boolean ? ((Boolean)antialias).booleanValue() : false; //if there is a boolean antialias attribute, return its value, else return false
	}

	/**
	 * Sets the antialias attribute for this view.
	 * @param a The attribute set.
	 * @param b Whether or not the view should show antialiased text.
	 */
	public static void setAntialias(final MutableAttributeSet a, final boolean b) {
		a.addAttribute(ANTIALIAS_ATTRIBUTE_NAME, new Boolean(b)); //add the attribute to the attribute set
	}

	/**
	 * Gets the base URI of the document in which the element resides, resolving up the attribute set hierarchy.
	 * @param attributeSet The attribute set.
	 * @return The base URI, or null if there is no base URI defined anywhere up the hierarchy.
	 */
	public static URI getBaseURI(AttributeSet attributeSet) {
		return (URI)attributeSet.getAttribute(BASE_URI_ATTRIBUTE_NAME); //get the name of the base URI, anywhere within the hierarchy
	}

	/**
	 * Sets the base URI of the document in which the element resides.
	 * @param attributeSet The attribute set.
	 * @param uri The base URI of the document.
	 */
	public static void setBaseURI(final MutableAttributeSet attributeSet, final URI uri) {
		attributeSet.addAttribute(BASE_URI_ATTRIBUTE_NAME, uri); //add the attribute to the attribute set
	}

	/**
	 * Calculates the href from the given href relative to any base URI defined in the attribute set.
	 * @param attributeSet The attribute set.
	 * @param href The relative or absolute location; if relative, it is interpreted in relation to the base URI, if present in the attribute set.
	 * @return An href that represents the href relative to any base URI defined in the attribute set.
	 * @throws URISyntaxException Thrown if one of the URIs used to determine the relative href is invalid.
	 * @see #getBaseURI
	 */
	public static String getBaseRelativeHRef(final AttributeSet attributeSet, final String href) throws URISyntaxException {
		final URI baseURI = getBaseURI(attributeSet); //get the base URI of the file
		if(baseURI != null) { //if we find a base URI
			return baseURI.relativize(new URI(href)).toString(); //create a relative URI from the base URI and return its string value
			//TODO this doesn't work; the base URL is not relative to where we're really starting from		  return URLUtilities.getRelativePath(baseURL, URLUtilities.createURL(baseURL, href)); //create an href relative to the document's base URL
			//TODO del when works		  return URLUtilities.createURL(baseURL, href).toString(); //create an href relative to the document's base URL
		} else
			//if we couldn't find a base URI
			return href; //just return the href as it is
	}

	/**
	 * Gets the media type of the document in which the element resides, resolving up the attribute set hierarchy.
	 * @param attributeSet The attribute set.
	 * @return The media type, or null if there is no media type defined anywhere up the hierarchy.
	 */
	public static ContentType getMediaType(AttributeSet attributeSet) {
		return (ContentType)attributeSet.getAttribute(MEDIA_TYPE_ATTRIBUTE_NAME); //get the name of the media type, anywhere within the hierarchy
	}

	/**
	 * Sets the media type of the document in which the element resides.
	 * @param attributeSet The attribute set.
	 * @param mediaType The media type of the document.
	 */
	public static void setMediaType(final MutableAttributeSet attributeSet, final ContentType mediaType) {
		attributeSet.addAttribute(MEDIA_TYPE_ATTRIBUTE_NAME, mediaType); //add the attribute to the attribute set
	}

	/**
	 * Gets the target URI of the element without resolving up the attribute set hierarchy. This URI is such as might be used for the target of a hypertext
	 * reference.
	 * @param attributeSet The attribute set.
	 * @return The target URI of the element, or null if the element has no target URI defined.
	 */
	public static URI getTargetURI(final AttributeSet attributeSet) {
		return (URI)getDefinedAttribute(attributeSet, TARGET_URI_ATTRIBUTE_NAME); //get the target URI if one is defined
	}

	/**
	 * Sets the target URI of the element.
	 * @param attributeSet The attribute set.
	 * @param uri The element target URI, such as would be the target of a hypertext reference.
	 */
	public static void setTargetURI(final MutableAttributeSet attributeSet, final URI uri) {
		attributeSet.addAttribute(TARGET_URI_ATTRIBUTE_NAME, uri); //add the attribute to the attribute set
	}

	/**
	 * Gets the RDF resource description of the document hierarchy the Swing attributes represent. The attribute is not resolved through the parent attribute set
	 * hierarchy.
	 * @param attributeSet The attribute set.
	 * @return The RDF resource, or null if the element has no RDF resource.
	 */
	public static RDFResource getDocumentDescription(final AttributeSet attributeSet) {
		return asInstance(getDefinedAttribute(attributeSet, DOCUMENT_DESCRIPTION_ATTRIBUTE_NAME), RDFResource.class); //get the document description
	}

	/**
	 * Sets the RDF resource description of the document hierarchy represented by the attribute set.
	 * @param attributeSet The attribute set
	 * @param rdfResource The RDF resource.
	 */
	public static void setDocumentDescription(final MutableAttributeSet attributeSet, final RDFResource documentDescription) {
		attributeSet.addAttribute(DOCUMENT_DESCRIPTION_ATTRIBUTE_NAME, documentDescription); //add the attribute to the attribute set
	}

	/**
	 * Gets the public ID of the document type of the document, an element of which this set of attributes represents, resolving up the attribute set hierarchy.
	 * @param attributeSet The attribute set.
	 * @return The document type public ID, or null if the attribute set has no document type public ID.
	 */
	public static String getXMLDocTypePublicID(final AttributeSet attributeSet) {
		return (String)attributeSet.getAttribute(XML_DOCTYPE_PUBLIC_ID); //get the XML document type public ID
	}

	/**
	 * Sets the XML document type public ID.
	 * @param attributeSet The attribute set
	 * @param xmlDocTypePublicID The XML document type public ID.
	 */
	public static void setXMLDocTypePublicID(final MutableAttributeSet attributeSet, final String xmlDocTypePublicID) {
		attributeSet.addAttribute(XML_DOCTYPE_PUBLIC_ID, xmlDocTypePublicID); //add the attribute to the attribute set
	}

	/**
	 * Gets the system ID of the document type of the document, an element of which this set of attributes represents, resolving up the attribute set hierarchy.
	 * @param attributeSet The attribute set.
	 * @return The document type system ID, or null if the attribute set has no document type system ID.
	 */
	public static String getXMLDocTypeSystemID(final AttributeSet attributeSet) {
		return (String)attributeSet.getAttribute(XML_DOCTYPE_SYSTEM_ID); //get the XML document type system ID
	}

	/**
	 * Sets the XML document type system ID.
	 * @param attributeSet The attribute set
	 * @param xmlDocTypeSystemID The XML document type system ID.
	 */
	public static void setXMLDocTypeSystemID(final MutableAttributeSet attributeSet, final String xmlDocTypeSystemID) {
		attributeSet.addAttribute(XML_DOCTYPE_SYSTEM_ID, xmlDocTypeSystemID); //add the attribute to the attribute set
	}

	/**
	 * Gets the local name of the XML element the Swing attributes represent. The attribute is not resolved through the parent attribute set hierarchy.
	 * @param attributeSet The attribute set.
	 * @return The local name of the XML element, or null if the element has no local name.
	 */
	public static String getXMLElementLocalName(AttributeSet attributeSet) {
		return (String)getDefinedAttribute(attributeSet, XML_ELEMENT_LOCAL_NAME_ATTRIBUTE_NAME); //get the local name of the XML element
	}

	/**
	 * Sets the local name of the XML element.
	 * @param attributeSet The attribute set
	 * @param xmlElementName The local name of the XML element.
	 */
	public static void setXMLElementLocalName(final MutableAttributeSet attributeSet, final String xmlElementLocalName) {
		attributeSet.addAttribute(XML_ELEMENT_LOCAL_NAME_ATTRIBUTE_NAME, xmlElementLocalName); //add the attribute to the attribute set
	}

	/**
	 * Gets the name of the XML element the Swing attributes represent. The attribute is not resolved through the parent attribute set hierarchy.
	 * @param attributeSet The attribute set.
	 * @return The name of the XML element.
	 */
	public static String getXMLElementName(AttributeSet attributeSet) {
		return (String)getDefinedAttribute(attributeSet, XML_ELEMENT_NAME_ATTRIBUTE_NAME); //get the name of the XML element
	}

	/**
	 * Sets the name of the XML element.
	 * @param attributeSet The attribute set
	 * @param xmlElementName The name of the XML element.
	 */
	public static void setXMLElementName(final MutableAttributeSet attributeSet, final String xmlElementName) {
		attributeSet.addAttribute(XML_ELEMENT_NAME_ATTRIBUTE_NAME, xmlElementName); //add the attribute to the attribute set
	}

	/**
	 * Gets the namespace URI of the XML element the Swing attributes represent. The attribute is not resolved through the parent attribute set hierarchy.
	 * @param attributeSet The attribute set.
	 * @return The name of the XML element namespace URI, or null if this element was not defined in a namespace.
	 */
	public static String getXMLElementNamespaceURI(AttributeSet attributeSet) {
		return (String)getDefinedAttribute(attributeSet, XML_ELEMENT_NAMESPACE_URI_ATTRIBUTE_NAME); //get the namespace URI of the XML element
	}

	/**
	 * Sets the namespace URI of the XML element.
	 * @param attributeSet The attribute set
	 * @param xmlElementNamespaceURI The namespaceURI of the XML element.
	 */
	public static void setXMLElementNamespaceURI(final MutableAttributeSet attributeSet, final String xmlElementNamespaceURI) {
		attributeSet.addAttribute(XML_ELEMENT_NAMESPACE_URI_ATTRIBUTE_NAME, xmlElementNamespaceURI); //add the attribute to the attribute set
	}

	/**
	 * Checks to see whether the XML element represented is an empty element, without resolving up the hierarchy.
	 * @param attributeSet The attribute set.
	 * @return true if the the represented XML element is an empty element, else false.
	 */
	public static boolean isXMLEmptyElement(final AttributeSet attributeSet) {
		final Boolean emptyElement = (Boolean)getDefinedAttribute(attributeSet, XML_EMPTY_ELEMENT); //get the empty element attribute
		return emptyElement != null ? emptyElement.booleanValue() : false; //if there is an empty element attribute, return its value, else return false
	}

	/**
	 * Sets whether the represented XML element is an empty element.
	 * @param attributeSet The attribute set
	 * @param isEmptyElement Whether or not the associated element is an empty element.
	 */
	public static void setXMLEmptyElement(final MutableAttributeSet attributeSet, final boolean isEmptyElement) {
		attributeSet.addAttribute(XML_EMPTY_ELEMENT, new Boolean(isEmptyElement)); //add the attribute to the attribute set
	}

	/**
	 * Gets the array of XML processing instructions, each represented by a name/value pair. The attribute is not resolved up the parent attribute set hierarchy.
	 * @param attributeSet The attribute set.
	 * @return The non-null array of processing instruction name/value pairs.
	 */
	public static NameValuePair[] getXMLProcessingInstructions(final AttributeSet attributeSet) {
		final NameValuePair[] processingInstructions = (NameValuePair[])getDefinedAttribute(attributeSet, XML_PROCESSING_INSTRUCTIONS_ATTRIBUTE_NAME); //get the XML processing instruction array, without checking up the hierarchy
		//return the processing instructions or, if there are none, an empty array
		return processingInstructions != null ? processingInstructions : EMPTY_NAME_VALUE_PAIR_ARRAY;
	}

	/**
	 * Sets the array of XML processing instructions.
	 * @param attributeSet The attribute set.
	 * @param processingInstructions The array of processing instruction names and values.
	 */
	public static void setXMLProcessingInstructions(final MutableAttributeSet attributeSet, final NameValuePair[] processingInstructions) {
		attributeSet.addAttribute(XML_PROCESSING_INSTRUCTIONS_ATTRIBUTE_NAME, processingInstructions); //add the attribute to the attribute set
	}

	/** The array of processing instructions this document contains. */
	//TODO del if not needed	public static final String XML_PROCESSING_INSTRUCTIONS_ATTRIBUTE_NAME=SWING_ATTRIBUTE_START+"xmlProcessingInstructions";

	/**
	 * Gets the XML element attributes the Swing attributes represent. The attribute is not resolved through the parent attribute set hierarchy.
	 * @param a The attribute set.
	 * @return The map of XML attributes.
	 */
	/*TODO fix
		public static NamedNodeMap getXMLAttributes(AttributeSet a)
		{
			return (NamedNodeMap)getDefinedAttribute(a, XMLAttributesAttributeName);	//get the attribute
		}
	*/

	/**
	 * Sets the map of XML attributes.
	 * @param a The attribute set
	 * @param xmlAttributes The map of XML attributes.
	 */
	/*TODO fix
		public static void setXMLAttributes(final MutableAttributeSet a, final NamedNodeMap xmlAttributes)
		{
			a.addAttribute(XMLAttributesAttributeName, xmlAttributes);	//add the attribute to the attribute set
		}
	*/

}