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:

java.io.Serializable, java.lang.Cloneable, javax.swing.tree.TreeNode, NamedSBase, SBase, UniqueNamedSBase, 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

Version:

$Rev: 1904 $

Author:

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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	graphicalObject
private static long	serialVersionUID Generated serial version identifier.
private java.lang.String	text

Fields inherited from class org.sbml.jsbml.AbstractSBase

ignoredExtensions, ignoredXMLElements

Fields inherited from class org.sbml.jsbml.AbstractTreeNode

listOfListeners, parent, UNKNOWN_ATTRIBUTES, UNKNOWN_ELEMENTS

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
TextGlyph	clone() Creates a deep copy of this object, i.e., a new SBase with the same properties like this one.
boolean	equals(java.lang.Object object) Returns true if and only if the given SBase has exactly the same properties like this SBase instance.
java.lang.String	getGraphicalObject()
GraphicalObject	getGraphicalObjectInstance() Direct access to the GraphicalObject linked to this TextGlyph.
java.lang.String	getOriginOfText()
NamedSBase	getOriginOfTextInstance()
java.lang.String	getText()
int	hashCode() Returns a hash code value for this SBase instance.
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(java.lang.String attributeName, java.lang.String prefix, java.lang.String value) Sets the given attribute in this SBase.
void	setGraphicalObject(GraphicalObject graphicalObject)
void	setGraphicalObject(java.lang.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(java.lang.String originOfText) Additionally the optional attribute originOfText holds the id of an entity in the Model.
void	setText(java.lang.String text) The String text attribute facilitates adding of independent text, like a title or a comment to the diagram.
java.lang.String	toString() Returns the name of the component, if it is available.
void	unsetGraphicalObject()
java.util.Map<java.lang.String,java.lang.String>	writeXMLAttributes() Returns a map with all the attributes of this SBase that need to be written out in XML.

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

getNamedSBaseInstance, getReference, getReferenceInstance, isSetReference, setNamedSBase, setReference, setReference, 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

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

Methods inherited from class org.sbml.jsbml.AbstractSBase

addCVTerm, addDeclaredNamespace, addExtension, addPlugin, appendNotes, appendNotes, checkLevelAndVersionCompatibility, createHistory, createPlugin, disablePackage, enablePackage, enablePackage, filterCVTerms, filterCVTerms, filterCVTerms, filterCVTerms, fireNodeRemovedEvent, firePropertyChange, getAnnotation, getAnnotationString, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementName, getExtension, getExtensionCount, getExtensionPackages, getHistory, getIdManager, getLevel, getLevelAndVersion, getMetaId, getModel, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getParent, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getVersion, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetNotes, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, isValidLevelAndVersionCombination, isValidMetaId, notifyChildChange, registerChild, removeCVTerm, removeCVTerm, setAnnotation, setHistory, setLevel, setMetaId, setNamespace, setNotes, setNotes, setParentSBML, setParentSBMLObject, setSBOTerm, setSBOTerm, setThisAsParentSBMLObject, setVersion, unregisterChild, unsetAnnotation, unsetCVTerms, unsetExtension, unsetHistory, unsetMetaId, 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, isLeaf, 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, appendNotes, appendNotes, createPlugin, disablePackage, enablePackage, enablePackage, filterCVTerms, filterCVTerms, filterCVTerms, filterCVTerms, getAnnotation, getAnnotationString, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementName, getExtension, getExtensionCount, getExtensionPackages, getHistory, getLevel, getLevelAndVersion, getMetaId, getModel, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getVersion, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetNotes, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, registerChild, removeCVTerm, removeCVTerm, removeTreeNodeChangeListener, setAnnotation, setHistory, setLevel, setMetaId, setNotes, setNotes, 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

Field Detail

serialVersionUID

private static final long serialVersionUID

Generated serial version identifier.

See Also:

Constant Field Values

graphicalObject

private java.lang.String graphicalObject

text

private java.lang.String text

Constructor Detail

TextGlyph

public TextGlyph()

TextGlyph

public TextGlyph(int level,
         int version)

Parameters:

level -

version -

TextGlyph

public TextGlyph(java.lang.String id)

Parameters:

id -

TextGlyph

public TextGlyph(java.lang.String id,
         int level,
         int version)

Parameters:

id -

level -

version -

TextGlyph

public TextGlyph(TextGlyph textGlyph)

Parameters:

textGlyph -

Method Detail

clone

public TextGlyph clone()

Description copied from interface: SBase

Creates a deep copy of this object, i.e., a new SBase with the same properties like this one.

Specified by:

clone in interface SBase

Specified by:

clone in class AbstractReferenceGlyph

Returns:

a copy of this object

equals

public boolean equals(java.lang.Object object)

Description copied from interface: SBase

Returns true if and only if the given SBase has exactly the same properties like this SBase instance.

Specified by:

equals in interface SBase

Overrides:

equals in class AbstractReferenceGlyph

Parameters:

object - the SBase to be compared to.

Returns:

true if and only if the given Object is an instance of SBase that has exactly the same properties like this SBase instance.

getGraphicalObject

public java.lang.String getGraphicalObject()

Returns:

getGraphicalObjectInstance

public GraphicalObject getGraphicalObjectInstance()

Direct access to the GraphicalObject linked to this TextGlyph.

getOriginOfText

public java.lang.String getOriginOfText()

Returns:

getOriginOfTextInstance

public NamedSBase getOriginOfTextInstance()

Returns:

getText

public java.lang.String getText()

Returns:

hashCode

public int hashCode()

Description copied from interface: SBase

Returns a hash code value for this SBase instance.

Specified by:

hashCode in interface SBase

Overrides:

hashCode in class AbstractReferenceGlyph

Returns:

a hash code value for this SBase instance.

See Also:

Object.hashCode()

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.

isSetOriginOfText

public boolean isSetOriginOfText()

Returns:

isSetText

public boolean isSetText()

Returns:

readAttribute

public boolean readAttribute(java.lang.String attributeName,
                    java.lang.String prefix,
                    java.lang.String value)

Description copied from interface: SBase

Sets the given attribute in this SBase.

If the given attribute name is not recognized, nothing is done and false is returned.

Specified by:

readAttribute in interface SBase

Overrides:

readAttribute in class GraphicalObject

Parameters:

attributeName - localName of the XML attribute

prefix - prefix of the XML attribute

value - value of the XML attribute

Returns:

true if the attribute has been successfully read.

setGraphicalObject

public void setGraphicalObject(GraphicalObject graphicalObject)

Parameters:

graphicalObject -

unsetGraphicalObject

public void unsetGraphicalObject()

setGraphicalObject

public void setGraphicalObject(java.lang.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(java.lang.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(java.lang.String text)

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

Parameters:

text -

toString

public java.lang.String toString()

Description copied from class: AbstractNamedSBase

Returns the name of the component, if it is available. Otherwise, the identifier is returned. If both is not possible, the class name of this element is returned.

Overrides:

toString in class AbstractReferenceGlyph

writeXMLAttributes

public java.util.Map<java.lang.String,java.lang.String> writeXMLAttributes()

Description copied from interface: SBase

Returns a map with all the attributes of this SBase that need to be written out in XML.

The attribute name is used as a key and the attribute value as value. If a prefix is needed for the attribute name, it need to be set directly in this map.

Specified by:

writeXMLAttributes in interface SBase

Overrides:

writeXMLAttributes in class GraphicalObject

Returns:

a Map containing the XML attributes of this object.