Rectangle (LibSBML Java API)

java.lang.Object
- org.sbml.libsbml.SBase
- - org.sbml.libsbml.Transformation
  - - org.sbml.libsbml.Transformation2D
    - - org.sbml.libsbml.GraphicalPrimitive1D
      - org.sbml.libsbml.GraphicalPrimitive2D
        
        org.sbml.libsbml.Rectangle

```
public class Rectangle
extends GraphicalPrimitive2D
```
render Representation of a rectangle.
Rectangle allows the definition of rectangles with or without rounded edges. The Rectangle object derives from the GraphicalPrimitive2D class and thus inherits any attributes and elements that are present on this class. In addition, the Rectangle object has the required attributes 'x', 'y', 'height', and 'width' as well as the optional attributes 'z', 'rx', 'ry' and 'ratio'.

Field Summary
- Fields inherited from class org.sbml.libsbml.GraphicalPrimitive2D
  EVENODD, INHERIT, INVALID, NONZERO, UNSET

Constructor Summary

Constructors
Constructor and Description
`Rectangle()` Creates a new `Rectangle` using the given SBML Level, Version and “render” package version.
`Rectangle(long level)` Creates a new `Rectangle` using the given SBML Level, Version and “render” package version.
`Rectangle(long level, long version)` Creates a new `Rectangle` using the given SBML Level, Version and “render” package version.
`Rectangle(long level, long version, long pkgVersion)` Creates a new `Rectangle` using the given SBML Level, Version and “render” package version.
`Rectangle(Rectangle orig)` Copy constructor for `Rectangle`.
`Rectangle(RenderPkgNamespaces renderns)` Creates a new `Rectangle` using the given `RenderPkgNamespaces` object.
`Rectangle(RenderPkgNamespaces renderns, java.lang.String id)` Instantiates a new `Rectangle` object.
`Rectangle(RenderPkgNamespaces renderns, java.lang.String id, RelAbsVector x, RelAbsVector y, RelAbsVector w, RelAbsVector h)` Instantiates a new `Rectangle` object.
`Rectangle(RenderPkgNamespaces renderns, java.lang.String id, RelAbsVector x, RelAbsVector y, RelAbsVector z, RelAbsVector w, RelAbsVector h)` Instantiates a new `Rectangle` object.
`Rectangle(XMLNode node)` Creates a new `Rectangle` object from the given `XMLNode` object.
`Rectangle(XMLNode node, long l2version)` Creates a new `Rectangle` object from the given `XMLNode` object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Rectangle`	`cloneObject()` Creates and returns a deep copy of this `Rectangle` object.
`void`	`delete()` Explicitly deletes the underlying native object.
`java.lang.String`	`getElementName()` Returns the XML element name of this `Rectangle` object.
`RelAbsVector`	`getHeight()` Returns the height of the rectangle
`RelAbsVector`	`getRadiusX()` Returns the corner radius along the x axis
`RelAbsVector`	`getRadiusY()` Returns the corner radius along the y axis
`double`	`getRatio()` Returns the value of the 'ratio' attribute of this `Rectangle`.
`RelAbsVector`	`getRX()` Returns the value of the 'rX' element of this `Rectangle`.
`RelAbsVector`	`getRY()` Returns the value of the 'rY' element of this `Rectangle`.
`int`	`getTypeCode()` Returns the libSBML type code for this `Rectangle` object.
`RelAbsVector`	`getWidth()` Returns the with of the rectangle
`RelAbsVector`	`getX()` Returns the x coordinate of the rectangle's position
`RelAbsVector`	`getY()` Returns the y coordinate of the rectangle's position
`RelAbsVector`	`getZ()` Returns the z coordinate of the rectangle's position
`boolean`	`hasRequiredAttributes()` Predicate returning `true` if all the required attributes for this `Rectangle` object have been set.
`boolean`	`isSetHeight()` Predicate returning `true` if this `Rectangle`'s 'height' attribute is set.
`boolean`	`isSetRadiusX()` Predicate returning `true` if this `Rectangle`'s 'rX' attribute is set.
`boolean`	`isSetRadiusY()` Predicate returning `true` if this `Rectangle`'s 'rY' attribute is set.
`boolean`	`isSetRatio()` Predicate returning `true` if this `Rectangle`'s 'ratio' attribute is set.
`boolean`	`isSetRX()` Predicate returning `true` if this `Rectangle`'s 'rX' attribute is set.
`boolean`	`isSetRY()` Predicate returning `true` if this `Rectangle`'s 'rY' attribute is set.
`boolean`	`isSetWidth()` Predicate returning `true` if this `Rectangle`'s 'width' attribute is set.
`boolean`	`isSetX()` Predicate returning `true` if this `Rectangle`'s 'x' attribute is set.
`boolean`	`isSetY()` Predicate returning `true` if this `Rectangle`'s 'y' attribute is set.
`boolean`	`isSetZ()` Predicate returning `true` if this `Rectangle`'s 'z' attribute is set.
`void`	`setCoordinates(RelAbsVector x, RelAbsVector y, RelAbsVector z)` Sets the position of the `Rectangle` within the viewport.
`void`	`setCoordinatesAndSize(RelAbsVector x, RelAbsVector y, RelAbsVector z, RelAbsVector w, RelAbsVector h)` Sets the position and the size of the `Rectangle` within the viewport.
`int`	`setHeight(RelAbsVector h)` Sets the height of the `Rectangle`
`void`	`setRadii(RelAbsVector rx, RelAbsVector ry)` Sets the two corner radii of the rectangle
`int`	`setRadiusX(RelAbsVector rx)` Sets the corner radius along the x axis
`int`	`setRadiusY(RelAbsVector ry)` Sets the corner radius along the y axis
`int`	`setRatio(double ratio)` Sets the value of the 'ratio' attribute of this `Rectangle`.
`int`	`setRX(RelAbsVector rx)` Sets the corner radius along the x axis
`int`	`setRY(RelAbsVector ry)` Sets the corner radius along the y axis
`void`	`setSize(RelAbsVector w, RelAbsVector h)` Sets the size of the `Rectangle`
`int`	`setWidth(RelAbsVector w)` Sets the width of the `Rectangle`
`int`	`setX(RelAbsVector x)` Sets the x position of the `Rectangle` within the viewport.
`int`	`setY(RelAbsVector y)` Sets the y position of the `Rectangle` within the viewport.
`int`	`setZ(RelAbsVector z)` Sets the z position of the `Rectangle` within the viewport.
`XMLNode`	`toXML()` Creates an `XMLNode` object from this `Rectangle` object.
`int`	`unsetHeight()` Unsets the value of the 'height' attribute of this `Rectangle`.
`int`	`unsetRadiusX()` Unsets the value of the 'rX' attribute of this `Rectangle`.
`int`	`unsetRadiusY()` Unsets the value of the 'rY' attribute of this `Rectangle`.
`int`	`unsetRatio()` Unsets the value of the 'ratio' attribute of this `Rectangle`.
`int`	`unsetRX()` Unsets the value of the 'rX' attribute of this `Rectangle`.
`int`	`unsetRY()` Unsets the value of the 'rY' attribute of this `Rectangle`.
`int`	`unsetWidth()` Unsets the value of the 'width' attribute of this `Rectangle`.
`int`	`unsetX()` Unsets the value of the 'x' attribute of this `Rectangle`.
`int`	`unsetY()` Unsets the value of the 'y' attribute of this `Rectangle`.
`int`	`unsetZ()` Unsets the value of the 'z' attribute of this `Rectangle`.

Methods inherited from class org.sbml.libsbml.GraphicalPrimitive2D
getFill, getFillColor, getFillRule, getFillRuleAsString, isEllipse, isLineEnding, isPolygon, isRectangle, isRenderGroup, isSetFill, isSetFillColor, isSetFillRule, setFill, setFillColor, setFillRule, setFillRule, unsetFill, unsetFillRule

Methods inherited from class org.sbml.libsbml.GraphicalPrimitive1D
addDash, clearDashes, getDashByIndex, getId, getNumDashes, getStroke, getStrokeDashArray, getStrokeWidth, insertDash, isRenderCurve, isSetDashArray, isSetId, isSetStroke, isSetStrokeDashArray, isSetStrokeWidth, isText, removeDash, setDashByIndex, setId, setStroke, setStrokeDashArray, setStrokeWidth, unsetId, unsetStroke, unsetStrokeDashArray, unsetStrokeWidth

Methods inherited from class org.sbml.libsbml.Transformation2D
getIdentityMatrix2D, getMatrix2D, isImage, setMatrix, setMatrix2D

Methods inherited from class org.sbml.libsbml.Transformation
getIdentityMatrix, getMatrix, getName, getTransform, isSetMatrix, isSetName, isSetTransform, setName, setTransform, unsetMatrix, unsetName, unsetTransform

Methods inherited from class org.sbml.libsbml.SBase
addCVTerm, addCVTerm, appendAnnotation, appendAnnotation, appendNotes, appendNotes, connectToChild, deleteDisabledPlugins, deleteDisabledPlugins, disablePackage, enablePackage, equals, getAncestorOfType, getAncestorOfType, getAnnotation, getAnnotationString, getColumn, getCVTerm, getCVTerms, getDisabledPlugin, getElementByMetaId, getElementBySId, getIdAttribute, getLevel, getLine, getListOfAllElements, getListOfAllElements, getListOfAllElementsFromPlugins, getListOfAllElementsFromPlugins, getMetaId, getModel, getModelHistory, getNamespaces, getNotes, getNotesString, getNumCVTerms, getNumDisabledPlugins, getNumPlugins, getPackageCoreVersion, getPackageName, getPackageVersion, getParentSBMLObject, getPlugin, getPlugin, getPrefix, getResourceBiologicalQualifier, getResourceModelQualifier, getSBMLDocument, getSBOTerm, getSBOTermAsURL, getSBOTermID, getURI, getVersion, hashCode, hasValidLevelVersionNamespaceCombination, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetIdAttribute, isSetMetaId, isSetModelHistory, isSetNotes, isSetSBOTerm, isSetUserData, matchesRequiredSBMLNamespacesForAddition, matchesSBMLNamespaces, removeFromParentAndDelete, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, renameMetaIdRefs, renameSIdRefs, renameUnitSIdRefs, replaceTopLevelAnnotationElement, replaceTopLevelAnnotationElement, setAnnotation, setAnnotation, setIdAttribute, setMetaId, setModelHistory, setNamespaces, setNotes, setNotes, setNotes, setSBOTerm, setSBOTerm, toSBML, toXMLNode, unsetAnnotation, unsetCVTerms, unsetIdAttribute, unsetMetaId, unsetModelHistory, unsetNotes, unsetSBOTerm, unsetUserData

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Rectangle
```
public Rectangle(long level,
                 long version,
                 long pkgVersion)
          throws SBMLConstructorException
