org.sbml.jsbml.ext.layout

Class TextGlyph

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.AbstractSBase

org.sbml.jsbml.AbstractNamedSBase

org.sbml.jsbml.ext.layout.GraphicalObject

org.sbml.jsbml.ext.layout.AbstractReferenceGlyph

org.sbml.jsbml.ext.layout.TextGlyph

All Implemented Interfaces:

Serializable, Cloneable, TreeNode, IBoundingBox, NamedSBase, SBase, UniqueNamedSBase, UniqueSId, TreeNodeWithChangeSupport

public class TextGlyph
extends AbstractReferenceGlyph

The TextGlyph class describes the position and dimension of text labels. It inherits from GraphicalObject and adds the attributes graphicalObject, text and originOfText.

Since:

1.0

Author:

Nicolas Rodriguez, Sebastian Frölich, Andreas Dräger

See Also:

Serialized Form

Field Summary

Fields inherited from class org.sbml.jsbml.AbstractSBase

ignoredExtensions, ignoredXMLElements, JSBML_WRONG_SBO_TERM, packageName

Fields inherited from class org.sbml.jsbml.AbstractTreeNode

listOfListeners, parent, resourceBundle

Constructor Summary

Constructors

Constructor and Description
TextGlyph()
TextGlyph(int level, int version)
TextGlyph(String id)
TextGlyph(String id, int level, int version)
TextGlyph(TextGlyph textGlyph)

Method Summary

Modifier and Type	Method and Description
TextGlyph	clone()
boolean	equals(Object object)
String	getGraphicalObject()
GraphicalObject	getGraphicalObjectInstance() Direct access to the GraphicalObject linked to this TextGlyph.
String	getOriginOfText()
NamedSBase	getOriginOfTextInstance()
String	getText()
int	hashCode()
void	initDefaults() Initializes the default values using the namespace.
boolean	isSetGraphicalObject()
boolean	isSetGraphicalObjectInstance() Method to test if an instance of a GraphicalObject with the id given by getGraphicalObject() can be found in the Model.
boolean	isSetOriginOfText()
boolean	isSetText()
boolean	readAttribute(String attributeName, String prefix, String value)
void	setGraphicalObject(GraphicalObject graphicalObject)
void	setGraphicalObject(String graphicalObject) The graphicalObject attribute contains the id of any GraphicalObject and specifies that the TextGlyph should be considered to be a label to that object.
void	setOriginOfText(NamedSBase originOfText)
void	setOriginOfText(String originOfText) Additionally the optional attribute originOfText holds the id of an entity in the Model.
void	setText(String text) The String text attribute facilitates adding of independent text, like a title or a comment to the diagram.
void	unsetGraphicalObject()
Map<String,String>	writeXMLAttributes()

Methods inherited from class org.sbml.jsbml.ext.layout.AbstractReferenceGlyph

getNamedSBaseInstance, getReference, getReferenceInstance, getSBaseInstance, isSetReference, setNamedSBase, setReference, setSBase, unsetReference

Methods inherited from class org.sbml.jsbml.ext.layout.GraphicalObject

createBoundingBox, createBoundingBox, createBoundingBox, createBoundingBox, getAllowsChildren, getBoundingBox, getChildAt, getChildCount, getMetaidRef, isIdMandatory, isSetBoundingBox, isSetMetaidRef, setBoundingBox, setMetaidRef, unsetBoundingBox, unsetMetaidRef

Methods inherited from class org.sbml.jsbml.AbstractNamedSBase

isValidId

Methods inherited from class org.sbml.jsbml.AbstractSBase

addCVTerm, addDeclaredNamespace, addExtension, addPlugin, appendAnnotation, appendAnnotation, appendNotes, appendNotes, checkAndSetPackageNamespaceAndVersion, checkAndSetPackageNamespaceAndVersion, checkAttribute, checkLevelAndVersionCompatibility, createHistory, createPlugin, disablePackage, enablePackage, enablePackage, filterCVTerms, filterCVTerms, filterCVTerms, filterCVTerms, fireNodeRemovedEvent, firePropertyChange, getAnnotation, getAnnotationString, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementByMetaId, getElementBySId, getElementName, getExtension, getExtensionCount, getExtensionPackages, getHistory, getId, getIdManager, getLevel, getLevelAndVersion, getMetaId, getModel, getName, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getPackageName, getPackageVersion, getParent, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getURI, getVersion, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetId, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetName, isSetNotes, isSetPackageVErsion, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, isValidLevelAndVersionCombination, isValidMetaId, notifyChildChange, registerChild, removeCVTerm, removeCVTerm, setAnnotation, setAnnotation, setAnnotation, setHistory, setId, setLevel, setMetaId, setName, setNamespace, setNotes, setNotes, setPackageVersion, setParentSBML, setParentSBMLObject, setSBOTerm, setSBOTerm, setThisAsParentSBMLObject, setVersion, toString, unregisterChild, unsetAnnotation, unsetCVTerms, unsetExtension, unsetHistory, unsetId, unsetMetaId, unsetName, unsetNamespace, unsetNotes, unsetPlugin, unsetSBOTerm

Methods inherited from class org.sbml.jsbml.AbstractTreeNode

addAllChangeListeners, addAllChangeListeners, addTreeNodeChangeListener, addTreeNodeChangeListener, children, clearUserObjects, containsUserObjectKey, filter, filter, filter, fireNodeAddedEvent, getIndex, getListOfTreeNodeChangeListeners, getNumChildren, getRoot, getTreeNodeChangeListenerCount, getUserObject, indexOf, isCloningInProgress, isInvalidSBMLAllowed, isLeaf, isReadingInProgress, isRoot, isSetParent, isSetUserObjects, putUserObject, removeAllTreeNodeChangeListeners, removeAllTreeNodeChangeListeners, removeFromParent, removeTreeNodeChangeListener, removeTreeNodeChangeListener, removeUserObject, setParent, userObjectKeySet

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.sbml.jsbml.NamedSBase

