Shape (Bio-Formats API)

java.lang.Object
- ome.xml.model.AbstractOMEModelObject
- - ome.xml.model.Shape

All Implemented Interfaces:

OMEModelObject

Direct Known Subclasses:

Ellipse, Label, Line, Mask, Point, Polygon, Polyline, Rectangle
```
public abstract class Shape
extends AbstractOMEModelObject
```

Field Summary

Fields
Modifier and Type Field and Description

static String NAMESPACE

Fields
Modifier and Type	Field and Description
`static String`	`NAMESPACE`

Constructor Summary

Constructors
Constructor and Description

Shape()
Default constructor.

Shape(Element element, OMEModel model)
Constructs Shape recursively from an XML DOM tree.

Constructors
Constructor and Description
`Shape()` Default constructor.
`Shape(Element element, OMEModel model)` Constructs Shape recursively from an XML DOM tree.

Method Summary

Methods
Modifier and Type	Method and Description
`protected Element`	`asXMLElement(Document document, Element Shape_element)` Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.
`Color`	`getFillColor()`
`FillRule`	`getFillRule()`
`FontFamily`	`getFontFamily()`
`NonNegativeInteger`	`getFontSize()`
`FontStyle`	`getFontStyle()`
`String`	`getID()`
`LineCap`	`getLineCap()`
`Boolean`	`getLocked()`
`Color`	`getStrokeColor()`
`String`	`getStrokeDashArray()`
`Double`	`getStrokeWidth()`
`String`	`getText()`
`NonNegativeInteger`	`getTheC()`
`NonNegativeInteger`	`getTheT()`
`NonNegativeInteger`	`getTheZ()`
`AffineTransform`	`getTransform()`
`Union`	`getUnion()`
`Boolean`	`getVisible()`
`boolean`	`link(Reference reference, OMEModelObject o)` Link a given OME model object to this model object.
`void`	`setFillColor(Color fillColor)`
`void`	`setFillRule(FillRule fillRule)`
`void`	`setFontFamily(FontFamily fontFamily)`
`void`	`setFontSize(NonNegativeInteger fontSize)`
`void`	`setFontStyle(FontStyle fontStyle)`
`void`	`setID(String id)`
`void`	`setLineCap(LineCap lineCap)`
`void`	`setLocked(Boolean locked)`
`void`	`setStrokeColor(Color strokeColor)`
`void`	`setStrokeDashArray(String strokeDashArray)`
`void`	`setStrokeWidth(Double strokeWidth)`
`void`	`setText(String text)`
`void`	`setTheC(NonNegativeInteger theC)`
`void`	`setTheT(NonNegativeInteger theT)`
`void`	`setTheZ(NonNegativeInteger theZ)`
`void`	`setTransform(AffineTransform transform)`
`void`	`setUnion(Union union_BackReference)`
`void`	`setVisible(Boolean visible)`
`void`	`update(Element element, OMEModel model)` Updates Shape recursively from an XML DOM tree.

Methods inherited from class ome.xml.model.AbstractOMEModelObject
asXMLElement, getChildrenByTagName, stripNamespacePrefix, update

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NAMESPACE
```
public static final String NAMESPACE
```
    See Also:
    Constant Field Values
- Constructor Detail
  - Shape
```
public Shape()
```
    Default constructor.
  - Shape
```
public Shape(Element element,
     OMEModel model)
      throws EnumerationException
```
    Constructs Shape recursively from an XML DOM tree.
    
    Parameters:
    element - Root of the XML DOM tree to construct a model object graph from.
    model - Handler for the OME model which keeps track of instances and references seen during object population.
    
    Throws:
    
    EnumerationException - If there is an error instantiating an enumeration during model object creation.
- Method Detail
  - update
```
public void update(Element element,
          OMEModel model)
            throws EnumerationException
```
    Updates Shape recursively from an XML DOM tree. NOTE: No properties are removed, only added or updated.
    
    Specified by:
    
    update in interface OMEModelObject
    
    Overrides:
    
    update in class AbstractOMEModelObject
    
    Parameters:
    element - Root of the XML DOM tree to construct a model object graph from.
    model - Handler for the OME model which keeps track of instances and references seen during object population.
    
    Throws:
    
    EnumerationException - If there is an error instantiating an enumeration during model object creation.
  - link
