TinyLine
v2.0

com.tinyline.svg
Class SVGUseElem

java.lang.Object
  extended bycom.tinyline.svg.SVGNode
      extended bycom.tinyline.svg.SVGGroupElem
          extended bycom.tinyline.svg.SVGUseElem

public class SVGUseElem
extends SVGGroupElem

The SVGUseElem class implements the 'use' element.

The 'use' element references another element and indicates that the graphical contents of that element is included/drawn at that given point in the document.

Unlike 'image', the 'use' element cannot reference entire files. The 'use' element has optional attributes x, y, width and height which are used to map the graphical contents of the referenced element onto a rectangular region within the current coordinate system.

Version:
1.9

Author:
Andrew Girow

Field Summary
 int height
          The height of the use rectangle
 int width
          The width of the use rectangle
 int x
          The top left x-axis coordinate of the use rectangle.
 int y
          The top left y-axis coordinate of the use rectangle.
 
Fields inherited from class com.tinyline.svg.SVGGroupElem
showBounds, xlink_href
 
Fields inherited from class com.tinyline.svg.SVGNode
animatedVals, bounds, children, color, display, fill, fillOpacity, fillRule, fontFamily, fontSize, fontStyle, fontWeight, helem, id, opacity, outlined, ownerDocument, parent, stopColor, stopOpacity, stroke, strokeDashArray, strokeDashOffset, strokeLineCap, strokeLineJoin, strokeMiterLimit, strokeOpacity, strokeWidth, textAnchor, transform, visibility, xmlSpace
 
Constructor Summary
SVGUseElem(SVGUseElem src)
          Constructs a copy of the given SVGUseElem node.
 
Method Summary
 SVGNode copyNode()
          Constructs a copy of the given node.
 int createOutline()
          Creates an outline of this node.
 java.lang.Object getAttribute(int hattr)
          Returns the value object for the given attribute, or null object otherwise.
 int setAttribute(int hattr, java.lang.Object value)
          Assigns or modifies the value of the specified attribute.
 
Methods inherited from class com.tinyline.svg.SVGGroupElem
getDevBounds, nodeHitAt, paint
 
Methods inherited from class com.tinyline.svg.SVGNode
addChild, contains, getBounds, getCapStyle, getCurrentColor, getDashArray, getDashOffset, getDisplay, getFillColor, getFillOpacity, getFillRule, getFontFamily, getFontSize, getGlobalTransform, getJoinStyle, getLineThickness, getMiterLimit, getNodeById, getOpacity, getStopColor, getStopOpacity, getStrokeColor, getStrokeOpacity, getTextAnchor, getVisibility, intersects, isDisplay, isVisible, matchUserAgent, removeChild, resolveColor, seekAElem
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

x

public int x
The top left x-axis coordinate of the use rectangle.


y

public int y
The top left y-axis coordinate of the use rectangle.


width

public int width
The width of the use rectangle


height

public int height
The height of the use rectangle

Constructor Detail

SVGUseElem

public SVGUseElem(SVGUseElem src)
Constructs a copy of the given SVGUseElem node.

Method Detail

copyNode

public SVGNode copyNode()
Constructs a copy of the given node.

Overrides:
copyNode in class SVGGroupElem

setAttribute

public int setAttribute(int hattr,
                        java.lang.Object value)
                 throws java.lang.Exception
Assigns or modifies the value of the specified attribute.

Overrides:
setAttribute in class SVGGroupElem
Parameters:
hattr - The attribute handle.
value - The value of the attribute.
Returns:
The error code that could be one of the following: SVG.ERR_OK, SVG.ERR_NUMBER_FORMAT, SVG.ERR_INVALID_ARG, SVG.ERR_NOT_FOUND, SVG.ERR_NOT_SUPPORTED, SVG.ERR_HIERARCHY_REQUEST
Throws:
java.lang.Exception - if the value type doesn not match to the attribute handle.

getAttribute

public java.lang.Object getAttribute(int hattr)
Returns the value object for the given attribute, or null object otherwise.

Overrides:
getAttribute in class SVGGroupElem
Parameters:
hattr - The attribute handle.
Returns:
The value of the attribute or null.

createOutline

public int createOutline()
Creates an outline of this node.

Overrides:
createOutline in class SVGGroupElem

TinyLine
v2.0

Provided under the terms of the TinyLine License Agreement that has been included with this distribution