GlobalRenderInformation (LibSBML Java API)

java.lang.Object
- org.sbml.libsbml.SBase
- - org.sbml.libsbml.RenderInformationBase
  - - org.sbml.libsbml.GlobalRenderInformation

```
public class GlobalRenderInformation
extends RenderInformationBase
```
GlobalRenderInformation is the render information stored in the ListOfLayouts. GlobalRenderInformation can be applied to all layouts.
GlobalRenderInformation is one of the subclasses of RenderInformationBase. A global render information object contains color definitions, gradient definitions and line endings as defined in RenderInformationBase. Additionally it has a list of global styles which specifies type and role based render information. Global render information can not specify id based render information because it does not belong to a certain layout but it belongs to all layouts.

Constructor Summary

Constructors
Constructor and Description
`GlobalRenderInformation()` Creates a new `GlobalRenderInformation` object with the given SBML level and SBML version.
`GlobalRenderInformation(long level)` Creates a new `GlobalRenderInformation` object with the given SBML level and SBML version.
`GlobalRenderInformation(long level, long version)` Creates a new `GlobalRenderInformation` object with the given SBML level and SBML version.
`GlobalRenderInformation(long level, long version, long pkgVersion)` Creates a new `GlobalRenderInformation` object with the given SBML level and SBML version.
`GlobalRenderInformation(RenderPkgNamespaces renderns)` Creates a new `GlobalRenderInformation` object with the given `SBMLNamespaces`.
`GlobalRenderInformation(RenderPkgNamespaces renderns, java.lang.String id)` Constructor which creates a `GlobalRenderInformation` with the given `id` and all lists empty.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`addStyle(GlobalStyle pStyle)` Adds a copy of a `GlobalStyle` to the `GlobalRenderInformation` object.
`GlobalRenderInformation`	`cloneObject()` Creates and returns a deep copy of this `GlobalRenderInformation` object.
`void`	`connectToChild()`
`GlobalStyle`	`createStyle(java.lang.String id)` Creates a new `GlobalStyle` object.
`void`	`delete()` Explicitly deletes the underlying native object.
`java.lang.String`	`getElementName()` Returns the XML element name of this object, which for `GlobalRenderInformation`, is always `'renderInformation'.`
`ListOfGlobalStyles`	`getListOfStyles()` Returns a pointer to the `ListOfGlobalStyles` object.
`long`	`getNumStyles()` Returns the number of styles.
`GlobalStyle`	`getStyle(long i)` Returns a pointer to the style with the given index.
`GlobalStyle`	`getStyle(java.lang.String id)` Returns a pointer to the style with the given `id`.
`int`	`getTypeCode()` Returns the libSBML type code for this SBML object.
`void`	`parseXML(XMLNode node)` Parses the xml information in the given node and sets the attributes.
`XMLNode`	`toXML()` Creates an `XMLNode` object from this `GlobalRenderInformation` object.

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, getElementByMetaId, getElementBySId, 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, removeFromParentAndDelete, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, renameMetaIdRefs, renameSIdRefs, renameUnitSIdRefs, replaceTopLevelAnnotationElement, replaceTopLevelAnnotationElement, setAnnotation, setAnnotation, setMetaId, setModelHistory, setNamespaces, setNotes, setNotes, setNotes, setSBOTerm, setSBOTerm, toSBML, toXMLNode, unsetAnnotation, unsetCVTerms, unsetMetaId, unsetModelHistory, unsetNotes, unsetSBOTerm, unsetUserData

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

- Constructor Detail
  - GlobalRenderInformation
```
public GlobalRenderInformation(long level,
                               long version,
                               long pkgVersion)
                        throws SBMLConstructorException
```
    Creates a new GlobalRenderInformation object with the given SBML level and SBML version.
    
    Parameters:
    
    level - SBML level of the new object
    
    level - SBML version of the new object
    
    Throws:
    
    SBMLConstructorException
  - GlobalRenderInformation
```
public GlobalRenderInformation(long level,
                               long version)
                        throws SBMLConstructorException
```
    Creates a new GlobalRenderInformation object with the given SBML level and SBML version.
    
    Parameters:
    
    level - SBML level of the new object
    
    level - SBML version of the new object
    
    Throws:
    
    SBMLConstructorException
  - GlobalRenderInformation
```
public GlobalRenderInformation(long level)
                        throws SBMLConstructorException
```
    Creates a new GlobalRenderInformation object with the given SBML level and SBML version.
    
    Parameters:
    
    level - SBML level of the new object
    
    level - SBML version of the new object
    
    Throws:
    
    SBMLConstructorException
  - GlobalRenderInformation
```
public GlobalRenderInformation()
                        throws SBMLConstructorException
```
    Creates a new GlobalRenderInformation object with the given SBML level and SBML version.
    
    Parameters:
    
    level - SBML level of the new object
    
    level - SBML version of the new object
    
    Throws:
    
    SBMLConstructorException
  - GlobalRenderInformation
```
public GlobalRenderInformation(RenderPkgNamespaces renderns)
                        throws SBMLConstructorException
```
    Creates a new GlobalRenderInformation object with the given SBMLNamespaces.
    
    Parameters:
    
    sbmlns - The SBML namespace for the object.
    
    Throws:
    
    SBMLConstructorException
  - GlobalRenderInformation