getId, getName, isSetId, isSetName, setId, setName, unsetId, unsetName

Methods inherited from interface org.sbml.jsbml.SBase

addCVTerm, addDeclaredNamespace, addExtension, addPlugin, appendAnnotation, appendAnnotation, appendNotes, appendNotes, createPlugin, disablePackage, enablePackage, enablePackage, filterCVTerms, filterCVTerms, filterCVTerms, filterCVTerms, getAnnotation, getAnnotationString, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementByMetaId, getElementBySId, getElementName, getExtension, getExtensionCount, getExtensionPackages, getHistory, getLevel, getLevelAndVersion, getMetaId, getModel, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getPackageName, getPackageVersion, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getURI, getVersion, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetNotes, isSetPackageVErsion, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, registerChild, removeCVTerm, removeCVTerm, removeTreeNodeChangeListener, setAnnotation, setAnnotation, setAnnotation, setHistory, setLevel, setMetaId, setNotes, setNotes, setPackageVersion, setSBOTerm, setSBOTerm, setThisAsParentSBMLObject, setVersion, unregisterChild, unsetAnnotation, unsetCVTerms, unsetExtension, unsetHistory, unsetMetaId, unsetNotes, unsetPlugin, unsetSBOTerm

Methods inherited from interface org.sbml.jsbml.util.TreeNodeWithChangeSupport

addAllChangeListeners, addAllChangeListeners, addTreeNodeChangeListener, addTreeNodeChangeListener, clearUserObjects, containsUserObjectKey, filter, filter, filter, fireNodeAddedEvent, fireNodeRemovedEvent, firePropertyChange, getListOfTreeNodeChangeListeners, getRoot, getTreeNodeChangeListenerCount, getUserObject, isRoot, isSetParent, isSetUserObjects, putUserObject, removeAllTreeNodeChangeListeners, removeAllTreeNodeChangeListeners, removeFromParent, removeTreeNodeChangeListener, removeUserObject, userObjectKeySet

Methods inherited from interface javax.swing.tree.TreeNode

children, getIndex, getParent, isLeaf

Constructor Detail

TextGlyph

public TextGlyph()

TextGlyph

public TextGlyph(int level,
                 int version)

Parameters:

level -

version -

TextGlyph

public TextGlyph(String id)

Parameters:

id -

TextGlyph

public TextGlyph(String id,
                 int level,
                 int version)

Parameters:

id -

level -

version -

TextGlyph

public TextGlyph(TextGlyph textGlyph)

Parameters:

textGlyph -

Method Detail

clone

public TextGlyph clone()

Specified by:

clone in interface SBase

Specified by:

clone in class AbstractReferenceGlyph

initDefaults

public void initDefaults()

Initializes the default values using the namespace.

Overrides:

initDefaults in class GraphicalObject

equals

public boolean equals(Object object)

Specified by:

equals in interface SBase

Overrides:

equals in class AbstractReferenceGlyph

getGraphicalObject

public String getGraphicalObject()

Returns:

getGraphicalObjectInstance

public GraphicalObject getGraphicalObjectInstance()

Direct access to the GraphicalObject linked to this TextGlyph.

Returns:

getOriginOfText

public String getOriginOfText()

Returns:

getOriginOfTextInstance

public NamedSBase getOriginOfTextInstance()

Returns:

getText

public String getText()

Returns:

hashCode

public int hashCode()

Specified by:

hashCode in interface SBase

Overrides:

hashCode in class AbstractReferenceGlyph

isSetGraphicalObject

public boolean isSetGraphicalObject()

Returns:

isSetGraphicalObjectInstance

public boolean isSetGraphicalObjectInstance()

Method to test if an instance of a GraphicalObject with the id given by getGraphicalObject() can be found in the Model.

Returns:

isSetOriginOfText

public boolean isSetOriginOfText()

Returns:

isSetText

public boolean isSetText()

Returns:

readAttribute

public boolean readAttribute(String attributeName,
                             String prefix,
                             String value)

Specified by:

readAttribute in interface SBase

Overrides:

readAttribute in class GraphicalObject

setGraphicalObject

public void setGraphicalObject(GraphicalObject graphicalObject)

Parameters:

graphicalObject -

unsetGraphicalObject

public void unsetGraphicalObject()

setGraphicalObject

public void setGraphicalObject(String graphicalObject)

The graphicalObject attribute contains the id of any GraphicalObject and specifies that the TextGlyph should be considered to be a label to that object. This allows modelers to indicate that the label is to be moved together with the object. If the graphicalObject attribute is used together with the metaidRef they need to refer to the same object in the Layout.

Parameters:

graphicalObject -

setOriginOfText

public void setOriginOfText(NamedSBase originOfText)

Parameters:

originOfText -

setOriginOfText

public void setOriginOfText(String originOfText)

Additionally the optional attribute originOfText holds the id of an entity in the Model. If it is specified, the text to be displayed is taken from the name attribute of the referenced object. If both attributes originOfText and text are specified, the text attribute value overrides the value of originOfText.

Parameters:

originOfText -

setText

public void setText(String text)

The String text attribute facilitates adding of independent text, like a title or a comment to the diagram.

Parameters:

text -

writeXMLAttributes

public Map<String,String> writeXMLAttributes()

Specified by:

writeXMLAttributes in interface SBase

Overrides:

writeXMLAttributes in class GraphicalObject