org.apache.batik.extension.svg
Class BatikDomExtension

java.lang.Object
  extended by org.apache.batik.extension.svg.BatikDomExtension
All Implemented Interfaces:
DomExtension, BatikExtConstants

public class BatikDomExtension
extends Object
implements DomExtension, BatikExtConstants

This is a Service interface for classes that want to extend the functionality of the Dom, to support new tags in the rendering tree.


Nested Class Summary
protected static class BatikDomExtension.BatikHistogramNormalizationElementFactory
          To create a 'histogramNormalization' element.
protected static class BatikDomExtension.BatikRegularPolygonElementFactory
          To create a 'regularPolygon' element.
protected static class BatikDomExtension.BatikStarElementFactory
          To create a 'star' element.
protected static class BatikDomExtension.ColorSwitchElementFactory
          To create a 'colorSwitch' element.
protected static class BatikDomExtension.FlowDivElementFactory
          To create a 'flowDiv' element.
protected static class BatikDomExtension.FlowLineElementFactory
          To create a 'flowLine' element.
protected static class BatikDomExtension.FlowParaElementFactory
          To create a 'flowPara' element.
protected static class BatikDomExtension.FlowRegionBreakElementFactory
          To create a 'flowRegionBreak' element.
protected static class BatikDomExtension.FlowRegionElementFactory
          To create a 'flowRegion' element.
protected static class BatikDomExtension.FlowSpanElementFactory
          To create a 'flowSpan' element.
protected static class BatikDomExtension.FlowTextElementFactory
          To create a 'flowText' element.
 
Field Summary
 
Fields inherited from interface org.apache.batik.extension.svg.BatikExtConstants
BATIK_12_ATTR_NAMESPACE_URI, BATIK_12_NAMESPACE_URI, BATIK_EXT_ALIGN_BOTTOM_VALUE, BATIK_EXT_ALIGN_MIDDLE_VALUE, BATIK_EXT_ALIGN_TOP_VALUE, BATIK_EXT_BOTTOM_MARGIN_ATTRIBUTE, BATIK_EXT_COLOR_SWITCH_TAG, BATIK_EXT_FLOW_DIV_TAG, BATIK_EXT_FLOW_LINE_TAG, BATIK_EXT_FLOW_PARA_TAG, BATIK_EXT_FLOW_REGION_BREAK_TAG, BATIK_EXT_FLOW_REGION_EXCLUDE_TAG, BATIK_EXT_FLOW_REGION_TAG, BATIK_EXT_FLOW_SPAN_TAG, BATIK_EXT_FLOW_TEXT_TAG, BATIK_EXT_HEIGHT_ATTRIBUTE, BATIK_EXT_HISTOGRAM_NORMALIZATION_TAG, BATIK_EXT_INDENT_ATTRIBUTE, BATIK_EXT_IR_ATTRIBUTE, BATIK_EXT_JUSTIFICATION_ATTRIBUTE, BATIK_EXT_JUSTIFICATION_END_VALUE, BATIK_EXT_JUSTIFICATION_FULL_VALUE, BATIK_EXT_JUSTIFICATION_MIDDLE_VALUE, BATIK_EXT_JUSTIFICATION_START_VALUE, BATIK_EXT_LEFT_MARGIN_ATTRIBUTE, BATIK_EXT_MARGIN_ATTRIBUTE, BATIK_EXT_NAMESPACE_URI, BATIK_EXT_PREFORMATTED_ATTRIBUTE, BATIK_EXT_REGULAR_POLYGON_TAG, BATIK_EXT_RIGHT_MARGIN_ATTRIBUTE, BATIK_EXT_SIDES_ATTRIBUTE, BATIK_EXT_STAR_TAG, BATIK_EXT_TOP_MARGIN_ATTRIBUTE, BATIK_EXT_TRIM_ATTRIBUTE, BATIK_EXT_VERTICAL_ALIGN_ATTRIBUTE, BATIK_EXT_WIDTH_ATTRIBUTE, BATIK_EXT_X_ATTRIBUTE, BATIK_EXT_Y_ATTRIBUTE
 
Constructor Summary
BatikDomExtension()
           
 
Method Summary
 String getAuthor()
          This should return the individual or company name responsible for the this implementation of the extension.
 String getContactAddress()
          This should contain a contact address (usually an e-mail address).
 String getDescription()
          Human readable description of the extension.
 float getPriority()
          Return the priority of this Extension.
 String getURL()
          This should return a URL where information can be obtained on this extension.
 void registerTags(ExtensibleDOMImplementation di)
          This method should update the DomContext with support for the tags in this extension.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BatikDomExtension

public BatikDomExtension()
Method Detail

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.

Specified by:
getPriority in interface DomExtension

getAuthor

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

Specified by:
getAuthor in interface DomExtension

getContactAddress

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

Specified by:
getContactAddress in interface DomExtension

getURL

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

Specified by:
getURL in interface DomExtension

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)

Specified by:
getDescription in interface DomExtension

registerTags

public void registerTags(ExtensibleDOMImplementation di)
This method should update the DomContext 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.

Specified by:
registerTags in interface DomExtension
Parameters:
di - The ExtensibleDOMImplementation to register the extension elements with.


Copyright © 2008 Apache Software Foundation. All Rights Reserved.