org.vectomatic.dom.svg.impl
Class SVGLineElement

java.lang.Object
  extended by com.google.gwt.core.client.JavaScriptObject
      extended by com.google.gwt.dom.client.Node
          extended by com.google.gwt.dom.client.Element
              extended by org.vectomatic.dom.svg.impl.SVGElement
                  extended by org.vectomatic.dom.svg.impl.SVGLineElement

public class SVGLineElement
extends SVGElement

The SVGLineElement interface corresponds to the line element.


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
protected SVGLineElement()
           
 
Method Summary
 float distanceToLine(OMSVGPoint p)
          Computes the distance from the specified point to this line.
 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).
 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.
 SVGElement getFarthestViewportElement()
          The farthest ancestor svg element.
 SVGElement 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(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).
 OMSVGAnimatedLength getX1()
          Corresponds to attribute getX1() on the given line element.
 OMSVGAnimatedLength getX2()
          Corresponds to attribute getX2() on the given line element.
 String getXmllang()
          Corresponds to attribute xml:lang on the given element.
 String getXmlspace()
          Corresponds to attribute xml:space on the given element.
 OMSVGAnimatedLength getY1()
          Corresponds to attribute getY1() on the given line element.
 OMSVGAnimatedLength getY2()
          Corresponds to attribute getY2() on the given line element.
 boolean hasExtension(String extension)
          Returns true if the user agent supports the given extension, specified by a URI.
 OMSVGPoint intersectionPoint(OMSVGPoint p)
          Computes the intersection point between this line and the tangent perpendicular to this line through p.
 OMSVGPoint intersectionPoint(OMSVGPoint p, OMSVGPoint destination)
          Computes the intersection point between this line and the tangent perpendicular to this line through p and puts the result in the specified destination point.
 float parametricIntersection(OMSVGPoint p)
          Computes the intersection point between this line and the tangent perpendicular to this line through p.
 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.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, 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
 
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, removeChild, removeFromParent, replaceChild, setNodeValue
 
Methods inherited from class com.google.gwt.core.client.JavaScriptObject
cast, createArray, createFunction, createObject, equals, hashCode, toSource, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SVGLineElement

protected SVGLineElement()
Method Detail

getX1

public final OMSVGAnimatedLength getX1()
Corresponds to attribute getX1() on the given line element.


getY1

public final OMSVGAnimatedLength getY1()
Corresponds to attribute getY1() on the given line element.


getX2

public final OMSVGAnimatedLength getX2()
Corresponds to attribute getX2() on the given line element.


getY2

public final OMSVGAnimatedLength getY2()
Corresponds to attribute getY2() on the given line 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().


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.

getTransform

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


parametricIntersection

public final float parametricIntersection(OMSVGPoint p)
Computes the intersection point between this line and the tangent perpendicular to this line through p. The intersection is returned in parametric form. If one considers the parametric equation of this line to be:
P = P1 + t * (P2 - P1)
then this method returns the value of t at the intersection point.

Parameters:
p - The point which defines the tangent.
Returns:
the parametric value of the intersection point.

intersectionPoint

public final OMSVGPoint intersectionPoint(OMSVGPoint p)
Computes the intersection point between this line and the tangent perpendicular to this line through p.

Parameters:
p - The point which defines the tangent.
Returns:
the intersection point.

intersectionPoint

public final OMSVGPoint intersectionPoint(OMSVGPoint p,
                                          OMSVGPoint destination)
Computes the intersection point between this line and the tangent perpendicular to this line through p and puts the result in the specified destination point.

Parameters:
p - The point which defines the tangent.
destination - The point where to store the result.
Returns:
the intersection point.

distanceToLine

public final float distanceToLine(OMSVGPoint p)
Computes the distance from the specified point to this line.

Parameters:
p - A point in the plane
Returns:
the distance to this line.


Copyright © 2012. All Rights Reserved.