org.vectomatic.dom.svg.itf

Interface IGetSVGDocument

public interface IGetSVGDocument

This interface provides access to an SVG document embedded by reference in another DOM-based language. The expectation is that the interface is implemented on DOM objects that allow such SVG document references, such as the DOM OMElement object that corresponds to an HTML 'object' element. Such DOM objects are often also required to implement the EmbeddingElement defined in the Window specification [WINDOW].

This interface is deprecated and may be dropped from future versions of the SVG specification. Authors are suggested to use the contentDocument attribute on the EmbeddingElement interface to obtain a referenced SVG document, if that interface is available.

Method Summary

Modifier and Type	Method and Description
OMSVGDocument	getSVGDocument() This method must return the OMDocument object embedded content in an embedding element, or null if there is no document.

Method Detail

getSVGDocument

OMSVGDocument getSVGDocument()

This method must return the OMDocument object embedded content in an embedding element, or null if there is no document.

Note that this is equivalent to fetching the value of the EmbeddingElement::contentDocument attribute of the embedding element, if the EmbeddingElement interface is also implemented. The author is advised to check that the document element of the returned OMDocument is indeed an svg element instead of assuming that that will always be the case.

Returns:

The OMDocument object for the referenced document, or null if there is no document.