GraphicalPrimitive1D (LibSBML Java API)

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

Direct Known Subclasses:

GraphicalPrimitive2D, RenderCurve, Text
```
public class GraphicalPrimitive1D
extends Transformation2D
```
base class for all graphical primitives which implements all 1D attributes
The GraphicalPrimitive1D class implements attributes and methods necessary for 1D objects like lines. The attributes that are implemented are a stroke color, a stroke width and a stroke dasharray for dashed line drawing.
Additionally this class adds an id attribute with which all graphical primitives can be referenced.
The GraphicalPrimitive1D class is derived from Transformation2D and inherits all its methods and attributes.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addDash(long dash)` Adds a dash at the end of the current list
`void`	`clearDashes()` Clears all defined dashes.
`void`	`delete()` Explicitly deletes the underlying native object.
`long`	`getDashByIndex(long index)` Returns the dash at the given index.
`java.lang.String`	`getId()` Returns the value of the 'id' attribute of this GraphicalPrimitive.
`long`	`getNumDashes()` Returns the number of defined dashes.
`java.lang.String`	`getStroke()` Returns the stroke color.
`double`	`getStrokeWidth()` Returns the stroke width.
`void`	`insertDash(long index, long dash)` Inserts the dash at the given position.
`boolean`	`isSetDashArray()` Returns true is the dash array has been set or false otherwise.
`boolean`	`isSetId()` Predicate returning `true` or `false` depending on whether this GraphicalPrimitive's 'id' attribute has been set.
`boolean`	`isSetStroke()` Returns true is the stroke has been set or false otherwise.
`boolean`	`isSetStrokeWidth()` Returns true is the stroke width has been set or false otherwise.
`void`	`removeDash(long index)` Removes the dash at the given index
`void`	`setDashByIndex(long index, long dash)` Sets the dash at the given position.
`int`	`setId(java.lang.String id)` Sets the value of the 'id' attribute of this GraphicalPrimitive.
`void`	`setStroke(java.lang.String stroke)` Sets the stroke color to the given color definition id or color value string.
`void`	`setStrokeWidth(double width)` Sets the stroke width.
`XMLNode`	`toXML()` Creates an `XMLNode` object from this `GraphicalPrimitive1D` object.
`int`	`unsetId()` Unsets the value of the 'id' attribute of this GraphicalPrimitive.

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

Methods inherited from class org.sbml.libsbml.Transformation
getIdentityMatrix, getMatrix, getName, isSetMatrix, isSetName, setName, unsetName

Methods inherited from class org.sbml.libsbml.SBase
addCVTerm, addCVTerm, appendAnnotation, appendAnnotation, appendNotes, appendNotes, cloneObject, connectToChild, deleteDisabledPlugins, deleteDisabledPlugins, disablePackage, enablePackage, equals, getAncestorOfType, getAncestorOfType, getAnnotation, getAnnotationString, getColumn, getCVTerm, getCVTerms, getDisabledPlugin, getElementByMetaId, getElementBySId, getElementName, 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, getTypeCode, 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

- 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 GraphicalPrimitive1D.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 GraphicalPrimitive1D.delete() themselves.
    
    Overrides:
    
    delete in class Transformation2D
  - setStroke
```
public void setStroke(java.lang.String stroke)
```
    Sets the stroke color to the given color definition id or color value string. (
    
    Parameters:
    
    stroke - id of a ColorDefinition object or a valid color value string.
    
    See Also:
    
    ColorDefinition)
  - setStrokeWidth
```
public void setStrokeWidth(double width)
```
    Sets the stroke width.
    
    Parameters:
    
    width - New width for strokes. Should be a positive value.
  - getStroke
```
public java.lang.String getStroke()
```
    Returns the stroke color.
    
    Returns:
    
    the id of the color definition or a color value string.
  - getStrokeWidth
```
public double getStrokeWidth()
```
    Returns the stroke width.
    
    Returns:
    
    the stroke width
  - isSetStrokeWidth
```
public boolean isSetStrokeWidth()
```
    Returns true is the stroke width has been set or false otherwise. The stroke width is considered set if it is not NaN.
    
    Returns:
    
    true is the stroke width is set.
  - isSetStroke
```
public boolean isSetStroke()
```
    Returns true is the stroke has been set or false otherwise. The stroke color is considered set if the string is not empty.
    
    Returns:
    
    true if the stroke color is set.
  - isSetDashArray
```
public boolean isSetDashArray()
```
    Returns true is the dash array has been set or false otherwise. The array is considered set if it is not empty and if the first entry is not NaN.
  - getNumDashes
```
public long getNumDashes()
```
    Returns the number of defined dashes.
  - getDashByIndex
```
public long getDashByIndex(long index)
```
    Returns the dash at the given index.
  - addDash
```
public void addDash(long dash)
```
    Adds a dash at the end of the current list
  - clearDashes
```
public void clearDashes()
```
    Clears all defined dashes.
  - setDashByIndex
```
public void setDashByIndex(long index,
                           long dash)
```
    Sets the dash at the given position.
  - insertDash
```
public void insertDash(long index,
                       long dash)
```
    Inserts the dash at the given position.
  - removeDash
```
public void removeDash(long index)
```
    Removes the dash at the given index
  - toXML
```
public XMLNode toXML()
```
    Creates an XMLNode object from this GraphicalPrimitive1D object.
    
    Overrides:
    
    toXML in class Transformation2D
    
    Returns:
    
    the XMLNode with the XML representation for the GraphicalPrimitive1D object.
    This method is purely virtual and has to be implemented by subclasses.
  - getId
```
public java.lang.String getId()
```
    Returns the value of the 'id' attribute of this GraphicalPrimitive.
    
    Overrides:
    
    getId in class SBase
    
    Returns:
    
    the id of the GraphicalPrimitive
    
    See Also:
    
    SBase.getIdAttribute(), SBase.setIdAttribute(String sid), SBase.isSetIdAttribute(), SBase.unsetIdAttribute()
  - isSetId
```
public boolean isSetId()
```
    Predicate returning true or false depending on whether this GraphicalPrimitive's 'id' attribute has been set.
    
    Overrides:
    
    isSetId in class SBase
    
    Returns:
    
    returns true or false depending on whether the id on the GraphicalPrimitive has been set.
    
    See Also:
    
    SBase.getIdAttribute(), SBase.setIdAttribute(String sid), SBase.unsetIdAttribute(), SBase.isSetIdAttribute()
  - setId
```
public int setId(java.lang.String id)
```
    Sets the value of the 'id' attribute of this GraphicalPrimitive.
    
    Overrides:
    
    setId in class SBase
    
    Parameters:
    
    id - the new id for the GraphicalPrimitive
    
    Returns:
    
    status if the operation succeeded
    
    See Also:
    
    SBase.getIdAttribute(), SBase.setIdAttribute(String sid), SBase.isSetIdAttribute(), SBase.unsetIdAttribute()
  - unsetId
```
public int unsetId()
```
    Unsets the value of the 'id' attribute of this GraphicalPrimitive.
    Overrides:
    
    unsetId in class SBase
    
    Returns:
    integer value indicating success/failure of the function. The possible values returned by this function are:
    
    LIBSBML_OPERATION_SUCCESS
    LIBSBML_OPERATION_FAILED
    See Also:
    
    SBase.getIdAttribute(), SBase.setIdAttribute(String sid), SBase.isSetIdAttribute(), SBase.unsetIdAttribute()

Class GraphicalPrimitive1D

Method Summary

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

Method Detail

delete

setStroke

setStrokeWidth

getStroke

getStrokeWidth

isSetStrokeWidth

isSetStroke

isSetDashArray

getNumDashes

getDashByIndex

addDash

clearDashes

setDashByIndex

insertDash

removeDash

toXML

getId

isSetId

setId

unsetId