org.vectomatic.dom.svg.impl

Class SVGSVGElement

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

com.google.gwt.dom.client.Node

com.google.gwt.dom.client.Element

org.vectomatic.dom.svg.impl.SVGElement

org.vectomatic.dom.svg.impl.SVGSVGElement

public class SVGSVGElement
extends SVGElement

A key interface definition is the SVGSVGElement interface, which is the interface that corresponds to the svg element. This interface contains various miscellaneous commonly-used utility methods, such as matrix operations and the ability to control the time of redraw on visual rendering devices.

SVGSVGElement extends ViewCSS and DocumentCSS to provide access to the computed values of properties and the override style sheet as described in DOM Level 2 Style [DOM2STYLE].

Field Summary

Fields inherited from class com.google.gwt.dom.client.Element

DRAGGABLE_AUTO, DRAGGABLE_FALSE, DRAGGABLE_TRUE

Fields inherited from class com.google.gwt.dom.client.Node

DOCUMENT_NODE, ELEMENT_NODE, TEXT_NODE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SVGSVGElement()

Method Summary

Modifier and Type	Method and Description
boolean	animationsPaused() Returns true if this SVG document fragment is in a paused state.
boolean	checkEnclosure(SVGElement element, OMSVGRect rect) Returns true if the rendered content of the given element is entirely contained within the supplied rectangle.
boolean	checkIntersection(SVGElement element, OMSVGRect rect) Returns true if the rendered content of the given element intersects the supplied rectangle.
OMSVGAngle	createSVGAngle() Creates an OMSVGAngle object outside of any document trees.
OMSVGLength	createSVGLength() Creates an OMSVGLength object outside of any document trees.
OMSVGMatrix	createSVGMatrix() Creates an OMSVGMatrix object outside of any document trees.
OMSVGNumber	createSVGNumber() Creates an OMSVGNumber object outside of any document trees.
OMSVGPoint	createSVGPoint() Creates an OMSVGPoint object outside of any document trees.
OMSVGRect	createSVGRect() Creates an OMSVGRect object outside of any document trees.
OMSVGTransform	createSVGTransform() Creates an OMSVGTransform object outside of any document trees.
OMSVGTransform	createSVGTransformFromMatrix(OMSVGMatrix matrix) Creates an OMSVGTransform object outside of any document trees.
void	deselectAll() Unselects any selected objects, including any selections of text strings and type-in bars.
void	forceRedraw() In rendering environments supporting interactivity, forces the user agent to immediately redraw all regions of the viewport that require updating.
OMSVGRect	getBBox() Returns the tight bounding box in current user space (i.e., after application of the transform attribute, if any) on the geometry of all contained graphics elements, exclusive of stroking, clipping, masking and filter effects).
String	getContentScriptType() Corresponds to attribute getContentScriptType() on the given svg element.
String	getContentStyleType() Corresponds to attribute getContentStyleType() on the given svg element.
OMSVGMatrix	getCTM() Returns the transformation matrix from current user units (i.e., after application of the transform attribute, if any) to the viewport coordinate system for the ISVGLocatable.getNearestViewportElement().
float	getCurrentScale() On an outermost svg element, this attribute indicates the current scale factor relative to the initial view to take into account user magnification and panning operations, as described under Magnification and panning.
float	getCurrentTime() Returns the current time in seconds relative to the start time for the current SVG document fragment.
OMSVGPoint	getCurrentTranslate() On an outermost svg element, the corresponding translation factor that takes into account user "magnification".
OMSVGViewSpec	getCurrentView() The definition of the initial view (i.e., before magnification and panning) of the current innermost SVG document fragment.
com.google.gwt.dom.client.Element	getElementById(String elementId) Searches this SVG document fragment (i.e., the search is restricted to a subset of the document tree) for an Element whose id is given by elementId.
com.google.gwt.dom.client.NodeList<? extends com.google.gwt.dom.client.Node>	getEnclosureList(OMSVGRect rect, SVGElement referenceElement) Returns the list of graphics elements whose rendered content is entirely contained within the supplied rectangle.
OMSVGAnimatedBoolean	getExternalResourcesRequired() Corresponds to attribute ISVGExternalResourcesRequired.getExternalResourcesRequired() on the given element.
SVGElement	getFarthestViewportElement() The farthest ancestor svg element.
OMSVGAnimatedLength	getHeight() Corresponds to attribute getHeight() on the given svg element.
com.google.gwt.dom.client.NodeList<? extends com.google.gwt.dom.client.Node>	getIntersectionList(OMSVGRect rect, SVGElement referenceElement) Returns the list of graphics elements whose rendered content intersects the supplied rectangle.
SVGElement	getNearestViewportElement() The element which established the current viewport.
float	getPixelUnitToMillimeterX() Size of a pixel units (as defined by CSS2) along the x-axis of the viewport, which represents a unit somewhere in the range of 70dpi to 120dpi, and, on systems that support this, might actually match the characteristics of the target medium.
float	getPixelUnitToMillimeterY() Corresponding size of a pixel unit along the y-axis of the viewport.
OMSVGAnimatedPreserveAspectRatio	getPreserveAspectRatio() Corresponds to attribute ISVGFitToViewBox.getPreserveAspectRatio() on the given element.
OMSVGStringList	getRequiredExtensions() Corresponds to attribute ISVGTests.getRequiredExtensions() on the given element.
OMSVGStringList	getRequiredFeatures() Corresponds to attribute ISVGTests.getRequiredFeatures() on the given element.
OMSVGMatrix	getScreenCTM() Returns the transformation matrix from current user units (i.e., after application of the transform attribute, if any) to the parent user agent's notice of a "pixel".
float	getScreenPixelToMillimeterX() User interface (UI) events in DOM Level 2 indicate the screen positions at which the given UI event occurred.
float	getScreenPixelToMillimeterY() Corresponding size of a screen pixel along the y-axis of the viewport.
OMSVGStringList	getSystemLanguage() Corresponds to attribute ISVGTests.getSystemLanguage() on the given element.
OMSVGMatrix	getTransformToElement(SVGElement element) Returns the transformation matrix from the user coordinate system on the current element (after application of the transform attribute, if any) to the user coordinate system on parameter element (after application of its transform attribute, if any).
boolean	getUseCurrentView() The initial view (i.e., before magnification and panning) of the current innermost SVG document fragment can be either the "standard" view (i.e., based on attributes on the svg element such as svg/viewBox) or to a "custom" view (i.e., a hyperlink into a particular view or other element - see Linking into SVG content: URI fragments and SVG views).
OMSVGAnimatedRect	getViewBox() Corresponds to attribute ISVGFitToViewBox.getViewBox() on the given element.
OMSVGRect	getViewport() The position and size of the viewport (implicit or explicit) that corresponds to this svg element.
OMSVGAnimatedLength	getWidth() Corresponds to attribute getWidth() on the given svg element.
OMSVGAnimatedLength	getX() Corresponds to attribute getX() on the given svg element.
String	getXmllang() Corresponds to attribute xml:lang on the given element.
String	getXmlspace() Corresponds to attribute xml:space on the given element.
OMSVGAnimatedLength	getY() Corresponds to attribute getY() on the given svg element.
short	getZoomAndPan() Corresponds to attribute ISVGZoomAndPan.getZoomAndPan() on the given element.
boolean	hasExtension(String extension) Returns true if the user agent supports the given extension, specified by a URI.
void	pauseAnimations() Suspends (i.e., pauses) all currently running animations that are defined within the SVG document fragment corresponding to this svg element, causing the animation clock corresponding to this document fragment to stand still until it is unpaused.
void	setContentScriptType(String value) Corresponds to attribute getContentScriptType() on the given svg element.
void	setContentStyleType(String value) Corresponds to attribute getContentStyleType() on the given svg element.
void	setCurrentScale(float value) On an outermost svg element, this attribute indicates the current scale factor relative to the initial view to take into account user magnification and panning operations, as described under Magnification and panning.
void	setCurrentTime(float seconds) Adjusts the clock for this SVG document fragment, establishing a new current time.
void	setXmllang(String value) Corresponds to attribute xml:lang on the given element.
void	setXmlspace(String value) Corresponds to attribute xml:space on the given element.
void	setZoomAndPan(short value) Corresponds to attribute ISVGZoomAndPan.getZoomAndPan() on the given element.
int	suspendRedraw(int maxWaitMilliseconds) Takes a time-out value which indicates that redraw shall not occur until: the corresponding unsuspendRedraw() call has been made, an unsuspendRedrawAll() call has been made, or its timer has timed out.
void	unpauseAnimations() Unsuspends (i.e., unpauses) currently running animations that are defined within the SVG document fragment, causing the animation clock to continue from the time at which it was suspended.
void	unsuspendRedraw(int suspendHandleID) Cancels a specified suspendRedraw() by providing a unique suspend handle ID that was returned by a previous suspendRedraw() call.
void	unsuspendRedrawAll() Cancels all currently active suspendRedraw() method calls.

