org.sbml.jsbml.ext.render

Class RenderGroup

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.AbstractSBase

org.sbml.jsbml.ext.render.Transformation

org.sbml.jsbml.ext.render.Transformation2D

org.sbml.jsbml.ext.render.GraphicalPrimitive1D

org.sbml.jsbml.ext.render.GraphicalPrimitive2D

org.sbml.jsbml.ext.render.RenderGroup

All Implemented Interfaces:

Serializable, Cloneable, TreeNode, org.sbml.jsbml.NamedSBase, org.sbml.jsbml.SBase, org.sbml.jsbml.UniqueNamedSBase, org.sbml.jsbml.util.TreeNodeWithChangeSupport

public class RenderGroup
extends GraphicalPrimitive2D
implements org.sbml.jsbml.UniqueNamedSBase

The RenderGroup class from the SBML render extension is used to group graphical primitives together to create composite representations from simple primitives.

The RenderGroup class is derived from GraphicalPrimitive2D and inherits all its methods and attributes. In addition to those, the class defines attributes to specify text render properties (@see Text), curve decorations (@see RenderCurve), an id and a list of child elements which can be any graphical primitive or other groups.

The attributes of a group are inherited by all children of the group unless they specify the attribute themselves.

Since:

1.0

Version:

$Rev$

Author:

Eugen Netz, Alexander Diamantikos, Jakob Matthes, Jan Rudolph, Nicolas Rodriguez

See Also:

Serialized Form

Last modified:

$Date$

Nested Class Summary

Nested classes/interfaces inherited from class org.sbml.jsbml.ext.render.GraphicalPrimitive2D

GraphicalPrimitive2D.FillRule

Field Summary

Fields inherited from class org.sbml.jsbml.ext.render.GraphicalPrimitive2D

fill, fillRule

Fields inherited from class org.sbml.jsbml.ext.render.GraphicalPrimitive1D

stroke, strokeDashArray, strokeWidth

Fields inherited from class org.sbml.jsbml.ext.render.Transformation2D

transform

Fields inherited from class org.sbml.jsbml.AbstractSBase

ignoredExtensions, ignoredXMLElements, packageName

Fields inherited from class org.sbml.jsbml.AbstractTreeNode

listOfListeners, parent, resourceBundle, UNKNOWN_ATTRIBUTES, UNKNOWN_ELEMENTS

Constructor Summary

Constructors

Constructor and Description
RenderGroup() Creates an Group instance
RenderGroup(int level, int version) Creates a Group instance with a level and version.
RenderGroup(RenderGroup obj) Clone constructor
RenderGroup(String id) Creates a Group instance with an id.
RenderGroup(String id, int level, int version) Creates a Group instance with an id, level, and version.
RenderGroup(String id, String name, int level, int version) Creates a Group instance with an id, name, level, and version.

Method Summary

