ListOfLocalRenderInformation (LibSBML Java API)

java.lang.Object
- org.sbml.libsbml.SBase
- - org.sbml.libsbml.ListOf
  - - org.sbml.libsbml.ListOfLocalRenderInformation

```
public class ListOfLocalRenderInformation
extends ListOf
```
container class that stores LocalRenderInformation objects.
Layouts can contain ListOfLocalRenderInformation which holds all LocalRenderInformation objects for a certain layout.

Constructor Summary

Constructors
Constructor and Description
`ListOfLocalRenderInformation()` Constructor which instantiates an empty `ListOfLocalRenderInformation` object.
`ListOfLocalRenderInformation(ListOfLocalRenderInformation source)` Copy constructor for `ListOfLocalRenderInformation` objects.
`ListOfLocalRenderInformation(long level)` Constructor which instantiates an empty `ListOfLocalRenderInformation` object.
`ListOfLocalRenderInformation(long level, long version)` Constructor which instantiates an empty `ListOfLocalRenderInformation` object.
`ListOfLocalRenderInformation(long level, long version, long pkgVersion)` Constructor which instantiates an empty `ListOfLocalRenderInformation` object.
`ListOfLocalRenderInformation(RenderPkgNamespaces renderns)` Ctor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ListOfLocalRenderInformation`	`cloneObject()` Creates and returns a deep copy of the `ListOfLocalRenderInformation` object.
`void`	`delete()` Explicitly deletes the underlying native object.
`SBase`	`get(long i)` Returns a pointer to the `LocalRenderInformation` with the given index or null if the index is invalid.
`LocalRenderInformation`	`get(java.lang.String id)` Returns a pointer to the `LocalRenderInformation` with the given `id` or `null` if the id is invalid.
`java.lang.String`	`getElementName()` Returns the XML element name of this object, which for `ListOfLocalRenderInformation`, is always `'listOfRenderInformation'.`
`int`	`getItemTypeCode()` Get the type code of the objects contained in this `ListOf`.
`long`	`getMajorVersion()` Returns the major version of the render information list.
`long`	`getMinorVersion()` Returns the minor version of the render information list.
`java.lang.String`	`getVersionString()` Returns the version as a string.
`boolean`	`isValidTypeForList(SBase item)`
`SBase`	`remove(long n)` Removes the nth item from this `ListOfLocalRenderInformation` items and returns a pointer to it.
`LocalRenderInformation`	`remove(java.lang.String sid)` Removes item in this `ListOfLocalRenderInformation` items with the given identifier.
`void`	`setVersion(long major, long minor)` Sets the version of the render information list.
`XMLNode`	`toXML()` Creates an `XMLNode` object from this `ListOfGradientDefinitions` object.

Methods inherited from class org.sbml.libsbml.ListOf
append, appendAndOwn, appendFrom, clear, clear, connectToChild, getElementByMetaId, getElementBySId, getTypeCode, insert, insertAndOwn, removeFromParentAndDelete, size

Methods inherited from class org.sbml.libsbml.SBase
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

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ListOfLocalRenderInformation
```
public ListOfLocalRenderInformation(long level,
                                    long version,
                                    long pkgVersion)
                             throws SBMLConstructorException
```
    Constructor which instantiates an empty ListOfLocalRenderInformation object.
    
    Throws:
    
    SBMLConstructorException
  - ListOfLocalRenderInformation
```
public ListOfLocalRenderInformation(long level,
                                    long version)
                             throws SBMLConstructorException
```
    Constructor which instantiates an empty ListOfLocalRenderInformation object.
    
    Throws:
    
    SBMLConstructorException
  - ListOfLocalRenderInformation
```
public ListOfLocalRenderInformation(long level)
                             throws SBMLConstructorException
```
    Constructor which instantiates an empty ListOfLocalRenderInformation object.
    
    Throws:
    
    SBMLConstructorException
  - ListOfLocalRenderInformation
```
public ListOfLocalRenderInformation()
                             throws SBMLConstructorException
```
    Constructor which instantiates an empty ListOfLocalRenderInformation object.
    
    Throws:
    
    SBMLConstructorException
  - ListOfLocalRenderInformation
```
public ListOfLocalRenderInformation(RenderPkgNamespaces renderns)
                             throws SBMLConstructorException
```
    Ctor.
    
    Throws:
    
    SBMLConstructorException
  - ListOfLocalRenderInformation
```
public ListOfLocalRenderInformation(ListOfLocalRenderInformation source)
                             throws SBMLConstructorException
