public class ListOfGlobalStyles extends ListOf
ListOfGlobalStyles
is the container class that stores GlobalStyles in GlobalRenderInformation
objects.
Each GlobalRenderInformation
object contains a ListOfGlobalStyles
which contains zero or
more global style objects.
Constructor and Description |
---|
ListOfGlobalStyles()
Constructor which instantiates an empty
ListOfGlobalStyles object. |
ListOfGlobalStyles(ListOfGlobalStyles source)
Copy constructor for
ListOfGlobalStyles objects. |
ListOfGlobalStyles(long level)
Constructor which instantiates an empty
ListOfGlobalStyles object. |
ListOfGlobalStyles(long level,
long version)
Constructor which instantiates an empty
ListOfGlobalStyles object. |
ListOfGlobalStyles(long level,
long version,
long pkgVersion)
Constructor which instantiates an empty
ListOfGlobalStyles object. |
ListOfGlobalStyles(RenderPkgNamespaces renderns)
Ctor.
|
ListOfGlobalStyles(XMLNode node)
Creates a new
ListOfGlobalStyles object from the given XMLNode object. |
Modifier and Type | Method and Description |
---|---|
ListOfGlobalStyles |
cloneObject()
Creates and returns a deep copy of the
ListOfGlobalStyles object. |
void |
delete()
Explicitly deletes the underlying native object.
|
GlobalStyle |
get(long i)
Returns a pointer to the
GlobalStyle with the given index or null if
the index is invalid. |
GlobalStyle |
get(String id)
|
String |
getElementName()
Returns the XML element name of this object, which for
ListOfGlobalStyles , is always 'listOfStyles'. |
int |
getItemTypeCode()
Get the type code of the objects contained in this
ListOf . |
int |
getTypeCode()
Returns the libSBML type code for the objects contained in this
ListOf
(i.e., GradientDefinition objects, if the list is non-empty). |
GlobalStyle |
remove(long n)
Removes the nth item from this
ListOfGlobalStyles items and returns a pointer to
it. |
GlobalStyle |
remove(String sid)
Removes item in this
ListOfGlobalStyles items with the given identifier. |
XMLNode |
toXML()
Creates an
XMLNode object from this ListOfGlobalStyles object. |
append, appendAndOwn, appendFrom, clear, clear, connectToChild, getElementByMetaId, getElementBySId, insert, insertAndOwn, removeFromParentAndDelete, size
addCVTerm, addCVTerm, appendAnnotation, appendAnnotation, appendNotes, appendNotes, deleteDisabledPlugins, deleteDisabledPlugins, disablePackage, enablePackage, equals, getAncestorOfType, getAncestorOfType, getAnnotation, getAnnotationString, getColumn, getCVTerm, getCVTerms, getDisabledPlugin, getLevel, getLine, getListOfAllElements, getListOfAllElements, getListOfAllElementsFromPlugins, getListOfAllElementsFromPlugins, getMetaId, getModel, getModelHistory, getNamespaces, getNotes, getNotesString, getNumCVTerms, getNumDisabledPlugins, getNumPlugins, getPackageName, getPackageVersion, getParentSBMLObject, getPlugin, getPlugin, getPrefix, getResourceBiologicalQualifier, getResourceModelQualifier, getSBMLDocument, getSBOTerm, getSBOTermAsURL, getSBOTermID, getURI, getVersion, hashCode, hasValidLevelVersionNamespaceCombination, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetMetaId, isSetModelHistory, isSetNotes, isSetSBOTerm, isSetUserData, 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, unsetUserData
public ListOfGlobalStyles(XMLNode node) throws SBMLConstructorException
ListOfGlobalStyles
object from the given XMLNode
object.
The XMLNode
object has to contain a valid XML representation of a
ListOfGlobalStyles
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 explicitly.
node
- the XMLNode
object reference that describes the ListOfGlobalStyles
object to be instantiated.SBMLConstructorException
public ListOfGlobalStyles(long level, long version, long pkgVersion) throws SBMLConstructorException
ListOfGlobalStyles
object.SBMLConstructorException
public ListOfGlobalStyles(long level, long version) throws SBMLConstructorException
ListOfGlobalStyles
object.SBMLConstructorException
public ListOfGlobalStyles(long level) throws SBMLConstructorException
ListOfGlobalStyles
object.SBMLConstructorException
public ListOfGlobalStyles() throws SBMLConstructorException
ListOfGlobalStyles
object.SBMLConstructorException
public ListOfGlobalStyles(RenderPkgNamespaces renderns) throws SBMLConstructorException
SBMLConstructorException
public ListOfGlobalStyles(ListOfGlobalStyles source) throws SBMLConstructorException
ListOfGlobalStyles
objects.SBMLConstructorException
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 ListOfGlobalStyles.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 ListOfGlobalStyles.delete()
themselves.
public ListOfGlobalStyles cloneObject()
ListOfGlobalStyles
object.
cloneObject
 in class ListOf
ListOfGlobalStyles
public int getTypeCode()
ListOf
(i.e., GradientDefinition objects, if the list is non-empty).
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
interface class libsbmlConstants
. The names of the type codes
all begin with the characters SBML_.
getTypeCode
 in class ListOf
ListOf
instance, or SBML_UNKNOWN
(default).
ListOfGlobalStyles.getElementName()
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 String getElementName()
ListOfGlobalStyles
, is always 'listOfStyles'.
getElementName
 in class ListOf
'listOfStyles'.
public XMLNode toXML()
XMLNode
object from this ListOfGlobalStyles
object.
XMLNode
with the XML representation for the
ListOfGlobalStyles
object.public GlobalStyle get(long i)
GlobalStyle
with the given index or null if
the index is invalid.
get
 in class ListOf
i
- index of the GlobalStyle
object to be returned
GlobalStyle
at the given index or null.ListOf.size()
public GlobalStyle get(String id)
id
- id of the GlobalStyle
object to be returned
GlobalStyle
at the given id
or null.
public GlobalStyle remove(long n)
ListOfGlobalStyles
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 GlobalStyle remove(String sid)
ListOfGlobalStyles
items with the given identifier.
The caller owns the returned item and is responsible for deleting it.
If none of the items in this list have the identifier sid
, then @c
null is returned.
sid
- the identifier of the item to remove