TPTP 4.5.0 Platform Project
Internal API Specification

org.eclipse.tptp.platform.report.chart.svg.internal.generator
Class SVGContainerBase

java.lang.Object
  extended by org.eclipse.tptp.platform.report.chart.svg.internal.generator.SVGBase
      extended by org.eclipse.tptp.platform.report.chart.svg.internal.generator.SVGContainerBase
All Implemented Interfaces:
java.io.Serializable, ISVGBase, ISVGContainerBase
Direct Known Subclasses:
SVGClipPathBase, SVGDefinition, SVGDocumentFragmentBase, SVGFeComponentTransferBase, SVGFilterBase, SVGGroup, SVGLinearGradientBase, SVGStyleBase, SVGSymbolBase

public abstract class SVGContainerBase
extends SVGBase
implements ISVGContainerBase, java.io.Serializable

SVGContainerBase is an abstract base class for classes which generate Scalable Vector Graphics (SVG) container elements. Applicable to SVG containers which support the common set of SVG attributes implemented here. $Revision: 1.1 $

See Also:
Serialized Form

Constructor Summary
SVGContainerBase()
           
 
Method Summary
protected  org.w3c.dom.Element doImplementation(org.w3c.dom.Document svgDocument)
          Calls the superclass to create the SVG container element and then sets any non-null base attributes.
 SVGBase[] getChildren()
          Returns the array of contained objects.
 java.lang.String getDesc()
          Returns the description text.
 java.lang.String getTitle()
          Returns the title text.
 void setChildren(SVGBase[] children)
          Sets the array of contained objects.
 void setDesc(java.lang.String desc)
          Sets the description text.
 void setTitle(java.lang.String title)
          Sets the title text.
 
Methods inherited from class org.eclipse.tptp.platform.report.chart.svg.internal.generator.SVGBase
getIdentifier, getImplementation, getStyle, getStyleClass, getTagName, getVisibility, setIdentifier, setStyle, setStyleClass, setTagName, setVisibility
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SVGContainerBase

public SVGContainerBase()
Method Detail

doImplementation

protected org.w3c.dom.Element doImplementation(org.w3c.dom.Document svgDocument)
                                        throws org.w3c.dom.DOMException,
                                               java.lang.NullPointerException
Calls the superclass to create the SVG container element and then sets any non-null base attributes. Calls the doImplementation(Document) method on all children - any children returning null will not have elements added to the container.

Overrides:
doImplementation in class SVGBase
Parameters:
Document - the target SVG Document
Returns:
Element the container implementation or null if the element was not created.
Throws:
org.w3c.dom.DOMException - if the tag name contains an illegal character.
java.lang.NullPointerException - if any child elements are null.

getChildren

public SVGBase[] getChildren()
Description copied from interface: ISVGContainerBase
Returns the array of contained objects.

Specified by:
getChildren in interface ISVGContainerBase
Returns:
SVGGraphicBase[]
See Also:
ISVGContainerBase.getChildren()

getDesc

public java.lang.String getDesc()
Description copied from interface: ISVGContainerBase
Returns the description text.

Specified by:
getDesc in interface ISVGContainerBase
Returns:
String
See Also:
ISVGContainerBase.getDesc()

getTitle

public java.lang.String getTitle()
Description copied from interface: ISVGContainerBase
Returns the title text.

Specified by:
getTitle in interface ISVGContainerBase
Returns:
String
See Also:
ISVGContainerBase.getTitle()

setChildren

public void setChildren(SVGBase[] children)
Description copied from interface: ISVGContainerBase
Sets the array of contained objects.

Specified by:
setChildren in interface ISVGContainerBase
Parameters:
children - The children to set.
See Also:
ISVGContainerBase#setChildren()

setDesc

public void setDesc(java.lang.String desc)
Description copied from interface: ISVGContainerBase
Sets the description text.

Specified by:
setDesc in interface ISVGContainerBase
Parameters:
desc - The desc to set
See Also:
ISVGContainerBase#setDesc()

setTitle

public void setTitle(java.lang.String title)
Description copied from interface: ISVGContainerBase
Sets the title text.

Specified by:
setTitle in interface ISVGContainerBase
Parameters:
title - The title to set
See Also:
ISVGContainerBase#setTitle()

TPTP 4.5.0 Platform Project
Internal API Specification