Modifier and Type	Method and Description
void	addChildElement(Transformation2D pChild) Adds the given element to the end of the list of children elements.
boolean	addElement(Transformation2D field) Adds a new Transformation2D to the listOfElements.
RenderGroup	clone()
RenderCurve	createCurve() Creates a new RenderCurve element, adds it to the ListOfElements list and returns it.
Ellipse	createEllipse() Creates a new Ellipse element, adds it to the ListOfElements list and returns it.
Image	createImage() Creates a new Image element, adds it to the ListOfElements list and returns it.
Polygon	createPolygon() Creates a new Polygon element, adds it to the ListOfElements list and returns it.
Rectangle	createRectangle() Creates a new Rectangle element, adds it to the ListOfElements list and returns it.
RenderGroup	createRenderGroup() Creates a new RenderGroup element, adds it to the ListOfElements list and returns it.
Text	createText() Creates a new Text element, adds it to the ListOfElements list and returns it.
boolean	equals(Object obj)
boolean	getAllowsChildren()
TreeNode	getChildAt(int index)
int	getChildCount()
Transformation2D	getElement(int i) Gets an element from the listOfElements at the given index.
Transformation2D	getElement(String fieldId) Gets an element from the listOfElements, with the given id.
int	getElementCount() Returns the number of Transformation2Ds in this RenderGroup.
String	getElementName()
String	getEndHead()
FontFamily	getFontFamily()
Short	getFontSize()
boolean	getFontStyleItalic() Returns the value of fontStyleItalic
boolean	getFontWeightBold() Returns the value of fontWeightBold
String	getId()
org.sbml.jsbml.ListOf<Transformation2D>	getListOfElements() Returns the listOfElements.
String	getName()
int	getNumElements() Returns the number of Transformation2Ds in this RenderGroup.
String	getStartHead()
TextAnchor	getTextAnchor()
VTextAnchor	getVTextAnchor()
int	hashCode()
void	initDefaults() Initializes the default values using the namespace.
boolean	isFontStyleItalic() Returns the value of fontStyleItalic
boolean	isFontWeightBold() Returns the value of fontWeightBold
boolean	isIdMandatory()
boolean	isSetEndHead()
boolean	isSetFontFamily()
boolean	isSetFontSize()
boolean	isSetFontStyleItalic() Returns whether fontStyleItalic is set
boolean	isSetFontWeightBold()
boolean	isSetId()
boolean	isSetListOfElements() Returns true, if listOfElements contains at least one element.
boolean	isSetName()
boolean	isSetStartHead()
boolean	isSetTextAnchor()
boolean	isSetVTextAnchor()
boolean	readAttribute(String attributeName, String prefix, String value)
Transformation2D	removeElement(int i) Removes an element from the listOfElements at the given index.
Transformation2D	removeElement(String fieldId) Removes an element from the listOfElements.
boolean	removeElement(Transformation2D field) Removes an element from the listOfElements.
void	setEndHead(String endHead) Set the value of endHead
void	setFontFamily(FontFamily fontFamily) Set the value of fontFamily
void	setFontSize(Short fontSize) Set the value of fontSize
void	setFontStyleItalic(Boolean fontStyleItalic) Set the value of fontStyleItalic
void	setFontWeightBold(Boolean fontWeightBold) Set the value of fontWeightBold
void	setId(String id)
void	setListOfElements(org.sbml.jsbml.ListOf<Transformation2D> listOfElements) Sets the given ListOf<Transformation2D>.
void	setName(String name)
void	setStartHead(String startHead) Set the value of startHead
void	setTextAnchor(TextAnchor textAnchor) Set the value of textAnchor
void	setVTextAnchor(VTextAnchor vTextAnchor) Set the value of vTextAnchor
String	toString()
boolean	unsetEndHead() Unsets the variable endHead
boolean	unsetFontFamily() Unsets the variable fontFamily
boolean	unsetFontSize() Unsets the variable fontSize
boolean	unsetFontStyleItalic() Unsets the variable fontStyleItalic
boolean	unsetFontWeightBold() Unsets the variable fontWeightBold
void	unsetId() Unsets the variable id
boolean	unsetListOfElements() Returns true, if listOfElements contain at least one element, otherwise false.
void	unsetName()
boolean	unsetStartHead() Unsets the variable startHead
boolean	unsetTextAnchor() Unsets the variable textAnchor
boolean	unsetVTextAnchor() Unsets the variable vTextAnchor
Map<String,String>	writeXMLAttributes()

Methods inherited from class org.sbml.jsbml.ext.render.GraphicalPrimitive2D

getFill, getFillRule, isSetFill, isSetFillRule, setFill, setFillRule, unsetFill, unsetFillRule

Methods inherited from class org.sbml.jsbml.ext.render.GraphicalPrimitive1D

getStroke, getStrokeDashArray, getStrokeWidth, isSetStroke, isSetStrokeDashArray, isSetStrokeWidth, setStroke, setStrokeDashArray, setStrokeWidth, unsetStroke, unsetStrokeDashArray, unsetStrokeWidth

Methods inherited from class org.sbml.jsbml.ext.render.Transformation2D

getTransform, isSetTransform, setTransform, unsetTransform