```
public GlobalRenderInformation(RenderPkgNamespaces renderns,
                               java.lang.String id)
                        throws SBMLConstructorException
```
    Constructor which creates a GlobalRenderInformation with the given id and all lists empty.
    
    Parameters:
    
    id - the new id for the GlobalRenderInformation.
    This constructor is deprecated. The new libsbml API only has constructors which take the SBML level and version or one that takes an SBMLNamespaces object.
    
    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 GlobalRenderInformation.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 GlobalRenderInformation.delete() themselves.
    
    Overrides:
    
    delete in class RenderInformationBase
  - parseXML
```
public void parseXML(XMLNode node)
```
    Parses the xml information in the given node and sets the attributes. This method should never be called by the user. It is only used to read render information from annotations.
    
    Parameters:
    
    node - the XMLNode object reference that describes the GlobalRenderInformation object to be instantiated.
  - getNumStyles
```
public long getNumStyles()
```
    Returns the number of styles.
    
    Returns:
    
    the number of global styles in the global render information object
  - getListOfStyles
```
public ListOfGlobalStyles getListOfStyles()
```
    Returns a pointer to the ListOfGlobalStyles object.
    
    Returns:
    
    pointer to the list of global styles.
  - getStyle
```
public GlobalStyle getStyle(long i)
```
    Returns a pointer to the style with the given index. If the index is invalid, null is returned.
    
    Parameters:
    
    i - index of the GlobalStyle to be returned.
    
    Returns:
    
    pointer to the style with the given index or null
  - getStyle
```
public GlobalStyle getStyle(java.lang.String id)
```
    Returns a pointer to the style with the given id. If the id is invalid, null is returned.
    
    Parameters:
    
    id - id of the GlobalStyle to be returned.
    
    Returns:
    
    pointer to the style with the given id or null
  - createStyle
```
public GlobalStyle createStyle(java.lang.String id)
```
    Creates a new GlobalStyle object. The object is added to and owned by the GlobalRenderInformation object.
    
    Parameters:
    
    id - for the new style.
  - addStyle
```
public int addStyle(GlobalStyle pStyle)
```
    Adds a copy of a GlobalStyle to the GlobalRenderInformation object. The style is only added if it is valid, i.e. it has to have an id and a valid group.
    Parameters:
    
    pointer - to the global style object to be added.
    
    Returns:
    integer value indicating success/failure of the function. The possible values returned by this function are:
    
    LIBSBML_OPERATION_SUCCESS
    LIBSBML_LEVEL_MISMATCH
    LIBSBML_VERSION_MISMATCH
    LIBSBML_OPERATION_FAILED
    See Also:
    
    #createStyle()
    
    "Note:"
    
    This method should be used with some caution. The fact that this method copies the object passed to it means that the caller will be left holding a physically different object instance than the one contained in this GlobalRenderInformation. Changes made to the original object instance (such as resetting attribute values) will not affect the instance in the GlobalRenderInformation. In addition, the caller should make sure to free the original object if it is no longer being used, or else a memory leak will result. Please see GlobalRenderInformation#createStyle() for a method that does not lead to these issues.
  - getElementName
```
public java.lang.String getElementName()
```
    Returns the XML element name of this object, which for GlobalRenderInformation, is always 'renderInformation'.
    
    Overrides:
    
    getElementName in class SBase
    
    Returns:
    
    the name of this element, i.e., 'renderInformation'.
  - cloneObject
```
public GlobalRenderInformation cloneObject()
```
    Creates and returns a deep copy of this GlobalRenderInformation object.
    
    Overrides:
    
    cloneObject in class SBase
    
    Returns:
    
    a (deep) copy of this GlobalRenderInformation.
  - getTypeCode
```
public int getTypeCode()
```
    Returns the libSBML type code for this SBML object.
    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_.
    
    Overrides:
    
    getTypeCode in class SBase
    
    Returns:
    
    the SBML type code for this object, or SBML_UNKNOWN (default).
    
    See Also:
    
    GlobalRenderInformation.getElementName()
  - toXML
```
public XMLNode toXML()
```
    Creates an XMLNode object from this GlobalRenderInformation object.
    
    Returns:
    
    the XMLNode with the XML representation for the GlobalRenderInformation object.
  - connectToChild
```
public void connectToChild()
```
    Overrides:
    
    connectToChild in class RenderInformationBase

Class GlobalRenderInformation

Constructor Summary

Method Summary

Methods inherited from class org.sbml.libsbml.RenderInformationBase

Methods inherited from class org.sbml.libsbml.SBase

Methods inherited from class java.lang.Object

Constructor Detail

GlobalRenderInformation

GlobalRenderInformation

GlobalRenderInformation

GlobalRenderInformation

GlobalRenderInformation

GlobalRenderInformation

Method Detail

delete

parseXML

getNumStyles

getListOfStyles

getStyle

getStyle

createStyle

addStyle

getElementName

cloneObject

getTypeCode

toXML

connectToChild