org.sbml.jsbml.ext.render

Class GradientBase

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.AbstractSBase

org.sbml.jsbml.AbstractNamedSBase

org.sbml.jsbml.ext.render.GradientBase

All Implemented Interfaces:

Serializable, Cloneable, TreeNode, NamedSBase, SBase, UniqueNamedSBase, UniqueSId, TreeNodeWithChangeSupport

Direct Known Subclasses:

LinearGradient, RadialGradient

public class GradientBase
extends AbstractNamedSBase
implements UniqueNamedSBase

Since:

1.0

Author:

Eugen Netz, Alexander Diamantikos, Jakob Matthes, Jan Rudolph

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GradientBase.Spread The type GradientSpreadMethod is being used by GradientBase elements to decide how gradients propagate over the whole element they are applied to.

Field Summary

Fields

Modifier and Type	Field and Description
protected ListOf<GradientStop>	listOfGradientStops
protected GradientBase.Spread	spreadMethod

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	addGradientStop(GradientStop field)
GradientBase	clone()
GradientStop	createGradientStop(double offset, String stopColor) create a new GradientStop element and adds it to the ListOfGradientStops list
boolean	equals(Object obj)
boolean	getAllowsChildren()
TreeNode	getChildAt(int index)
int	getChildCount()
ListOf<GradientStop>	getListOfGradientStops()
GradientBase.Spread	getSpreadMethod()
int	hashCode()
void	initDefaults() Initializes the default values using the namespace.
boolean	isIdMandatory()
boolean	isSetListOfGradientStops()
boolean	isSetSpreadMethod()
boolean	readAttribute(String attributeName, String prefix, String value)
boolean	removeGradientStop(GradientStop field)
void	removeGradientStop(int i)
void	setListOfGradientStops(ListOf<GradientStop> listOfGradientStops)
void	setSpreadMethod(GradientBase.Spread spreadMethod) Set the value of spreadMethod
boolean	unsetListOfGradientStops()
boolean	unsetSpreadMethod() Unsets the variable spreadMethod
Map<String,String>	writeXMLAttributes()

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, checkAndSetPackageNamespaceAndVersion, checkAndSetPackageNamespaceAndVersion, checkAttribute, checkIdentifier, checkLevelAndVersionCompatibility, 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, getIdManager, 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, notifyChildChange, registerChild, removeCVTerm, removeCVTerm, removeDeclaredNamespaceByNamespace, removeDeclaredNamespaceByPrefix, 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 java.lang.Object

finalize, 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, 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

Field Detail

spreadMethod

protected GradientBase.Spread spreadMethod

listOfGradientStops

protected ListOf<GradientStop> listOfGradientStops

Constructor Detail

GradientBase

public GradientBase()

Creates an GradientBase instance

GradientBase

public GradientBase(String id,
                    GradientStop stop)

Creates a GradientBase instance with an id.

Parameters:

id -

stop -

GradientBase

public GradientBase(String id,
                    GradientStop stop,
                    int level,
                    int version)

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

Parameters:

id -

stop -

level -

version -

GradientBase

public GradientBase(GradientBase obj)

Clone constructor

Parameters:

obj -

Method Detail

getAllowsChildren

public boolean getAllowsChildren()

Specified by:

getAllowsChildren in interface TreeNode

Overrides:

getAllowsChildren in class AbstractSBase

getChildCount

public int getChildCount()

Specified by:

getChildCount in interface TreeNode

Overrides:

getChildCount in class AbstractSBase

getChildAt

public TreeNode getChildAt(int index)

Specified by:

getChildAt in interface TreeNode

Overrides:

getChildAt in class AbstractSBase

clone

public GradientBase clone()

Specified by:

clone in interface SBase

Overrides:

clone in class AbstractSBase

initDefaults

public void initDefaults()

Initializes the default values using the namespace.

hashCode

public int hashCode()

Specified by:

hashCode in interface SBase

Overrides:

hashCode in class AbstractSBase

equals

public boolean equals(Object obj)

Specified by:

equals in interface SBase

Overrides:

equals in class AbstractSBase

getSpreadMethod

public GradientBase.Spread getSpreadMethod()

Returns:

the value of spreadMethod

isSetSpreadMethod

public boolean isSetSpreadMethod()

Returns:

whether spreadMethod is set

setSpreadMethod

public void setSpreadMethod(GradientBase.Spread spreadMethod)

Set the value of spreadMethod

Parameters:

spreadMethod -

unsetSpreadMethod

public boolean unsetSpreadMethod()

Unsets the variable spreadMethod

Returns:

true, if spreadMethod was set before, otherwise false

isSetListOfGradientStops

public boolean isSetListOfGradientStops()

Returns:

true, if listOfGradientStops contains at least one element, otherwise false

getListOfGradientStops

public ListOf<GradientStop> getListOfGradientStops()

Returns:

the listOfGradientStops

setListOfGradientStops

public void setListOfGradientStops(ListOf<GradientStop> listOfGradientStops)

Parameters:

listOfGradientStops -

unsetListOfGradientStops

public boolean unsetListOfGradientStops()

Returns:

true, if listOfGradientStops contained at least one element, otherwise false

addGradientStop

public boolean addGradientStop(GradientStop field)

Parameters:

field -

Returns:

removeGradientStop

public boolean removeGradientStop(GradientStop field)

Parameters:

field -

Returns:

removeGradientStop

public void removeGradientStop(int i)

Parameters:

i -

createGradientStop

public GradientStop createGradientStop(double offset,
                                       String stopColor)

create a new GradientStop element and adds it to the ListOfGradientStops list

Parameters:

offset -

stopColor -

Returns:

isIdMandatory

public boolean isIdMandatory()

Specified by:

isIdMandatory in interface NamedSBase

Specified by:

isIdMandatory in interface SBase

Overrides:

isIdMandatory in class AbstractSBase

writeXMLAttributes

public Map<String,String> writeXMLAttributes()

Specified by:

writeXMLAttributes in interface SBase

Overrides:

writeXMLAttributes in class AbstractSBase

readAttribute

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

Specified by:

readAttribute in interface SBase

Overrides:

readAttribute in class AbstractSBase