org.sbml.jsbml.ext.layout
public class CompartmentGlyph extends AbstractReferenceGlyph
CompartmentGlyph
class is derived from GraphicalObject
and inherits its attributes. Additionally it has tow optional attributes:
compartment and order.Modifier and Type | Field and Description |
---|---|
private java.lang.Double |
order |
private static long |
serialVersionUID
Generated serial version identifier.
|
ignoredExtensions, ignoredXMLElements
listOfListeners, parent, UNKNOWN_ATTRIBUTES, UNKNOWN_ELEMENTS
Constructor and Description |
---|
CompartmentGlyph() |
CompartmentGlyph(CompartmentGlyph compartmentGlyph) |
CompartmentGlyph(int level,
int version) |
CompartmentGlyph(java.lang.String id) |
CompartmentGlyph(java.lang.String id,
int level,
int version) |
Modifier and Type | Method and Description |
---|---|
CompartmentGlyph |
clone()
Creates a deep copy of this object, i.e., a new
SBase with the same properties
like this one. |
java.lang.String |
getCompartment() |
NamedSBase |
getCompartmentInstance()
Note that the return type of this method is
NamedSBase because it
could be possible to link some element from other packages to this glyph. |
double |
getOrder()
Returns the value of order
|
boolean |
isSetCompartment() |
boolean |
isSetOrder()
Returns whether order is set
|
boolean |
readAttribute(java.lang.String attributeName,
java.lang.String prefix,
java.lang.String value)
Sets the given attribute in this
SBase . |
void |
setCompartment(Compartment compartment)
The compartment attribute is used to add a reference to the id of
the corresponding
Compartment in the Model . |
void |
setCompartment(java.lang.String compartment)
See annotation for setCompartment(Compartment)
|
void |
setOrder(double order)
The order attribute is an optional attribute of type
Double . |
void |
unsetCompartment() |
boolean |
unsetOrder()
Unsets the variable order
|
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. |
equals, getNamedSBaseInstance, getReference, getReferenceInstance, hashCode, isSetReference, setNamedSBase, setReference, setReference, toString, 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.Double order
public CompartmentGlyph()
public CompartmentGlyph(CompartmentGlyph compartmentGlyph)
compartmentGlyph
- public CompartmentGlyph(int level, int version)
level
- version
- public CompartmentGlyph(java.lang.String id)
id
- public CompartmentGlyph(java.lang.String id, int level, int version)
id
- level
- version
- public CompartmentGlyph clone()
SBase
SBase
with the same properties
like this one.clone
in interface SBase
clone
in class AbstractReferenceGlyph
public java.lang.String getCompartment()
public NamedSBase getCompartmentInstance()
NamedSBase
because it
could be possible to link some element from other packages to this glyph.public double getOrder()
public boolean isSetCompartment()
public boolean isSetOrder()
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 setCompartment(Compartment compartment)
Compartment
in the Model
. Since
the compartment is optional, the user can specify Compartment
s
in the Layout
that are not part of the Model
.
This attribute is optional.compartment
- public void setCompartment(java.lang.String compartment)
compartment
- public void setOrder(double order)
Double
. It is there
to handle the case where compartments in a layout overlap, and tools want to
clearly disambiguate which CompartmentGlyph
is on top of the other.
The order attribute follows the coordinate system. There are z dimension points
into a screen; thus, an element with a lower order value will be in front
of an elements with a higher value. If not specified, the order is undefined
and tools are free to display the compartment glyphs in the order that best fits their
needs.
Note: if z coordinates are used (and this order is seemingly redundant), the order
can still be used to disambiguate drawing order.order
- public void unsetCompartment()
public boolean unsetOrder()
true
, if order was set before,
otherwise false
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.