Methods inherited from class org.vectomatic.dom.svg.impl.SVGElement

getClassName_, getMarkup, getOwnerSVGElement, getViewportElement, getXmlbase, setXmlbase

Methods inherited from class com.google.gwt.dom.client.Element

addClassName, as, as, blur, dispatchEvent, focus, getAbsoluteBottom, getAbsoluteLeft, getAbsoluteRight, getAbsoluteTop, getAttribute, getClassName, getClientHeight, getClientWidth, getDir, getDraggable, getElementsByTagName, getFirstChildElement, getId, getInnerHTML, getInnerText, getLang, getNextSiblingElement, getOffsetHeight, getOffsetLeft, getOffsetParent, getOffsetTop, getOffsetWidth, getPreviousSiblingElement, getPropertyBoolean, getPropertyDouble, getPropertyInt, getPropertyJSO, getPropertyObject, getPropertyString, getScrollHeight, getScrollLeft, getScrollTop, getScrollWidth, getString, getStyle, getTabIndex, getTagName, getTitle, hasAttribute, hasClassName, hasTagName, is, is, removeAttribute, removeClassName, replaceClassName, scrollIntoView, setAttribute, setClassName, setDir, setDraggable, setId, setInnerHTML, setInnerSafeHtml, setInnerText, setLang, setPropertyBoolean, setPropertyDouble, setPropertyInt, setPropertyJSO, setPropertyObject, setPropertyString, setScrollLeft, setScrollTop, setTabIndex, setTitle, toggleClassName

