org.vectomatic.dom.svg
Class OMSVGFilterElement

java.lang.Object
  extended by org.vectomatic.dom.svg.OMNode
      extended by org.vectomatic.dom.svg.OMElement
          extended by org.vectomatic.dom.svg.OMSVGElement
              extended by org.vectomatic.dom.svg.OMSVGFilterElement
All Implemented Interfaces:
com.google.gwt.event.shared.HasHandlers, ISVGExternalResourcesRequired, ISVGLangSpace, ISVGStylable, ISVGUnitTypes, ISVGURIReference

@TagName(value="filter")
public class OMSVGFilterElement
extends OMSVGElement
implements ISVGURIReference, ISVGLangSpace, ISVGExternalResourcesRequired, ISVGStylable, ISVGUnitTypes

The OMSVGFilterElement interface corresponds to the filter element.


Field Summary
static String IN_BACKGROUND_ALPHA
          Same as BackgroundImage except only the alpha channel is used.
static String IN_BACKGROUND_IMAGE
          This keyword represents an image snapshot of the canvas under the filter region at the time that the ‘filter’ element was invoked.
static String IN_FILL_PAINT
          This keyword represents the value of the ‘fill’ property on the target element for the filter effect.
static String IN_SOURCE_ALPHA
          This keyword represents the graphics elements that were the original input into the ‘filter’ element.
static String IN_SOURCE_GRAPHIC
          This keyword represents the graphics elements that were the original input into the ‘filter’ element.
static String IN_STROKE_PAINT
          This keyword represents the value of the ‘stroke’ property on the target element for the filter effect.
 
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
  OMSVGFilterElement()
           
protected OMSVGFilterElement(SVGFilterElement ot)
           
 
Method Summary
 OMSVGAnimatedBoolean getExternalResourcesRequired()
          Corresponds to attribute ISVGExternalResourcesRequired.getExternalResourcesRequired() on the given element.
 OMSVGAnimatedInteger getFilterResX()
          Corresponds to attribute filterRes on the given filter element.
 OMSVGAnimatedInteger getFilterResY()
          Corresponds to attribute filterRes on the given filter element.
 OMSVGAnimatedEnumeration getFilterUnits()
          Corresponds to attribute getFilterUnits() on the given filter element.
 OMSVGAnimatedLength getHeight()
          Corresponds to attribute getHeight() on the given filter element.
 OMSVGAnimatedString getHref()
          Corresponds to attribute 'xlink:href' on the given element.
 OMSVGAnimatedEnumeration getPrimitiveUnits()
          Corresponds to attribute getPrimitiveUnits() on the given filter element.
 OMSVGAnimatedLength getWidth()
          Corresponds to attribute getWidth() on the given filter element.
 OMSVGAnimatedLength getX()
          Corresponds to attribute getX() on the given filter element.
 String getXmllang()
          Corresponds to attribute xml:lang on the given element.
 String getXmlspace()
          Corresponds to attribute xml:space on the given element.
 OMSVGAnimatedLength getY()
          Corresponds to attribute getY() on the given filter element.
 void setFilterRes(int filterResX, int filterResY)
          Sets the values for attribute filterRes.
 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
 

Field Detail

IN_SOURCE_GRAPHIC

public static final String IN_SOURCE_GRAPHIC
This keyword represents the graphics elements that were the original input into the ‘filter’ element. For raster effects filter primitives, the graphics elements will be rasterized into an initially clear RGBA raster in image space. Pixels left untouched by the original graphic will be left clear. The image is specified to be rendered in linear RGBA pixels. The alpha channel of this image captures any anti-aliasing specified by SVG. (Since the raster is linear, the alpha channel of this image will represent the exact percent coverage of each pixel.)

See Also:
Constant Field Values

IN_SOURCE_ALPHA

public static final String IN_SOURCE_ALPHA
This keyword represents the graphics elements that were the original input into the ‘filter’ element. SourceAlpha has all of the same rules as SourceGraphic except that only the alpha channel is used. The input image is an RGBA image consisting of implicitly black color values for the RGB channels, but whose alpha channel is the same as SourceGraphic. If this option is used, then some implementations might need to rasterize the graphics elements in order to extract the alpha channel.

See Also:
Constant Field Values

IN_BACKGROUND_IMAGE

public static final String IN_BACKGROUND_IMAGE
This keyword represents an image snapshot of the canvas under the filter region at the time that the ‘filter’ element was invoked.

See Also:
Constant Field Values

IN_BACKGROUND_ALPHA

public static final String IN_BACKGROUND_ALPHA
Same as BackgroundImage except only the alpha channel is used.

See Also:
Constant Field Values

IN_FILL_PAINT

public static final String IN_FILL_PAINT
This keyword represents the value of the ‘fill’ property on the target element for the filter effect. The FillPaint image has conceptually infinite extent. Frequently this image is opaque everywhere, but it might not be if the "paint" itself has alpha, as in the case of a gradient or pattern which itself includes transparent or semi-transparent parts.

See Also:
Constant Field Values

IN_STROKE_PAINT

public static final String IN_STROKE_PAINT
This keyword represents the value of the ‘stroke’ property on the target element for the filter effect. The StrokePaint image has conceptually infinite extent. Frequently this image is opaque everywhere, but it might not be if the "paint" itself has alpha, as in the case of a gradient or pattern which itself includes transparent or semi-transparent parts.

See Also:
Constant Field Values
Constructor Detail

OMSVGFilterElement

public OMSVGFilterElement()

OMSVGFilterElement

protected OMSVGFilterElement(SVGFilterElement ot)
Method Detail

getFilterUnits

public final OMSVGAnimatedEnumeration getFilterUnits()
Corresponds to attribute getFilterUnits() on the given filter element. Takes one of the constants defined in ISVGUnitTypes.


getPrimitiveUnits

public final OMSVGAnimatedEnumeration getPrimitiveUnits()
Corresponds to attribute getPrimitiveUnits() on the given filter element. Takes one of the constants defined in ISVGUnitTypes.


getX

public final OMSVGAnimatedLength getX()
Corresponds to attribute getX() on the given filter element.


getY

public final OMSVGAnimatedLength getY()
Corresponds to attribute getY() on the given filter element.


getWidth

public final OMSVGAnimatedLength getWidth()
Corresponds to attribute getWidth() on the given filter element.


getHeight

public final OMSVGAnimatedLength getHeight()
Corresponds to attribute getHeight() on the given filter element.


getFilterResX

public final OMSVGAnimatedInteger getFilterResX()
Corresponds to attribute filterRes on the given filter element. Contains the X component of attribute filterRes.


getFilterResY

public final OMSVGAnimatedInteger getFilterResY()
Corresponds to attribute filterRes on the given filter element. Contains the Y component (possibly computed automatically) of attribute filterRes.


setFilterRes

public final void setFilterRes(int filterResX,
                               int filterResY)
                        throws com.google.gwt.core.client.JavaScriptException
Sets the values for attribute filterRes.

Parameters:
filterResX - The X component of attribute filterRes.
filterResY - The Y component of attribute filterRes.
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

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

getHref

public final OMSVGAnimatedString getHref()
Corresponds to attribute 'xlink:href' on the given element.

Specified by:
getHref in interface ISVGURIReference


Copyright © 2012. All Rights Reserved.