org.sbml.jsbml.ext.render

Class LinearGradient

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

All Implemented Interfaces:

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

public class LinearGradient
extends GradientBase

Since:

1.0

Version:

$Rev: 1722 $

Author:

Eugen Netz, Alexander Diamantikos, Jakob Matthes, Jan Rudolph

See Also:

Serialized Form

Nested Class Summary

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

GradientBase.Spread

Field Summary

Fields

Modifier and Type	Field and Description
private static long	serialVersionUID Generated serial version identifier
private java.lang.Double	x1
private java.lang.Double	x2
private java.lang.Double	y1
private java.lang.Double	y2
private java.lang.Double	z1
private java.lang.Double	z2

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

listOfGradientStops, spreadMethod

Fields inherited from class org.sbml.jsbml.AbstractSBase

ignoredExtensions, ignoredXMLElements

Fields inherited from class org.sbml.jsbml.AbstractTreeNode

listOfListeners, parent, UNKNOWN_ATTRIBUTES, UNKNOWN_ELEMENTS

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
LinearGradient	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.
boolean	getAllowsChildren()
SBase	getChildAt(int childIndex)
int	getChildCount()
double	getX1()
double	getX2()
double	getY1()
double	getY2()
double	getZ1()
double	getZ2()
int	hashCode() Returns a hash code value for this SBase instance.
void	initDefaults() Initializes the default values using the namespace.
boolean	isSetX1()
boolean	isSetX2()
boolean	isSetY1()
boolean	isSetY2()
boolean	isSetZ1()
boolean	isSetZ2()
boolean	readAttribute(java.lang.String attributeName, java.lang.String prefix, java.lang.String value) Sets the given attribute in this SBase.
void	setX1(java.lang.Double x1) Set the value of x1
void	setX2(java.lang.Double x2) Set the value of x2
void	setY1(java.lang.Double y1) Set the value of y1
void	setY2(java.lang.Double y2) Set the value of y2
void	setZ1(java.lang.Double z1) Set the value of z1
void	setZ2(java.lang.Double z2) Set the value of z2
boolean	unsetX1() Unsets the variable x1
boolean	unsetX2() Unsets the variable x2
boolean	unsetY1() Unsets the variable y1
boolean	unsetY2() Unsets the variable y2
boolean	unsetZ1() Unsets the variable z1
boolean	unsetZ2() Unsets the variable z2
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, getListOfGradientStops, getSpreadMethod, isIdMandatory, isSetListOfGradientStops, isSetSpreadMethod, removeGradientStop, removeGradientStop, setListOfGradientStops, setSpreadMethod, toString, unsetListOfGradientStops, unsetSpreadMethod

Methods inherited from class org.sbml.jsbml.AbstractNamedSBase

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

Methods inherited from class org.sbml.jsbml.AbstractSBase

addCVTerm, addDeclaredNamespace, addExtension, addPlugin, appendNotes, appendNotes, checkLevelAndVersionCompatibility, createHistory, createPlugin, disablePackage, enablePackage, enablePackage, filterCVTerms, filterCVTerms, filterCVTerms, filterCVTerms, fireNodeRemovedEvent, firePropertyChange, getAnnotation, getAnnotationString, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementName, getExtension, getExtensionCount, getExtensionPackages, getHistory, getIdManager, getLevel, getLevelAndVersion, getMetaId, getModel, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getParent, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getVersion, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetNotes, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, isValidLevelAndVersionCombination, isValidMetaId, notifyChildChange, registerChild, removeCVTerm, removeCVTerm, setAnnotation, setHistory, setLevel, setMetaId, setNamespace, setNotes, setNotes, 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.NamedSBase

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

Methods inherited from interface org.sbml.jsbml.SBase

addCVTerm, addDeclaredNamespace, addExtension, addPlugin, appendNotes, appendNotes, createPlugin, disablePackage, enablePackage, enablePackage, filterCVTerms, filterCVTerms, filterCVTerms, filterCVTerms, getAnnotation, getAnnotationString, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementName, getExtension, getExtensionCount, getExtensionPackages, getHistory, getLevel, getLevelAndVersion, getMetaId, getModel, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getVersion, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetNotes, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, registerChild, removeCVTerm, removeCVTerm, removeTreeNodeChangeListener, setAnnotation, setHistory, setLevel, setMetaId, setNotes, setNotes, 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

serialVersionUID

private static final long serialVersionUID

Generated serial version identifier

See Also:

Constant Field Values

x1

private java.lang.Double x1

y1

private java.lang.Double y1

z1

private java.lang.Double z1

x2

private java.lang.Double x2

y2

private java.lang.Double y2

z2

private java.lang.Double z2

Constructor Detail

LinearGradient

public LinearGradient()

Creates an LinearGradient instance

LinearGradient

public LinearGradient(LinearGradient obj)

Clone constructor

Method Detail

clone

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

initDefaults

public void initDefaults()

Description copied from class: GradientBase

Initializes the default values using the namespace.

Overrides:

initDefaults in class GradientBase

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.

getAllowsChildren

public boolean getAllowsChildren()

Specified by:

getAllowsChildren in interface javax.swing.tree.TreeNode

Overrides:

getAllowsChildren in class GradientBase

getChildCount

public int getChildCount()

Specified by:

getChildCount in interface javax.swing.tree.TreeNode

Overrides:

getChildCount in class GradientBase

getChildAt

public SBase getChildAt(int childIndex)

Specified by:

getChildAt in interface javax.swing.tree.TreeNode

Overrides:

getChildAt in class GradientBase

getX1

public double getX1()

Returns:

the value of x1

isSetX1

public boolean isSetX1()

Returns:

whether x1 is set

setX1

public void setX1(java.lang.Double x1)

Set the value of x1

unsetX1

public boolean unsetX1()

Unsets the variable x1

Returns:

true, if x1 was set before, otherwise false

getX2

public double getX2()

Returns:

the value of x2

isSetX2

public boolean isSetX2()

Returns:

whether x2 is set

setX2

public void setX2(java.lang.Double x2)

Set the value of x2

unsetX2

public boolean unsetX2()

Unsets the variable x2

Returns:

true, if x2 was set before, otherwise false

getY1

public double getY1()

Returns:

the value of y1

isSetY1

public boolean isSetY1()

Returns:

whether y1 is set

setY1

public void setY1(java.lang.Double y1)

Set the value of y1

unsetY1

public boolean unsetY1()

Unsets the variable y1

Returns:

true, if y1 was set before, otherwise false

getY2

public double getY2()

Returns:

the value of y2

isSetY2

public boolean isSetY2()

Returns:

whether y2 is set

setY2

public void setY2(java.lang.Double y2)

Set the value of y2

unsetY2

public boolean unsetY2()

Unsets the variable y2

Returns:

true, if y2 was set before, otherwise false

getZ1

public double getZ1()

Returns:

the value of z1

isSetZ1

public boolean isSetZ1()

Returns:

whether z1 is set

setZ1

public void setZ1(java.lang.Double z1)

Set the value of z1

unsetZ1

public boolean unsetZ1()

Unsets the variable z1

Returns:

true, if z1 was set before, otherwise false

getZ2

public double getZ2()

Returns:

the value of z2

isSetZ2

public boolean isSetZ2()

Returns:

whether z2 is set

setZ2

public void setZ2(java.lang.Double z2)

Set the value of z2

unsetZ2

public boolean unsetZ2()

Unsets the variable z2

Returns:

true, if z2 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.