org.sbml.libsbml

Class TextGlyph

java.lang.Object

org.sbml.libsbml.SBase

org.sbml.libsbml.GraphicalObject

org.sbml.libsbml.TextGlyph

public class TextGlyph
extends GraphicalObject

layout The TextGlyph class describes the position and dimension of text labels in the &ldquolayout&rdquo package.

It inherits from GraphicalObject and adds the attributes graphicalObject, text and originOfText.

Constructor Summary

Constructors

Constructor and Description
TextGlyph() Creates a new TextGlyph with the given SBML level, versin and package version.
TextGlyph(LayoutPkgNamespaces layoutns) Ctor.
TextGlyph(LayoutPkgNamespaces layoutns, java.lang.String id) Creates a new TextGlyph.
TextGlyph(LayoutPkgNamespaces layoutns, java.lang.String id, java.lang.String text) Creates a new TextGlyph.
TextGlyph(long level) Creates a new TextGlyph with the given SBML level, versin and package version.
TextGlyph(long level, long version) Creates a new TextGlyph with the given SBML level, versin and package version.
TextGlyph(long level, long version, long pkgVersion) Creates a new TextGlyph with the given SBML level, versin and package version.
TextGlyph(TextGlyph source) Copy constructor.
TextGlyph(XMLNode node) Creates a new TextGlyph from the given XMLNode
TextGlyph(XMLNode node, long l2version) Creates a new TextGlyph from the given XMLNode

Method Summary

Methods

Modifier and Type	Method and Description
TextGlyph	cloneObject() Creates and returns a deep copy of this TextGlyph.
void	delete() Explicitly deletes the underlying native object.
java.lang.String	getElementName() Returns the XML element name of this SBML object.
java.lang.String	getGraphicalObjectId() Returns the id of the associated graphical object.
java.lang.String	getOriginOfTextId() Returns the id of the origin of text.
java.lang.String	getText() Returns the text to be displayed by the text glyph.
int	getTypeCode() Returns the libSBML type code of this object instance.
void	initDefaults() Calls initDefaults from GraphicalObject.
boolean	isSetGraphicalObjectId() Returns true if the id of the associated graphical object is not the empty string.
boolean	isSetOriginOfTextId() Returns true if the id of the origin of text is not the empty string.
boolean	isSetText() Returns true if the text is not the empty string.
void	renameSIdRefs(java.lang.String oldid, java.lang.String newid) Renames all the SIdRef attributes on this element, including any found in MathML content (if such exists).
int	setGraphicalObjectId(java.lang.String id) Sets the id of the associated graphical object.
int	setOriginOfTextId(java.lang.String orig) Sets the id of the origin of text.
void	setText(java.lang.String text) Sets the text to be displayed by the text glyph.
XMLNode	toXML() Creates an XMLNode object from this.

Methods inherited from class org.sbml.libsbml.GraphicalObject

getBoundingBox, getBoundingBoxExplicitlySet, getId, getMetaIdRef, isSetId, isSetMetaIdRef, renameMetaIdRefs, setBoundingBox, setId, setMetaIdRef, unsetId, unsetMetaIdRef

Methods inherited from class org.sbml.libsbml.SBase

addCVTerm, addCVTerm, appendAnnotation, appendAnnotation, appendNotes, appendNotes, disablePackage, enablePackage, equals, getAncestorOfType, getAncestorOfType, getAnnotation, getAnnotationString, getColumn, getCVTerm, getCVTerms, getElementByMetaId, getElementBySId, 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, removeFromParentAndDelete, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, renameUnitSIdRefs, replaceTopLevelAnnotationElement, replaceTopLevelAnnotationElement, setAnnotation, setAnnotation, setMetaId, setModelHistory, setNamespaces, setNotes, setNotes, setNotes, setSBOTerm, setSBOTerm, toSBML, toXMLNode, unsetAnnotation, unsetCVTerms, unsetMetaId, unsetModelHistory, unsetName, unsetNotes, unsetSBOTerm

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TextGlyph

public TextGlyph()
          throws SBMLConstructorException

Creates a new TextGlyph with the given SBML level, versin and package version. The ids of the associated GraphicalObject and the originOfText are set to the empty string. The actual text is set to the empty string as well.

Throws:

SBMLConstructorException

TextGlyph

public TextGlyph(LayoutPkgNamespaces layoutns)
          throws SBMLConstructorException

Ctor.

Throws:

SBMLConstructorException

TextGlyph

public TextGlyph(LayoutPkgNamespaces layoutns,
         java.lang.String id)
          throws SBMLConstructorException

Creates a new TextGlyph. The id is given as the first argument.

(FOR BACKWARD COMPATIBILITY)

Throws:

SBMLConstructorException

TextGlyph

public TextGlyph(LayoutPkgNamespaces layoutns,
         java.lang.String id,
         java.lang.String text)
          throws SBMLConstructorException