Methods inherited from class org.sbml.jsbml.AbstractSBase

addCVTerm, addDeclaredNamespace, addExtension, addPlugin, appendAnnotation, appendAnnotation, appendNotes, appendNotes, checkAndSetPackageNamespaceAndVersion, checkAndSetPackageNamespaceAndVersion, checkLevelAndVersionCompatibility, createHistory, createPlugin, disablePackage, enablePackage, enablePackage, filterCVTerms, filterCVTerms, filterCVTerms, filterCVTerms, fireNodeRemovedEvent, firePropertyChange, getAnnotation, getAnnotationString, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getExtension, getExtensionCount, getExtensionPackages, getHistory, getIdManager, getLevel, getLevelAndVersion, getMetaId, getModel, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getPackageName, getPackageVersion, getParent, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getURI, getVersion, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetNotes, isSetPackageVErsion, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, isValidLevelAndVersionCombination, isValidMetaId, notifyChildChange, registerChild, removeCVTerm, removeCVTerm, setAnnotation, setAnnotation, setAnnotation, setHistory, setLevel, setMetaId, setNamespace, setNotes, setNotes, setPackageVersion, setParentSBML, setParentSBMLObject, setSBOTerm, setSBOTerm, setThisAsParentSBMLObject, setVersion, unregisterChild, unsetAnnotation, unsetCVTerms, unsetExtension, unsetHistory, unsetMetaId, unsetNamespace, unsetNotes, unsetPlugin, unsetSBOTerm

Methods inherited from class org.sbml.jsbml.AbstractTreeNode

addAllChangeListeners, addAllChangeListeners, addTreeNodeChangeListener, addTreeNodeChangeListener, children, clearUserObjects, containsUserObjectKey, filter, filter, filter, fireNodeAddedEvent, getIndex, getListOfTreeNodeChangeListeners, getNumChildren, getRoot, getTreeNodeChangeListenerCount, getUserObject, indexOf, isLeaf, isRoot, isSetParent, isSetUserObjects, putUserObject, removeAllTreeNodeChangeListeners, removeAllTreeNodeChangeListeners, removeFromParent, removeTreeNodeChangeListener, removeTreeNodeChangeListener, removeUserObject, setParent, userObjectKeySet

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.sbml.jsbml.SBase

addCVTerm, addDeclaredNamespace, addExtension, addPlugin, appendAnnotation, appendAnnotation, appendNotes, appendNotes, createPlugin, disablePackage, enablePackage, enablePackage, filterCVTerms, filterCVTerms, filterCVTerms, filterCVTerms, getAnnotation, getAnnotationString, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getExtension, getExtensionCount, getExtensionPackages, getHistory, getLevel, getLevelAndVersion, getMetaId, getModel, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getPackageName, getPackageVersion, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getURI, getVersion, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetNotes, isSetPackageVErsion, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, registerChild, removeCVTerm, removeCVTerm, removeTreeNodeChangeListener, setAnnotation, setAnnotation, setAnnotation, setHistory, setLevel, setMetaId, setNotes, setNotes, setPackageVersion, setSBOTerm, setSBOTerm, setThisAsParentSBMLObject, setVersion, unregisterChild, unsetAnnotation, unsetCVTerms, unsetExtension, unsetHistory, unsetMetaId, unsetNotes, unsetPlugin, unsetSBOTerm

Methods inherited from interface org.sbml.jsbml.util.TreeNodeWithChangeSupport

addAllChangeListeners, addAllChangeListeners, addTreeNodeChangeListener, addTreeNodeChangeListener, clearUserObjects, containsUserObjectKey, filter, filter, filter, fireNodeAddedEvent, fireNodeRemovedEvent, firePropertyChange, getListOfTreeNodeChangeListeners, getRoot, getTreeNodeChangeListenerCount, getUserObject, isRoot, isSetParent, isSetUserObjects, putUserObject, removeAllTreeNodeChangeListeners, removeAllTreeNodeChangeListeners, removeFromParent, removeTreeNodeChangeListener, removeUserObject, userObjectKeySet

