Package org.sbml.jsbml.ext.render

Class Rectangle

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.AbstractSBase

org.sbml.jsbml.ext.render.Transformation

org.sbml.jsbml.ext.render.Transformation2D

org.sbml.jsbml.ext.render.GraphicalPrimitive1D

org.sbml.jsbml.ext.render.GraphicalPrimitive2D

org.sbml.jsbml.ext.render.Rectangle

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, javax.swing.tree.TreeNode, Point3D, SBase, TreeNodeWithChangeSupport

public class Rectangle
extends GraphicalPrimitive2D
implements Point3D

Since:

1.0

Author:

Eugen Netz, Alexander Diamantikos, Jakob Matthes, Jan Rudolph, David Emanuel Vetter

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.sbml.jsbml.ext.render.GraphicalPrimitive2D

GraphicalPrimitive2D.FillRule

Field Summary

Fields inherited from class org.sbml.jsbml.AbstractSBase

JSBML_WRONG_SBO_TERM

Constructor Summary

Constructors

Constructor	Description
Rectangle()	Creates a new Rectangle instance.
Rectangle(Rectangle obj)	Clone constructor

Method Summary

Modifier and Type	Method	Description
Rectangle	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 obj)	Returns true if and only if the given SBase has exactly the same properties like this SBase instance.
boolean	getAllowsChildren()
SBase	getChildAt(int childIndex)
int	getChildCount()
RelAbsVector	getHeight()
double	getRatio()
RelAbsVector	getRx()
RelAbsVector	getRy()
RelAbsVector	getWidth()
RelAbsVector	getX()
RelAbsVector	getY()
RelAbsVector	getZ()
int	hashCode()	Returns a hash code value for this SBase instance.
void	initDefaults()	Initializes the default values using the namespace.
boolean	isSetHeight()
boolean	isSetRatio()
boolean	isSetRx()
boolean	isSetRy()
boolean	isSetWidth()
boolean	isSetX()
boolean	isSetY()
boolean	isSetZ()
boolean	readAttribute(java.lang.String attributeName, java.lang.String prefix, java.lang.String value)	Sets the given attribute in this SBase.
void	setHeight(RelAbsVector height)	Set the value of height
void	setRatio(double ratio)
void	setRx(RelAbsVector rx)	Set the value of rx
void	setRy(RelAbsVector ry)	Set the value of ry
void	setWidth(RelAbsVector width)	Set the value of width
void	setX(RelAbsVector x)	Set the value of x
void	setY(RelAbsVector y)	Set the value of y
void	setZ(RelAbsVector z)	Set the value of z
boolean	unsetHeight()	Unsets the variable height
boolean	unsetRatio()
boolean	unsetRx()	Unsets the variable rx
boolean	unsetRy()	Unsets the variable ry
boolean	unsetWidth()	Unsets the variable width
boolean	unsetX()	Unsets the variable x
boolean	unsetY()	Unsets the variable y
boolean	unsetZ()	Unsets the variable z
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.AbstractSBase

addCVTerm, addDeclaredNamespace, addExtension, addPlugin, addResources, appendAnnotation, appendAnnotation, appendNotes, appendNotes, createHistory, createPlugin, disablePackage, enablePackage, enablePackage, filterCVTerms, filterCVTerms, filterCVTerms, filterCVTerms, fireNodeRemovedEvent, firePropertyChange, getAllDeclaredNamespaces, getAnnotation, getAnnotationString, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementByMetaId, getElementBySId, getElementName, getExtension, getExtensionCount, getExtensionPackages, getFirstElementIndex, getHistory, getId, getLevel, getLevelAndVersion, getMetaId, getModel, getName, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getPackageName, getPackageVersion, getParent, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getURI, getVersion, hasExtension, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isIdMandatory, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetId, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetName, isSetNotes, isSetPackageVErsion, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, isValidLevelAndVersionCombination, isValidMetaId, registerChild, removeCVTerm, removeCVTerm, removeDeclaredNamespaceByNamespace, removeDeclaredNamespaceByPrefix, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, replaceTopLevelAnnotationElement, replaceTopLevelAnnotationElement, setAnnotation, setAnnotation, setAnnotation, setHistory, setId, setLevel, setMetaId, setName, setNamespace, setNotes, setNotes, setPackageVersion, 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, isLeaf, isRoot, isSetParent, isSetUserObjects, putUserObject, removeAllTreeNodeChangeListeners, removeAllTreeNodeChangeListeners, removeFromParent, removeTreeNodeChangeListener, removeTreeNodeChangeListener, removeUserObject, setParent, userObjectKeySet

Methods inherited from class org.sbml.jsbml.ext.render.GraphicalPrimitive1D

addStrokeDash, getStroke, getStrokeDash, getStrokeDashArray, getStrokeWidth, isSetStroke, isSetStrokeDashArray, isSetStrokeWidth, setStroke, setStrokeDashArray, setStrokeDashArray, setStrokeWidth, unsetStroke, unsetStrokeDashArray, unsetStrokeWidth

Methods inherited from class org.sbml.jsbml.ext.render.GraphicalPrimitive2D

getFill, getFillRule, isSetFill, isSetFillRule, setFill, setFillRule, unsetFill, unsetFillRule

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.sbml.jsbml.SBase

removeTreeNodeChangeListener

Methods inherited from class org.sbml.jsbml.ext.render.Transformation

isSetTransform, setTransform

Methods inherited from class org.sbml.jsbml.ext.render.Transformation2D

getTransform, unsetTransform

Methods inherited from interface javax.swing.tree.TreeNode

children, getIndex, isLeaf

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

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

Constructor Detail

Rectangle

public Rectangle()

Creates a new Rectangle instance.

Rectangle

public Rectangle(Rectangle obj)

Clone constructor

Parameters:

obj -

Method Detail

getRx

public RelAbsVector getRx()

Returns:

the value of rx

isSetRx

public boolean isSetRx()

Returns:

whether rx is set

setRx

public void setRx(RelAbsVector rx)

Set the value of rx

Parameters:

rx -

unsetRx

public boolean unsetRx()

Unsets the variable rx

Returns:

true, if rx was set before, otherwise false

getRy

public RelAbsVector getRy()

Returns:

the value of ry

isSetRy

public boolean isSetRy()

Returns:

whether ry is set

setRy

public void setRy(RelAbsVector ry)

Set the value of ry

Parameters:

ry -

unsetRy

public boolean unsetRy()

Unsets the variable ry

Returns:

true, if ry was set before, otherwise false

getX

public RelAbsVector getX()

Specified by:

getX in interface Point3D

Returns:

the value of x

isSetX

public boolean isSetX()

Specified by:

isSetX in interface Point3D

Returns:

whether x is set

setX

public void setX(RelAbsVector x)

Description copied from interface: Point3D

Set the value of x

Specified by:

setX in interface Point3D

unsetX

public boolean unsetX()

Unsets the variable x

Specified by:

unsetX in interface Point3D

Returns:

true, if x was set before, otherwise false

getY

public RelAbsVector getY()

Specified by:

getY in interface Point3D

Returns:

the value of y

isSetY

public boolean isSetY()

Specified by:

isSetY in interface Point3D

Returns:

whether y is set

setY

public void setY(RelAbsVector y)

Description copied from interface: Point3D

Set the value of y

Specified by:

setY in interface Point3D

unsetY

public boolean unsetY()

Unsets the variable y

Specified by:

unsetY in interface Point3D

Returns:

true, if y was set before, otherwise false

getZ

public RelAbsVector getZ()

Specified by:

getZ in interface Point3D

Returns:

the value of z

isSetZ

public boolean isSetZ()

Specified by:

isSetZ in interface Point3D

Returns:

whether z is set

setZ

public void setZ(RelAbsVector z)

Description copied from interface: Point3D

Set the value of z

Specified by:

setZ in interface Point3D

unsetZ

public boolean unsetZ()

Unsets the variable z

Specified by:

unsetZ in interface Point3D

Returns:

true, if z was set before, otherwise false

getHeight

public RelAbsVector getHeight()

Returns:

the value of height

isSetHeight

public boolean isSetHeight()

Returns:

whether height is set

setHeight

public void setHeight(RelAbsVector height)

Set the value of height

Parameters:

height -

unsetHeight

public boolean unsetHeight()

Unsets the variable height

Returns:

true, if height was set before, otherwise false

getWidth

public RelAbsVector getWidth()

Returns:

the value of width

isSetWidth

public boolean isSetWidth()

Returns:

whether width is set

setWidth

public void setWidth(RelAbsVector width)

Set the value of width

Parameters:

width -

unsetWidth

public boolean unsetWidth()

Unsets the variable width

Returns:

true, if width was set before, otherwise false

getRatio

public double getRatio()

Returns:

the ratio width/height

isSetRatio

public boolean isSetRatio()

Returns:

whether the ratio of width/height is set

setRatio

public void setRatio(double ratio)

Parameters:

ratio - of width/height

unsetRatio

public boolean unsetRatio()

Returns:

whether the ratio of width/height could be unset

clone

public Rectangle 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

Overrides:

clone in class GraphicalPrimitive2D

Returns:

a copy of this object

initDefaults

public void initDefaults()

Description copied from class: Transformation

Initializes the default values using the namespace.

Overrides:

initDefaults in class GraphicalPrimitive2D

getAllowsChildren

public boolean getAllowsChildren()

Specified by:

getAllowsChildren in interface javax.swing.tree.TreeNode

Overrides:

getAllowsChildren in class AbstractSBase

getChildCount

public int getChildCount()

Specified by:

getChildCount in interface javax.swing.tree.TreeNode

Overrides:

getChildCount in class AbstractSBase

getChildAt

public SBase getChildAt(int childIndex)

Specified by:

getChildAt in interface javax.swing.tree.TreeNode

Overrides:

getChildAt in class AbstractSBase

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 GraphicalPrimitive2D

Returns:

a Map containing the XML attributes of this object.

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 GraphicalPrimitive2D

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.

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 GraphicalPrimitive2D

Returns:

a hash code value for this SBase instance.

See Also:

Object.hashCode()

equals

public boolean equals(java.lang.Object obj)

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 GraphicalPrimitive2D

Parameters:

obj - 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.