```
    Creates a new Rectangle using the given SBML Level, Version and “render” package version.
    
    Parameters:
    
    level - a long integer, the SBML Level to assign to this Rectangle.
    
    version - a long integer, the SBML Version to assign to this Rectangle.
    
    pkgVersion - a long integer, the SBML Render Version to assign to this Rectangle.
    
    Throws:
    
    SBMLConstructorException
    
    Note:
    
    Attempting to add an object to an SBMLDocument having a different combination of SBML Level, Version and XML namespaces than the object itself will result in an error at the time a caller attempts to make the addition. A parent object must have compatible Level, Version and XML namespaces. (Strictly speaking, a parent may also have more XML namespaces than a child, but the reverse is not permitted.) The restriction is necessary to ensure that an SBML model has a consistent overall structure. This requires callers to manage their objects carefully, but the benefit is increased flexibility in how models can be created by permitting callers to create objects bottom-up if desired. In situations where objects are not yet attached to parents (e.g., SBMLDocument), knowledge of the intented SBML Level and Version help libSBML determine such things as whether it is valid to assign a particular value to an attribute. For packages, this means that the parent object to which this package element is being added must have been created with the package namespace, or that the package namespace was added to it, even if that parent is not a package object itself.
  - Rectangle
```
public Rectangle(long level,
                 long version)
          throws SBMLConstructorException
