org.sbml.jsbml.ext.layout

Class BoundingBox

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.AbstractSBase

org.sbml.jsbml.AbstractNamedSBase

org.sbml.jsbml.ext.layout.BoundingBox

All Implemented Interfaces:

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

public class BoundingBox
extends AbstractNamedSBase
implements UniqueNamedSBase

The BoundingBox class specifies the required elements position and dimension. The class describes the rectangular area by which other classes of the Layout package will be situated.

Since:

1.0

Author:

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

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
BoundingBox() Creates a new instance of BoundingBox.
BoundingBox(BoundingBox boundingBox) Creates a new instance of BoundingBox.
BoundingBox(int level, int version) Creates a new instance of BoundingBox.
BoundingBox(String id) Creates a new instance of BoundingBox.
BoundingBox(String id, int level, int version) Creates a new instance of BoundingBox.

Method Summary

Modifier and Type	Method and Description
BoundingBox	clone()
Dimensions	createDimensions() Creates, sets and returns a Dimensions
Dimensions	createDimensions(double width, double height, double depth) Creates, sets and returns Dimensions based on the given values.
Point	createPosition() Creates, sets and returns a Point
Point	createPosition(double x, double y, double z) Creates, sets and returns a Point based on the given values.
boolean	equals(Object object)
TreeNode	getChildAt(int index)
int	getChildCount()
Dimensions	getDimensions()
Point	getPosition()
int	hashCode()
boolean	isIdMandatory()
boolean	isSetDimensions()
boolean	isSetPosition()
void	setDimensions(Dimensions dimensions) Sets the Dimensions.
void	setPosition(Point point) Sets the position.
Map<String,String>	writeXMLAttributes()

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, getAllowsChildren, 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, readAttribute, 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, readAttribute, 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, getAllowsChildren, getIndex, getParent, isLeaf

Constructor Detail

BoundingBox

public BoundingBox()

Creates a new instance of BoundingBox.

BoundingBox

public BoundingBox(BoundingBox boundingBox)

Creates a new instance of BoundingBox.

Parameters:

boundingBox - the BoundingBox to clone.

BoundingBox

public BoundingBox(int level,
                   int version)

Creates a new instance of BoundingBox.

Parameters:

level - the SBML level

version - the SBML version

BoundingBox

public BoundingBox(String id)

Creates a new instance of BoundingBox.

Parameters:

id - the id

BoundingBox

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

Creates a new instance of BoundingBox.

Parameters:

id - the id

level - the SBML level

version - the SBML version

Method Detail

clone

public BoundingBox clone()

Specified by:

clone in interface SBase

Overrides:

clone in class AbstractSBase

createDimensions

public Dimensions createDimensions()

Creates, sets and returns a Dimensions

Returns:

new Dimensions object.

createDimensions

public Dimensions createDimensions(double width,
                                   double height,
                                   double depth)

Creates, sets and returns Dimensions based on the given values.

Parameters:

width -

height -

depth -

Returns:

new Dimensions object.

createPosition

public Point createPosition()

Creates, sets and returns a Point

Returns:

new Point object.

createPosition

public Point createPosition(double x,
                            double y,
                            double z)

Creates, sets and returns a Point based on the given values.

Parameters:

x -

y -

z -

Returns:

new Point object.

equals

public boolean equals(Object object)

Specified by:

equals in interface SBase

Overrides:

equals in class AbstractSBase

getChildAt

public TreeNode getChildAt(int index)

Specified by:

getChildAt in interface TreeNode

Overrides:

getChildAt in class AbstractSBase

getChildCount

public int getChildCount()

Specified by:

getChildCount in interface TreeNode

Overrides:

getChildCount in class AbstractSBase

getDimensions

public Dimensions getDimensions()

Returns:

getPosition

public Point getPosition()

Returns:

hashCode

public int hashCode()

Specified by:

hashCode in interface SBase

Overrides:

hashCode in class AbstractSBase

isIdMandatory

public boolean isIdMandatory()

Specified by:

isIdMandatory in interface NamedSBase

Specified by:

isIdMandatory in interface SBase

Overrides:

isIdMandatory in class AbstractSBase

isSetDimensions

public boolean isSetDimensions()

Returns:

isSetPosition

public boolean isSetPosition()

Returns:

setDimensions

public void setDimensions(Dimensions dimensions)

Sets the Dimensions.

The dimensions element is required and of type Dimensions. It represents the size of the BoundingBox.

Parameters:

dimensions -

setPosition

public void setPosition(Point point)

Sets the position.

Position always specifies the upper left corner of the BoundingBox. The position is of type Point.

Parameters:

point -

writeXMLAttributes

public Map<String,String> writeXMLAttributes()

Specified by:

writeXMLAttributes in interface SBase

Overrides:

writeXMLAttributes in class AbstractSBase