org.apache.batik.bridge

Interface BridgeExtension

public interface BridgeExtension

This is a Service interface for classes that want to extend the functionality of the Bridge, to support new tags in the rendering tree.
Method Summary
StringgetAuthor()
This should return the individual or company name responsible for the this implementation of the extension.
StringgetContactAddress()
This should return a contact address (usually an e-mail address).
StringgetDescription()
Human readable description of the extension.
IteratorgetImplementedExtensions()
This should return the list of extensions implemented by this BridgeExtension, these are added to the list of requiredExtensions that the User Agent supports for purposes of the 'switch' element in SVG.
floatgetPriority()
Return the priority of this Extension.
StringgetURL()
This should return a URL where information can be obtained on this extension.
booleanisDynamicElement(Element e)
Whether the presence of the specified element should cause the document to be dynamic.
voidregisterTags(BridgeContext ctx)
This method should update the BridgeContext with support for the tags in this extension.

Method Detail

getAuthor

public String getAuthor()
This should return the individual or company name responsible for the this implementation of the extension.

getContactAddress

public String getContactAddress()
This should return a contact address (usually an e-mail address).

getDescription

public String getDescription()
Human readable description of the extension. Perhaps that should be a resource for internationalization? (although I suppose it could be done internally)

getImplementedExtensions

public Iterator getImplementedExtensions()
This should return the list of extensions implemented by this BridgeExtension, these are added to the list of requiredExtensions that the User Agent supports for purposes of the 'switch' element in SVG.

Returns: An iterator containing strings one for each implemented extension.

getPriority

public float getPriority()
Return the priority of this Extension. Extensions are registered from lowest to highest priority. So if for some reason you need to come before/after another existing extension make sure your priority is lower/higher than theirs.

getURL

public String getURL()
This should return a URL where information can be obtained on this extension.

isDynamicElement

public boolean isDynamicElement(Element e)
Whether the presence of the specified element should cause the document to be dynamic. If this element isn't handled by this BridgeExtension, just return false.

Parameters: e The element to check.

registerTags

public void registerTags(BridgeContext ctx)
This method should update the BridgeContext with support for the tags in this extension. In some rare cases it may be necessary to replace existing tag handlers, although this is discouraged.

Parameters: ctx The BridgeContext instance to be updated

Copyright B) 2007 Apache Software Foundation. All Rights Reserved.