omero.gateway.model

Class ShapeSettingsData

java.lang.Object

omero.gateway.model.DataObject

omero.gateway.model.ShapeSettingsData

public class ShapeSettingsData
extends DataObject

Stores the settings related to a given shape.

Since:

3.0-Beta4

Field Summary

Fields

Modifier and Type	Field and Description
static java.awt.Color	DEFAULT_FILL_COLOUR The default fill color.
static java.awt.Color	DEFAULT_FILL_COLOUR_ALPHA The default fill color.
static java.lang.String	DEFAULT_FONT_FAMILY The default font family.
static int	DEFAULT_FONT_SIZE The default font size in "pt".
static java.awt.Color	DEFAULT_STROKE_COLOUR The default stroke color.
static double	DEFAULT_STROKE_WIDTH The default stroke width.
static java.lang.String	FONT_BOLD Set if font bold.
static java.lang.String	FONT_BOLD_ITALIC Set if font bold.
static java.lang.String	FONT_ITALIC Set if font italic.
static java.lang.String	FONT_REGULAR Set if font bold.

Method Summary

Modifier and Type	Method and Description
static java.awt.Color	getColor(int rgba) Creates a Color object from an RGBA integer value
java.awt.Color	getFill() Returns the fill color.
java.lang.String	getFillRule() Returns the fill rule.
java.awt.Font	getFont() Get the style of the font for Shape.
java.lang.String	getFontFamily() Returns the stroke.
omero.model.Length	getFontSize(omero.model.enums.UnitsLength unit) Returns the stroke.
java.lang.String	getFontStyle() Returns the font style.
java.lang.String	getMarkerEnd() Returns the marker end.
java.lang.String	getMarkerStart() Returns the marker start.
static int	getRGBA(java.awt.Color c) Returns the Color's RGBA value as integer
java.awt.Color	getStroke() Returns the color of the stroke.
double[]	getStrokeDashArray() Returns the stroke dashes.
omero.model.Length	getStrokeWidth(omero.model.enums.UnitsLength unit) Returns the stroke's width (or 1 px if it's not set or less than or equals to 0)
boolean	isFontBold() Returns true if it is bold, false otherwise.
boolean	isFontItalic() Returns true if it is italic, false otherwise.
void	setFill(java.awt.Color fillColour) Set the fill color.
void	setFillRule(java.lang.String fillRule) Set the fill rule.
void	setFontFamily(java.lang.String fontFamily) Returns the stroke.
void	setFontSize(omero.model.Length fontSize) Set the size of the font.
void	setFontStyle(java.lang.String fontStyle) Sets the style of the font.
void	setMarkerEnd(java.lang.String end) Sets the marker end.
void	setMarkerStart(java.lang.String start) Sets the marker start.
void	setStroke(java.awt.Color strokeColour) Set the stroke color.
void	setStrokeDashArray(double[] dashArray) Set the stroke dashes.
void	setStrokeWidth(omero.model.Length strokeWidth) Set the stroke width.

Methods inherited from class omero.gateway.model.DataObject

asAnnotation, asChannel, asDataset, asExperimenter, asFolder, asGroup, asIAnnotated, asImage, asIObject, asPixels, asPlate, asPojo, asPojos, asPojos, asProject, asScreen, asWell, asWellSample, canAnnotate, canChgrp, canChown, 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

DEFAULT_FILL_COLOUR

public static final java.awt.Color DEFAULT_FILL_COLOUR

The default fill color.

DEFAULT_FILL_COLOUR_ALPHA

public static final java.awt.Color DEFAULT_FILL_COLOUR_ALPHA

The default fill color.

DEFAULT_STROKE_COLOUR

public static final java.awt.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 java.lang.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 java.lang.String FONT_ITALIC

Set if font italic.

See Also:

Constant Field Values

FONT_BOLD

public static final java.lang.String FONT_BOLD

Set if font bold.

See Also:

Constant Field Values

FONT_BOLD_ITALIC

public static final java.lang.String FONT_BOLD_ITALIC

Set if font bold.

See Also:

Constant Field Values

FONT_REGULAR

public static final java.lang.String FONT_REGULAR

Set if font bold.

See Also:

Constant Field Values

Method Detail

getRGBA

public static int getRGBA(java.awt.Color c)

Returns the Color's RGBA value as integer

Parameters:

c - The Color

Returns:

See above.

getColor

public static java.awt.Color getColor(int rgba)

Creates a Color object from an RGBA integer value

Parameters:

rgba - The RGBA value

Returns:

See above.

getFillRule

public java.lang.String getFillRule()

Returns the fill rule.

Returns:

See above.

setFillRule

public void setFillRule(java.lang.String fillRule)

Set the fill rule.

Parameters:

fillRule - See above.

getFill

public java.awt.Color getFill()

Returns the fill color.

Returns:

See above.

setFill

public void setFill(java.awt.Color fillColour)

Set the fill color.

Parameters:

fillColour - See above.

getStroke

public java.awt.Color getStroke()

Returns the color of the stroke.

Returns:

See above.

setStroke

public void setStroke(java.awt.Color strokeColour)

Set the stroke color.

Parameters:

strokeColour - 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 less than or equals to 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

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.

getFont

public java.awt.Font getFont()

Get the style of the font for Shape.

Returns:

See above.

getFontFamily

public java.lang.String getFontFamily()

Returns the stroke.

Returns:

See above.

setFontFamily

public void setFontFamily(java.lang.String fontFamily)

Returns the stroke.

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

public void setFontSize(omero.model.Length fontSize)

Set the size of the font.

getFontStyle

public java.lang.String getFontStyle()

Returns the font style.

Returns:

See above.

setFontStyle

public void setFontStyle(java.lang.String fontStyle)

Sets the style of the font.

getMarkerStart

public java.lang.String getMarkerStart()

Returns the marker start.

Returns:

See above.

getMarkerEnd

public java.lang.String getMarkerEnd()

Returns the marker end.

Returns:

See above.

setMarkerStart

public void setMarkerStart(java.lang.String start)

Sets the marker start.

Parameters:

start - The value to set.

setMarkerEnd

public void setMarkerEnd(java.lang.String end)

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