org.sbml.jsbml.ext.render

Class GradientStop

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.AbstractSBase

org.sbml.jsbml.ext.render.GradientStop

All Implemented Interfaces:

Serializable, Cloneable, TreeNode, SBase, TreeNodeWithChangeSupport

public class GradientStop
extends AbstractSBase

Since:

1.0

Author:

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

See Also:

Serialized Form

Field Summary

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
GradientStop()
GradientStop(double offset, String stopColor) Convenience-constructor: As by the specification, the offset ought to be purely relative-valued (i.e.e.g.
GradientStop(GradientStop obj) Clone constructor
GradientStop(RelAbsVector offset, String stopColor) Creates a GradientStop instance with an offset and a color.
GradientStop(RelAbsVector offset, String stopColor, int level, int version) Creates a GradientStop instance with an offset, color, level, and version.

Method Summary

Modifier and Type	Method and Description
GradientStop	clone()
boolean	equals(Object obj)
boolean	getAllowsChildren()
SBase	getChildAt(int childIndex)
int	getChildCount()
String	getElementName()
RelAbsVector	getOffset()
String	getStopColor()
int	hashCode()
void	initDefaults() Initializes the default values using the namespace.
boolean	isSetOffset()
boolean	isSetStopColor()
boolean	readAttribute(String attributeName, String prefix, String value)
void	setOffset(RelAbsVector offset) Set the value of offset
void	setStopColor(String stopColor) Set the value of stopColor
boolean	unsetOffset() Unsets the variable offset
boolean	unsetStopColor() Unsets the variable stopColor
Map<String,String>	writeXMLAttributes()

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, 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, 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 java.lang.Object

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

Methods inherited from interface org.sbml.jsbml.SBase

removeTreeNodeChangeListener

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

Methods inherited from interface javax.swing.tree.TreeNode

children, getIndex, isLeaf

Constructor Detail

GradientStop

public GradientStop(RelAbsVector offset,
                    String stopColor)

Creates a GradientStop instance with an offset and a color.

Parameters:

offset -

stopColor -

GradientStop

public GradientStop(double offset,
                    String stopColor)

Convenience-constructor: As by the specification, the offset ought to be purely relative-valued (i.e.e.g. 25d for 25%), the absolute part of the RelAbsVector is to be ignored anyways.

Parameters:

offset -

stopColor -

GradientStop

public GradientStop(RelAbsVector offset,
                    String stopColor,
                    int level,
                    int version)

Creates a GradientStop instance with an offset, color, level, and version.

Parameters:

offset -

stopColor -

level -

version -

GradientStop

public GradientStop(GradientStop obj)

Clone constructor

Parameters:

obj -

GradientStop

public GradientStop()

Method Detail

clone

public GradientStop 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

getAllowsChildren

public boolean getAllowsChildren()

Specified by:

getAllowsChildren in interface TreeNode

Overrides:

getAllowsChildren in class AbstractSBase

getChildAt

public SBase getChildAt(int childIndex)

Specified by:

getChildAt in interface TreeNode

Overrides:

getChildAt in class AbstractSBase

getChildCount

public int getChildCount()

Specified by:

getChildCount in interface TreeNode

Overrides:

getChildCount in class AbstractSBase

getElementName

public String getElementName()

Specified by:

getElementName in interface SBase

Overrides:

getElementName in class AbstractSBase

getOffset

public RelAbsVector getOffset()

Returns:

the value of offset

getStopColor

public String getStopColor()

Returns:

the value of stopColor

isSetOffset

public boolean isSetOffset()

Returns:

whether offset is set

isSetStopColor

public boolean isSetStopColor()

Returns:

whether stopColor is set

setOffset

public void setOffset(RelAbsVector offset)

Set the value of offset

Parameters:

offset -

setStopColor

public void setStopColor(String stopColor)

Set the value of stopColor

Parameters:

stopColor -

unsetOffset

public boolean unsetOffset()

Unsets the variable offset

Returns:

true, if offset was set before, otherwise false

unsetStopColor

public boolean unsetStopColor()

Unsets the variable stopColor

Returns:

true, if stopColor was set before, otherwise false

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