Package org.sbml.jsbml.ext.render

Class Ellipse

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.Ellipse

public class Ellipse
extends GraphicalPrimitive2D

Encodes an ellipse.

Since:

1.0

Author:

Eugen Netz, Alexander Diamantikos, Jakob Matthes, Jan Rudolph, David Vetter

See Also:

Serialized Form

Nested Class Summary

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

GraphicalPrimitive2D.FillRule

Field Summary

Fields

Modifier and Type	Field	Description
protected RelAbsVector	cx
protected RelAbsVector	cy
protected RelAbsVector	cz
protected java.lang.Double	ratio	Optional: Ratio of width to height
protected RelAbsVector	rx
protected RelAbsVector	ry

Fields inherited from class org.sbml.jsbml.AbstractSBase

ignoredExtensions, ignoredXMLElements, JSBML_WRONG_SBO_TERM, packageName

Fields inherited from class org.sbml.jsbml.AbstractTreeNode

listOfListeners, parent, resourceBundle

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

stroke, strokeDashArray, strokeWidth

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

fill, fillRule

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

transform

Constructor Summary

Constructors

Constructor	Description
Ellipse()	Creates a new Ellipse instance.
Ellipse(int level, int version)	Creates a new Ellipse instance.
Ellipse(Ellipse obj)	Creates a new Ellipse instance, copied from the given ellipse.

Method Summary

Modifier and Type	Method	Description
Ellipse	clone()
boolean	equals(java.lang.Object obj)
RelAbsVector	getCx()
RelAbsVector	getCy()
RelAbsVector	getCz()
double	getRatio()
RelAbsVector	getRx()
RelAbsVector	getRy()
int	hashCode()
boolean	isSetCx()
boolean	isSetCy()
boolean	isSetCz()
boolean	isSetRatio()
boolean	isSetRx()
boolean	isSetRy()
boolean	readAttribute(java.lang.String attributeName, java.lang.String prefix, java.lang.String value)
void	setCx(RelAbsVector cx)	Set the value of cx
void	setCy(RelAbsVector cy)	Set the value of cy
void	setCz(RelAbsVector cz)	Set the value of cz
void	setRatio(java.lang.Double newRatio)	Sets the ratio-attribute to given value and fires appropriate change-events
void	setRx(RelAbsVector rx)	Set the value of rx
void	setRy(RelAbsVector ry)	Set the value of ry
boolean	unsetCx()	Unsets the variable cx
boolean	unsetCy()	Unsets the variable cy
boolean	unsetCz()	Unsets the variable cz
boolean	unsetRatio()	Unsets the ratio-attribute (if set)
boolean	unsetRx()	Unsets the variable rx
boolean	unsetRy()	Unsets the variable ry
java.util.Map<java.lang.String,java.lang.String>	writeXMLAttributes()

Methods inherited from class org.sbml.jsbml.AbstractSBase

addCVTerm, addDeclaredNamespace, addExtension, addPlugin, addResources, appendAnnotation, appendAnnotation, appendNotes, appendNotes, checkAndSetPackageNamespaceAndVersion, checkAndSetPackageNamespaceAndVersion, checkAttribute, checkIdentifier, checkLevelAndVersionCompatibility, createHistory, createPlugin, disablePackage, enablePackage, enablePackage, filterCVTerms, filterCVTerms, filterCVTerms, filterCVTerms, fireNodeRemovedEvent, firePropertyChange, getAllDeclaredNamespaces, getAllowsChildren, getAnnotation, getAnnotationString, getChildAt, getChildCount, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementByMetaId, getElementBySId, getElementName, getExtension, getExtensionCount, getExtensionPackages, getFirstElementIndex, getHistory, getId, getIdManager, getLevel, getLevelAndVersion, getMetaId, getModel, getName, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getPackageName, getPackageVersion, getParent, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getURI, getVersion, hasExtension, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isIdMandatory, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetId, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetName, isSetNotes, isSetPackageVErsion, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, isValidLevelAndVersionCombination, isValidMetaId, notifyChildChange, registerChild, removeCVTerm, removeCVTerm, removeDeclaredNamespaceByNamespace, removeDeclaredNamespaceByPrefix, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, replaceTopLevelAnnotationElement, replaceTopLevelAnnotationElement, setAnnotation, setAnnotation, setAnnotation, setHistory, setId, setLevel, setMetaId, setName, setNamespace, setNotes, setNotes, setPackageVersion, setParentSBML, setParentSBMLObject, setSBOTerm, setSBOTerm, setThisAsParentSBMLObject, setVersion, toString, unregisterChild, unsetAnnotation, unsetCVTerms, unsetExtension, unsetHistory, unsetId, unsetMetaId, unsetName, 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, isCloningInProgress, isInvalidSBMLAllowed, isLeaf, isReadingInProgress, isRoot, isSetParent, isSetUserObjects, putUserObject, removeAllTreeNodeChangeListeners, removeAllTreeNodeChangeListeners, removeFromParent, removeTreeNodeChangeListener, removeTreeNodeChangeListener, removeUserObject, setParent, userObjectKeySet

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

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

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.sbml.jsbml.SBase