Methods inherited from class com.google.gwt.dom.client.Node

appendChild, cloneNode, getChild, getChildCount, getChildNodes, getFirstChild, getLastChild, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentElement, getParentNode, getPreviousSibling, hasChildNodes, hasParentElement, insertAfter, insertBefore, insertFirst, isOrHasChild, removeAllChildren, removeChild, removeFromParent, replaceChild, setNodeValue

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SVGSVGElement

protected SVGSVGElement()

Method Detail

getX

public final OMSVGAnimatedLength getX()

Corresponds to attribute getX() on the given svg element.

getY

public final OMSVGAnimatedLength getY()

Corresponds to attribute getY() on the given svg element.

getWidth

public final OMSVGAnimatedLength getWidth()

Corresponds to attribute getWidth() on the given svg element.

getHeight

public final OMSVGAnimatedLength getHeight()

Corresponds to attribute getHeight() on the given svg element.

getContentScriptType

public final String getContentScriptType()

Corresponds to attribute getContentScriptType() on the given svg element.

setContentScriptType

public final void setContentScriptType(String value)
                                throws com.google.gwt.core.client.JavaScriptException

Corresponds to attribute getContentScriptType() on the given svg element.

Throws:

DOMException(NO_MODIFICATION_ALLOWED_ERR) - Raised on an attempt to change the value of a read only attribute.

com.google.gwt.core.client.JavaScriptException

getContentStyleType