Methods inherited from interface javax.swing.tree.TreeNode

children, getIndex, getParent, isLeaf

Constructor Detail

RenderGroup

public RenderGroup()

Creates an Group instance

RenderGroup

public RenderGroup(String id)

Creates a Group instance with an id.

Parameters:

id -

RenderGroup

public RenderGroup(int level,
                   int version)

Creates a Group instance with a level and version.

Parameters:

level -

version -

RenderGroup

public RenderGroup(String id,
                   int level,
                   int version)

Creates a Group instance with an id, level, and version.

Parameters:

id -

level -

version -

RenderGroup

public RenderGroup(String id,
                   String name,
                   int level,
                   int version)

Creates a Group instance with an id, name, level, and version.

Parameters:

id -

name -

level -

version -

RenderGroup

public RenderGroup(RenderGroup obj)

Clone constructor

Parameters:

obj -

Method Detail

clone

public RenderGroup clone()

Specified by:

clone in interface org.sbml.jsbml.SBase

Overrides:

clone in class GraphicalPrimitive2D

initDefaults

public void initDefaults()

Description copied from class: Transformation

Initializes the default values using the namespace.

Overrides:

initDefaults in class GraphicalPrimitive2D

hashCode

public int hashCode()

Specified by:

hashCode in interface org.sbml.jsbml.SBase

Overrides:

hashCode in class GraphicalPrimitive2D

equals

public boolean equals(Object obj)

Specified by:

equals in interface org.sbml.jsbml.SBase

Overrides:

equals in class GraphicalPrimitive2D

toString

public String toString()

Overrides:

toString in class Transformation

getAllowsChildren

public boolean getAllowsChildren()

Specified by:

getAllowsChildren in interface TreeNode

Overrides:

getAllowsChildren in class org.sbml.jsbml.AbstractSBase

getChildCount

public int getChildCount()

Specified by:

getChildCount in interface TreeNode

Overrides:

getChildCount in class org.sbml.jsbml.AbstractSBase

getChildAt

public TreeNode getChildAt(int index)

Specified by:

getChildAt in interface TreeNode

Overrides:

getChildAt in class org.sbml.jsbml.AbstractSBase

getElementName

public String getElementName()

Specified by:

getElementName in interface org.sbml.jsbml.SBase

Overrides:

getElementName in class org.sbml.jsbml.AbstractSBase

getId

public String getId()

Specified by:

getId in interface org.sbml.jsbml.NamedSBase

Returns:

the value of id

isSetId

public boolean isSetId()

Specified by:

isSetId in interface org.sbml.jsbml.NamedSBase

Returns:

whether id is set

setId

public void setId(String id)

Specified by:

setId in interface org.sbml.jsbml.NamedSBase

unsetId

public void unsetId()

Unsets the variable id

Specified by:

unsetId in interface org.sbml.jsbml.NamedSBase

getFontFamily

public FontFamily getFontFamily()

Returns:

the value of fontFamily

isSetFontFamily

public boolean isSetFontFamily()

Returns:

whether fontFamily is set

setFontFamily

public void setFontFamily(FontFamily fontFamily)

Set the value of fontFamily

Parameters:

fontFamily -

unsetFontFamily

public boolean unsetFontFamily()

Unsets the variable fontFamily

Returns:

true, if fontFamily was set before, otherwise false

getFontSize

public Short getFontSize()

Returns:

the value of fontSize

isSetFontSize

public boolean isSetFontSize()

Returns:

whether fontSize is set

setFontSize

public void setFontSize(Short fontSize)

Set the value of fontSize

Parameters:

fontSize -

unsetFontSize

public boolean unsetFontSize()

Unsets the variable fontSize

Returns:

true, if fontSize was set before, otherwise false

getFontWeightBold

public boolean getFontWeightBold()

Returns the value of fontWeightBold

Returns:

the value of fontWeightBold

isFontWeightBold

public boolean isFontWeightBold()

Returns the value of fontWeightBold

Returns:

the value of fontWeightBold

isSetFontWeightBold

public boolean isSetFontWeightBold()

Returns:

whether fontWeightBold is set

setFontWeightBold

public void setFontWeightBold(Boolean fontWeightBold)

Set the value of fontWeightBold

Parameters:

fontWeightBold -

unsetFontWeightBold

public boolean unsetFontWeightBold()

Unsets the variable fontWeightBold

Returns:

true, if fontWeightBold was set before, otherwise false

getFontStyleItalic

public boolean getFontStyleItalic()

Returns the value of fontStyleItalic

Returns:

the value of fontStyleItalic

isFontStyleItalic

public boolean isFontStyleItalic()

Returns the value of fontStyleItalic

Returns:

the value of fontStyleItalic

isSetFontStyleItalic

public boolean isSetFontStyleItalic()

Returns whether fontStyleItalic is set

Returns:

whether fontStyleItalic is set

setFontStyleItalic

public void setFontStyleItalic(Boolean fontStyleItalic)

Set the value of fontStyleItalic

Parameters:

fontStyleItalic -

unsetFontStyleItalic

public boolean unsetFontStyleItalic()

Unsets the variable fontStyleItalic

Returns:

true, if fontStyleItalic was set before, otherwise false

getStartHead

public String getStartHead()

Returns:

the value of startHead

isSetStartHead

public boolean isSetStartHead()

Returns:

whether startHead is set

setStartHead

public void setStartHead(String startHead)

Set the value of startHead

Parameters:

startHead -

unsetStartHead

public boolean unsetStartHead()

Unsets the variable startHead

Returns:

true, if startHead was set before, otherwise false

getEndHead

public String getEndHead()

Returns:

the value of endHead

isSetEndHead

public boolean isSetEndHead()

Returns:

whether endHead is set

setEndHead

public void setEndHead(String endHead)

Set the value of endHead

Parameters:

endHead -

unsetEndHead

public boolean unsetEndHead()

Unsets the variable endHead

Returns:

true, if endHead was set before, otherwise false

getTextAnchor

public TextAnchor getTextAnchor()

Returns:

the value of textAnchor

isSetTextAnchor

public boolean isSetTextAnchor()

Returns:

whether textAnchor is set

setTextAnchor

public void setTextAnchor(TextAnchor textAnchor)

Set the value of textAnchor

Parameters:

textAnchor -

unsetTextAnchor

public boolean unsetTextAnchor()

Unsets the variable textAnchor

Returns:

true, if textAnchor was set before, otherwise false

getVTextAnchor

public VTextAnchor getVTextAnchor()

Returns:

the value of vTextAnchor

isSetVTextAnchor

public boolean isSetVTextAnchor()

Returns:

whether vTextAnchor is set

setVTextAnchor

public void setVTextAnchor(VTextAnchor vTextAnchor)

Set the value of vTextAnchor

Parameters:

vTextAnchor -

unsetVTextAnchor

public boolean unsetVTextAnchor()

Unsets the variable vTextAnchor

Returns:

true, if vTextAnchor was set before, otherwise false

isSetListOfElements

public boolean isSetListOfElements()

Returns true, if listOfElements contains at least one element.

Returns:

true, if listOfElements contains at least one element, otherwise false.

getListOfElements

public org.sbml.jsbml.ListOf<Transformation2D> getListOfElements()

Returns the listOfElements. Creates it if it is not already existing.

Returns:

the listOfElements.

setListOfElements

public void setListOfElements(org.sbml.jsbml.ListOf<Transformation2D> listOfElements)

Sets the given ListOf<Transformation2D>. If listOfElements was defined before and contains some elements, they are all unset.

Parameters:

listOfElements -

unsetListOfElements

public boolean unsetListOfElements()

Returns true, if listOfElements contain at least one element, otherwise false.

Returns:

true, if listOfElements contain at least one element, otherwise false.

addElement

public boolean addElement(Transformation2D field)

Adds a new Transformation2D to the listOfElements.

The listOfElements is initialized if necessary.