```
    Creates a new Rectangle using the given SBML Level, Version and “render” package version.
    
    Parameters:
    
    level - a long integer, the SBML Level to assign to this Rectangle.
    
    version - a long integer, the SBML Version to assign to this Rectangle.
    
    pkgVersion - a long integer, the SBML Render Version to assign to this Rectangle.
    
    Throws:
    
    SBMLConstructorException
    
    Note:
    
    Attempting to add an object to an SBMLDocument having a different combination of SBML Level, Version and XML namespaces than the object itself will result in an error at the time a caller attempts to make the addition. A parent object must have compatible Level, Version and XML namespaces. (Strictly speaking, a parent may also have more XML namespaces than a child, but the reverse is not permitted.) The restriction is necessary to ensure that an SBML model has a consistent overall structure. This requires callers to manage their objects carefully, but the benefit is increased flexibility in how models can be created by permitting callers to create objects bottom-up if desired. In situations where objects are not yet attached to parents (e.g., SBMLDocument), knowledge of the intented SBML Level and Version help libSBML determine such things as whether it is valid to assign a particular value to an attribute. For packages, this means that the parent object to which this package element is being added must have been created with the package namespace, or that the package namespace was added to it, even if that parent is not a package object itself.
  - Rectangle
```
public Rectangle(long level)
          throws SBMLConstructorException
```
    Creates a new Rectangle using the given SBML Level, Version and “render” package version.
    
    Parameters:
    
    level - a long integer, the SBML Level to assign to this Rectangle.
    
    version - a long integer, the SBML Version to assign to this Rectangle.
    
    pkgVersion - a long integer, the SBML Render Version to assign to this Rectangle.
    
    Throws:
    
    SBMLConstructorException
    
    Note:
    
    Attempting to add an object to an SBMLDocument having a different combination of SBML Level, Version and XML namespaces than the object itself will result in an error at the time a caller attempts to make the addition. A parent object must have compatible Level, Version and XML namespaces. (Strictly speaking, a parent may also have more XML namespaces than a child, but the reverse is not permitted.) The restriction is necessary to ensure that an SBML model has a consistent overall structure. This requires callers to manage their objects carefully, but the benefit is increased flexibility in how models can be created by permitting callers to create objects bottom-up if desired. In situations where objects are not yet attached to parents (e.g., SBMLDocument), knowledge of the intented SBML Level and Version help libSBML determine such things as whether it is valid to assign a particular value to an attribute. For packages, this means that the parent object to which this package element is being added must have been created with the package namespace, or that the package namespace was added to it, even if that parent is not a package object itself.
  - Rectangle
```
public Rectangle()
          throws SBMLConstructorException
