org.vectomatic.dom.svg.OMAttr Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of lib-gwt-svg Show documentation
A GWT library to access the SVG functionalities of web browsers
There is a newer version: 0.5.15
/**********************************************
 * Copyright (C) 2010 Lukas Laag
 * This file is part of lib-gwt-svg.
 * 
 * libgwtsvg is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * libgwtsvg is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with libgwtsvg.  If not, see http://www.gnu.org/licenses/
 **********************************************/
/*
 * Copyright (c) 2004 World Wide Web Consortium,
 *
 * (Massachusetts Institute of Technology, European Research Consortium for
 * Informatics and Mathematics, Keio University). All Rights Reserved. This
 * work is distributed under the W3C(r) Software License [1] in the hope that
 * it will be useful, but WITHOUT ANY WARRANTY; without even the implied
 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 *
 * [1] http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231
 */
package org.vectomatic.dom.svg;

import org.vectomatic.dom.svg.impl.Attr;
import org.w3c.dom.DOMException;

/**
 * Wrapper class for DOM Attr
 * @author laaglu
 */
public class OMAttr extends OMNode {
	/**
	 * Constructor
	 * @param ot the {@link org.vectomatic.dom.svg.impl.Attr} to wrap.
	 */
	protected OMAttr(Attr ot) {
		super(ot);
	}
	/**
	 * Returns the wrapped {@link org.vectomatic.dom.svg.impl.Attr}
	 * @return the wrapped {@link org.vectomatic.dom.svg.impl.Attr}
	 */
	public Attr getAttr() {
		return ot.cast();
	}

    /**
     * Returns the name of this attribute. If OMNode.localName is 
     * different from null, this attribute is a qualified name.
     * @return the attribute name
     */
	public final String getName() {
	   return ((Attr)ot).getName();
	 }

    /**
     * On retrieval, the value of the attribute is returned as a string. 
     * Character and general entity references are replaced with their 
     * values. See also the method getAttribute on the 
     * OMElement interface.
     * 
On setting, this creates a OMText node with the unparsed 
     * contents of the string, i.e. any characters that an XML processor 
     * would recognize as markup are instead treated as literal text. See 
     * also the method OMElement.setAttribute().
     * 
 Some specialized implementations, such as some [SVG 1.1] 
     * implementations, may do normalization automatically, even after 
     * mutation; in such case, the value on retrieval may differ from the 
     * value on setting.
     * @return the attribute value
     */
	public final String getValue() {
	   return ((Attr)ot).getValue();
	 }

    /**
     * On retrieval, the value of the attribute is returned as a string. 
     * Character and general entity references are replaced with their 
     * values. See also the method getAttribute on the 
     * OMElement interface.
     * 
On setting, this creates a OMText node with the unparsed 
     * contents of the string, i.e. any characters that an XML processor 
     * would recognize as markup are instead treated as literal text. See 
     * also the method OMElement.setAttribute().
     * 
 Some specialized implementations, such as some [SVG 1.1] 
     * implementations, may do normalization automatically, even after 
     * mutation; in such case, the value on retrieval may differ from the 
     * value on setting.
     * @param value the attribute value
     * @exception DOMException
     *   NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
     */
	public final void setValue(String value) {
	   ((Attr)ot).setValue(value);
	 }

    /**
     *  Returns whether this attribute is known to be of type ID (i.e. to 
     * contain an identifier for its owner element) or not. When it is and 
     * its value is unique, the ownerElement of this attribute 
     * can be retrieved using the method OMDocument.getElementById
     * . The implementation could use several ways to determine if an 
     * attribute node is known to contain an identifier: 
     * 
     *  If validation 
     * occurred using an XML Schema [XML Schema Part 1]
     *  while loading the document or while invoking 
     * OMDocument.normalizeDocument(), the post-schema-validation 
     * infoset contributions (PSVI contributions) values are used to 
     * determine if this attribute is a schema-determined ID attribute using 
     * the 
     * schema-determined ID definition in [XPointer]
     * . 
     * 
     *  If validation occurred using a DTD while loading the document or 
     * while invoking OMDocument.normalizeDocument(), the infoset [type definition] value is used to determine if this attribute is a DTD-determined ID 
     * attribute using the 
     * DTD-determined ID definition in [XPointer]
     * . 
     * 
     *  from the use of the methods OMElement.setIdAttribute(), 
     * OMElement.setIdAttributeNS(), or 
     * OMElement.setIdAttributeNode(), i.e. it is an 
     * user-determined ID attribute; 
     * Note:  XPointer framework (see section 3.2 in [XPointer]
     * ) consider the DOM user-determined ID attribute as being part of the 
     * XPointer externally-determined ID definition. 
     * 
     *  using mechanisms that 
     * are outside the scope of this specification, it is then an 
     * externally-determined ID attribute. This includes using schema 
     * languages different from XML schema and DTD. 
     * 
     * 
     * 
 If validation occurred while invoking 
     * OMDocument.normalizeDocument(), all user-determined ID 
     * attributes are reset and all attribute nodes ID information are then 
     * reevaluated in accordance to the schema used. As a consequence, if 
     * the OMAttr.schemaTypeInfo attribute contains an ID type, 
     * isId will always return true. 
     * @since DOM Level 3
     */
	public final boolean isId() {
	 return ((Attr)ot).isId();
	}
}