public class LocalRenderInformation extends RenderInformationBase
LocalRenderInformation
is the render information stored in Layouts.
LocalRenderInformation
can be applied to all layouts.
LocalRenderInformation
is one of the subclasses of RenderInformationBase
. A local render information object
contains color definitions, gradient definitions and line endings as defined in RenderInformationBase
.
Additionally it has a list of local styles which specifies type, role and id based render information.
Local render information can specify id based render information because it does belong to a certain layout and it can reference ids of object in that layout.
Constructor and Description |
---|
LocalRenderInformation()
Creates a new
LocalRenderInformation object with the given SBML level
and SBML version. |
LocalRenderInformation(long level)
Creates a new
LocalRenderInformation object with the given SBML level
and SBML version. |
LocalRenderInformation(long level,
long version)
Creates a new
LocalRenderInformation object with the given SBML level
and SBML version. |
LocalRenderInformation(long level,
long version,
long pkgVersion)
Creates a new
LocalRenderInformation object with the given SBML level
and SBML version. |
LocalRenderInformation(RenderPkgNamespaces renderns)
Creates a new
LocalRenderInformation object with the given SBMLNamespaces . |
LocalRenderInformation(RenderPkgNamespaces renderns,
java.lang.String id)
Constructor which creates a
LocalRenderInformation with the given id
and all lists empty. |
Modifier and Type | Method and Description |
---|---|
int |
addStyle(LocalStyle pStyle)
Adds a copy of a
LocalStyle to the GlobalRenderInformation object. |
LocalRenderInformation |
cloneObject()
Creates and returns a deep copy of this
LocalRenderInformation object. |
void |
connectToChild()   |
LocalStyle |
createStyle(java.lang.String id)
Creates a new
LocalStyle object. |
void |
delete()
Explicitly deletes the underlying native object.
|
java.lang.String |
getElementName()
Returns the XML element name of this object, which for
LocalRenderInformation , is always 'renderInformation'. |
ListOfLocalStyles |
getListOfStyles()
Returns a pointer to the
ListOfLocalStyles object. |
long |
getNumStyles()
Returns the number of styles.
|
LocalStyle |
getStyle(long i)
Returns a pointer to the style with the given index.
|
LocalStyle |
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 LocalRenderInformation object. |
addColorDefinition, addGradientDefinition, addLineEnding, createColorDefinition, createLinearGradientDefinition, createLineEnding, createRadialGradientDefinition, getBackgroundColor, getColorDefinition, getColorDefinition, getGradientDefinition, getGradientDefinition, getId, getLineEnding, getLineEnding, getListOfColorDefinitions, getListOfGradientDefinitions, getListOfLineEndings, getName, getNumColorDefinitions, getNumGradientDefinitions, getNumLineEndings, getProgramName, getProgramVersion, getReferenceRenderInformationId, isSetId, isSetName, removeColorDefinition, removeGradientDefinition, removeLineEnding, setBackgroundColor, setId, setName, setProgramName, setProgramVersion, setReferenceRenderInformationId, unsetId, unsetName
addCVTerm, addCVTerm, appendAnnotation, appendAnnotation, appendNotes, appendNotes, deleteDisabledPlugins, deleteDisabledPlugins, disablePackage, enablePackage, equals, getAncestorOfType, getAncestorOfType, getAnnotation, getAnnotationString, getColumn, getCVTerm, getCVTerms, getDisabledPlugin, getElementByMetaId, getElementBySId, getIdAttribute, getLevel, getLine, getListOfAllElements, getListOfAllElements, getListOfAllElementsFromPlugins, getListOfAllElementsFromPlugins, getMetaId, getModel, getModelHistory, getNamespaces, getNotes, getNotesString, getNumCVTerms, getNumDisabledPlugins, getNumPlugins, getObjectVersion, getPackageName, getPackageVersion, getParentSBMLObject, getPlugin, getPlugin, getPrefix, getResourceBiologicalQualifier, getResourceModelQualifier, getSBMLDocument, getSBOTerm, getSBOTermAsURL, getSBOTermID, getURI, getVersion, hashCode, hasValidLevelVersionNamespaceCombination, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetIdAttribute, isSetMetaId, isSetModelHistory, isSetNotes, isSetSBOTerm, isSetUserData, matchesRequiredSBMLNamespacesForAddition, matchesSBMLNamespaces, removeFromParentAndDelete, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, renameMetaIdRefs, renameSIdRefs, renameUnitSIdRefs, replaceTopLevelAnnotationElement, replaceTopLevelAnnotationElement, setAnnotation, setAnnotation, setIdAttribute, setMetaId, setModelHistory, setNamespaces, setNotes, setNotes, setNotes, setSBOTerm, setSBOTerm, toSBML, toXMLNode, unsetAnnotation, unsetCVTerms, unsetIdAttribute, unsetMetaId, unsetModelHistory, unsetNotes, unsetSBOTerm, unsetUserData
public LocalRenderInformation(long level, long version, long pkgVersion) throws SBMLConstructorException
LocalRenderInformation
object with the given SBML level
and SBML version.
level
- SBML level of the new objectlevel
- SBML version of the new objectSBMLConstructorException
public LocalRenderInformation(long level, long version) throws SBMLConstructorException
LocalRenderInformation
object with the given SBML level
and SBML version.
level
- SBML level of the new objectlevel
- SBML version of the new objectSBMLConstructorException
public LocalRenderInformation(long level) throws SBMLConstructorException
LocalRenderInformation
object with the given SBML level
and SBML version.
level
- SBML level of the new objectlevel
- SBML version of the new objectSBMLConstructorException
public LocalRenderInformation() throws SBMLConstructorException
LocalRenderInformation
object with the given SBML level
and SBML version.
level
- SBML level of the new objectlevel
- SBML version of the new objectSBMLConstructorException
public LocalRenderInformation(RenderPkgNamespaces renderns) throws SBMLConstructorException
LocalRenderInformation
object with the given SBMLNamespaces
.
sbmlns
- The SBML namespace for the object.SBMLConstructorException
public LocalRenderInformation(RenderPkgNamespaces renderns, java.lang.String id) throws SBMLConstructorException
LocalRenderInformation
with the given id
and all lists empty.
id
- the new id for the LocalRenderInformation
.
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.
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 LocalRenderInformation.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 LocalRenderInformation.delete()
themselves.
delete
 in class RenderInformationBase