```
    Creates a new Rectangle using the given SBML Level, Version and “render” package version.
    
    Parameters:
    
    level - a long integer, the SBML Level to assign to this Rectangle.
    
    version - a long integer, the SBML Version to assign to this Rectangle.
    
    pkgVersion - a long integer, the SBML Render Version to assign to this Rectangle.
    
    Throws:
    
    SBMLConstructorException
    
    Note:
    
    Attempting to add an object to an SBMLDocument having a different combination of SBML Level, Version and XML namespaces than the object itself will result in an error at the time a caller attempts to make the addition. A parent object must have compatible Level, Version and XML namespaces. (Strictly speaking, a parent may also have more XML namespaces than a child, but the reverse is not permitted.) The restriction is necessary to ensure that an SBML model has a consistent overall structure. This requires callers to manage their objects carefully, but the benefit is increased flexibility in how models can be created by permitting callers to create objects bottom-up if desired. In situations where objects are not yet attached to parents (e.g., SBMLDocument), knowledge of the intented SBML Level and Version help libSBML determine such things as whether it is valid to assign a particular value to an attribute. For packages, this means that the parent object to which this package element is being added must have been created with the package namespace, or that the package namespace was added to it, even if that parent is not a package object itself.
  - Rectangle
```
public Rectangle(RenderPkgNamespaces renderns)
          throws SBMLConstructorException
```
    Creates a new Rectangle using the given RenderPkgNamespaces object.
    
    The package namespaces object used in this constructor is derived from a SBMLNamespaces object, which encapsulates SBML Level/Version/namespaces information. It is used to communicate the SBML Level, Version, and package version and name information used in addition to SBML Level 3 Core. A common approach to using libSBML's SBMLNamespaces facilities is to create an package namespace object somewhere in a program once, then hand that object as needed to object constructors of that package that accept it as and argument, such as this one.
    
    Parameters:
    
    renderns - the RenderPkgNamespaces object.
    
    Throws:
    
    SBMLConstructorException
    
    Note:
    
    Attempting to add an object to an SBMLDocument having a different combination of SBML Level, Version and XML namespaces than the object itself will result in an error at the time a caller attempts to make the addition. A parent object must have compatible Level, Version and XML namespaces. (Strictly speaking, a parent may also have more XML namespaces than a child, but the reverse is not permitted.) The restriction is necessary to ensure that an SBML model has a consistent overall structure. This requires callers to manage their objects carefully, but the benefit is increased flexibility in how models can be created by permitting callers to create objects bottom-up if desired. In situations where objects are not yet attached to parents (e.g., SBMLDocument), knowledge of the intented SBML Level and Version help libSBML determine such things as whether it is valid to assign a particular value to an attribute. For packages, this means that the parent object to which this package element is being added must have been created with the package namespace, or that the package namespace was added to it, even if that parent is not a package object itself.
  - Rectangle
```
public Rectangle(XMLNode node,
                 long l2version)
          throws SBMLConstructorException
```
    Creates a new Rectangle object from the given XMLNode object. The XMLNode object has to contain a valid XML representation of a Rectangle object as defined in the render extension specification. This method is normally called when render information is read from a file and should normally not have to be called explicitly.
    
    Parameters:
    
    node - the XMLNode object reference that describes the Rectangle object to be instantiated.
    
    l2version - an integer indicating the version of SBML Level 2
    
    Throws:
    
    SBMLConstructorException
  - Rectangle
```
public Rectangle(XMLNode node)
          throws SBMLConstructorException
```
    Creates a new Rectangle object from the given XMLNode object. The XMLNode object has to contain a valid XML representation of a Rectangle object as defined in the render extension specification. This method is normally called when render information is read from a file and should normally not have to be called explicitly.
    
    Parameters:
    
    node - the XMLNode object reference that describes the Rectangle object to be instantiated.
    
    l2version - an integer indicating the version of SBML Level 2
    
    Throws:
    
    SBMLConstructorException
  - Rectangle
```
public Rectangle(RenderPkgNamespaces renderns,
                 java.lang.String id)
          throws SBMLConstructorException