Parameters:

field - the element to add to the list

Returns:

true (as specified by Collection.add(E))

removeElement

public boolean removeElement(Transformation2D field)

Removes an element from the listOfElements.

Parameters:

field - the element to be removed from the list.

Returns:

true if the list contained the specified element and it was removed.

See Also:

List.remove(Object)

removeElement

public Transformation2D removeElement(String fieldId)

Removes an element from the listOfElements.

Parameters:

fieldId - the id of the element to be removed from the list.

Returns:

the removed element, if it was successfully found and removed or null.

removeElement

public Transformation2D removeElement(int i)

Removes an element from the listOfElements at the given index.

Parameters:

i - the index where to remove the Transformation2D.

Returns:

the specified element, if it was successfully found and removed.

Throws:

IndexOutOfBoundsException - if the listOf is not set or if the index is out of bound (index < 0 || index > list.size).

createCurve

public RenderCurve createCurve()

Creates a new RenderCurve element, adds it to the ListOfElements list and returns it.

Returns:

createEllipse

public Ellipse createEllipse()

Creates a new Ellipse element, adds it to the ListOfElements list and returns it.

Returns:

createImage

public Image createImage()

Creates a new Image element, adds it to the ListOfElements list and returns it.

Returns:

createPolygon

public Polygon createPolygon()

Creates a new Polygon element, adds it to the ListOfElements list and returns it.

Returns:

createRectangle

public Rectangle createRectangle()

Creates a new Rectangle element, adds it to the ListOfElements list and returns it.

Returns:

createRenderGroup

public RenderGroup createRenderGroup()

Creates a new RenderGroup element, adds it to the ListOfElements list and returns it.

Returns:

createText

public Text createText()

Creates a new Text element, adds it to the ListOfElements list and returns it.

Returns:

getElement

public Transformation2D getElement(int i)

Gets an element from the listOfElements at the given index.

Parameters:

i - the index of the Transformation2D element to get.

Returns:

an element from the listOfElements at the given index.

Throws:

IndexOutOfBoundsException - if the listOf is not set or if the index is out of bound (index < 0 || index > list.size).

getElement

public Transformation2D getElement(String fieldId)

Gets an element from the listOfElements, with the given id.

Parameters:

fieldId - the id of the Transformation2D element to get.

Returns:

an element from the listOfElements with the given id or null.

getElementCount

public int getElementCount()

Returns the number of Transformation2Ds in this RenderGroup.

Returns:

the number of Transformation2Ds in this RenderGroup.

getNumElements

public int getNumElements()

Returns the number of Transformation2Ds in this RenderGroup.

Returns:

the number of Transformation2Ds in this RenderGroup.

Note: this method is kept here as it exist in libSBML.

same as getElementCount()

addChildElement

public void addChildElement(Transformation2D pChild)

Adds the given element to the end of the list of children elements.

Parameters:

pChild -

See Also:

createEllipse(), createRectangle(), createPolygon(), createText(), createCurve(), createRenderGroup(), createImage()

writeXMLAttributes

public Map<String,String> writeXMLAttributes()

Specified by:

writeXMLAttributes in interface org.sbml.jsbml.SBase

Overrides:

writeXMLAttributes in class GraphicalPrimitive2D

readAttribute

public boolean readAttribute(String attributeName,
                             String prefix,
                             String value)

Specified by:

readAttribute in interface org.sbml.jsbml.SBase

Overrides:

readAttribute in class GraphicalPrimitive2D

getName

public String getName()

Specified by:

getName in interface org.sbml.jsbml.NamedSBase

isIdMandatory

public boolean isIdMandatory()

Specified by:

isIdMandatory in interface org.sbml.jsbml.NamedSBase

isSetName

public boolean isSetName()

Specified by:

isSetName in interface org.sbml.jsbml.NamedSBase

setName

public void setName(String name)

Specified by:

setName in interface org.sbml.jsbml.NamedSBase

unsetName

public void unsetName()

Specified by:

unsetName in interface org.sbml.jsbml.NamedSBase