```
public boolean link(Reference reference,
           OMEModelObject o)
```
    Description copied from interface: OMEModelObject
    
    Link a given OME model object to this model object.
    
    Specified by:
    
    link in interface OMEModelObject
    
    Overrides:
    
    link in class AbstractOMEModelObject
    
    Parameters:
    reference - The type qualifier for the reference. This should be the corresponding reference type for o. If, for example, o is of type Image, reference MUST be of type ImageRef.
    o - Model object to link to.
    
    Returns:
    true if this model object was able to handle the reference, false otherwise.
  - getStrokeDashArray
```
public String getStrokeDashArray()
```
  - setStrokeDashArray
```
public void setStrokeDashArray(String strokeDashArray)
```
  - getStrokeWidth
```
public Double getStrokeWidth()
```
  - setStrokeWidth
```
public void setStrokeWidth(Double strokeWidth)
```
  - getLocked
```
public Boolean getLocked()
```
  - setLocked
```
public void setLocked(Boolean locked)
```
  - getFillRule
```
public FillRule getFillRule()
```
  - setFillRule
```
public void setFillRule(FillRule fillRule)
```
  - getVisible
```
public Boolean getVisible()
```
  - setVisible
```
public void setVisible(Boolean visible)
```
  - getLineCap
```
public LineCap getLineCap()
```
  - setLineCap
```
public void setLineCap(LineCap lineCap)
```
  - getTheC
```
public NonNegativeInteger getTheC()
```
  - setTheC
```
public void setTheC(NonNegativeInteger theC)
```
  - getFontFamily
```
public FontFamily getFontFamily()
```
  - setFontFamily
```
public void setFontFamily(FontFamily fontFamily)
```
  - getFontStyle
```
public FontStyle getFontStyle()
```
  - setFontStyle
```
public void setFontStyle(FontStyle fontStyle)
```
  - getFontSize
```
public NonNegativeInteger getFontSize()
```
  - setFontSize
```
public void setFontSize(NonNegativeInteger fontSize)
```
  - getFillColor
```
public Color getFillColor()
```
  - setFillColor
```
public void setFillColor(Color fillColor)
```
  - getText
```
public String getText()
```
  - setText
```
public void setText(String text)
```
  - getStrokeColor
```
public Color getStrokeColor()
```
  - setStrokeColor
```
public void setStrokeColor(Color strokeColor)
```
  - getTheT
```
public NonNegativeInteger getTheT()
```
  - setTheT
```
public void setTheT(NonNegativeInteger theT)
```
  - getID
```
public String getID()
```
  - setID
```
public void setID(String id)
```
  - getTheZ
```
public NonNegativeInteger getTheZ()
```
  - setTheZ
```
public void setTheZ(NonNegativeInteger theZ)
```
  - getTransform
```
public AffineTransform getTransform()
```
  - setTransform
```
public void setTransform(AffineTransform transform)
```
  - getUnion
```
public Union getUnion()
```
  - setUnion
```
public void setUnion(Union union_BackReference)
```
  - asXMLElement
```
protected Element asXMLElement(Document document,
                   Element Shape_element)
```
    Description copied from class: AbstractOMEModelObject
    
    Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.
    
    Overrides:
    
    asXMLElement in class AbstractOMEModelObject
    
    Parameters:
    document - Destination document for element creation, etc.
    Shape_element - Element from the subclass. If null a new element will be created of this class.
    
    Returns:
    element populated with properties from this class.

Class Shape

Field Summary

Constructor Summary

Method Summary

Methods inherited from class ome.xml.model.AbstractOMEModelObject

Methods inherited from class java.lang.Object

Field Detail

NAMESPACE

Constructor Detail

Shape

Shape

Method Detail

update

link

getStrokeDashArray

setStrokeDashArray

getStrokeWidth

setStrokeWidth

getLocked

setLocked

getFillRule

setFillRule

getVisible

setVisible

getLineCap

setLineCap

getTheC

setTheC

getFontFamily

setFontFamily

getFontStyle

setFontStyle

getFontSize

setFontSize

getFillColor

setFillColor

getText

setText

getStrokeColor

setStrokeColor

getTheT

setTheT

getID

setID

getTheZ

setTheZ

getTransform

setTransform

getUnion

setUnion

asXMLElement