Creates a new TextGlyph. The id is given as the first argument, the text to be displayed as the second. All other attirbutes are set to the empty string.

(FOR BACKWARD COMPATIBILITY)

Throws:

SBMLConstructorException

TextGlyph

public TextGlyph(long level)
          throws SBMLConstructorException

Creates a new TextGlyph with the given SBML level, versin and package version. The ids of the associated GraphicalObject and the originOfText are set to the empty string. The actual text is set to the empty string as well.

Throws:

SBMLConstructorException

TextGlyph

public TextGlyph(long level,
         long version)
          throws SBMLConstructorException

Creates a new TextGlyph with the given SBML level, versin and package version. The ids of the associated GraphicalObject and the originOfText are set to the empty string. The actual text is set to the empty string as well.

Throws:

SBMLConstructorException

TextGlyph

public TextGlyph(long level,
         long version,
         long pkgVersion)
          throws SBMLConstructorException

Creates a new TextGlyph with the given SBML level, versin and package version. The ids of the associated GraphicalObject and the originOfText are set to the empty string. The actual text is set to the empty string as well.

Throws:

SBMLConstructorException

TextGlyph

public TextGlyph(TextGlyph source)
          throws SBMLConstructorException

Copy constructor.

Throws:

SBMLConstructorException

TextGlyph

public TextGlyph(XMLNode node)
          throws SBMLConstructorException

Creates a new TextGlyph from the given XMLNode

(FOR BACKWARD COMPATIBILITY)

Throws:

SBMLConstructorException

TextGlyph

public TextGlyph(XMLNode node,
         long l2version)
          throws SBMLConstructorException

Creates a new TextGlyph from the given XMLNode

(FOR BACKWARD COMPATIBILITY)

Throws:

SBMLConstructorException

Method Detail

cloneObject

public TextGlyph cloneObject()

Creates and returns a deep copy of this TextGlyph.

Overrides:

cloneObject in class GraphicalObject

Returns:

a (deep) copy of this TextGlyph.

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 TextGlyph.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 TextGlyph.delete() themselves.

Overrides:

delete in class GraphicalObject

getElementName

public java.lang.String getElementName()

Returns the XML element name of this SBML object.

Overrides:

getElementName in class GraphicalObject

getGraphicalObjectId

public java.lang.String getGraphicalObjectId()

Returns the id of the associated graphical object.

getOriginOfTextId

public java.lang.String getOriginOfTextId()

Returns the id of the origin of text.

getText

public java.lang.String getText()

Returns the text to be displayed by the text glyph.

getTypeCode

public int getTypeCode()

Returns the libSBML type code of this object instance.

LibSBML attaches an identifying code to every kind of SBML object. These are integer constants known as SBML type codes. The names of all the codes begin with the characters &ldquoSBML_&rdquo. In the Java language interface for libSBML, the type codes are defined as static integer constants in the interface class libsbmlConstants. Note that different Level 3 package plug-ins may use overlapping type codes to identify the package to which a given object belongs, call the getPackageName() method on the object.

Overrides:

getTypeCode in class GraphicalObject

Returns:

the SBML type code for this object: SBML_LAYOUT_TEXTGLYPH

See Also:

TextGlyph.getElementName(), SBase.getPackageName()

"Warning:"

The specific integer values of the possible type codes may be reused by different Level 3 package plug-ins. Thus, to identifiy the correct code, it is necessary to invoke both getTypeCode() and getPackageName().

initDefaults

public void initDefaults()

Calls initDefaults from GraphicalObject.

Overrides:

initDefaults in class GraphicalObject

isSetGraphicalObjectId

public boolean isSetGraphicalObjectId()

Returns true if the id of the associated graphical object is not the empty string.

isSetOriginOfTextId

public boolean isSetOriginOfTextId()

Returns true if the id of the origin of text is not the empty string.

isSetText

public boolean isSetText()

Returns true if the text is not the empty string.

renameSIdRefs

public void renameSIdRefs(java.lang.String oldid,
                 java.lang.String newid)

Renames all the SIdRef attributes on this element, including any found in MathML content (if such exists).

This method works by looking at all attributes and (if appropriate) mathematical formulas, comparing the identifiers to the value of oldid. If any matches are found, the matching identifiers are replaced with newid. The method does not descend into child elements.

Overrides:

renameSIdRefs in class SBase

Parameters:

oldid - the old identifier

newid - the new identifier

setGraphicalObjectId

public int setGraphicalObjectId(java.lang.String id)

Sets the id of the associated graphical object.

setOriginOfTextId

public int setOriginOfTextId(java.lang.String orig)

Sets the id of the origin of text.

setText

public void setText(java.lang.String text)

Sets the text to be displayed by the text glyph.

toXML

public XMLNode toXML()

Creates an XMLNode object from this.

Overrides:

toXML in class GraphicalObject