org.vectomatic.dom.svg.impl.SVGTextContentElement 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
Show all versions of lib-gwt-svg Show documentation
A GWT library to access the SVG functionalities of web browsers
/**********************************************
* 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.impl;
import org.vectomatic.dom.svg.OMSVGAnimatedBoolean;
import org.vectomatic.dom.svg.OMSVGAnimatedEnumeration;
import org.vectomatic.dom.svg.OMSVGAnimatedLength;
import org.vectomatic.dom.svg.OMSVGPoint;
import org.vectomatic.dom.svg.OMSVGRect;
import org.vectomatic.dom.svg.OMSVGStringList;
import com.google.gwt.core.client.JavaScriptException;
/**
* The {@link org.vectomatic.dom.svg.impl.SVGTextContentElement} is inherited
* by various text-related interfaces, such as {@link org.vectomatic.dom.svg.impl.SVGTextElement},
* {@link org.vectomatic.dom.svg.impl.SVGTSpanElement}, {@link org.vectomatic.dom.svg.impl.SVGTRefElement},
* {@link org.vectomatic.dom.svg.impl.SVGAltGlyphElement} and {@link org.vectomatic.dom.svg.impl.SVGTextPathElement}.
* For the methods on this interface that refer to an index to a character
* or a number of characters, these references are to be interpreted as an
* index to a UTF-16 code unit or a number of UTF-16 code units, respectively.
* This is for consistency with DOM Level 2 Core, where methods on the CharacterData
* interface use UTF-16 code units as indexes and counts within the character
* data. Thus for example, if the text content of a text element is a single non-BMP
* character, such as U+10000, then invoking {@link org.vectomatic.dom.svg.impl.SVGTextContentElement#getNumberOfChars()}
* on that element will return 2 since there are two UTF-16 code units (the
* surrogate pair) used to represent that one character.
*/
public class SVGTextContentElement extends SVGElement {
protected SVGTextContentElement() {
}
// Implementation of the svg::SVGTextContentElement W3C IDL interface
/**
* Corresponds to attribute 'textLength' on
* the given element.
*/
public final native OMSVGAnimatedLength getTextLength() /*-{
return this.textLength;
}-*/;
/**
* Corresponds to attribute 'lengthAdjust'
* on the given element. The value must be one of the length adjust constants
* defined on this interface.
*/
public final native OMSVGAnimatedEnumeration getLengthAdjust() /*-{
return this.lengthAdjust;
}-*/;
/**
* Returns the total number of characters available for rendering within the
* current element, which includes referenced characters from tref reference, regardless of whether
* they will be rendered. Effectively, this is equivalent to the length of
* the Node::textContent
* attribute from DOM Level 3 Core ([DOM3],
* section 1.4), if that attribute also expanded tref elements.
* @return Total number of characters.
*/
public final native int getNumberOfChars() /*-{
return this.getNumberOfChars();
}-*/;
/**
* The total sum of all of the advance values from rendering all of the characters
* within this element, including the advance value on the glyphs (horizontal
* or vertical), the effect of properties kerning, letter-spacing
* and word-spacing and adjustments due to attributes tspan/dx
* and tspan/dy on tspan elements. For non-rendering
* environments, the user agent shall make reasonable assumptions about glyph
* metrics.
* @return The text advance distance.
*/
public final native float getComputedTextLength() /*-{
return this.getComputedTextLength();
}-*/;
/**
* The total sum of all of the advance values from rendering the specified
* substring of the characters, including the advance value on the glyphs
* (horizontal or vertical), the effect of properties kerning,
* letter-spacing and word-spacing and adjustments
* due to attributes tspan/dx and tspan/dy on tspan elements. For non-rendering environments, the
* user agent shall make reasonable assumptions about glyph metrics. If multiple
* consecutive characters are rendered inseparably (e.g., as a single glyph
* or a sequence of glyphs, or because the range encompasses half of a surrogate
* pair), and nchars is greater than 0 then the measured range shall be expanded
* so that each of the inseparable characters are included.
* @param charnum The index of the first character in the substring, where
* the first character has an index of 0.
* @param nchars The number of characters in the substring. If nchars specifies
* more characters than are available, then the substring will consist of
* all characters starting with charnum until the end of the list of characters.
* @return The text advance distance.
* @throws DOMException(INDEX_SIZE_ERR) Raised if charnum or
* nchars is negative or if charnum is greater than
* or equal to the number of characters at this node.
*/
public final native float getSubStringLength(int charnum, int nchars) throws JavaScriptException /*-{
return this.getSubStringLength(charnum, nchars);
}-*/;
/**
* Returns the current text position before rendering the character in the
* user coordinate system for rendering the glyph(s) that correspond to the
* specified character. The current text position has already taken into account
* the effects of any inter-character adjustments due to properties kerning,
* letter-spacing and word-spacing and adjustments
* due to attributes 'x', 'y',
* 'dx' and 'dy'.
* If multiple consecutive characters are rendered inseparably (e.g., as a
* single glyph or a sequence of glyphs), then each of the inseparable characters
* will return the start position for the first glyph.
* @param charnum The index of the character, where the first character has
* an index of 0.
* @return The character's start position.
* @throws DOMException(INDEX_SIZE_ERR) Raised if the charnum is
* negative or if charnum is greater than or equal to the number
* of characters at this node.
*/
public final native OMSVGPoint getStartPositionOfChar(int charnum) throws JavaScriptException /*-{
return this.getStartPositionOfChar(charnum);
}-*/;
/**
* Returns the current text position after rendering the character in the
* user coordinate system for rendering the glyph(s) that correspond to the
* specified character. This current text position does not take
* into account the effects of any inter-character adjustments to prepare
* for the next character, such as properties kerning, letter-spacing
* and word-spacing and adjustments due to attributes 'x',
* 'y', 'dx'
* and 'dy'. If multiple consecutive characters
* are rendered inseparably (e.g., as a single glyph or a sequence of glyphs),
* then each of the inseparable characters will return the end position for
* the last glyph.
* @param charnum The index of the character, where the first character has
* an index of 0.
* @return The character's end position.
* @throws DOMException(INDEX_SIZE_ERR) Raised if the charnum is
* negative or if charnum is greater than or equal to the number
* of characters at this node.
*/
public final native OMSVGPoint getEndPositionOfChar(int charnum) throws JavaScriptException /*-{
return this.getEndPositionOfChar(charnum);
}-*/;
/**
* Returns a tightest rectangle which defines the minimum and maximum X and
* Y values in the user coordinate system for rendering the glyph(s) that
* correspond to the specified character. The calculations assume that all
* glyphs occupy the full standard glyph cell for the font. If multiple consecutive
* characters are rendered inseparably (e.g., as a single glyph or a sequence
* of glyphs), then each of the inseparable characters will return the same
* extent.
* @param charnum The index of the character, where the first character has
* an index of 0.
* @return The rectangle which encloses all of the rendered glyph(s).
* @throws DOMException(INDEX_SIZE_ERR) Raised if the charnum is
* negative or if charnum is greater than or equal to the number
* of characters at this node.
*/
public final native OMSVGRect getExtentOfChar(int charnum) throws JavaScriptException /*-{
return this.getExtentOfChar(charnum);
}-*/;
/**
* Returns the rotation value relative to the current user coordinate system
* used to render the glyph(s) corresponding to the specified character. If
* multiple glyph(s) are used to render the given character and the glyphs
* each have different rotations (e.g., due to text-on-a-path), the user agent
* shall return an average value (e.g., the rotation angle at the midpoint
* along the path for all glyphs used to render this character). The rotation
* value represents the rotation that is supplemental to any rotation due
* to properties glyph-orientation-horizontal and glyph-orientation-vertical;
* thus, any glyph rotations due to these properties are not included into
* the returned rotation value. If multiple consecutive characters are rendered
* inseparably (e.g., as a single glyph or a sequence of glyphs), then each
* of the inseparable characters will return the same rotation value.
* @param charnum The index of the character, where the first character has
* an index of 0.
* @return The rotation angle.
* @throws DOMException(INDEX_SIZE_ERR) Raised if the charnum is
* negative or if charnum is greater than or equal to the number
* of characters at this node.
*/
public final native float getRotationOfChar(int charnum) throws JavaScriptException /*-{
return this.getRotationOfChar(charnum);
}-*/;
/**
* Returns the index of the character whose corresponding glyph cell bounding
* box contains the specified point. The calculations assume that all glyphs
* occupy the full standard glyph cell for the font. If no such character
* exists, a value of -1 is returned. If multiple such characters exist, the
* character within the element whose glyphs were rendered last (i.e., take
* into account any reordering such as for bidirectional text) is used. If
* multiple consecutive characters are rendered inseparably (e.g., as a single
* glyph or a sequence of glyphs), then the user agent shall allocate an equal
* percentage of the text advance amount to each of the contributing characters
* in determining which of the characters is chosen.
* @param point A point in user space.
* @return The index of the character which is at the given point, where
* the first character has an index of 0.
*/
public final native int getCharNumAtPosition(OMSVGPoint point) /*-{
return this.getCharNumAtPosition(point);
}-*/;
/**
* Causes the specified substring to be selected just as if the user selected
* the substring interactively.
* @param charnum The index of the start character which is at the given
* point, where the first character has an index of 0.
* @param nchars The number of characters in the substring. If nchars specifies
* more characters than are available, then the substring will consist of
* all characters starting with charnum until the end of the list of characters.
* @throws DOMException(INDEX_SIZE_ERR) Raised if charnum or
* nchars is negative or if charnum is greater than
* or equal to the number of characters at this node.
*/
public final native void selectSubString(int charnum, int nchars) throws JavaScriptException /*-{
this.selectSubString(charnum, nchars);
}-*/;
// Implementation of the svg::SVGExternalResourcesRequired W3C IDL interface
/**
* Corresponds to attribute {@link org.vectomatic.dom.svg.itf.ISVGExternalResourcesRequired#getExternalResourcesRequired()}
* on the given element. Note that the SVG DOM defines the attribute {@link
* org.vectomatic.dom.svg.itf.ISVGExternalResourcesRequired#getExternalResourcesRequired()}
* as being of type {@link org.vectomatic.dom.svg.OMSVGAnimatedBoolean}, whereas
* the SVG language definition says that {@link org.vectomatic.dom.svg.itf.ISVGExternalResourcesRequired#getExternalResourcesRequired()}
* is not animated. Because the SVG language definition states that {@link
* org.vectomatic.dom.svg.itf.ISVGExternalResourcesRequired#getExternalResourcesRequired()}
* cannot be animated, the {@link org.vectomatic.dom.svg.OMSVGAnimatedBoolean#getAnimVal()}
* will always be the same as the {@link org.vectomatic.dom.svg.OMSVGAnimatedBoolean#getBaseVal()}.
*/
public final native OMSVGAnimatedBoolean getExternalResourcesRequired() /*-{
return this.externalResourcesRequired;
}-*/;
// Implementation of the svg::SVGLangSpace W3C IDL interface
/**
* Corresponds to attribute xml:lang on the given element.
*/
public final native String getXmllang() /*-{
return this.xmllang;
}-*/;
/**
* Corresponds to attribute xml:lang on the given element.
* @throws DOMException(NO_MODIFICATION_ALLOWED_ERR) Raised on an attempt
* to change the value of a read only
* attribute.
*/
public final native void setXmllang(String value) throws JavaScriptException /*-{
this.xmllang = value;
}-*/;
/**
* Corresponds to attribute xml:space on the given element.
*/
public final native String getXmlspace() /*-{
return this.xmlspace;
}-*/;
/**
* Corresponds to attribute xml:space on the given element.
* @throws DOMException(NO_MODIFICATION_ALLOWED_ERR) Raised on an attempt
* to change the value of a read only
* attribute.
*/
public final native void setXmlspace(String value) throws JavaScriptException /*-{
this.xmlspace = value;
}-*/;
// Implementation of the svg::SVGTests W3C IDL interface
/**
* Corresponds to attribute {@link org.vectomatic.dom.svg.itf.ISVGTests#getRequiredFeatures()}
* on the given element.
*/
public final native OMSVGStringList getRequiredFeatures() /*-{
return @org.vectomatic.dom.svg.OMNode::convertList(Lcom/google/gwt/core/client/JavaScriptObject;)(this.requiredFeatures);
}-*/;
/**
* Corresponds to attribute {@link org.vectomatic.dom.svg.itf.ISVGTests#getRequiredExtensions()}
* on the given element.
*/
public final native OMSVGStringList getRequiredExtensions() /*-{
return @org.vectomatic.dom.svg.OMNode::convertList(Lcom/google/gwt/core/client/JavaScriptObject;)(this.requiredExtensions);
}-*/;
/**
* Corresponds to attribute {@link org.vectomatic.dom.svg.itf.ISVGTests#getSystemLanguage()}
* on the given element.
*/
public final native OMSVGStringList getSystemLanguage() /*-{
return @org.vectomatic.dom.svg.OMNode::convertList(Lcom/google/gwt/core/client/JavaScriptObject;)(this.systemLanguage);
}-*/;
/**
* Returns true if the user agent supports the given extension, specified
* by a URI.
* @param extension The name of the extension, expressed as a URI.
* @return True or false, depending on whether the given extension is supported.
*/
public final native boolean hasExtension(String extension) /*-{
return this.hasExtension(extension);
}-*/;
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy