public class ListOfGradientStops extends ListOf
GradientStop
objects.
The ListOfGradientStops
is used in linear and radial gradient objects to store the
GradientStop
objects that define the gradient. A valid gradient should have two or more
gradient stops.
Constructor and Description |
---|
ListOfGradientStops()
Constructor which instantiated an empty
ListOfGradientStops object. |
ListOfGradientStops(ListOfGradientStops source)
Copy constructor creates a copy of the given
ListOfGradientStops object. |
ListOfGradientStops(long level)
Constructor which instantiated an empty
ListOfGradientStops object. |
ListOfGradientStops(long level,
long version)
Constructor which instantiated an empty
ListOfGradientStops object. |
ListOfGradientStops(long level,
long version,
long pkgVersion)
Constructor which instantiated an empty
ListOfGradientStops object. |
ListOfGradientStops(RenderPkgNamespaces renderns)
Ctor.
|
ListOfGradientStops(XMLNode node)
Creates a new
ListOfGradientStops object from the given XMLNode object. |
ListOfGradientStops(XMLNode node,
long l2version)
Creates a new
ListOfGradientStops object from the given XMLNode object. |
Modifier and Type | Method and Description |
---|---|
ListOfGradientStops |
cloneObject()
Creates a deep copy of the
ListOfGradientStops object. |
void |
delete()
Explicitly deletes the underlying native object.
|
SBase |
get(long i)
Returns a pointer to the
GradientStop with the given index or null if
the index is invalid. |
java.lang.String |
getElementName()
Returns the XML element name of this object, which for
ListOfGradientStops , is always 'listOfGradientStops'. |
int |
getItemTypeCode()
Get the type code of the objects contained in this
ListOf . |
SBase |
remove(long n)
Removes the nth item from this
ListOfGradientStops items and returns a pointer to
it. |
XMLNode |
toXML()
Creates an
XMLNode object from this ListOfGradientStops object. |
append, appendAndOwn, appendFrom, clear, clear, getElementByMetaId, getElementBySId, getTypeCode, insert, insertAndOwn, removeFromParentAndDelete, size
addCVTerm, addCVTerm, appendAnnotation, appendAnnotation, appendNotes, appendNotes, disablePackage, enablePackage, equals, getAncestorOfType, getAncestorOfType, getAnnotation, getAnnotationString, getColumn, getCVTerm, getCVTerms, getLevel, getLine, getListOfAllElements, getListOfAllElements, getListOfAllElementsFromPlugins, getListOfAllElementsFromPlugins, getMetaId, getModel, getModelHistory, getNamespaces, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getPackageName, getPackageVersion, getParentSBMLObject, getPlugin, getPlugin, getPrefix, getResourceBiologicalQualifier, getResourceModelQualifier, getSBMLDocument, getSBOTerm, getSBOTermAsURL, getSBOTermID, getURI, getVersion, hashCode, hasValidLevelVersionNamespaceCombination, isPackageEnabled, isPackageURIEnabled, isSetAnnotation, isSetMetaId, isSetModelHistory, isSetNotes, isSetSBOTerm, matchesRequiredSBMLNamespacesForAddition, matchesSBMLNamespaces, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, renameMetaIdRefs, renameSIdRefs, renameUnitSIdRefs, replaceTopLevelAnnotationElement, replaceTopLevelAnnotationElement, setAnnotation, setAnnotation, setMetaId, setModelHistory, setNamespaces, setNotes, setNotes, setNotes, setSBOTerm, setSBOTerm, toSBML, toXMLNode, unsetAnnotation, unsetCVTerms, unsetId, unsetMetaId, unsetModelHistory, unsetName, unsetNotes, unsetSBOTerm
public ListOfGradientStops() throws SBMLConstructorException
ListOfGradientStops
object.SBMLConstructorException
public ListOfGradientStops(ListOfGradientStops source) throws SBMLConstructorException
ListOfGradientStops
object.
the
- ListOfGradientStops
object to be copied.SBMLConstructorException
public ListOfGradientStops(long level) throws SBMLConstructorException
ListOfGradientStops
object.SBMLConstructorException
public ListOfGradientStops(long level, long version) throws SBMLConstructorException
ListOfGradientStops
object.SBMLConstructorException
public ListOfGradientStops(long level, long version, long pkgVersion) throws SBMLConstructorException
ListOfGradientStops
object.SBMLConstructorException
public ListOfGradientStops(RenderPkgNamespaces renderns) throws SBMLConstructorException
SBMLConstructorException
public ListOfGradientStops(XMLNode node) throws SBMLConstructorException
ListOfGradientStops
object from the given XMLNode
object.
The XMLNode
object has to contain a valid XML representation of a
ListOfGradientStops
object as defined in the render extension specification.
This method is normally called when render information is read from a file and
should normally not have to be called explicitely.
node
- the XMLNode
object reference that describes the ListOfGradientStops
object to be instantiated.SBMLConstructorException
public ListOfGradientStops(XMLNode node, long l2version) throws SBMLConstructorException
ListOfGradientStops
object from the given XMLNode
object.
The XMLNode
object has to contain a valid XML representation of a
ListOfGradientStops
object as defined in the render extension specification.
This method is normally called when render information is read from a file and
should normally not have to be called explicitely.
node
- the XMLNode
object reference that describes the ListOfGradientStops
object to be instantiated.SBMLConstructorException
public ListOfGradientStops cloneObject()
ListOfGradientStops
object.
cloneObject
 in class ListOf
ListOfGradientStops
public void delete()
In general, application software will not need to call this method directly. The Java language binding for libSBML is implemented as a language wrapper that provides a Java interface to libSBML's underlying C++/C code. Some of the Java methods return objects that are linked to objects created not by Java code, but by C++ code. The Java objects wrapped around them will be deleted when the garbage collector invokes the corresponding C++ finalize()
methods for the objects. The finalize()
methods in turn call the ListOfGradientStops.delete()
method on the libSBML object.
This method is exposed in case calling programs want to ensure that the underlying object is freed immediately, and not at some arbitrary time determined by the Java garbage collector. In normal usage, callers do not need to invoke ListOfGradientStops.delete()
themselves.
public SBase get(long i)
GradientStop
with the given index or null if
the index is invalid.
get
 in class ListOf
i
- index of the GradientStop
object to be returned
GradientStop
at the given index or null.ListOf.size()
public java.lang.String getElementName()
ListOfGradientStops
, is always 'listOfGradientStops'.
getElementName
 in class ListOf
'listOfGradientStops'.
public int getItemTypeCode()
ListOf
.
LibSBML attaches an identifying code to every
kind of SBML object. These are known as SBML type codes. In
other languages, the set of type codes is stored in an enumeration in
the Java language interface for libSBML, the type codes are defined as
static integer constants in the interface class libsbmlConstants
. The names of the type codes all begin with the
characters SBML_.
getItemTypeCode
 in class ListOf
ListOf
instance, or SBML_UNKNOWN
(default).ListOf.getElementName()
,
SBase.getPackageName()
public SBase remove(long n)
ListOfGradientStops
items and returns a pointer to
it.
The caller owns the returned item and is responsible for deleting it.
remove
 in class ListOf
n
- the index of the item to remove
ListOf.size()
public XMLNode toXML()
XMLNode
object from this ListOfGradientStops
object.
XMLNode
with the XML representation for the
ListOfGradientStops
object.