org.sbml.jsbml.ext.render

Class RadialGradient

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.AbstractSBase

org.sbml.jsbml.AbstractNamedSBase

org.sbml.jsbml.ext.render.GradientBase

org.sbml.jsbml.ext.render.RadialGradient

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, javax.swing.tree.TreeNode, NamedSBase, SBase, UniqueNamedSBase, UniqueSId, TreeNodeWithChangeSupport

public class RadialGradient
extends GradientBase

Since:

1.0

Author:

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

See Also:

Serialized Form

Nested Class Summary

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

GradientBase.Spread

Field Summary

Fields inherited from class org.sbml.jsbml.AbstractSBase

JSBML_WRONG_SBO_TERM

Constructor Summary

Constructors

Constructor and Description
RadialGradient() Creates an RadialGradient instance
RadialGradient(RadialGradient obj) Clone constructor

Method Summary

Modifier and Type	Method and Description
RadialGradient	clone() Creates a deep copy of this object, i.e., a new SBase with the same properties like this one.
boolean	equals(java.lang.Object obj) Returns true if and only if the given SBase has exactly the same properties like this SBase instance.
RelAbsVector	getCx()
RelAbsVector	getCy()
RelAbsVector	getCz()
RelAbsVector	getFx()
RelAbsVector	getFy()
RelAbsVector	getFz()
RelAbsVector	getR()
int	hashCode() Returns a hash code value for this SBase instance.
void	initDefaults() Initializes the default values using the namespace.
boolean	isSetCx()
boolean	isSetCy()
boolean	isSetCz()
boolean	isSetFx()
boolean	isSetFy()
boolean	isSetFz()
boolean	isSetR()
boolean	readAttribute(java.lang.String attributeName, java.lang.String prefix, java.lang.String value) Sets the given attribute in this SBase.
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	setFx(RelAbsVector fx) Set the value of fx
void	setFy(RelAbsVector fy) Set the value of fy
void	setFz(RelAbsVector fz) Set the value of fz
void	setR(RelAbsVector r) Set the value of r
boolean	unsetCx() Unsets the variable cx
boolean	unsetCy() Unsets the variable cy
boolean	unsetCz() Unsets the variable cz
boolean	unsetFx() Unsets the variable fx
boolean	unsetFy() Unsets the variable fy
boolean	unsetFz() Unsets the variable fz
boolean	unsetR() Unsets the variable r
java.util.Map<java.lang.String,java.lang.String>	writeXMLAttributes() Returns a map with all the attributes of this SBase that need to be written out in XML.

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

addGradientStop, createGradientStop, getAllowsChildren, getChildAt, getChildCount, getListOfGradientStops, getSpreadMethod, isIdMandatory, isListOfGradientStopsEmpty, isSetListOfGradientStops, isSetSpreadMethod, removeGradientStop, removeGradientStop, setListOfGradientStops, setSpreadMethod, unsetListOfGradientStops, unsetSpreadMethod

Methods inherited from class org.sbml.jsbml.AbstractNamedSBase

isValidId

Methods inherited from class org.sbml.jsbml.AbstractSBase

addCVTerm, addDeclaredNamespace, addExtension, addPlugin, appendAnnotation, appendAnnotation, appendNotes, appendNotes, createHistory, createPlugin, disablePackage, enablePackage, enablePackage, filterCVTerms, filterCVTerms, filterCVTerms, filterCVTerms, fireNodeRemovedEvent, firePropertyChange, getAllDeclaredNamespaces, getAnnotation, getAnnotationString, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementByMetaId, getElementBySId, getElementName, getExtension, getExtensionCount, getExtensionPackages, getFirstElementIndex, getHistory, getId, getLevel, getLevelAndVersion, getMetaId, getModel, getName, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getPackageName, getPackageVersion, getParent, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getURI, getVersion, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetId, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetName, isSetNotes, isSetPackageVErsion, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, isValidLevelAndVersionCombination, isValidMetaId, registerChild, removeCVTerm, removeCVTerm, removeDeclaredNamespaceByNamespace, removeDeclaredNamespaceByPrefix, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, replaceTopLevelAnnotationElement, replaceTopLevelAnnotationElement, setAnnotation, setAnnotation, setAnnotation, setHistory, setId, setLevel, setMetaId, setName, setNamespace, setNotes, setNotes, setPackageVersion, 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, isLeaf, isRoot, isSetParent, isSetUserObjects, putUserObject, removeAllTreeNodeChangeListeners, removeAllTreeNodeChangeListeners, removeFromParent, removeTreeNodeChangeListener, removeTreeNodeChangeListener, removeUserObject, setParent, userObjectKeySet

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.sbml.jsbml.NamedSBase

