org.sbml.jsbml.ext.layout
public class TextGlyph extends AbstractReferenceGlyph
TextGlyph
class describes the position and dimension of text labels. It inherits
from GraphicalObject
and adds the attributes graphicalObject, text and originOfText.Modifier and Type | Field and Description |
---|---|
private java.lang.String |
graphicalObject |
private static long |
serialVersionUID
Generated serial version identifier.
|
private java.lang.String |
text |
ignoredExtensions, ignoredXMLElements
listOfListeners, parent, UNKNOWN_ATTRIBUTES, UNKNOWN_ELEMENTS
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) |
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)
|
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. |
getNamedSBaseInstance, getReference, getReferenceInstance, isSetReference, setNamedSBase, setReference, setReference, unsetReference
createBoundingBox, createBoundingBox, createBoundingBox, createBoundingBox, getAllowsChildren, getBoundingBox, getChildAt, getChildCount, getMetaidRef, isIdMandatory, isSetBoundingBox, isSetMetaidRef, setBoundingBox, setMetaidRef, unsetBoundingBox, unsetMetaidRef
getId, getName, isSetId, isSetName, isValidId, setId, setName, unsetId, unsetName
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
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
finalize, getClass, notify, notifyAll, wait, wait, wait
getId, getName, isSetId, isSetName, setId, setName, unsetId, unsetName
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
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
private static final long serialVersionUID
private java.lang.String graphicalObject
private java.lang.String text
public TextGlyph()
public TextGlyph(int level, int version)
level
- version
- public TextGlyph(java.lang.String id)
id
- public TextGlyph(java.lang.String id, int level, int version)
id
- level
- version
- public TextGlyph(TextGlyph textGlyph)
textGlyph
- public TextGlyph clone()
SBase
SBase
with the same properties
like this one.clone
in interface SBase
clone
in class AbstractReferenceGlyph
public boolean equals(java.lang.Object object)
SBase
public java.lang.String getGraphicalObject()
public GraphicalObject getGraphicalObjectInstance()
GraphicalObject
linked to this
TextGlyph
.public java.lang.String getOriginOfText()
public NamedSBase getOriginOfTextInstance()
public java.lang.String getText()
public int hashCode()
SBase
SBase
instance.hashCode
in interface SBase
hashCode
in class AbstractReferenceGlyph
SBase
instance.Object.hashCode()
public boolean isSetGraphicalObject()
public boolean isSetGraphicalObjectInstance()
GraphicalObject
with the id
given by getGraphicalObject()
can be found in the Model
.public boolean isSetOriginOfText()
public boolean isSetText()
public boolean readAttribute(java.lang.String attributeName, java.lang.String prefix, java.lang.String value)
SBase
SBase
.
If the given attribute name is not recognized, nothing is done and
false
is returned.
readAttribute
in interface SBase
readAttribute
in class GraphicalObject
attributeName
- localName of the XML attributeprefix
- prefix of the XML attributevalue
- value of the XML attributetrue
if the attribute has been successfully read.public void setGraphicalObject(GraphicalObject graphicalObject)
graphicalObject
- public void unsetGraphicalObject()
public void setGraphicalObject(java.lang.String graphicalObject)
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
.graphicalObject
- public void setOriginOfText(NamedSBase originOfText)
originOfText
- public void setOriginOfText(java.lang.String originOfText)
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.originOfText
- public void setText(java.lang.String text)
text
- public java.lang.String toString()
AbstractNamedSBase
toString
in class AbstractReferenceGlyph
public java.util.Map<java.lang.String,java.lang.String> writeXMLAttributes()
SBase
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.
writeXMLAttributes
in interface SBase
writeXMLAttributes
in class GraphicalObject
Map
containing the XML attributes of this object.