1 /**********************************************
2 * Copyright (C) 2010 Lukas Laag
3 * This file is part of lib-gwt-svg.
4 *
5 * libgwtsvg is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU Lesser General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
9 *
10 * libgwtsvg is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU Lesser General Public License for more details.
14 *
15 * You should have received a copy of the GNU Lesser General Public License
16 * along with libgwtsvg. If not, see http://www.gnu.org/licenses/
17 **********************************************/
18 /*
19 * Copyright (c) 2004 World Wide Web Consortium,
20 *
21 * (Massachusetts Institute of Technology, European Research Consortium for
22 * Informatics and Mathematics, Keio University). All Rights Reserved. This
23 * work is distributed under the W3C(r) Software License [1] in the hope that
24 * it will be useful, but WITHOUT ANY WARRANTY; without even the implied
25 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
26 *
27 * [1] http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231
28 */
29
30 package org.vectomatic.dom.svg;
31
32 import org.vectomatic.dom.svg.impl.SVGGradientElement;
33 import org.vectomatic.dom.svg.itf.ISVGExternalResourcesRequired;
34 import org.vectomatic.dom.svg.itf.ISVGStylable;
35 import org.vectomatic.dom.svg.itf.ISVGURIReference;
36 import org.vectomatic.dom.svg.itf.ISVGUnitTypes;
37
38 /**
39 * The {@link org.vectomatic.dom.svg.OMSVGGradientElement} interface is a
40 * base interface used by {@link org.vectomatic.dom.svg.OMSVGLinearGradientElement}
41 * and {@link org.vectomatic.dom.svg.OMSVGRadialGradientElement}.
42 */
43 public abstract class OMSVGGradientElement extends OMSVGElement implements ISVGURIReference, ISVGExternalResourcesRequired, ISVGStylable, ISVGUnitTypes {
44 /**
45 * The type is not one of predefined types. It is invalid to attempt to define
46 * a new value of this type or to attempt to switch an existing value to this
47 * type.
48 */
49 public static final short SVG_SPREADMETHOD_UNKNOWN = 0;
50 /**
51 * Corresponds to value <span class='attr-value'>'pad'</span>.
52 */
53 public static final short SVG_SPREADMETHOD_PAD = 1;
54 /**
55 * Corresponds to value <span class='attr-value'>'reflect'</span>.
56 */
57 public static final short SVG_SPREADMETHOD_REFLECT = 2;
58 /**
59 * Corresponds to value <span class='attr-value'>'repeat'</span>.
60 */
61 public static final short SVG_SPREADMETHOD_REPEAT = 3;
62 protected OMSVGGradientElement(SVGGradientElement ot) {
63 super(ot);
64 }
65
66 // Implementation of the svg::SVGGradientElement W3C IDL interface
67 /**
68 * Corresponds to attribute <span class='attr-name'>'gradientUnits'</span>
69 * on the given element. Takes one of the constants defined in {@link org.vectomatic.dom.svg.itf.ISVGUnitTypes}.
70 */
71 public final OMSVGAnimatedEnumeration getGradientUnits() {
72 return ((SVGGradientElement)ot).getGradientUnits();
73 }
74 /**
75 * Corresponds to attribute <span class='attr-name'>'gradientTransform'</span>
76 * on the given element.
77 */
78 public final OMSVGAnimatedTransformList getGradientTransform() {
79 return ((SVGGradientElement)ot).getGradientTransform();
80 }
81 /**
82 * Corresponds to attribute <span class='attr-name'>'spreadMethod'</span>
83 * on the given element. One of the Spread Method Types defined on this interface.
84 */
85 public final OMSVGAnimatedEnumeration getSpreadMethod() {
86 return ((SVGGradientElement)ot).getSpreadMethod();
87 }
88
89 // Implementation of the svg::SVGExternalResourcesRequired W3C IDL interface
90 /**
91 * Corresponds to attribute {@link org.vectomatic.dom.svg.itf.ISVGExternalResourcesRequired#getExternalResourcesRequired()}
92 * on the given element. Note that the SVG DOM defines the attribute {@link
93 * org.vectomatic.dom.svg.itf.ISVGExternalResourcesRequired#getExternalResourcesRequired()}
94 * as being of type {@link org.vectomatic.dom.svg.OMSVGAnimatedBoolean}, whereas
95 * the SVG language definition says that {@link org.vectomatic.dom.svg.itf.ISVGExternalResourcesRequired#getExternalResourcesRequired()}
96 * is not animated. Because the SVG language definition states that {@link
97 * org.vectomatic.dom.svg.itf.ISVGExternalResourcesRequired#getExternalResourcesRequired()}
98 * cannot be animated, the {@link org.vectomatic.dom.svg.OMSVGAnimatedBoolean#getAnimVal()}
99 * will always be the same as the {@link org.vectomatic.dom.svg.OMSVGAnimatedBoolean#getBaseVal()}.
100 */
101 public final OMSVGAnimatedBoolean getExternalResourcesRequired() {
102 return ((SVGGradientElement)ot).getExternalResourcesRequired();
103 }
104
105 // Implementation of the svg::SVGURIReference W3C IDL interface
106 /**
107 * Corresponds to attribute <span class='attr-name'>'xlink:href'</span> on
108 * the given element.
109 */
110 public final OMSVGAnimatedString getHref() {
111 return ((SVGGradientElement)ot).getHref();
112 }
113
114 // Implementation of the svg::SVGUnitTypes W3C IDL interface
115
116 }