org.vectomatic.dom.svg

Class OMSVGLineElement

java.lang.Object

org.vectomatic.dom.svg.OMNode

org.vectomatic.dom.svg.OMElement

org.vectomatic.dom.svg.OMSVGElement

org.vectomatic.dom.svg.OMSVGLineElement

All Implemented Interfaces:

com.google.gwt.event.dom.client.HasAllDragAndDropHandlers, com.google.gwt.event.dom.client.HasAllTouchHandlers, com.google.gwt.event.dom.client.HasClickHandlers, com.google.gwt.event.dom.client.HasDragEndHandlers, com.google.gwt.event.dom.client.HasDragEnterHandlers, com.google.gwt.event.dom.client.HasDragHandlers, com.google.gwt.event.dom.client.HasDragLeaveHandlers, com.google.gwt.event.dom.client.HasDragOverHandlers, com.google.gwt.event.dom.client.HasDragStartHandlers, com.google.gwt.event.dom.client.HasDropHandlers, com.google.gwt.event.dom.client.HasLoadHandlers, com.google.gwt.event.dom.client.HasMouseDownHandlers, com.google.gwt.event.dom.client.HasMouseMoveHandlers, com.google.gwt.event.dom.client.HasMouseOutHandlers, com.google.gwt.event.dom.client.HasMouseOverHandlers, com.google.gwt.event.dom.client.HasMouseUpHandlers, com.google.gwt.event.dom.client.HasTouchCancelHandlers, com.google.gwt.event.dom.client.HasTouchEndHandlers, com.google.gwt.event.dom.client.HasTouchMoveHandlers, com.google.gwt.event.dom.client.HasTouchStartHandlers, com.google.gwt.event.shared.HasHandlers, HasActivateHandlers, HasFocusInHandlers, HasFocusOutHandlers, HasGraphicalHandlers, ISVGExternalResourcesRequired, ISVGGraphicsElement, ISVGLangSpace, ISVGLocatable, ISVGStylable, ISVGTests, ISVGTransformable

@TagName(value="line")
public class OMSVGLineElement
extends OMSVGElement
implements HasGraphicalHandlers, ISVGTests, ISVGLangSpace, ISVGExternalResourcesRequired, ISVGStylable, ISVGTransformable, ISVGGraphicsElement

The OMSVGLineElement interface corresponds to the line element.

Field Summary

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

eventBus, ot

Constructor Summary

Constructors

Modifier	Constructor and Description
	OMSVGLineElement()
	OMSVGLineElement(float x1, float y1, float x2, float y2) Constructor
	OMSVGLineElement(OMSVGPoint p1, OMSVGPoint p2) Constructor
protected	OMSVGLineElement(SVGLineElement ot)

Method Summary

Modifier and Type	Method and Description
com.google.gwt.event.shared.HandlerRegistration	addActivateHandler(ActivateHandler handler) Adds a ActivateHandler handler.
com.google.gwt.event.shared.HandlerRegistration	addClickHandler(com.google.gwt.event.dom.client.ClickHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addDragEndHandler(com.google.gwt.event.dom.client.DragEndHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addDragEnterHandler(com.google.gwt.event.dom.client.DragEnterHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addDragHandler(com.google.gwt.event.dom.client.DragHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addDragLeaveHandler(com.google.gwt.event.dom.client.DragLeaveHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addDragOverHandler(com.google.gwt.event.dom.client.DragOverHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addDragStartHandler(com.google.gwt.event.dom.client.DragStartHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addDropHandler(com.google.gwt.event.dom.client.DropHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addFocusInHandler(FocusInHandler handler) Adds a FocusInHandler handler.
com.google.gwt.event.shared.HandlerRegistration	addFocusOutHandler(FocusOutHandler handler) Adds a FocusOutHandler handler.
com.google.gwt.event.shared.HandlerRegistration	addLoadHandler(com.google.gwt.event.dom.client.LoadHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addMouseDownHandler(com.google.gwt.event.dom.client.MouseDownHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addMouseMoveHandler(com.google.gwt.event.dom.client.MouseMoveHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addMouseOutHandler(com.google.gwt.event.dom.client.MouseOutHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addMouseOverHandler(com.google.gwt.event.dom.client.MouseOverHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addMouseUpHandler(com.google.gwt.event.dom.client.MouseUpHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addTouchCancelHandler(com.google.gwt.event.dom.client.TouchCancelHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addTouchEndHandler(com.google.gwt.event.dom.client.TouchEndHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addTouchMoveHandler(com.google.gwt.event.dom.client.TouchMoveHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addTouchStartHandler(com.google.gwt.event.dom.client.TouchStartHandler handler)
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.
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).
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.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 com.google.gwt.event.shared.HasHandlers

fireEvent

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

addClassNameBaseVal, getClassName, getStyle, removeClassNameBaseVal, replaceClassNameBaseVal, setClassNameBaseVal

Constructor Detail

OMSVGLineElement

public OMSVGLineElement()

OMSVGLineElement

protected OMSVGLineElement(SVGLineElement ot)

OMSVGLineElement

public OMSVGLineElement(float x1,
                        float y1,
                        float x2,
                        float y2)

Constructor

Parameters:

x1 - the X coordinate of the first endpoint

y1 - the Y coordinate of the first endpoint

x2 - the X coordinate of the second endpoint

y2 - the Y coordinate of the second endpoint

OMSVGLineElement

public OMSVGLineElement(OMSVGPoint p1,
                        OMSVGPoint p2)

Constructor

Parameters:

p1 - the first endpoint

p2 - the the second endpoint

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

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

addClickHandler

public final com.google.gwt.event.shared.HandlerRegistration addClickHandler(com.google.gwt.event.dom.client.ClickHandler handler)

Specified by:

addClickHandler in interface com.google.gwt.event.dom.client.HasClickHandlers

addDragEndHandler

public final com.google.gwt.event.shared.HandlerRegistration addDragEndHandler(com.google.gwt.event.dom.client.DragEndHandler handler)

Specified by:

addDragEndHandler in interface com.google.gwt.event.dom.client.HasDragEndHandlers

addDragEnterHandler

public final com.google.gwt.event.shared.HandlerRegistration addDragEnterHandler(com.google.gwt.event.dom.client.DragEnterHandler handler)

Specified by:

addDragEnterHandler in interface com.google.gwt.event.dom.client.HasDragEnterHandlers

addDragHandler

public final com.google.gwt.event.shared.HandlerRegistration addDragHandler(com.google.gwt.event.dom.client.DragHandler handler)

Specified by:

addDragHandler in interface com.google.gwt.event.dom.client.HasDragHandlers

addDragLeaveHandler

public final com.google.gwt.event.shared.HandlerRegistration addDragLeaveHandler(com.google.gwt.event.dom.client.DragLeaveHandler handler)

Specified by:

addDragLeaveHandler in interface com.google.gwt.event.dom.client.HasDragLeaveHandlers

addDragOverHandler

public final com.google.gwt.event.shared.HandlerRegistration addDragOverHandler(com.google.gwt.event.dom.client.DragOverHandler handler)

Specified by:

addDragOverHandler in interface com.google.gwt.event.dom.client.HasDragOverHandlers

addDragStartHandler

public final com.google.gwt.event.shared.HandlerRegistration addDragStartHandler(com.google.gwt.event.dom.client.DragStartHandler handler)

Specified by:

addDragStartHandler in interface com.google.gwt.event.dom.client.HasDragStartHandlers

addDropHandler

public final com.google.gwt.event.shared.HandlerRegistration addDropHandler(com.google.gwt.event.dom.client.DropHandler handler)

Specified by:

addDropHandler in interface com.google.gwt.event.dom.client.HasDropHandlers

addLoadHandler

public final com.google.gwt.event.shared.HandlerRegistration addLoadHandler(com.google.gwt.event.dom.client.LoadHandler handler)

Specified by:

addLoadHandler in interface com.google.gwt.event.dom.client.HasLoadHandlers

addMouseDownHandler

public final com.google.gwt.event.shared.HandlerRegistration addMouseDownHandler(com.google.gwt.event.dom.client.MouseDownHandler handler)

Specified by:

addMouseDownHandler in interface com.google.gwt.event.dom.client.HasMouseDownHandlers

addMouseMoveHandler

public final com.google.gwt.event.shared.HandlerRegistration addMouseMoveHandler(com.google.gwt.event.dom.client.MouseMoveHandler handler)

Specified by:

addMouseMoveHandler in interface com.google.gwt.event.dom.client.HasMouseMoveHandlers

addMouseOutHandler

public final com.google.gwt.event.shared.HandlerRegistration addMouseOutHandler(com.google.gwt.event.dom.client.MouseOutHandler handler)

Specified by:

addMouseOutHandler in interface com.google.gwt.event.dom.client.HasMouseOutHandlers

addMouseOverHandler

public final com.google.gwt.event.shared.HandlerRegistration addMouseOverHandler(com.google.gwt.event.dom.client.MouseOverHandler handler)

Specified by:

addMouseOverHandler in interface com.google.gwt.event.dom.client.HasMouseOverHandlers

addMouseUpHandler

public final com.google.gwt.event.shared.HandlerRegistration addMouseUpHandler(com.google.gwt.event.dom.client.MouseUpHandler handler)

Specified by:

addMouseUpHandler in interface com.google.gwt.event.dom.client.HasMouseUpHandlers

addTouchCancelHandler

public final com.google.gwt.event.shared.HandlerRegistration addTouchCancelHandler(com.google.gwt.event.dom.client.TouchCancelHandler handler)

Specified by:

addTouchCancelHandler in interface com.google.gwt.event.dom.client.HasTouchCancelHandlers

addTouchEndHandler

public final com.google.gwt.event.shared.HandlerRegistration addTouchEndHandler(com.google.gwt.event.dom.client.TouchEndHandler handler)

Specified by:

addTouchEndHandler in interface com.google.gwt.event.dom.client.HasTouchEndHandlers

addTouchMoveHandler

public final com.google.gwt.event.shared.HandlerRegistration addTouchMoveHandler(com.google.gwt.event.dom.client.TouchMoveHandler handler)

Specified by:

addTouchMoveHandler in interface com.google.gwt.event.dom.client.HasTouchMoveHandlers

addTouchStartHandler

public final com.google.gwt.event.shared.HandlerRegistration addTouchStartHandler(com.google.gwt.event.dom.client.TouchStartHandler handler)

Specified by:

addTouchStartHandler in interface com.google.gwt.event.dom.client.HasTouchStartHandlers

addActivateHandler

public final com.google.gwt.event.shared.HandlerRegistration addActivateHandler(ActivateHandler handler)

Description copied from interface: HasActivateHandlers

Adds a ActivateHandler handler.

Specified by:

addActivateHandler in interface HasActivateHandlers

Parameters:

handler - the activate handler

Returns:

HandlerRegistration used to remove this handler

addFocusInHandler

public final com.google.gwt.event.shared.HandlerRegistration addFocusInHandler(FocusInHandler handler)

Description copied from interface: HasFocusInHandlers

Adds a FocusInHandler handler.

Specified by:

addFocusInHandler in interface HasFocusInHandlers

Parameters:

handler - the focusin handler

Returns:

HandlerRegistration used to remove this handler

addFocusOutHandler

public final com.google.gwt.event.shared.HandlerRegistration addFocusOutHandler(FocusOutHandler handler)

Description copied from interface: HasFocusOutHandlers

Adds a FocusOutHandler handler.

Specified by:

addFocusOutHandler in interface HasFocusOutHandlers

Parameters:

handler - the focusout handler

Returns:

HandlerRegistration used to remove this handler

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.