org.vectomatic.dom.svg
Class OMSVGClipPathElement

java.lang.Object
  org.vectomatic.dom.svg.OMNode
      org.vectomatic.dom.svg.OMElement
          org.vectomatic.dom.svg.OMSVGElement
              org.vectomatic.dom.svg.OMSVGClipPathElement

All Implemented Interfaces:

com.google.gwt.event.shared.HasHandlers, ISVGExternalResourcesRequired, ISVGLangSpace, ISVGLocatable, ISVGStylable, ISVGTests, ISVGTransformable, ISVGUnitTypes

@TagName(value="clipPath")
public class OMSVGClipPathElement
extends OMSVGElement
implements ISVGTests, ISVGLangSpace, ISVGExternalResourcesRequired, ISVGStylable, ISVGTransformable, ISVGUnitTypes

The OMSVGClipPathElement interface corresponds to the clipPath element.

Field Summary

Fields inherited from class org.vectomatic.dom.svg.OMNode

eventBus, ot

Fields inherited from interface org.vectomatic.dom.svg.itf.ISVGUnitTypes

SVG_UNIT_TYPE_OBJECTBOUNDINGBOX, SVG_UNIT_TYPE_UNKNOWN, SVG_UNIT_TYPE_USERSPACEONUSE

Constructor Summary

	OMSVGClipPathElement()
protected	OMSVGClipPathElement(SVGClipPathElement ot)

Method Summary

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).
OMSVGAnimatedEnumeration	getClipPathUnits() Corresponds to attribute getClipPathUnits() on the given clipPath 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().
OMSVGAnimatedBoolean	getExternalResourcesRequired() Corresponds to attribute ISVGExternalResourcesRequired.getExternalResourcesRequired() on the given element.
OMSVGElement	getFarthestViewportElement() The farthest ancestor svg element.
OMSVGElement	getNearestViewportElement() The element which established the current viewport.
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".
OMSVGStringList	getSystemLanguage() Corresponds to attribute ISVGTests.getSystemLanguage() on the given element.
OMSVGAnimatedTransformList	getTransform() Corresponds to attribute ISVGTransformable.getTransform() on the given element.
OMSVGMatrix	getTransformToElement(OMSVGElement 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).
String	getXmllang() Corresponds to attribute xml:lang on the given element.
String	getXmlspace() Corresponds to attribute xml:space on the given element.
boolean	hasExtension(String extension) Returns true if the user agent supports the given extension, specified by a URI.
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.

Methods inherited from class org.vectomatic.dom.svg.OMSVGElement

addClassNameBaseVal, getClassName, getMarkup, getOwnerSVGElement, getStyle, getViewportElement, getXmlbase, removeClassNameBaseVal, replaceClassNameBaseVal, setClassNameBaseVal, setId, setXmlbase

Methods inherited from class org.vectomatic.dom.svg.OMElement

getAttribute, getAttributeNode, getAttributeNS, getAttributes, getElement, getElementsByTagName, getElementsByTagNameNS, getId, getTagName, hasAttribute, hasAttributeNS, removeAttribute, setAttribute, setAttributeNode, setAttributeNS

Methods inherited from class org.vectomatic.dom.svg.OMNode

addDomHandler, addHandler, appendChild, cleanup, cloneNode, convert, convertList, dispatch, fireEvent, getChildNodes, getEventBus, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNode, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPreviousSibling, hasChildNodes, insertBefore, normalize, removeChild, replaceChild, setNodeValue, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.vectomatic.dom.svg.itf.ISVGStylable

addClassNameBaseVal, getClassName, getStyle, removeClassNameBaseVal, replaceClassNameBaseVal, setClassNameBaseVal

Constructor Detail

OMSVGClipPathElement

public OMSVGClipPathElement()

OMSVGClipPathElement

protected OMSVGClipPathElement(SVGClipPathElement ot)

Method Detail

getClipPathUnits

public final OMSVGAnimatedEnumeration getClipPathUnits()

Corresponds to attribute getClipPathUnits() on the given clipPath element. Takes one of the constants defined in ISVGUnitTypes.

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().

Specified by:

getExternalResourcesRequired in interface ISVGExternalResourcesRequired

getXmllang

public final String getXmllang()

Corresponds to attribute xml:lang on the given element.

Specified by:

getXmllang in interface ISVGLangSpace

setXmllang

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

Corresponds to attribute xml:lang on the given element.

Specified by:

setXmllang in interface ISVGLangSpace

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.

Specified by:

getXmlspace in interface ISVGLangSpace

setXmlspace

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

Corresponds to attribute xml:space on the given element.

Specified by:

setXmlspace in interface ISVGLangSpace

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 OMSVGElement getNearestViewportElement()

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

Specified by:

getNearestViewportElement in interface ISVGLocatable

getFarthestViewportElement

public final OMSVGElement getFarthestViewportElement()

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

Specified by:

getFarthestViewportElement in interface ISVGLocatable

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.

Specified by:

getBBox in interface ISVGLocatable

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().

Specified by:

getCTM in interface ISVGLocatable

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.

Specified by:

getScreenCTM in interface ISVGLocatable

Returns:

An OMSVGMatrix object that defines the given transformation matrix.

getTransformToElement

public final OMSVGMatrix getTransformToElement(OMSVGElement 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).

Specified by:

getTransformToElement in interface ISVGLocatable

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.

Specified by:

getRequiredFeatures in interface ISVGTests

getRequiredExtensions

public final OMSVGStringList getRequiredExtensions()

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

Specified by:

getRequiredExtensions in interface ISVGTests

getSystemLanguage

public final OMSVGStringList getSystemLanguage()

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

Specified by:

getSystemLanguage in interface ISVGTests

hasExtension

public final boolean hasExtension(String extension)

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

Specified by:

hasExtension in interface ISVGTests

Parameters:

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

Returns:

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

getTransform

public final OMSVGAnimatedTransformList getTransform()

Corresponds to attribute ISVGTransformable.getTransform() on the given element.

Specified by:

getTransform in interface ISVGTransformable