public final String getContentStyleType()

Corresponds to attribute getContentStyleType() on the given svg element.

setContentStyleType

public final void setContentStyleType(String value)
                               throws com.google.gwt.core.client.JavaScriptException

Corresponds to attribute getContentStyleType() on the given svg element.

Throws:

DOMException(NO_MODIFICATION_ALLOWED_ERR) - Raised on an attempt to change the value of a read only attribute.

com.google.gwt.core.client.JavaScriptException

getViewport

public final OMSVGRect getViewport()

The position and size of the viewport (implicit or explicit) that corresponds to this svg element. When the user agent is actually rendering the content, then the position and size values represent the actual values when rendering. The position and size values are unitless values in the coordinate system of the parent element. If no parent element exists (i.e., svg element represents the root of the document tree), if this SVG document is embedded as part of another document (e.g., via the HTML 'object' element), then the position and size are unitless values in the coordinate system of the parent document. (If the parent uses CSS or XSL layout, then unitless values represent pixel units for the current CSS or XSL viewport, as described in the CSS2 specification.) If the parent element does not have a coordinate system, then the user agent should provide reasonable default values for this attribute.

The OMSVGRect object is read only.

getPixelUnitToMillimeterX

public final float getPixelUnitToMillimeterX()

Size of a pixel units (as defined by CSS2) along the x-axis of the viewport, which represents a unit somewhere in the range of 70dpi to 120dpi, and, on systems that support this, might actually match the characteristics of the target medium. On systems where it is impossible to know the size of a pixel, a suitable default pixel size is provided.

getPixelUnitToMillimeterY

public final float getPixelUnitToMillimeterY()

Corresponding size of a pixel unit along the y-axis of the viewport.

getScreenPixelToMillimeterX

public final float getScreenPixelToMillimeterX()

User interface (UI) events in DOM Level 2 indicate the screen positions at which the given UI event occurred. When the user agent actually knows the physical size of a "screen unit", this attribute will express that information; otherwise, user agents will provide a suitable default value such as .28mm.

getScreenPixelToMillimeterY

public final float getScreenPixelToMillimeterY()

Corresponding size of a screen pixel along the y-axis of the viewport.

getUseCurrentView

public final boolean getUseCurrentView()

The initial view (i.e., before magnification and panning) of the current innermost SVG document fragment can be either the "standard" view (i.e., based on attributes on the svg element such as svg/viewBox) or to a "custom" view (i.e., a hyperlink into a particular view or other element - see Linking into SVG content: URI fragments and SVG views). If the initial view is the "standard" view, then this attribute is false. If the initial view is a "custom" view, then this attribute is true.

getCurrentView

public final OMSVGViewSpec getCurrentView()

The definition of the initial view (i.e., before magnification and panning) of the current innermost SVG document fragment. The meaning depends on the situation:

• If the initial view was a "standard" view, then:
  • the values for ISVGFitToViewBox.getViewBox(), ISVGFitToViewBox.getPreserveAspectRatio() and ISVGZoomAndPan.getZoomAndPan() within getCurrentView() will match the values for the corresponding DOM attributes that are on SVGSVGElement directly
  • the values for ISVGViewSpec.getTransform() and ISVGViewSpec.getViewTarget() within getCurrentView() will be null
• If the initial view was a link into a view element, then:
  • the values for ISVGFitToViewBox.getViewBox(), ISVGFitToViewBox.getPreserveAspectRatio() and ISVGZoomAndPan.getZoomAndPan() within getCurrentView() will correspond to the corresponding attributes for the given view element
  • the values for ISVGViewSpec.getTransform() and ISVGViewSpec.getViewTarget() within getCurrentView() will be null
• If the initial view was a link into another element (i.e., other than a view), then:
  • the values for ISVGFitToViewBox.getViewBox(), ISVGFitToViewBox.getPreserveAspectRatio() and ISVGZoomAndPan.getZoomAndPan() within getCurrentView() will match the values for the corresponding DOM attributes that are on SVGSVGElement directly for the closest ancestor svg element
  • the values for ISVGViewSpec.getTransform() within getCurrentView() will be null
  • the ISVGViewSpec.getViewTarget() within getCurrentView() will represent the target of the link