public void parseXML(XMLNode node)
node
- the XMLNode
object reference that describes the LocalRenderInformation
object to be instantiated.public long getNumStyles()
public LocalRenderInformation cloneObject()
LocalRenderInformation
object.
cloneObject
 in class SBase
LocalRenderInformation
.public ListOfLocalStyles getListOfStyles()
ListOfLocalStyles
object.
public LocalStyle getStyle(long i)
null
is returned.
i
- index of the LocalStyle
to be returned.
public LocalStyle getStyle(java.lang.String id)
id
.
If the id is invalid, null
is returned.
id
- id of the LocalStyle
to be returned.
id
or null
public LocalStyle createStyle(java.lang.String id)
LocalStyle
object. The object is added to and owned
by the LocalRenderInformation
object.
id
- for the new style.
public int addStyle(LocalStyle pStyle)
LocalStyle
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.
pointer
- to the local style object to be added.
#createStyle()
LocalRenderInformation
. Changes made to the original object
instance (such as resetting attribute values) will not affect the
instance in the LocalRenderInformation
. 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 LocalRenderInformation#createStyle()
for a method that does not lead to these issues.
public XMLNode toXML()
XMLNode
object from this LocalRenderInformation
object.
XMLNode
with the XML representation for the
LocalRenderInformation
object.public java.lang.String getElementName()
LocalRenderInformation
, is always 'renderInformation'.
getElementName
 in class SBase
'renderInformation'.
public int getTypeCode()
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 SBase
SBML_UNKNOWN
(default).
LocalRenderInformation.getElementName()
public void connectToChild()
connectToChild
 in class RenderInformationBase