getId, getName, isSetId, isSetName, setId, setName, unsetId, unsetName

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, getElementByMetaId, getElementBySId, getElementName, 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, removeDeclaredNamespaceByNamespace, removeDeclaredNamespaceByPrefix, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, removeTreeNodeChangeListener, replaceTopLevelAnnotationElement, replaceTopLevelAnnotationElement, 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

RadialGradient

public RadialGradient()

Creates an RadialGradient instance

RadialGradient

public RadialGradient(RadialGradient obj)

Clone constructor

Parameters:

obj -

Method Detail

clone

public RadialGradient clone()

Description copied from interface: SBase

Creates a deep copy of this object, i.e., a new SBase with the same properties like this one.

Specified by:

clone in interface SBase

Overrides:

clone in class GradientBase

Returns:

a copy of this object

getCx

public RelAbsVector getCx()

Returns:

the value of cx

getCy

public RelAbsVector getCy()

Returns:

the value of cy

getCz

public RelAbsVector getCz()

Returns:

the value of cz

getFx

public RelAbsVector getFx()

Returns:

the value of fx

getFy

public RelAbsVector getFy()

Returns:

the value of fy

getFz

public RelAbsVector getFz()

Returns:

the value of fz

getR

public RelAbsVector getR()

Returns:

the value of r

initDefaults

public void initDefaults()

Description copied from class: GradientBase

Initializes the default values using the namespace.

Overrides:

initDefaults in class GradientBase

isSetCx

public boolean isSetCx()

Returns:

whether cx is set

isSetCy

public boolean isSetCy()

Returns:

whether cy is set

isSetCz

public boolean isSetCz()

Returns:

whether cz is set

isSetFx

public boolean isSetFx()

Returns:

whether fx is set

isSetFy

public boolean isSetFy()

Returns:

whether fy is set

isSetFz

public boolean isSetFz()

Returns:

whether fz is set

isSetR

public boolean isSetR()

Returns:

whether r is set

setCx

public void setCx(RelAbsVector cx)

Set the value of cx

Parameters:

cx -

setCy

public void setCy(RelAbsVector cy)

Set the value of cy

Parameters:

cy -

setCz

public void setCz(RelAbsVector cz)

Set the value of cz

Parameters:

cz -

setFx

public void setFx(RelAbsVector fx)

Set the value of fx

Parameters:

fx -

setFy

public void setFy(RelAbsVector fy)

Set the value of fy

Parameters:

fy -

setFz

public void setFz(RelAbsVector fz)

Set the value of fz

Parameters:

fz -

setR

public void setR(RelAbsVector r)

Set the value of r

Parameters:

r -

unsetCx

public boolean unsetCx()

Unsets the variable cx

Returns:

true, if cx was set before, otherwise false

unsetCy

public boolean unsetCy()

Unsets the variable cy

Returns:

true, if cy was set before, otherwise false

unsetCz

public boolean unsetCz()

Unsets the variable cz

Returns:

true, if cz was set before, otherwise false

unsetFx

public boolean unsetFx()

Unsets the variable fx

Returns:

true, if fx was set before, otherwise false

unsetFy

public boolean unsetFy()

Unsets the variable fy

Returns:

true, if fy was set before, otherwise false

unsetFz

public boolean unsetFz()

Unsets the variable fz

Returns:

true, if fz was set before, otherwise false

unsetR

public boolean unsetR()

Unsets the variable r

Returns:

true, if r was set before, otherwise false

writeXMLAttributes

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

Description copied from interface: SBase

Returns a map with all the attributes of this SBase that need to be written out in XML.

The attribute name is used as a key and the attribute value as value. If a prefix is needed for the attribute name, it need to be set directly in this map.

Specified by:

writeXMLAttributes in interface SBase

Overrides:

writeXMLAttributes in class GradientBase

Returns:

a Map containing the XML attributes of this object.

readAttribute

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

Description copied from interface: SBase

Sets the given attribute in this SBase.

If the given attribute name is not recognized, nothing is done and false is returned.

Specified by:

readAttribute in interface SBase

Overrides:

readAttribute in class GradientBase

Parameters:

attributeName - localName of the XML attribute

prefix - prefix of the XML attribute

value - value of the XML attribute

Returns:

true if the attribute has been successfully read.

hashCode

public int hashCode()

Description copied from interface: SBase

Returns a hash code value for this SBase instance.

Specified by:

hashCode in interface SBase

Overrides:

hashCode in class GradientBase

Returns:

a hash code value for this SBase instance.

See Also:

Object.hashCode()

equals

public boolean equals(java.lang.Object obj)

Description copied from interface: SBase

Returns true if and only if the given SBase has exactly the same properties like this SBase instance.

Specified by:

equals in interface SBase

Overrides:

equals in class GradientBase

Parameters:

obj - the SBase to be compared to.

Returns:

true if and only if the given Object is an instance of SBase that has exactly the same properties like this SBase instance.