• If the initial view was a link into the SVG document fragment using an SVG view specification fragment identifier (i.e., #svgView(...)), then:
  • the values for ISVGFitToViewBox.getViewBox(), ISVGFitToViewBox.getPreserveAspectRatio(), ISVGZoomAndPan.getZoomAndPan(), ISVGViewSpec.getTransform() and ISVGViewSpec.getViewTarget() within getCurrentView() will correspond to the values from the SVG view specification fragment identifier

The object itself and its contents are both read only.

getCurrentScale

public final float getCurrentScale()

On an outermost svg element, this attribute indicates the current scale factor relative to the initial view to take into account user magnification and panning operations, as described under Magnification and panning. DOM attributes getCurrentScale() and getCurrentTranslate() are equivalent to the 2x3 matrix [a b c d e f] = [currentScale 0 0 currentScale currentTranslate.x currentTranslate.y]. If "magnification" is enabled (i.e., zoomAndPan="magnify"), then the effect is as if an extra transformation were placed at the outermost level on the SVG document fragment (i.e., outside the outermost svg element).

When accessed on an svg element that is not an outermost svg element, it is undefined what behavior this attribute has.

setCurrentScale

public final void setCurrentScale(float value)

On an outermost svg element, this attribute indicates the current scale factor relative to the initial view to take into account user magnification and panning operations, as described under Magnification and panning. DOM attributes getCurrentScale() and getCurrentTranslate() are equivalent to the 2x3 matrix [a b c d e f] = [currentScale 0 0 currentScale currentTranslate.x currentTranslate.y]. If "magnification" is enabled (i.e., zoomAndPan="magnify"), then the effect is as if an extra transformation were placed at the outermost level on the SVG document fragment (i.e., outside the outermost svg element).

When accessed on an svg element that is not an outermost svg element, it is undefined what behavior this attribute has.

getCurrentTranslate

public final OMSVGPoint getCurrentTranslate()

On an outermost svg element, the corresponding translation factor that takes into account user "magnification".

When accessed on an svg element that is not an outermost svg element, it is undefined what behavior this attribute has.

suspendRedraw

public final int suspendRedraw(int maxWaitMilliseconds)

Takes a time-out value which indicates that redraw shall not occur until:

1. the corresponding unsuspendRedraw() call has been made,
2. an unsuspendRedrawAll() call has been made, or
3. its timer has timed out.

In environments that do not support interactivity (e.g., print media), then redraw shall not be suspended. Calls to suspendRedraw() and unsuspendRedraw() should, but need not be, made in balanced pairs.

To suspend redraw actions as a collection of SVG DOM changes occur, precede the changes to the SVG DOM with a method call similar to:

suspendHandleID
 = suspendRedraw(maxWaitMilliseconds);

and follow the changes with a method call similar to:

unsuspendRedraw(suspendHandleID);

Note that multiple suspendRedraw calls can be used at once and that each such method call is treated independently of the other suspendRedraw method calls.

Parameters:

maxWaitMilliseconds - The amount of time in milliseconds to hold off before redrawing the device. Values greater than 60 seconds will be truncated down to 60 seconds.

Returns:

A number which acts as a unique identifier for the given suspendRedraw() call. This value must be passed as the parameter to the corresponding unsuspendRedraw() method call.

unsuspendRedraw

public final void unsuspendRedraw(int suspendHandleID)

Cancels a specified suspendRedraw() by providing a unique suspend handle ID that was returned by a previous suspendRedraw() call.

Parameters:

suspendHandleID - A number which acts as a unique identifier for the desired suspendRedraw() call. The number supplied must be a value returned from a previous call to suspendRedraw(). If an invalid handle ID value is provided then the request to unsuspendRedraw() is silently ignored.

unsuspendRedrawAll

public final void unsuspendRedrawAll()

Cancels all currently active suspendRedraw() method calls. This method is most useful at the very end of a set of SVG DOM calls to ensure that all pending suspendRedraw() method calls have been cancelled.

forceRedraw

public final void forceRedraw()

In rendering environments supporting interactivity, forces the user agent to immediately redraw all regions of the viewport that require updating.

pauseAnimations

public final void pauseAnimations()

Suspends (i.e., pauses) all currently running animations that are defined within the SVG document fragment corresponding to this svg element, causing the animation clock corresponding to this document fragment to stand still until it is unpaused.

unpauseAnimations

public final void unpauseAnimations()

Unsuspends (i.e., unpauses) currently running animations that are defined within the SVG document fragment, causing the animation clock to continue from the time at which it was suspended.

animationsPaused

public final boolean animationsPaused()

Returns true if this SVG document fragment is in a paused state.

Returns:

Boolean indicating whether this SVG document fragment is in a paused state.

getCurrentTime

public final float getCurrentTime()

Returns the current time in seconds relative to the start time for the current SVG document fragment. If getCurrentTime is called before the document timeline has begun (for example, by script running in a script element before the document's SVGLoad event is dispatched), then 0 is returned.

Returns:

The current time in seconds, or 0 if the document timeline has not yet begun.

setCurrentTime

public final void setCurrentTime(float seconds)

Adjusts the clock for this SVG document fragment, establishing a new current time. If setCurrentTime is called before the document timeline has begun (for example, by script running in a script element before the document's SVGLoad event is dispatched), then the value of seconds in the last invocation of the method gives the time that the document will seek to once the document timeline has begun.

Parameters:

seconds - The new current time in seconds relative to the start time for the current SVG document fragment.

getIntersectionList

public final com.google.gwt.dom.client.NodeList<? extends com.google.gwt.dom.client.Node> getIntersectionList(OMSVGRect rect,
                                                                                                              SVGElement referenceElement)

Returns the list of graphics elements whose rendered content intersects the supplied rectangle. Each candidate graphics element is to be considered a match only if the same graphics element can be a target of pointer events as defined in pointer-events processing.

Parameters:

rect - The test rectangle. The values are in the initial coordinate system for the current svg element.

referenceElement - If not null, then any intersected element that doesn't have the referenceElement as ancestor must not be included in the returned NodeList.

Returns:

A list of Elements whose content intersects the supplied rectangle. This NodeList must be implemented identically to the NodeList interface as defined in DOM Level 2 Core ([DOM2], section 1.2) with the exception that the interface is not live.

getEnclosureList

public final com.google.gwt.dom.client.NodeList<? extends com.google.gwt.dom.client.Node> getEnclosureList(OMSVGRect rect,
                                                                                                           SVGElement referenceElement)

Returns the list of graphics elements whose rendered content is entirely contained within the supplied rectangle. Each candidate graphics element is to be considered a match only if the same graphics element can be a target of pointer events as defined in pointer-events processing.

Parameters:

rect - The test rectangle. The values are in the initial coordinate system for the current svg element.

referenceElement - If not null, then any intersected element that doesn't have the referenceElement as ancestor must not be included in the returned NodeList.

Returns:

A list of Elements whose content is enclosed by the supplied rectangle. This NodeList must be implemented identically to the NodeList interface as defined in DOM Level 2 Core ([DOM2], section 1.2) with the exception that the interface is not live.

checkIntersection

public final boolean checkIntersection(SVGElement element,
                                       OMSVGRect rect)

Returns true if the rendered content of the given element intersects the supplied rectangle. Each candidate graphics element is to be considered a match only if the same graphics element can be a target of pointer events as defined in pointer-events processing.

Parameters:

element - The element on which to perform the given test.

rect - The test rectangle. The values are in the initial coordinate system for the current svg element.

Returns:

True or false, depending on whether the given element intersects the supplied rectangle.

checkEnclosure

public final boolean checkEnclosure(SVGElement element,
                                    OMSVGRect rect)

Returns true if the rendered content of the given element is entirely contained within the supplied rectangle. Each candidate graphics element is to be considered a match only if the same graphics element can be a target of pointer events as defined in pointer-events processing.

Parameters:

element - The element on which to perform the given test.

rect - The test rectangle. The values are in the initial coordinate system for the current svg element.

Returns:

True or false, depending on whether the given element is enclosed by the supplied rectangle.

deselectAll

public final void deselectAll()

Unselects any selected objects, including any selections of text strings and type-in bars.

createSVGNumber

public final OMSVGNumber createSVGNumber()

Creates an OMSVGNumber object outside of any document trees. The object is initialized to a value of zero.

Returns:

An OMSVGNumber object.

createSVGLength

public final OMSVGLength createSVGLength()

Creates an OMSVGLength object outside of any document trees. The object is initialized to the value of 0 user units.

Returns:

An OMSVGLength object.

createSVGAngle

public final OMSVGAngle createSVGAngle()

Creates an OMSVGAngle object outside of any document trees. The object is initialized to the value 0 degrees (unitless).

Returns:

An OMSVGAngle object.

createSVGPoint

public final OMSVGPoint createSVGPoint()

Creates an OMSVGPoint object outside of any document trees. The object is initialized to the point (0,0) in the user coordinate system.

Returns:

An OMSVGPoint object.

createSVGMatrix

public final OMSVGMatrix createSVGMatrix()

Creates an OMSVGMatrix object outside of any document trees. The object is initialized to the identity matrix.

Returns:

An OMSVGMatrix object.

createSVGRect

public final OMSVGRect createSVGRect()

Creates an OMSVGRect object outside of any document trees. The object is initialized such that all values are set to 0 user units.

Returns:

An OMSVGRect object.

createSVGTransform

public final OMSVGTransform createSVGTransform()

Creates an OMSVGTransform object outside of any document trees. The object is initialized to an identity matrix transform (SVG_TRANSFORM_MATRIX).

Returns:

An OMSVGTransform object.

createSVGTransformFromMatrix

public final OMSVGTransform createSVGTransformFromMatrix(OMSVGMatrix matrix)

Creates an OMSVGTransform object outside of any document trees. The object is initialized to the given matrix transform (i.e., SVG_TRANSFORM_MATRIX). The values from the parameter matrix are copied, the matrix parameter is not adopted as SVGTransform::matrix.

Parameters:

matrix - The transform matrix.

Returns:

An OMSVGTransform object.

getElementById

public final com.google.gwt.dom.client.Element getElementById(String elementId)

Searches this SVG document fragment (i.e., the search is restricted to a subset of the document tree) for an Element whose id is given by elementId. If an Element is found, that Element is returned. If no such element exists, returns null. Behavior is not defined if more than one element has this id.

Parameters:

elementId - The unique id value for an element.

Returns:

The matching element.

getExternalResourcesRequired

public final OMSVGAnimatedBoolean getExternalResourcesRequired()

Corresponds to attribute ISVGExternalResourcesRequired.getExternalResourcesRequired() on the given element. Note that the SVG DOM defines the attribute ISVGExternalResourcesRequired.getExternalResourcesRequired() as being of type OMSVGAnimatedBoolean, whereas the SVG language definition says that ISVGExternalResourcesRequired.getExternalResourcesRequired() is not animated. Because the SVG language definition states that ISVGExternalResourcesRequired.getExternalResourcesRequired() cannot be animated, the OMSVGAnimatedBoolean.getAnimVal() will always be the same as the OMSVGAnimatedBoolean.getBaseVal().

getViewBox

public final OMSVGAnimatedRect getViewBox()

Corresponds to attribute ISVGFitToViewBox.getViewBox() on the given element.

getPreserveAspectRatio

public final OMSVGAnimatedPreserveAspectRatio getPreserveAspectRatio()

Corresponds to attribute ISVGFitToViewBox.getPreserveAspectRatio() on the given element.

getXmllang

public final String getXmllang()

Corresponds to attribute xml:lang on the given element.

setXmllang

public final void setXmllang(String value)
                      throws com.google.gwt.core.client.JavaScriptException

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.

com.google.gwt.core.client.JavaScriptException

getXmlspace

public final String getXmlspace()

Corresponds to attribute xml:space on the given element.

setXmlspace

public final void setXmlspace(String value)
                       throws com.google.gwt.core.client.JavaScriptException

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.

com.google.gwt.core.client.JavaScriptException

getNearestViewportElement

public final SVGElement getNearestViewportElement()

The element which established the current viewport. Often, the nearest ancestor svg element. Null if the current element is the outermost svg element.

getFarthestViewportElement

public final SVGElement getFarthestViewportElement()

The farthest ancestor svg element. Null if the current element is the outermost svg element.

getBBox

public final OMSVGRect getBBox()

Returns the tight bounding box in current user space (i.e., after application of the transform attribute, if any) on the geometry of all contained graphics elements, exclusive of stroking, clipping, masking and filter effects). Note that getBBox must return the actual bounding box at the time the method was called, even in case the element has not yet been rendered.

Returns:

An OMSVGRect object that defines the bounding box.

getCTM

public final OMSVGMatrix getCTM()

Returns the transformation matrix from current user units (i.e., after application of the transform attribute, if any) to the viewport coordinate system for the ISVGLocatable.getNearestViewportElement().

Returns:

An OMSVGMatrix object that defines the CTM.

getScreenCTM

public final OMSVGMatrix getScreenCTM()

Returns the transformation matrix from current user units (i.e., after application of the transform attribute, if any) to the parent user agent's notice of a "pixel". For display devices, ideally this represents a physical screen pixel. For other devices or environments where physical pixel sizes are not known, then an algorithm similar to the CSS2 definition of a "pixel" can be used instead. Note that null is returned if this element is not hooked into the document tree. This method would have been more aptly named as getClientCTM, but the name getScreenCTM is kept for historical reasons.

Returns:

An OMSVGMatrix object that defines the given transformation matrix.

getTransformToElement

public final OMSVGMatrix getTransformToElement(SVGElement element)
                                        throws com.google.gwt.core.client.JavaScriptException

Returns the transformation matrix from the user coordinate system on the current element (after application of the transform attribute, if any) to the user coordinate system on parameter element (after application of its transform attribute, if any).

Parameters:

element - The target element.

Returns:

An OMSVGMatrix object that defines the transformation.

Throws:

SVGException(SVG_MATRIX_NOT_INVERTABLE) - Raised if the currently defined transformation matrices make it impossible to compute the given matrix (e.g., because one of the transformations is singular).

com.google.gwt.core.client.JavaScriptException

getRequiredFeatures

public final OMSVGStringList getRequiredFeatures()

Corresponds to attribute ISVGTests.getRequiredFeatures() on the given element.

getRequiredExtensions

public final OMSVGStringList getRequiredExtensions()

Corresponds to attribute ISVGTests.getRequiredExtensions() on the given element.

getSystemLanguage

public final OMSVGStringList getSystemLanguage()

Corresponds to attribute ISVGTests.getSystemLanguage() on the given element.

hasExtension

public final boolean hasExtension(String extension)

Returns true if the user agent supports the given extension, specified by a URI.

Parameters:

extension - The name of the extension, expressed as a URI.

Returns:

True or false, depending on whether the given extension is supported.

getZoomAndPan

public final short getZoomAndPan()

Corresponds to attribute ISVGZoomAndPan.getZoomAndPan() on the given element. The value must be one of the SVG_ZOOMANDPAN_ constants defined on this interface.

setZoomAndPan

public final void setZoomAndPan(short value)
                         throws com.google.gwt.core.client.JavaScriptException

Corresponds to attribute ISVGZoomAndPan.getZoomAndPan() on the given element. The value must be one of the SVG_ZOOMANDPAN_ constants defined on this interface.

Throws:

DOMException(NO_MODIFICATION_ALLOWED_ERR) - Raised on an attempt to change the value of a read only attribute.

com.google.gwt.core.client.JavaScriptException