```
    Copy constructor for ListOfLocalRenderInformation objects.
    
    Throws:
    
    SBMLConstructorException
- Method Detail
  - delete
```
public void delete()
```
    Explicitly deletes the underlying native object.
    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 ListOfLocalRenderInformation.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 ListOfLocalRenderInformation.delete() themselves.
    
    Overrides:
    
    delete in class ListOf
  - cloneObject
```
public ListOfLocalRenderInformation cloneObject()
```
    Creates and returns a deep copy of the ListOfLocalRenderInformation object.
    
    Overrides:
    
    cloneObject in class ListOf
    
    Returns:
    
    a (deep) copy of this ListOfLocalRenderInformation
  - getElementName
```
public java.lang.String getElementName()
```
    Returns the XML element name of this object, which for ListOfLocalRenderInformation, is always 'listOfRenderInformation'.
    
    Overrides:
    
    getElementName in class ListOf
    
    Returns:
    
    the name of this element, i.e., 'listOfRenderInformation'.
  - toXML
```
public XMLNode toXML()
```
    Creates an XMLNode object from this ListOfGradientDefinitions object.
    
    Returns:
    
    the XMLNode with the XML representation for the ListOfGradientDefinitions object.
  - setVersion
```
public void setVersion(long major,
                       long minor)
```
    Sets the version of the render information list. The version consists of a major and a minor version number.
    
    Parameters:
    
    major - major version number
    
    minor - minor version number
  - getMajorVersion
```
public long getMajorVersion()
```
    Returns the major version of the render information list.
    
    Returns:
    
    the major version number of the local render information list
  - getMinorVersion
```
public long getMinorVersion()
```
    Returns the minor version of the render information list.
    
    Returns:
    
    the minor version number of the local render information list
  - getVersionString
```
public java.lang.String getVersionString()
```
    Returns the version as a string.
    
    Returns:
    
    the version of the LocalRenderInformation object as a string
  - get
```
public SBase get(long i)
```
    Returns a pointer to the LocalRenderInformation with the given index or null if the index is invalid.
    
    Overrides:
    
    get in class ListOf
    
    Parameters:
    
    i - index of the LocalRenderInformation object to be returned
    
    Returns:
    
    pointer to the LocalRenderInformation at the given index or null.
    
    See Also:
    
    ListOf.size()
  - get
```
public LocalRenderInformation get(java.lang.String id)
```
    Returns a pointer to the LocalRenderInformation with the given id or null if the id is invalid.
    
    Parameters:
    
    id - id of the LocalRenderInformation object to be returned
    
    Returns:
    
    pointer to the LocalRenderInformation at the given id or null.
  - remove
```
public SBase remove(long n)
```
    Removes the nth item from this ListOfLocalRenderInformation items and returns a pointer to it.
    The caller owns the returned item and is responsible for deleting it.
    
    Overrides:
    
    remove in class ListOf
    
    Parameters:
    
    n - the index of the item to remove
    
    See Also:
    
    ListOf.size()
  - remove
```
public LocalRenderInformation remove(java.lang.String sid)
```
    Removes item in this ListOfLocalRenderInformation 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.
    
    Parameters:
    
    sid - the identifier of the item to remove
    
    Returns:
    
    the item removed. As mentioned above, the caller owns the returned item.
  - getItemTypeCode
```
public int getItemTypeCode()
```
    Get the type code of the objects contained in this 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_.
    
    Overrides:
    
    getItemTypeCode in class ListOf
    
    Returns:
    
    the SBML type code for the objects contained in this ListOf instance, or SBML_UNKNOWN (default).
    
    See Also:
    
    ListOf.getElementName(), SBase.getPackageName()
  - isValidTypeForList
```
public boolean isValidTypeForList(SBase item)
```

Class ListOfLocalRenderInformation

Constructor Summary

Method Summary

Methods inherited from class org.sbml.libsbml.ListOf

Methods inherited from class org.sbml.libsbml.SBase

Methods inherited from class java.lang.Object

Constructor Detail

ListOfLocalRenderInformation

ListOfLocalRenderInformation

ListOfLocalRenderInformation

ListOfLocalRenderInformation

ListOfLocalRenderInformation

ListOfLocalRenderInformation

Method Detail

delete

cloneObject

getElementName

toXML

setVersion

getMajorVersion

getMinorVersion

getVersionString

get

get

remove

remove

getItemTypeCode

isValidTypeForList