```
    Instantiates a new Rectangle object. All attributes are set as described for the default constructor of GraphicalPrimitive2D.
    The id is set to the given string and all rectangle specific attributes are set to 0.
    
    Parameters:
    
    renderns - the SBMLNamespaces object for the SBML 'render' package
    
    id - id string for the rectangle
    
    Throws:
    
    SBMLConstructorException
    
    Warning:
    
    This constructor is deprecated. The new libSBML API uses constructors that either take the SBML Level and Version, or take an SBMLNamespaces object.
  - Rectangle
```
public Rectangle(RenderPkgNamespaces renderns,
                 java.lang.String id,
                 RelAbsVector x,
                 RelAbsVector y,
                 RelAbsVector z,
                 RelAbsVector w,
                 RelAbsVector h)
          throws SBMLConstructorException
```
    Instantiates a new Rectangle object. All attributes are set as described for the default constructor of GraphicalPrimitive2D.
    The id is set to the given string and all rectangle specific attributes are set to the given values.
    
    Parameters:
    
    renderns - the SBMLNamespaces object for the SBML 'render' package
    
    id - id string for the rectangle
    
    x - x coordinate of the position
    
    y - y coordinate of the position
    
    z - z coordinate of the position
    
    w - w width
    
    h - h height
    
    Throws:
    
    SBMLConstructorException
    
    Warning:
    
    This constructor is deprecated. The new libSBML API uses constructors that either take the SBML Level and Version, or take an SBMLNamespaces object.
  - Rectangle
```
public Rectangle(RenderPkgNamespaces renderns,
                 java.lang.String id,
                 RelAbsVector x,
                 RelAbsVector y,
                 RelAbsVector w,
                 RelAbsVector h)
          throws SBMLConstructorException
```
    Instantiates a new Rectangle object. All attributes are set as described for the default constructor of GraphicalPrimitive2D.
    The id is set to the given string and all rectangle specific attributes are set to the given values. The z coordinate of the position is set to 0.
    
    Parameters:
    
    renderns - the SBMLNamespaces object for the SBML 'render' package
    
    id - id string for the rectangle
    
    x - x coordinate of the position
    
    y - y coordinate of the position
    
    w - w width
    
    h - h height
    
    Throws:
    
    SBMLConstructorException
    
    Warning:
    
    This constructor is deprecated. The new libSBML API uses constructors that either take the SBML Level and Version, or take an SBMLNamespaces object.
  - Rectangle
```
public Rectangle(Rectangle orig)
          throws SBMLConstructorException
```
    Copy constructor for Rectangle.
    
    Parameters:
    
    orig - the Rectangle instance to copy.
    
    Throws:
    
    SBMLConstructorException
- Method Detail
  - delete
```
public void delete()
```
    Explicitly deletes the underlying native object.
    In general, application software will not need to call this method directly. The Java language binding for libSBML is implemented as a language wrapper that provides a Java interface to libSBML's underlying C++/C code. Some of the Java methods return objects that are linked to objects created not by Java code, but by C++ code. The Java objects wrapped around them will be deleted when the garbage collector invokes the corresponding C++ finalize() methods for the objects. The finalize() methods in turn call the Rectangle.delete() method on the libSBML object.
    This method is exposed in case calling programs want to ensure that the underlying object is freed immediately, and not at some arbitrary time determined by the Java garbage collector. In normal usage, callers do not need to invoke Rectangle.delete() themselves.
    
    Overrides:
    
    delete in class GraphicalPrimitive2D
  - cloneObject
```
public Rectangle cloneObject()
```
    Creates and returns a deep copy of this Rectangle object.
    
    Overrides:
    
    cloneObject in class GraphicalPrimitive2D
    
    Returns:
    
    a (deep) copy of this Rectangle object.
  - getRatio
```
public double getRatio()
```
    Returns the value of the 'ratio' attribute of this Rectangle.
    
    Returns:
    
    the value of the 'ratio' attribute of this Rectangle as a double.
  - isSetRatio
```
public boolean isSetRatio()
```
    Predicate returning true if this Rectangle's 'ratio' attribute is set.
    
    Returns:
    
    true if this Rectangle's 'ratio' attribute has been set, otherwise false is returned.
  - setRatio
```
public int setRatio(double ratio)
```
    Sets the value of the 'ratio' attribute of this Rectangle.
    Parameters:
    
    ratio - double value of the 'ratio' attribute to be set.
    
    Returns:
    integer value indicating success/failure of the function. This particular function only does one thing irrespective of user input or object state, and thus will only return a single value:
    
    LIBSBML_OPERATION_SUCCESS OperationReturnValues_t}
  - unsetRatio
```
public int unsetRatio()
```
    Unsets the value of the 'ratio' attribute of this Rectangle.
    Returns:
    integer value indicating success/failure of the function. The possible values returned by this function are:
    
    LIBSBML_OPERATION_SUCCESS
    LIBSBML_OPERATION_FAILED
  - getX
```
public RelAbsVector getX()
```
    Returns the x coordinate of the rectangle's position
    
    Returns:
    
    reference to RelAbsVector that represents the x position
  - getY
```
public RelAbsVector getY()
```
    Returns the y coordinate of the rectangle's position
    
    Returns:
    
    reference to RelAbsVector that represents the y position
  - getZ
```
public RelAbsVector getZ()
```
    Returns the z coordinate of the rectangle's position
    
    Returns:
    
    reference to RelAbsVector that represents the z position
  - getWidth
```
public RelAbsVector getWidth()
```
    Returns the with of the rectangle
    
    Returns:
    
    reference to the RelAbsVector that represents the width
  - getHeight
```
public RelAbsVector getHeight()
```
    Returns the height of the rectangle
    
    Returns:
    
    reference to the RelAbsVector that represents the height
  - getRX
```
public RelAbsVector getRX()
```
    Returns the value of the 'rX' element of this Rectangle.
    
    Returns:
    
    the value of the 'rX' element of this Rectangle as a RelAbsVector.
  - getRadiusX
```
public RelAbsVector getRadiusX()
```
    Returns the corner radius along the x axis
    
    Returns:
    
    reference to the RelAbsVector that corner radius along the x axis
  - getRY
```
public RelAbsVector getRY()
```
    Returns the value of the 'rY' element of this Rectangle.
    
    Returns:
    
    the value of the 'rY' element of this Rectangle as a RelAbsVector.
  - getRadiusY
```
public RelAbsVector getRadiusY()
```
    Returns the corner radius along the y axis
    
    Returns:
    
    reference to the RelAbsVector that corner radius along the y axis
  - isSetX
```
public boolean isSetX()
```
    Predicate returning true if this Rectangle's 'x' attribute is set.
    
    Returns:
    
    true if this Rectangle's 'x' attribute has been set, otherwise false is returned.
  - isSetY
```
public boolean isSetY()
```
    Predicate returning true if this Rectangle's 'y' attribute is set.
    
    Returns:
    
    true if this Rectangle's 'y' attribute has been set, otherwise false is returned.
  - isSetZ
```
public boolean isSetZ()
```
    Predicate returning true if this Rectangle's 'z' attribute is set.
    
    Returns:
    
    true if this Rectangle's 'z' attribute has been set, otherwise false is returned.
  - isSetWidth
```
public boolean isSetWidth()
```
    Predicate returning true if this Rectangle's 'width' attribute is set.
    
    Returns:
    
    true if this Rectangle's 'width' attribute has been set, otherwise false is returned.
  - isSetHeight
```
public boolean isSetHeight()
```
    Predicate returning true if this Rectangle's 'height' attribute is set.
    
    Returns:
    
    true if this Rectangle's 'height' attribute has been set, otherwise false is returned.
  - isSetRX
```
public boolean isSetRX()
```
    Predicate returning true if this Rectangle's 'rX' attribute is set.
    
    Returns:
    
    true if this Rectangle's 'rX' attribute has been set, otherwise false is returned.
  - isSetRadiusX
```
public boolean isSetRadiusX()
```
    Predicate returning true if this Rectangle's 'rX' attribute is set.
    
    Returns:
    
    true if this Rectangle's 'rX' attribute has been set, otherwise false is returned.
  - isSetRY
```
public boolean isSetRY()
```
    Predicate returning true if this Rectangle's 'rY' attribute is set.
    
    Returns:
    
    true if this Rectangle's 'rY' attribute has been set, otherwise false is returned.
  - isSetRadiusY
```
public boolean isSetRadiusY()
```
    Predicate returning true if this Rectangle's 'rY' attribute is set.
    
    Returns:
    
    true if this Rectangle's 'rY' attribute has been set, otherwise false is returned.
  - setCoordinatesAndSize
```
public void setCoordinatesAndSize(RelAbsVector x,
                                  RelAbsVector y,
                                  RelAbsVector z,
                                  RelAbsVector w,
                                  RelAbsVector h)
```
    Sets the position and the size of the Rectangle within the viewport.
    
    Parameters:
    
    x - x coordinate of the position
    
    y - y coordinate of the position
    
    z - z coordinate of the position
    
    w - w width
    
    h - h height
  - setCoordinates
```
public void setCoordinates(RelAbsVector x,
                           RelAbsVector y,
                           RelAbsVector z)
```
    Sets the position of the Rectangle within the viewport.
    
    Parameters:
    
    x - x coordinate of the position
    
    y - y coordinate of the position
    
    z - z coordinate of the position
  - setSize
```
public void setSize(RelAbsVector w,
                    RelAbsVector h)
```
    Sets the size of the Rectangle
    
    Parameters:
    
    w - w width
    
    h - h height
  - setRadii
```
public void setRadii(RelAbsVector rx,
                     RelAbsVector ry)
```
    Sets the two corner radii of the rectangle
    
    Parameters:
    
    rx - corner radius along the x axis
    
    ry - corner radius along the y axis
  - setX
```
public int setX(RelAbsVector x)
```
    Sets the x position of the Rectangle within the viewport.
    Parameters:
    
    x - x coordinate of the position
    
    Returns:
    integer value indicating success/failure of the function. This particular function only does one thing irrespective of user input or object state, and thus will only return a single value:
    
    LIBSBML_OPERATION_SUCCESS
  - setY
```
public int setY(RelAbsVector y)
```
    Sets the y position of the Rectangle within the viewport.
    Parameters:
    
    y - y coordinate of the position
    
    Returns:
    integer value indicating success/failure of the function. This particular function only does one thing irrespective of user input or object state, and thus will only return a single value:
    
    LIBSBML_OPERATION_SUCCESS
  - setZ
```
public int setZ(RelAbsVector z)
```
    Sets the z position of the Rectangle within the viewport.
    Parameters:
    
    z - z coordinate of the position
    
    Returns:
    integer value indicating success/failure of the function. This particular function only does one thing irrespective of user input or object state, and thus will only return a single value:
    
    LIBSBML_OPERATION_SUCCESS
  - setWidth
```
public int setWidth(RelAbsVector w)
```
    Sets the width of the Rectangle
    Parameters:
    
    w - w width
    
    Returns:
    integer value indicating success/failure of the function. This particular function only does one thing irrespective of user input or object state, and thus will only return a single value:
    
    LIBSBML_OPERATION_SUCCESS
  - setHeight
```
public int setHeight(RelAbsVector h)
```
    Sets the height of the Rectangle
    Parameters:
    
    h - h height
    
    Returns:
    integer value indicating success/failure of the function. This particular function only does one thing irrespective of user input or object state, and thus will only return a single value:
    
    LIBSBML_OPERATION_SUCCESS
  - setRadiusX
```
public int setRadiusX(RelAbsVector rx)
```
    Sets the corner radius along the x axis
    Parameters:
    
    rx - corner radius along the x axis
    
    Returns:
    integer value indicating success/failure of the function. This particular function only does one thing irrespective of user input or object state, and thus will only return a single value:
    
    LIBSBML_OPERATION_SUCCESS
  - setRX
```
public int setRX(RelAbsVector rx)
```
    Sets the corner radius along the x axis
    Parameters:
    
    rx - corner radius along the x axis
    
    Returns:
    integer value indicating success/failure of the function. This particular function only does one thing irrespective of user input or object state, and thus will only return a single value:
    
    LIBSBML_OPERATION_SUCCESS
  - setRadiusY
```
public int setRadiusY(RelAbsVector ry)
```
    Sets the corner radius along the y axis
    Parameters:
    
    ry - corner radius along the y axis
    
    Returns:
    integer value indicating success/failure of the function. This particular function only does one thing irrespective of user input or object state, and thus will only return a single value:
    
    LIBSBML_OPERATION_SUCCESS
  - setRY
```
public int setRY(RelAbsVector ry)
```
    Sets the corner radius along the y axis
    Parameters:
    
    ry - corner radius along the y axis
    
    Returns:
    integer value indicating success/failure of the function. This particular function only does one thing irrespective of user input or object state, and thus will only return a single value:
    
    LIBSBML_OPERATION_SUCCESS
  - unsetX
```
public int unsetX()
```
    Unsets the value of the 'x' attribute of this Rectangle.
    Returns:
    integer value indicating success/failure of the function. This particular function only does one thing irrespective of user input or object state, and thus will only return a single value:
    
    LIBSBML_OPERATION_SUCCESS
  - unsetY
```
public int unsetY()
```
    Unsets the value of the 'y' attribute of this Rectangle.
    Returns:
    integer value indicating success/failure of the function. This particular function only does one thing irrespective of user input or object state, and thus will only return a single value:
    
    LIBSBML_OPERATION_SUCCESS
  - unsetZ
```
public int unsetZ()
```
    Unsets the value of the 'z' attribute of this Rectangle.
    Returns:
    integer value indicating success/failure of the function. This particular function only does one thing irrespective of user input or object state, and thus will only return a single value:
    
    LIBSBML_OPERATION_SUCCESS
  - unsetWidth
```
public int unsetWidth()
```
    Unsets the value of the 'width' attribute of this Rectangle.
    Returns:
    integer value indicating success/failure of the function. This particular function only does one thing irrespective of user input or object state, and thus will only return a single value:
    
    LIBSBML_OPERATION_SUCCESS
  - unsetHeight
```
public int unsetHeight()
```
    Unsets the value of the 'height' attribute of this Rectangle.
    Returns:
    integer value indicating success/failure of the function. This particular function only does one thing irrespective of user input or object state, and thus will only return a single value:
    
    LIBSBML_OPERATION_SUCCESS
  - unsetRadiusX
```
public int unsetRadiusX()
```
    Unsets the value of the 'rX' attribute of this Rectangle.
    Returns:
    integer value indicating success/failure of the function. This particular function only does one thing irrespective of user input or object state, and thus will only return a single value:
    
    LIBSBML_OPERATION_SUCCESS
  - unsetRX
```
public int unsetRX()
```
    Unsets the value of the 'rX' attribute of this Rectangle.
    Returns:
    integer value indicating success/failure of the function. This particular function only does one thing irrespective of user input or object state, and thus will only return a single value:
    
    LIBSBML_OPERATION_SUCCESS
  - unsetRadiusY
```
public int unsetRadiusY()
```
    Unsets the value of the 'rY' attribute of this Rectangle.
    Returns:
    integer value indicating success/failure of the function. This particular function only does one thing irrespective of user input or object state, and thus will only return a single value:
    
    LIBSBML_OPERATION_SUCCESS
  - unsetRY
```
public int unsetRY()
```
    Unsets the value of the 'rY' attribute of this Rectangle.
    Returns:
    integer value indicating success/failure of the function. This particular function only does one thing irrespective of user input or object state, and thus will only return a single value:
    
    LIBSBML_OPERATION_SUCCESS
  - getElementName
```
public java.lang.String getElementName()
```
    Returns the XML element name of this Rectangle object.
    For Rectangle, the XML element name is always 'rectangle'.
    
    Overrides:
    
    getElementName in class GraphicalPrimitive2D
    
    Returns:
    
    the name of this element, i.e. 'rectangle'.
  - getTypeCode
```
public int getTypeCode()
```
    Returns the libSBML type code for this Rectangle object.
    
    LibSBML attaches an identifying code to every kind of SBML object. These are integer constants known as SBML type codes. The names of all the codes begin with the characters SBML_. In the Java language interface for libSBML, the type codes are defined as static integer constants in the interface class libsbmlConstants. Note that different Level 3 package plug-ins may use overlapping type codes; to identify the package to which a given object belongs, call the SBase.getPackageName() method on the object.
    The exception to this is lists: all SBML-style list elements have the type SBML_LIST_OF, regardless of what package they are from.
    
    Overrides:
    
    getTypeCode in class GraphicalPrimitive2D
    
    Returns:
    
    the SBML type code for this object: SBML_RENDER_RECTANGLE.
    
    See Also:
    
    Rectangle.getElementName(), SBase.getPackageName()
    
    Warning:
    
    The specific integer values of the possible type codes may be reused by different libSBML plug-ins for SBML Level 3. packages, To fully identify the correct code, it is necessary to invoke both getPackageName() and getTypeCode() (or ListOf.getItemTypeCode()).
  - hasRequiredAttributes
```
public boolean hasRequiredAttributes()
```
    Predicate returning true if all the required attributes for this Rectangle object have been set.
    
    Overrides:
    
    hasRequiredAttributes in class GraphicalPrimitive2D
    
    Returns:
    
    true to indicate that all the required attributes of this Rectangle have been set, otherwise false is returned.
  - toXML
```
public XMLNode toXML()
```
    Creates an XMLNode object from this Rectangle object.
    
    Overrides:
    
    toXML in class GraphicalPrimitive1D
    
    Returns:
    
    the XMLNode with the XML representation for the Rectangle object.

Class Rectangle

Field Summary

Fields inherited from class org.sbml.libsbml.GraphicalPrimitive2D

Constructor Summary

Method Summary

Methods inherited from class org.sbml.libsbml.GraphicalPrimitive2D

Methods inherited from class org.sbml.libsbml.GraphicalPrimitive1D

Methods inherited from class org.sbml.libsbml.Transformation2D

Methods inherited from class org.sbml.libsbml.Transformation

Methods inherited from class org.sbml.libsbml.SBase

Methods inherited from class java.lang.Object

Constructor Detail

Rectangle

Rectangle

Rectangle

Rectangle

Rectangle

Rectangle

Rectangle

Rectangle

Rectangle

Rectangle

Rectangle

Method Detail

delete

cloneObject

getRatio

isSetRatio

setRatio

unsetRatio

getX

getY

getZ

getWidth

getHeight

getRX

getRadiusX

getRY

getRadiusY

isSetX

isSetY

isSetZ

isSetWidth

isSetHeight

isSetRX

isSetRadiusX

isSetRY

isSetRadiusY

setCoordinatesAndSize

setCoordinates

setSize

setRadii

setX

setY

setZ

setWidth

setHeight

setRadiusX

setRX

setRadiusY

setRY

unsetX

unsetY

unsetZ

unsetWidth

unsetHeight

unsetRadiusX

unsetRX

unsetRadiusY

unsetRY

getElementName

getTypeCode

hasRequiredAttributes

toXML