org.vectomatic.dom.svg.OMSVGSVGElement Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of lib-gwt-svg Show documentation
Show all versions of lib-gwt-svg Show documentation
A GWT library to access the SVG functionalities of web browsers
/**********************************************
* Copyright (C) 2010-2011 Lukas Laag
* This file is part of lib-gwt-svg.
*
* libgwtsvg is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* libgwtsvg is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with libgwtsvg. If not, see http://www.gnu.org/licenses/
**********************************************/
/*
* Copyright (c) 2004 World Wide Web Consortium,
*
* (Massachusetts Institute of Technology, European Research Consortium for
* Informatics and Mathematics, Keio University). All Rights Reserved. This
* work is distributed under the W3C(r) Software License [1] in the hope that
* it will be useful, but WITHOUT ANY WARRANTY; without even the implied
* warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
*
* [1] http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231
*/
package org.vectomatic.dom.svg;
import org.vectomatic.dom.svg.events.ActivateEvent;
import org.vectomatic.dom.svg.events.ActivateHandler;
import org.vectomatic.dom.svg.events.FocusInEvent;
import org.vectomatic.dom.svg.events.FocusInHandler;
import org.vectomatic.dom.svg.events.FocusOutEvent;
import org.vectomatic.dom.svg.events.FocusOutHandler;
import org.vectomatic.dom.svg.events.HasDocumentHandlers;
import org.vectomatic.dom.svg.events.HasGraphicalHandlers;
import org.vectomatic.dom.svg.events.SVGZoomEvent;
import org.vectomatic.dom.svg.events.SVGZoomHandler;
import org.vectomatic.dom.svg.impl.SVGElement;
import org.vectomatic.dom.svg.impl.SVGSVGElement;
import org.vectomatic.dom.svg.itf.ISVGContainerElement;
import org.vectomatic.dom.svg.itf.ISVGExternalResourcesRequired;
import org.vectomatic.dom.svg.itf.ISVGFitToViewBox;
import org.vectomatic.dom.svg.itf.ISVGLangSpace;
import org.vectomatic.dom.svg.itf.ISVGLocatable;
import org.vectomatic.dom.svg.itf.ISVGStylable;
import org.vectomatic.dom.svg.itf.ISVGTests;
import org.vectomatic.dom.svg.itf.ISVGZoomAndPan;
import org.vectomatic.dom.svg.utils.DOMHelper;
import org.vectomatic.dom.svg.utils.SVGConstants;
import com.google.gwt.core.client.JavaScriptException;
import com.google.gwt.dom.client.Element;
import com.google.gwt.dom.client.Node;
import com.google.gwt.dom.client.NodeList;
import com.google.gwt.dom.client.Style;
import com.google.gwt.dom.client.TagName;
import com.google.gwt.event.dom.client.ClickEvent;
import com.google.gwt.event.dom.client.ClickHandler;
import com.google.gwt.event.dom.client.DragEndEvent;
import com.google.gwt.event.dom.client.DragEndHandler;
import com.google.gwt.event.dom.client.DragEnterEvent;
import com.google.gwt.event.dom.client.DragEnterHandler;
import com.google.gwt.event.dom.client.DragEvent;
import com.google.gwt.event.dom.client.DragHandler;
import com.google.gwt.event.dom.client.DragLeaveEvent;
import com.google.gwt.event.dom.client.DragLeaveHandler;
import com.google.gwt.event.dom.client.DragOverEvent;
import com.google.gwt.event.dom.client.DragOverHandler;
import com.google.gwt.event.dom.client.DragStartEvent;
import com.google.gwt.event.dom.client.DragStartHandler;
import com.google.gwt.event.dom.client.DropEvent;
import com.google.gwt.event.dom.client.DropHandler;
import com.google.gwt.event.dom.client.LoadEvent;
import com.google.gwt.event.dom.client.LoadHandler;
import com.google.gwt.event.dom.client.MouseDownEvent;
import com.google.gwt.event.dom.client.MouseDownHandler;
import com.google.gwt.event.dom.client.MouseMoveEvent;
import com.google.gwt.event.dom.client.MouseMoveHandler;
import com.google.gwt.event.dom.client.MouseOutEvent;
import com.google.gwt.event.dom.client.MouseOutHandler;
import com.google.gwt.event.dom.client.MouseOverEvent;
import com.google.gwt.event.dom.client.MouseOverHandler;
import com.google.gwt.event.dom.client.MouseUpEvent;
import com.google.gwt.event.dom.client.MouseUpHandler;
import com.google.gwt.event.dom.client.ScrollEvent;
import com.google.gwt.event.dom.client.ScrollHandler;
import com.google.gwt.event.dom.client.TouchCancelEvent;
import com.google.gwt.event.dom.client.TouchCancelHandler;
import com.google.gwt.event.dom.client.TouchEndEvent;
import com.google.gwt.event.dom.client.TouchEndHandler;
import com.google.gwt.event.dom.client.TouchMoveEvent;
import com.google.gwt.event.dom.client.TouchMoveHandler;
import com.google.gwt.event.dom.client.TouchStartEvent;
import com.google.gwt.event.dom.client.TouchStartHandler;
import com.google.gwt.event.logical.shared.ResizeEvent;
import com.google.gwt.event.logical.shared.ResizeHandler;
import com.google.gwt.event.shared.HandlerRegistration;
/**
* A key interface definition is the {@link org.vectomatic.dom.svg.OMSVGSVGElement}
* 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.
* {@link org.vectomatic.dom.svg.OMSVGSVGElement} 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].
*/
@TagName("svg")
public class OMSVGSVGElement extends OMSVGElement implements HasGraphicalHandlers, HasDocumentHandlers, ISVGTests, ISVGLangSpace, ISVGExternalResourcesRequired, ISVGStylable, ISVGLocatable, ISVGFitToViewBox, ISVGZoomAndPan, ISVGContainerElement {
public OMSVGSVGElement() {
this((SVGSVGElement)DOMHelper.createElementNS(DOMHelper.getCurrentDocument(), SVGConstants.SVG_NAMESPACE_URI, SVGConstants.SVG_SVG_TAG).cast());
}
public OMSVGSVGElement(SVGSVGElement ot) {
super(ot);
}
// Implementation of the svg::SVGSVGElement W3C IDL interface
/**
* Corresponds to attribute {@link org.vectomatic.dom.svg.OMSVGSVGElement#getX()}
* on the given svg element.
*/
public final OMSVGAnimatedLength getX() {
return ((SVGSVGElement)ot).getX();
}
/**
* Corresponds to attribute {@link org.vectomatic.dom.svg.OMSVGSVGElement#getY()}
* on the given svg element.
*/
public final OMSVGAnimatedLength getY() {
return ((SVGSVGElement)ot).getY();
}
/**
* Corresponds to attribute {@link org.vectomatic.dom.svg.OMSVGSVGElement#getWidth()}
* on the given svg element.
*/
public final OMSVGAnimatedLength getWidth() {
return ((SVGSVGElement)ot).getWidth();
}
/**
* Corresponds to attribute {@link org.vectomatic.dom.svg.OMSVGSVGElement#getHeight()}
* on the given svg element.
*/
public final OMSVGAnimatedLength getHeight() {
return ((SVGSVGElement)ot).getHeight();
}
/**
* Corresponds to attribute {@link org.vectomatic.dom.svg.OMSVGSVGElement#getContentScriptType()}
* on the given svg element.
*/
public final String getContentScriptType() {
return ((SVGSVGElement)ot).getContentScriptType();
}
/**
* Corresponds to attribute {@link org.vectomatic.dom.svg.OMSVGSVGElement#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.
*/
public final void setContentScriptType(java.lang.String value) throws JavaScriptException {
((SVGSVGElement)ot).setContentScriptType(value);
}
/**
* Corresponds to attribute {@link org.vectomatic.dom.svg.OMSVGSVGElement#getContentStyleType()}
* on the given svg element.
*/
public final String getContentStyleType() {
return ((SVGSVGElement)ot).getContentStyleType();
}
/**
* Corresponds to attribute {@link org.vectomatic.dom.svg.OMSVGSVGElement#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.
*/
public final void setContentStyleType(java.lang.String value) throws JavaScriptException {
((SVGSVGElement)ot).setContentStyleType(value);
}
/**
* 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 {@link org.vectomatic.dom.svg.OMSVGRect}
* object is read only.
*/
public final OMSVGRect getViewport() {
return ((SVGSVGElement)ot).getViewport();
}
/**
* 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.
*/
public final float getPixelUnitToMillimeterX() {
return ((SVGSVGElement)ot).getPixelUnitToMillimeterX();
}
/**
* Corresponding size of a pixel unit along the y-axis of the viewport.
*/
public final float getPixelUnitToMillimeterY() {
return ((SVGSVGElement)ot).getPixelUnitToMillimeterY();
}
/**
* 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.
*/
public final float getScreenPixelToMillimeterX() {
return ((SVGSVGElement)ot).getScreenPixelToMillimeterX();
}
/**
* Corresponding size of a screen pixel along the y-axis of the viewport.
*/
public final float getScreenPixelToMillimeterY() {
return ((SVGSVGElement)ot).getScreenPixelToMillimeterY();
}
/**
* 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.
*/
public final boolean getUseCurrentView() {
return ((SVGSVGElement)ot).getUseCurrentView();
}
/**
* 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 {@link org.vectomatic.dom.svg.itf.ISVGFitToViewBox#getViewBox()},
* {@link org.vectomatic.dom.svg.itf.ISVGFitToViewBox#getPreserveAspectRatio()}
* and {@link org.vectomatic.dom.svg.itf.ISVGZoomAndPan#getZoomAndPan()}
* within {@link org.vectomatic.dom.svg.OMSVGSVGElement#getCurrentView()}
* will match the values for the corresponding DOM attributes that are
* on SVGSVGElement directly
- the values for {@link org.vectomatic.dom.svg.itf.ISVGViewSpec#getTransform()}
* and {@link org.vectomatic.dom.svg.itf.ISVGViewSpec#getViewTarget()}
* within {@link org.vectomatic.dom.svg.OMSVGSVGElement#getCurrentView()}
* will be null
- If the initial view was
* a link into a view element, then:
* - the values for {@link org.vectomatic.dom.svg.itf.ISVGFitToViewBox#getViewBox()},
* {@link org.vectomatic.dom.svg.itf.ISVGFitToViewBox#getPreserveAspectRatio()}
* and {@link org.vectomatic.dom.svg.itf.ISVGZoomAndPan#getZoomAndPan()}
* within {@link org.vectomatic.dom.svg.OMSVGSVGElement#getCurrentView()}
* will correspond to the corresponding attributes for the given view element
- the values for {@link
* org.vectomatic.dom.svg.itf.ISVGViewSpec#getTransform()} and {@link
* org.vectomatic.dom.svg.itf.ISVGViewSpec#getViewTarget()} within {@link
* org.vectomatic.dom.svg.OMSVGSVGElement#getCurrentView()} will be
* null
- If the initial view was a link into
* another element (i.e., other than a view), then:
- the
* values for {@link org.vectomatic.dom.svg.itf.ISVGFitToViewBox#getViewBox()},
* {@link org.vectomatic.dom.svg.itf.ISVGFitToViewBox#getPreserveAspectRatio()}
* and {@link org.vectomatic.dom.svg.itf.ISVGZoomAndPan#getZoomAndPan()}
* within {@link org.vectomatic.dom.svg.OMSVGSVGElement#getCurrentView()}
* will match the values for the corresponding DOM attributes that are
* on SVGSVGElement directly for the closest ancestor svg element
- the values
* for {@link org.vectomatic.dom.svg.itf.ISVGViewSpec#getTransform()} within
* {@link org.vectomatic.dom.svg.OMSVGSVGElement#getCurrentView()} will be
* null
- the {@link org.vectomatic.dom.svg.itf.ISVGViewSpec#getViewTarget()}
* within {@link org.vectomatic.dom.svg.OMSVGSVGElement#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 {@link org.vectomatic.dom.svg.itf.ISVGFitToViewBox#getViewBox()},
* {@link org.vectomatic.dom.svg.itf.ISVGFitToViewBox#getPreserveAspectRatio()},
* {@link org.vectomatic.dom.svg.itf.ISVGZoomAndPan#getZoomAndPan()},
* {@link org.vectomatic.dom.svg.itf.ISVGViewSpec#getTransform()} and
* {@link org.vectomatic.dom.svg.itf.ISVGViewSpec#getViewTarget()} within
* {@link org.vectomatic.dom.svg.OMSVGSVGElement#getCurrentView()} will
* correspond to the values from the SVG view specification fragment
* identifier
The object itself and its contents
* are both read only.
*/
public final OMSVGViewSpec getCurrentView() {
return ((SVGSVGElement)ot).getCurrentView();
}
/**
* 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 {@link org.vectomatic.dom.svg.OMSVGSVGElement#getCurrentScale()}
* and {@link org.vectomatic.dom.svg.OMSVGSVGElement#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.
*/
public final float getCurrentScale() {
return ((SVGSVGElement)ot).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 {@link org.vectomatic.dom.svg.OMSVGSVGElement#getCurrentScale()}
* and {@link org.vectomatic.dom.svg.OMSVGSVGElement#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.
*/
public final void setCurrentScale(float value) {
((SVGSVGElement)ot).setCurrentScale(value);
}
/**
* 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.
*/
public final OMSVGPoint getCurrentTranslate() {
return ((SVGSVGElement)ot).getCurrentTranslate();
}
/**
* 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.
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.
* @param 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.
* @return 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.
*/
public final int suspendRedraw(int maxWaitMilliseconds) {
return ((SVGSVGElement)ot).suspendRedraw(maxWaitMilliseconds);
}
/**
* Cancels a specified suspendRedraw() by providing a unique suspend handle
* ID that was returned by a previous suspendRedraw() call.
* @param 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.
*/
public final void unsuspendRedraw(int suspendHandleID) {
((SVGSVGElement)ot).unsuspendRedraw(suspendHandleID);
}
/**
* 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.
*/
public final void unsuspendRedrawAll() {
((SVGSVGElement)ot).unsuspendRedrawAll();
}
/**
* In rendering environments supporting interactivity, forces the user agent
* to immediately redraw all regions of the viewport that require updating.
*/
public final void forceRedraw() {
((SVGSVGElement)ot).forceRedraw();
}
/**
* 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.
*/
public final void pauseAnimations() {
((SVGSVGElement)ot).pauseAnimations();
}
/**
* 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.
*/
public final void unpauseAnimations() {
((SVGSVGElement)ot).unpauseAnimations();
}
/**
* Returns true if this SVG document fragment is in a paused state.
* @return Boolean indicating whether this SVG document fragment is in a
* paused state.
*/
public final boolean animationsPaused() {
return ((SVGSVGElement)ot).animationsPaused();
}
/**
* 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.
* @return The current time in seconds, or 0 if the document timeline has
* not yet begun.
*/
public final float getCurrentTime() {
return ((SVGSVGElement)ot).getCurrentTime();
}
/**
* 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.
* @param seconds The new current time in seconds relative to the start
* time for the current SVG document fragment.
*/
public final void setCurrentTime(float seconds) {
((SVGSVGElement)ot).setCurrentTime(seconds);
}
/**
* 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.
* @param rect The test rectangle. The values are in the initial coordinate
* system for the current svg element.
* @param referenceElement If not null, then any intersected element that
* doesn't have the referenceElement as ancestor must not be included in
* the returned NodeList.
* @return A list of Elements whose content intersects the supplied rectangle.
* This {@link com.google.gwt.dom.client.NodeList} must be implemented identically
* to the {@link com.google.gwt.dom.client.NodeList} interface as defined
* in DOM Level 2 Core ([DOM2], section
* 1.2) with the exception that the interface is not live.
*/
public final NodeList getIntersectionList(OMSVGRect rect, OMSVGElement referenceElement) {
return ((SVGSVGElement)ot).getIntersectionList(rect, ((SVGElement)referenceElement.ot));
}
/**
* 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.
* @param rect The test rectangle. The values are in the initial coordinate
* system for the current svg element.
* @param referenceElement If not null, then any intersected element that
* doesn't have the referenceElement as ancestor must not be included in
* the returned NodeList.
* @return A list of Elements whose content is enclosed by the supplied
* rectangle. This {@link com.google.gwt.dom.client.NodeList} must be implemented
* identically to the {@link com.google.gwt.dom.client.NodeList} interface
* as defined in DOM Level 2 Core ([DOM2],
* section 1.2) with the exception that the interface is not live.
*/
public final NodeList getEnclosureList(OMSVGRect rect, OMSVGElement referenceElement) {
return ((SVGSVGElement)ot).getEnclosureList(rect, ((SVGElement)referenceElement.ot));
}
/**
* 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.
* @param element The element on which to perform the given test.
* @param rect The test rectangle. The values are in the initial coordinate
* system for the current svg element.
* @return True or false, depending on whether the given element intersects
* the supplied rectangle.
*/
public final boolean checkIntersection(OMSVGElement element, OMSVGRect rect) {
return ((SVGSVGElement)ot).checkIntersection(((SVGElement)element.ot), 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.
* @param element The element on which to perform the given test.
* @param rect The test rectangle. The values are in the initial coordinate
* system for the current svg element.
* @return True or false, depending on whether the given element is enclosed
* by the supplied rectangle.
*/
public final boolean checkEnclosure(OMSVGElement element, OMSVGRect rect) {
return ((SVGSVGElement)ot).checkEnclosure(((SVGElement)element.ot), rect);
}
/**
* Unselects any selected objects, including any selections of text strings
* and type-in bars.
*/
public final void deselectAll() {
((SVGSVGElement)ot).deselectAll();
}
/**
* Creates an {@link org.vectomatic.dom.svg.OMSVGNumber} object outside of
* any document trees. The object is initialized to a value of zero.
* @return An {@link org.vectomatic.dom.svg.OMSVGNumber} object.
*/
public final OMSVGNumber createSVGNumber() {
return ((SVGSVGElement)ot).createSVGNumber();
}
/**
* Creates an {@link org.vectomatic.dom.svg.OMSVGLength} object outside of
* any document trees. The object is initialized to the value of 0 user units.
* @return An {@link org.vectomatic.dom.svg.OMSVGLength} object.
*/
public final OMSVGLength createSVGLength() {
return ((SVGSVGElement)ot).createSVGLength();
}
/**
* Creates an {@link org.vectomatic.dom.svg.OMSVGAngle} object outside of
* any document trees. The object is initialized to the value 0 degrees (unitless).
* @return An {@link org.vectomatic.dom.svg.OMSVGAngle} object.
*/
public final OMSVGAngle createSVGAngle() {
return ((SVGSVGElement)ot).createSVGAngle();
}
/**
* Creates an {@link org.vectomatic.dom.svg.OMSVGPoint} object outside of
* any document trees. The object is initialized to the point (0,0) in the
* user coordinate system.
* @return An {@link org.vectomatic.dom.svg.OMSVGPoint} object.
*/
public final OMSVGPoint createSVGPoint() {
return ((SVGSVGElement)ot).createSVGPoint();
}
/**
* Creates an {@link org.vectomatic.dom.svg.OMSVGMatrix} object outside of
* any document trees. The object is initialized to the identity matrix.
* @return An {@link org.vectomatic.dom.svg.OMSVGMatrix} object.
*/
public final OMSVGMatrix createSVGMatrix() {
return ((SVGSVGElement)ot).createSVGMatrix();
}
/**
* Creates an {@link org.vectomatic.dom.svg.OMSVGRect} object outside of any
* document trees. The object is initialized such that all values are set
* to 0 user units.
* @return An {@link org.vectomatic.dom.svg.OMSVGRect} object.
*/
public final OMSVGRect createSVGRect() {
return ((SVGSVGElement)ot).createSVGRect();
}
/**
* Creates an {@link org.vectomatic.dom.svg.OMSVGTransform} object outside
* of any document trees. The object is initialized to an identity matrix
* transform (SVG_TRANSFORM_MATRIX).
* @return An {@link org.vectomatic.dom.svg.OMSVGTransform} object.
*/
public final OMSVGTransform createSVGTransform() {
return ((SVGSVGElement)ot).createSVGTransform();
}
/**
* Creates an {@link org.vectomatic.dom.svg.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.
* @param matrix The transform matrix.
* @return An {@link org.vectomatic.dom.svg.OMSVGTransform} object.
*/
public final OMSVGTransform createSVGTransformFromMatrix(OMSVGMatrix matrix) {
return ((SVGSVGElement)ot).createSVGTransformFromMatrix(matrix);
}
/**
* 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.
* @param elementId The unique id value for an element.
* @return The matching element.
*/
public final OMElement getElementById(String elementId) {
Element elt = ((SVGSVGElement)ot).getElementById(elementId);
return elt != null ? (OMElement) convert(elt) : null;
}
// Implementation of the svg::SVGExternalResourcesRequired W3C IDL interface
/**
* Corresponds to attribute {@link org.vectomatic.dom.svg.itf.ISVGExternalResourcesRequired#getExternalResourcesRequired()}
* on the given element. Note that the SVG DOM defines the attribute {@link
* org.vectomatic.dom.svg.itf.ISVGExternalResourcesRequired#getExternalResourcesRequired()}
* as being of type {@link org.vectomatic.dom.svg.OMSVGAnimatedBoolean}, whereas
* the SVG language definition says that {@link org.vectomatic.dom.svg.itf.ISVGExternalResourcesRequired#getExternalResourcesRequired()}
* is not animated. Because the SVG language definition states that {@link
* org.vectomatic.dom.svg.itf.ISVGExternalResourcesRequired#getExternalResourcesRequired()}
* cannot be animated, the {@link org.vectomatic.dom.svg.OMSVGAnimatedBoolean#getAnimVal()}
* will always be the same as the {@link org.vectomatic.dom.svg.OMSVGAnimatedBoolean#getBaseVal()}.
*/
public final OMSVGAnimatedBoolean getExternalResourcesRequired() {
return ((SVGSVGElement)ot).getExternalResourcesRequired();
}
// Implementation of the svg::SVGFitToViewBox W3C IDL interface
/**
* Corresponds to attribute {@link org.vectomatic.dom.svg.itf.ISVGFitToViewBox#getViewBox()}
* on the given element.
*/
public final OMSVGAnimatedRect getViewBox() {
return ((SVGSVGElement)ot).getViewBox();
}
/**
* Corresponds to attribute {@link org.vectomatic.dom.svg.itf.ISVGFitToViewBox#getPreserveAspectRatio()}
* on the given element.
*/
public final OMSVGAnimatedPreserveAspectRatio getPreserveAspectRatio() {
return ((SVGSVGElement)ot).getPreserveAspectRatio();
}
// Implementation of the svg::SVGLangSpace W3C IDL interface
/**
* Corresponds to attribute xml:lang on the given element.
*/
public final String getXmllang() {
return ((SVGSVGElement)ot).getXmllang();
}
/**
* 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.
*/
public final void setXmllang(java.lang.String value) throws JavaScriptException {
((SVGSVGElement)ot).setXmllang(value);
}
/**
* Corresponds to attribute xml:space on the given element.
*/
public final String getXmlspace() {
return ((SVGSVGElement)ot).getXmlspace();
}
/**
* 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.
*/
public final void setXmlspace(java.lang.String value) throws JavaScriptException {
((SVGSVGElement)ot).setXmlspace(value);
}
// Implementation of the svg::SVGLocatable W3C IDL interface
/**
* The element which established the current viewport. Often, the nearest
* ancestor svg element. Null if the current element is
* the outermost svg element.
*/
public final OMSVGElement getNearestViewportElement() {
SVGElement elt = ((SVGSVGElement)ot).getNearestViewportElement();
return elt != null ? (OMSVGElement)convert(elt) : null;
}
/**
* The farthest ancestor svg element. Null if the current
* element is the outermost svg element.
*/
public final OMSVGElement getFarthestViewportElement() {
SVGElement elt = ((SVGSVGElement)ot).getFarthestViewportElement();
return elt != null ? (OMSVGElement)convert(elt) : null;
}
/**
* 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.
* @return An {@link org.vectomatic.dom.svg.OMSVGRect} object that defines
* the bounding box.
*/
public final OMSVGRect getBBox() {
return ((SVGSVGElement)ot).getBBox();
}
/**
* 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 {@link org.vectomatic.dom.svg.itf.ISVGLocatable#getNearestViewportElement()}.
* @return An {@link org.vectomatic.dom.svg.OMSVGMatrix} object that defines
* the CTM.
*/
public final OMSVGMatrix getCTM() {
return ((SVGSVGElement)ot).getCTM();
}
/**
* 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.
* @return An {@link org.vectomatic.dom.svg.OMSVGMatrix} object that defines
* the given transformation matrix.
*/
public final OMSVGMatrix getScreenCTM() {
return ((SVGSVGElement)ot).getScreenCTM();
}
/**
* 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).
* @param element The target element.
* @return An {@link org.vectomatic.dom.svg.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).
*/
public final OMSVGMatrix getTransformToElement(OMSVGElement element) throws JavaScriptException {
return ((SVGSVGElement)ot).getTransformToElement(((SVGElement)element.ot));
}
// Implementation of the svg::SVGTests W3C IDL interface
/**
* Corresponds to attribute {@link org.vectomatic.dom.svg.itf.ISVGTests#getRequiredFeatures()}
* on the given element.
*/
public final OMSVGStringList getRequiredFeatures() {
return ((SVGSVGElement)ot).getRequiredFeatures();
}
/**
* Corresponds to attribute {@link org.vectomatic.dom.svg.itf.ISVGTests#getRequiredExtensions()}
* on the given element.
*/
public final OMSVGStringList getRequiredExtensions() {
return ((SVGSVGElement)ot).getRequiredExtensions();
}
/**
* Corresponds to attribute {@link org.vectomatic.dom.svg.itf.ISVGTests#getSystemLanguage()}
* on the given element.
*/
public final OMSVGStringList getSystemLanguage() {
return ((SVGSVGElement)ot).getSystemLanguage();
}
/**
* Returns true if the user agent supports the given extension, specified
* by a URI.
* @param extension The name of the extension, expressed as a URI.
* @return True or false, depending on whether the given extension is supported.
*/
public final boolean hasExtension(String extension) {
return ((SVGSVGElement)ot).hasExtension(extension);
}
// Implementation of the svg::SVGZoomAndPan W3C IDL interface
/**
* Corresponds to attribute {@link org.vectomatic.dom.svg.itf.ISVGZoomAndPan#getZoomAndPan()}
* on the given element. The value must be one of the SVG_ZOOMANDPAN_ constants
* defined on this interface.
*/
public final short getZoomAndPan() {
return ((SVGSVGElement)ot).getZoomAndPan();
}
/**
* Corresponds to attribute {@link org.vectomatic.dom.svg.itf.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.
*/
public final void setZoomAndPan(short value) throws JavaScriptException {
((SVGSVGElement)ot).setZoomAndPan(value);
}
@Override
public final HandlerRegistration addClickHandler(ClickHandler handler) {
return addDomHandler(handler, ClickEvent.getType());
}
@Override
public final HandlerRegistration addDragEndHandler(DragEndHandler handler) {
return addDomHandler(handler, DragEndEvent.getType());
}
@Override
public final HandlerRegistration addDragEnterHandler(DragEnterHandler handler) {
return addDomHandler(handler, DragEnterEvent.getType());
}
@Override
public final HandlerRegistration addDragHandler(DragHandler handler) {
return addDomHandler(handler, DragEvent.getType());
}
@Override
public final HandlerRegistration addDragLeaveHandler(DragLeaveHandler handler) {
return addDomHandler(handler, DragLeaveEvent.getType());
}
@Override
public final HandlerRegistration addDragOverHandler(DragOverHandler handler) {
return addDomHandler(handler, DragOverEvent.getType());
}
@Override
public final HandlerRegistration addDragStartHandler(DragStartHandler handler) {
return addDomHandler(handler, DragStartEvent.getType());
}
@Override
public final HandlerRegistration addDropHandler(DropHandler handler) {
return addDomHandler(handler, DropEvent.getType());
}
@Override
public final HandlerRegistration addLoadHandler(LoadHandler handler) {
return addDomHandler(handler, LoadEvent.getType());
}
@Override
public final HandlerRegistration addMouseDownHandler(MouseDownHandler handler) {
return addDomHandler(handler, MouseDownEvent.getType());
}
@Override
public final HandlerRegistration addMouseMoveHandler(MouseMoveHandler handler) {
return addDomHandler(handler, MouseMoveEvent.getType());
}
@Override
public final HandlerRegistration addMouseOutHandler(MouseOutHandler handler) {
return addDomHandler(handler, MouseOutEvent.getType());
}
@Override
public final HandlerRegistration addMouseOverHandler(MouseOverHandler handler) {
return addDomHandler(handler, MouseOverEvent.getType());
}
@Override
public final HandlerRegistration addMouseUpHandler(MouseUpHandler handler) {
return addDomHandler(handler, MouseUpEvent.getType());
}
@Override
public final HandlerRegistration addScrollHandler(ScrollHandler handler) {
return addDomHandler(handler, ScrollEvent.getType());
}
@Override
public final HandlerRegistration addTouchCancelHandler(TouchCancelHandler handler) {
return addDomHandler(handler, TouchCancelEvent.getType());
}
@Override
public final HandlerRegistration addTouchEndHandler(TouchEndHandler handler) {
return addDomHandler(handler, TouchEndEvent.getType());
}
@Override
public final HandlerRegistration addTouchMoveHandler(TouchMoveHandler handler) {
return addDomHandler(handler, TouchMoveEvent.getType());
}
@Override
public final HandlerRegistration addTouchStartHandler(TouchStartHandler handler) {
return addDomHandler(handler, TouchStartEvent.getType());
}
@Override
public final HandlerRegistration addResizeHandler(ResizeHandler handler) {
return addHandler(handler, ResizeEvent.getType());
}
@Override
public final HandlerRegistration addActivateHandler(ActivateHandler handler) {
return addDomHandler(handler, ActivateEvent.getType());
}
@Override
public final HandlerRegistration addFocusInHandler(FocusInHandler handler) {
return addDomHandler(handler, FocusInEvent.getType());
}
@Override
public final HandlerRegistration addFocusOutHandler(FocusOutHandler handler) {
return addDomHandler(handler, FocusOutEvent.getType());
}
@Override
public final HandlerRegistration addSVGZoomHandler(SVGZoomHandler handler) {
return addDomHandler(handler, SVGZoomEvent.getType());
}
// Helper methods
/**
* Creates an {@link org.vectomatic.dom.svg.OMSVGNumber} object outside of
* any document trees. The object is initialized to the specified value.
* @param value the value to use for initialization
* @return An {@link org.vectomatic.dom.svg.OMSVGNumber} object.
*/
public final OMSVGNumber createSVGNumber(float value) {
OMSVGNumber number = createSVGNumber();
number.setValue(value);
return number;
}
/**
* Creates an {@link org.vectomatic.dom.svg.OMSVGLength} object outside of
* any document trees. The object is initialized to the specified value
* and unit type.
* @param unitType the unit type to use for initialization
* @param valueInSpecifiedUnits the value to use for initialization, in the specified units
* @return An {@link org.vectomatic.dom.svg.OMSVGLength} object.
*/
public final OMSVGLength createSVGLength(short unitType, float valueInSpecifiedUnits) {
OMSVGLength length = ((SVGSVGElement)ot).createSVGLength();
length.newValueSpecifiedUnits(unitType, valueInSpecifiedUnits);
return length;
}
/**
* Creates an {@link org.vectomatic.dom.svg.OMSVGLength} object outside of
* any document trees. The object is initialized to the specified value
* and unit type.
* @param unitType the unit type to use for initialization
* @param valueInSpecifiedUnits the value to use for initialization, in the specified units
* @return An {@link org.vectomatic.dom.svg.OMSVGLength} object.
*/
public final OMSVGLength createSVGLength(Style.Unit unitType, float valueInSpecifiedUnits) {
return createSVGLength(OMSVGLength.unitToCode(unitType), valueInSpecifiedUnits);
}
/**
* Creates an {@link org.vectomatic.dom.svg.OMSVGLength} object outside of
* any document trees. The object is initialized to the specified length.
* @param l the length to use for initialization
* @return An {@link org.vectomatic.dom.svg.OMSVGLength} object.
*/
public final OMSVGLength createSVGLength(OMSVGLength l) {
return createSVGLength(l.getUnitType(), l.getValueInSpecifiedUnits());
}
/**
* Creates an {@link org.vectomatic.dom.svg.OMSVGAngle} object outside of
* any document trees. The object is initialized to the specified value
* and unit type.
* @param unitType the unit type to use for initialization
* @param valueInSpecifiedUnits the value to use for initialization, in the specified units
* @return An {@link org.vectomatic.dom.svg.OMSVGAngle} object.
*/
public final OMSVGAngle createSVGAngle(short unitType, float valueInSpecifiedUnits) {
OMSVGAngle angle = ((SVGSVGElement)ot).createSVGAngle();
angle.newValueSpecifiedUnits(unitType, valueInSpecifiedUnits);
return angle;
}
/**
* Creates an {@link org.vectomatic.dom.svg.OMSVGAngle} object outside of
* any document trees. The object is initialized to the specified angle.
* @param a the angle to use for initialization
* @return An {@link org.vectomatic.dom.svg.OMSVGAngle} object.
*/
public final OMSVGAngle createSVGAngle(OMSVGAngle a) {
return createSVGAngle(a.getUnitType(), a.getValueInSpecifiedUnits());
}
/**
* Creates an {@link org.vectomatic.dom.svg.OMSVGPoint} object outside of
* any document trees. The object is initialized to the specified coordinates.
* @param x the X coordinate to use for initialization
* @param y the Y coordinate to use for initialization
* @return An {@link org.vectomatic.dom.svg.OMSVGPoint} object.
*/
public final OMSVGPoint createSVGPoint(float x, float y) {
OMSVGPoint point = ((SVGSVGElement)ot).createSVGPoint();
point.setX(x);
point.setY(y);
return point;
}
/**
* Creates an {@link org.vectomatic.dom.svg.OMSVGPoint} object outside of
* any document trees. The object is initialized to the specified point.
* @param p the point to use for initialization
* @return An {@link org.vectomatic.dom.svg.OMSVGPoint} object.
*/
public final OMSVGPoint createSVGPoint(OMSVGPoint p) {
return createSVGPoint(p.getX(), p.getY());
}
/**
* Creates an {@link org.vectomatic.dom.svg.OMSVGMatrix} object outside of
* any document trees. The object is initialized to the specified components.
* @param a the A component to use for initialization
* @param b the B component to use for initialization
* @param c the C component to use for initialization
* @param d the D component to use for initialization
* @param e the E component to use for initialization
* @param f the F component to use for initialization
* @return An {@link org.vectomatic.dom.svg.OMSVGMatrix} object.
*/
public final OMSVGMatrix createSVGMatrix(float a, float b, float c, float d, float e, float f) {
OMSVGMatrix matrix = ((SVGSVGElement)ot).createSVGMatrix();
matrix.setA(a);
matrix.setB(b);
matrix.setC(c);
matrix.setD(d);
matrix.setE(e);
matrix.setF(f);
return matrix;
}
/**
* Creates an {@link org.vectomatic.dom.svg.OMSVGMatrix} object outside of
* any document trees. The object is initialized to the specified matrix.
* @param m the matrix to use for initialization
* @return An {@link org.vectomatic.dom.svg.OMSVGMatrix} object.
*/
public final OMSVGMatrix createSVGMatrix(OMSVGMatrix m) {
return createSVGMatrix(m.getA(), m.getB(), m.getC(), m.getD(), m.getE(), m.getF());
}
/**
* Creates an {@link org.vectomatic.dom.svg.OMSVGRect} object outside of
* any document trees. The object is initialized to the specified coordinates
* and size.
* @param x the X coordinate to use for initialization
* @param y the Y coordinate to use for initialization
* @param width the width to use for initialization
* @param height the height to use for initialization
* @return An {@link org.vectomatic.dom.svg.OMSVGRect} object.
*/
public final OMSVGRect createSVGRect(float x, float y, float width, float height) {
OMSVGRect rect = ((SVGSVGElement)ot).createSVGRect();
rect.setX(x);
rect.setY(y);
rect.setWidth(width);
rect.setHeight(height);
return rect;
}
/**
* Creates an {@link org.vectomatic.dom.svg.OMSVGRect} object outside of
* any document trees. The object is initialized to the specified rectangle.
* @param rect the rect to use for initialization
* @return An {@link org.vectomatic.dom.svg.OMSVGRect} object.
*/
public final OMSVGRect createSVGRect(OMSVGRect rect) {
return createSVGRect(rect.getX(), rect.getY(), rect.getWidth(), rect.getHeight());
}
/**
* Sets the base value for the height of this {@link org.vectomatic.dom.svg.OMSVGSVGElement}
* to the specified value and unit type.
* @param unitType the unit type in which the height is specified
* @param height the height in the specified units
*/
public final void setHeight(short unitType, float height) {
getHeight().getBaseVal().newValueSpecifiedUnits(unitType, height);
}
/**
* Sets the base value for the height of this {@link org.vectomatic.dom.svg.OMSVGSVGElement}
* to the specified value and unit type.
* @param unitType the unit type in which the height is specified
* @param height the height in the specified units
*/
public final void setHeight(com.google.gwt.dom.client.Style.Unit unitType, float height) {
getHeight().getBaseVal().newValueSpecifiedUnits(unitType, height);
}
/**
* Sets the base value for the viewbox of this {@link org.vectomatic.dom.svg.OMSVGSVGElement}
* to the specified rectangle.
* @param rect the rectangle used to specify the viewbox
*/
public final void setViewBox(OMSVGRect rect) {
setViewBox(rect.getX(), rect.getY(), rect.getWidth(), rect.getHeight());
}
/**
* Sets the base value for the viewbox of this {@link org.vectomatic.dom.svg.OMSVGSVGElement}
* to the specified coordinates and size.
* @param x the X coordinate to use for the viewbox
* @param y the Y coordinate to use for the viewbox
* @param width the width to use for the viewbox
* @param height the height to use for the viewbox
*/
public final void setViewBox(float x, float y, float width, float height) {
if (!((SVGSVGElement)ot).hasAttribute(SVGConstants.SVG_VIEW_BOX_ATTRIBUTE)) {
StringBuilder builder = new StringBuilder();
builder.append(x);
builder.append(" ");
builder.append(y);
builder.append(" ");
builder.append(width);
builder.append(" ");
builder.append(height);
((SVGSVGElement)ot).setAttribute(SVGConstants.SVG_VIEW_BOX_ATTRIBUTE, builder.toString());
return;
}
OMSVGRect viewBox = getViewBox().getBaseVal();
viewBox.setX(x);
viewBox.setY(y);
viewBox.setWidth(width);
viewBox.setHeight(height);
}
/**
* Sets the base value for the width of this {@link org.vectomatic.dom.svg.OMSVGSVGElement}
* to the specified value and unit type.
* @param unitType the unit type in which the width is specified
* @param width the width in the specified units
*/
public final void setWidth(short unitType, float width) {
getWidth().getBaseVal().newValueSpecifiedUnits(unitType, width);
}
/**
* Sets the base value for the width of this {@link org.vectomatic.dom.svg.OMSVGSVGElement}
* to the specified value and unit type.
* @param unitType the unit type in which the width is specified
* @param width the width in the specified units
*/
public final void setWidth(com.google.gwt.dom.client.Style.Unit unitType, float width) {
getWidth().getBaseVal().newValueSpecifiedUnits(unitType, width);
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy