ShapeSettingsData (OMERO (OME Remote Objects) Server)

java.lang.Object
- pojos.DataObject
- - pojos.ShapeSettingsData

```
public class ShapeSettingsData
extends DataObject
```
Stores the settings related to a given shape.

Since:

3.0-Beta4

Version:

3.0 (Internal version: $Revision: $Date: $)

Author:

Jean-Marie Burel j.burel@dundee.ac.uk, Donald MacDonald donald@lifesci.dundee.ac.uk

Field Summary

Fields
Modifier and Type	Field and Description
`static Color`	`DEFAULT_FILL_COLOUR` The default fill color.
`static Color`	`DEFAULT_FILL_COLOUR_ALPHA` The default fill color.
`static String`	`DEFAULT_FONT_FAMILY` The default font family.
`static int`	`DEFAULT_FONT_SIZE` The default font size in "pt".
`static Color`	`DEFAULT_STROKE_COLOUR` The default stroke color.
`static double`	`DEFAULT_STROKE_WIDTH` The default stroke width.
`static String`	`FONT_BOLD` Set if font bold.
`static String`	`FONT_BOLD_ITALIC` Set if font bold.
`static String`	`FONT_ITALIC` Set if font italic.
`static String`	`FONT_REGULAR` Set if font bold.
`static String`	`LINE_CAP_BUTT` The `Butt` descriptor.
`static String`	`LINE_CAP_ROUND` The `Round` descriptor.
`static String`	`LINE_CAP_SQUARE` The `Square` descriptor.

Method Summary

Methods
Modifier and Type	Method and Description
`Color`	`getFill()` Returns the fill color.
`String`	`getFillRule()` Returns the fill rule.
`Font`	`getFont()` Get the style of the font for Shape.
`String`	`getFontFamily()` Returns the stroke.
`double`	`getFontSize()` Deprecated. Replaced by `getFontSize(UnitsLength)`
`omero.model.Length`	`getFontSize(omero.model.enums.UnitsLength unit)` Returns the stroke.
`String`	`getFontStyle()` Returns the font style.
`int`	`getLineCap()` Returns the shape of the end of the line..
`String`	`getMarkerEnd()` Returns the marker end.
`String`	`getMarkerStart()` Returns the marker start.
`Color`	`getStroke()` Returns the color of the stroke.
`double[]`	`getStrokeDashArray()` Returns the stroke dashes.
`double`	`getStrokeWidth()` Deprecated. Replaced by `getStrokeWidth(UnitsLength)`
`omero.model.Length`	`getStrokeWidth(omero.model.enums.UnitsLength unit)` Returns the stroke's width (or 1 px if it's not set or <= 0)
`boolean`	`isFontBold()` Returns `true` if it is bold, `false` otherwise.
`boolean`	`isFontItalic()` Returns `true` if it is italic, `false` otherwise.
`void`	`setFill(Color fillColour)` Set the fill color.
`void`	`setFillRule(String fillRule)` Set the fill rule.
`void`	`setFontFamily(String fontFamily)` Returns the stroke.
`void`	`setFontSize(int fontSize)` Deprecated. Replaced by `setFontSize(Length)`
`void`	`setFontSize(omero.model.Length fontSize)` Set the size of the font.
`void`	`setFontStyle(String fontStyle)` Sets the style of the font.
`void`	`setLineCap(int lineCap)` Sets the line cap.
`String`	`setMarkerEnd(String end)` Returns the marker end.
`String`	`setMarkerStart(String start)` Returns the marker start.
`void`	`setStroke(Color strokeColour)` Set the stroke color.
`void`	`setStrokeDashArray(double[] dashArray)` Set the stroke dashes.
`void`	`setStrokeWidth(Double strokeWidth)` Deprecated. Replaced by `setStrokeWidth(Length)`
`void`	`setStrokeWidth(omero.model.Length strokeWidth)` Set the stroke width.

Methods inherited from class pojos.DataObject
asAnnotation, asChannel, asDataset, asExperimenter, asGroup, asIAnnotated, asImage, asIObject, asPixels, asPlate, asPojo, asPojos, asPojos, asProject, asScreen, asWell, asWellSample, canAnnotate, canDelete, canEdit, canLink, getCreated, getDetails, getGroupId, getId, getOwner, getPermissions, getUpdated, getVersion, isDirty, isLoaded, nullDetails, nullSafe, nullSafe, nullSafe, nullSafe, nullSafe, nullSafe, nullSafe, nullSafe, setDirty, setId, setValue, setVersion, timeOfEvent, toString

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

- Field Detail
  - LINE_CAP_BUTT
```
public static final String LINE_CAP_BUTT
```
    The Butt descriptor.
    
    See Also:
    Constant Field Values
  - LINE_CAP_ROUND
```
public static final String LINE_CAP_ROUND
```
    The Round descriptor.
    
    See Also:
    Constant Field Values
  - LINE_CAP_SQUARE
```
public static final String LINE_CAP_SQUARE
```
    The Square descriptor.
    
    See Also:
    Constant Field Values
  - DEFAULT_FILL_COLOUR
```
public static final Color DEFAULT_FILL_COLOUR
```
    The default fill color.
  - DEFAULT_FILL_COLOUR_ALPHA
```
public static final Color DEFAULT_FILL_COLOUR_ALPHA
```
    The default fill color.
  - DEFAULT_STROKE_COLOUR
```
public static final Color DEFAULT_STROKE_COLOUR
```
    The default stroke color.
  - DEFAULT_FONT_SIZE
```
public static final int DEFAULT_FONT_SIZE
```
    The default font size in "pt".
    
    See Also:
    Constant Field Values
  - DEFAULT_FONT_FAMILY
```
public static final String DEFAULT_FONT_FAMILY
```
    The default font family.
    
    See Also:
    Constant Field Values
  - DEFAULT_STROKE_WIDTH
```
public static final double DEFAULT_STROKE_WIDTH
```
    The default stroke width.
    
    See Also:
    Constant Field Values
  - FONT_ITALIC
```
public static final String FONT_ITALIC
```
    Set if font italic.
    
    See Also:
    Constant Field Values
  - FONT_BOLD
```
public static final String FONT_BOLD
```
    Set if font bold.
    
    See Also:
    Constant Field Values
  - FONT_BOLD_ITALIC
```
public static final String FONT_BOLD_ITALIC
```
    Set if font bold.
    
    See Also:
    Constant Field Values
  - FONT_REGULAR
```
public static final String FONT_REGULAR
```
    Set if font bold.
    
    See Also:
    Constant Field Values
- Method Detail
  - getFillRule
```
public String getFillRule()
```
    Returns the fill rule.
    
    Returns:
    See above.
  - setFillRule
```
public void setFillRule(String fillRule)
```
    Set the fill rule.
    
    Parameters:
    fillRule - See above.
  - getFill
```
public Color getFill()
```
    Returns the fill color.
    
    Returns:
    See above.
  - setFill
```
public void setFill(Color fillColour)
```
    Set the fill color.
    
    Parameters:
    fillColour - See above.
  - getStroke
```
public Color getStroke()
```
    Returns the color of the stroke.
    
    Returns:
    See above.
  - setStroke
```
public void setStroke(Color strokeColour)
```
    Set the stroke color.
    
    Parameters:
    strokeColour - See above.
  - getStrokeWidth
```
@Deprecated
public double getStrokeWidth()
```
    Deprecated. Replaced by getStrokeWidth(UnitsLength)
    
    Returns the stroke's width.
    
    Returns:
    See above.
  - getStrokeWidth
```
public omero.model.Length getStrokeWidth(omero.model.enums.UnitsLength unit)
                                  throws ome.model.units.BigResult
```
    Returns the stroke's width (or 1 px if it's not set or <= 0)
    
    Parameters:
    unit - The unit (may be null, in which case no conversion will be performed)
    
    Returns:
    See above.
    
    Throws:
    
    ome.model.units.BigResult - If an arithmetic under-/overflow occurred
  - setStrokeWidth
```
@Deprecated
public void setStrokeWidth(Double strokeWidth)
```
    Deprecated. Replaced by setStrokeWidth(Length)
    
    Set the stroke width.
    
    Parameters:
    strokeWidth - See above.
  - setStrokeWidth
```
public void setStrokeWidth(omero.model.Length strokeWidth)
```
    Set the stroke width.
    
    Parameters:
    strokeWidth - See above.
  - getStrokeDashArray
```
public double[] getStrokeDashArray()
```
    Returns the stroke dashes.
    
    Returns:
    See above.
  - setStrokeDashArray
```
public void setStrokeDashArray(double[] dashArray)
```
    Set the stroke dashes.
    
    Parameters:
    dashArray - See above.
  - getLineCap
```
public int getLineCap()
```
    Returns the shape of the end of the line..
    
    Returns:
    See above.
  - setLineCap
```
public void setLineCap(int lineCap)
```
    Sets the line cap.
    
    Parameters:
    lineCap - See above.
  - getFont
```
public Font getFont()
```
    Get the style of the font for Shape.
    
    Returns:
    See above.
  - getFontFamily
```
public String getFontFamily()
```
    Returns the stroke.
    
    Returns:
    See above.
  - setFontFamily
```
public void setFontFamily(String fontFamily)
```
    Returns the stroke.
  - getFontSize
```
@Deprecated
public double getFontSize()
```
    Deprecated. Replaced by getFontSize(UnitsLength)
    
    Returns the stroke.
    
    Returns:
    See above.
  - getFontSize
```
public omero.model.Length getFontSize(omero.model.enums.UnitsLength unit)
                               throws ome.model.units.BigResult
```
    Returns the stroke.
    
    Parameters:
    unit - The unit (may be null, in which case no conversion will be performed)
    
    Returns:
    See above.
    
    Throws:
    
    ome.model.units.BigResult - If an arithmetic under-/overflow occurred
  - setFontSize
```
@Deprecated
public void setFontSize(int fontSize)
```
    Deprecated. Replaced by setFontSize(Length)
    
    Set the size of the font.
  - setFontSize
```
public void setFontSize(omero.model.Length fontSize)
```
    Set the size of the font.
  - getFontStyle
```
public String getFontStyle()
```
    Returns the font style.
    
    Returns:
    See above.
  - setFontStyle
```
public void setFontStyle(String fontStyle)
```
    Sets the style of the font.
  - getMarkerStart
```
public String getMarkerStart()
```
    Returns the marker start.
    
    Returns:
    See above.
  - getMarkerEnd
```
public String getMarkerEnd()
```
    Returns the marker end.
    
    Returns:
    See above.
  - setMarkerStart
```
public String setMarkerStart(String start)
```
    Returns the marker start.
    
    Parameters:
    start - The value to set.
  - setMarkerEnd
```
public String setMarkerEnd(String end)
```
    Returns the marker end.
    
    Parameters:
    end - The value to set.
  - isFontItalic
```
public boolean isFontItalic()
```
    Returns true if it is italic, false otherwise.
    
    Returns:
    See above.
  - isFontBold
```
public boolean isFontBold()
```
    Returns true if it is bold, false otherwise.
    
    Returns:
    See above.

Class ShapeSettingsData

Field Summary

Method Summary

Methods inherited from class pojos.DataObject

Methods inherited from class java.lang.Object

Field Detail

LINE_CAP_BUTT

LINE_CAP_ROUND

LINE_CAP_SQUARE

DEFAULT_FILL_COLOUR

DEFAULT_FILL_COLOUR_ALPHA

DEFAULT_STROKE_COLOUR

DEFAULT_FONT_SIZE

DEFAULT_FONT_FAMILY

DEFAULT_STROKE_WIDTH

FONT_ITALIC

FONT_BOLD

FONT_BOLD_ITALIC

FONT_REGULAR

Method Detail

getFillRule

setFillRule

getFill

setFill

getStroke

setStroke

getStrokeWidth

getStrokeWidth

setStrokeWidth

setStrokeWidth

getStrokeDashArray

setStrokeDashArray

getLineCap

setLineCap

getFont

getFontFamily

setFontFamily

getFontSize

getFontSize

setFontSize

setFontSize

getFontStyle

setFontStyle

getMarkerStart

getMarkerEnd

setMarkerStart

setMarkerEnd

isFontItalic

isFontBold