removeTreeNodeChangeListener

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

isSetTransform, setTransform

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

getTransform, unsetTransform

Methods inherited from interface javax.swing.tree.TreeNode

children, getIndex, isLeaf

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

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

Field Detail

cx

protected RelAbsVector cx

cy

protected RelAbsVector cy

cz

protected RelAbsVector cz

rx

protected RelAbsVector rx

ry

protected RelAbsVector ry

ratio

protected java.lang.Double ratio

Optional: Ratio of width to height

Constructor Detail

Ellipse

public Ellipse()

Creates a new Ellipse instance.

Ellipse

public Ellipse(Ellipse obj)

Creates a new Ellipse instance, copied from the given ellipse.

Parameters:

obj - the Ellipse to be cloned

Ellipse

public Ellipse(int level,
               int version)

Creates a new Ellipse instance.

Parameters:

level - the SBML level

version - the SBML version

Method Detail

clone

public Ellipse clone()

Overrides:

clone in class GraphicalPrimitive2D

getCx

public RelAbsVector getCx()

Returns:

the value of cx

hashCode

public int hashCode()

Overrides:

hashCode in class GraphicalPrimitive2D

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class GraphicalPrimitive2D

isSetCx

public boolean isSetCx()

Returns:

whether cx is set

setCx

public void setCx(RelAbsVector cx)

Set the value of cx

Parameters:

cx -

unsetCx

public boolean unsetCx()

Unsets the variable cx

Returns:

true, if cx was set before, otherwise false

getCy

public RelAbsVector getCy()

Returns:

the value of cy

isSetCy

public boolean isSetCy()

Returns:

whether cy is set

setCy

public void setCy(RelAbsVector cy)

Set the value of cy

Parameters:

cy -

unsetCy

public boolean unsetCy()

Unsets the variable cy

Returns:

true, if cy was set before, otherwise false

getCz

public RelAbsVector getCz()

Returns:

the value of cz

isSetCz

public boolean isSetCz()

Returns:

whether cz is set

setCz

public void setCz(RelAbsVector cz)

Set the value of cz

Parameters:

cz -

unsetCz

public boolean unsetCz()

Unsets the variable cz

Returns:

true, if cz was set before, otherwise false

getRatio

public double getRatio()

Returns:

the ratio-attribute (specifies rx/ry, cf. render specification: Ellipse class)

isSetRatio

public boolean isSetRatio()

Returns:

whether the ratio-attribute is set to a number

setRatio

public void setRatio(java.lang.Double newRatio)

Sets the ratio-attribute to given value and fires appropriate change-events

Parameters:

newRatio - the new value to be taken

unsetRatio

public boolean unsetRatio()

Unsets the ratio-attribute (if set)

Returns:

Whether the ratio could actually be unset

getRx

public RelAbsVector getRx()

Returns:

the value of rx

isSetRx

public boolean isSetRx()

Returns:

whether rx is set

setRx

public void setRx(RelAbsVector rx)

Set the value of rx

Parameters:

rx -

unsetRx

public boolean unsetRx()

Unsets the variable rx

Returns:

true, if rx was set before, otherwise false

getRy

public RelAbsVector getRy()

Returns:

the value of ry

isSetRy

public boolean isSetRy()

Returns:

whether ry is set

setRy

public void setRy(RelAbsVector ry)

Set the value of ry

Parameters:

ry -

unsetRy

public boolean unsetRy()

Unsets the variable ry

Returns:

true, if ry was set before, otherwise false

writeXMLAttributes

public java.util.Map<java.lang.String,java.lang.String> writeXMLAttributes()

Overrides:

writeXMLAttributes in class GraphicalPrimitive2D

readAttribute

public boolean readAttribute(java.lang.String attributeName,
                             java.lang.String prefix,
                             java.lang.String value)

Overrides:

readAttribute in class GraphicalPrimitive2D