com.inscoper.nbo.Shape_Type¶

Represents the XML complex type Shape. More...

Inherits from com.inscoper.nbo.NBOBaseClass

Inherited by com.inscoper.nbo.Ellipse, com.inscoper.nbo.Label, com.inscoper.nbo.Line, com.inscoper.nbo.Mask, com.inscoper.nbo.Point, com.inscoper.nbo.Polygon, com.inscoper.nbo.Polyline, com.inscoper.nbo.Rectangle

Public Functions¶

	Name
synchronized void	delete()
	Shape_Type()
String	getTypeName() Returns the class type name.
String	getXMLName() Returns the XML element name corresponding to this class.
ENBOType	getNBOType() Returns the NBO Type corresponding to this class.
NBOBaseClassVector	getChildren() Returns a list of all classes derived from this class.
NBOBaseClassVector	getSubElements() Returns a list of all child elements contained in this class.
void	fromJsonFile(String path, boolean validate) Populates this object from a JSON file.
void	fromJsonFile(String path) Populates this object from a JSON file.
void	fromJsonString(String json_string, boolean validate) Populates this object from a JSON string.
void	fromJsonString(String json_string) Populates this object from a JSON string.
void	fromXmlFile(String path, boolean validate) Populates this object from a XML file.
void	fromXmlFile(String path) Populates this object from a XML file.
void	fromXmlString(String xml_string, boolean validate) Populates this object from a XML string.
void	fromXmlString(String xml_string) Populates this object from a XML string.
void	toXmlFile(String filename, boolean validate) Serializes this object to an XML file.
void	toXmlFile(String filename) Serializes this object to an XML file.
String	toXmlString(boolean validate) Serializes this object to an XML string.
String	toXmlString() Serializes this object to an XML string.
void	setFillColor(Color_Type value, boolean validate) Sets the value of the FillColor attribute.
void	setFillColor(Color_Type value) Sets the value of the FillColor attribute.
Color_Type	getFillColor() Returns the value of the FillColor attribute.
void	resetFillColor() Resets the FillColor attribute to an unset state.
boolean	hasFillColor() Checks whether the optional FillColor attribute is present.
void	setFillRule(String value, boolean validate) Sets the value of the FillRule attribute.
void	setFillRule(String value) Sets the value of the FillRule attribute.
String	getFillRule() Returns the value of the FillRule attribute.
void	resetFillRule() Resets the FillRule attribute to an unset state.
boolean	hasFillRule() Checks whether the FillRule attribute is present.
void	setStrokeColor(Color_Type value, boolean validate) Sets the value of the StrokeColor attribute.
void	setStrokeColor(Color_Type value) Sets the value of the StrokeColor attribute.
Color_Type	getStrokeColor() Returns the value of the StrokeColor attribute.
void	resetStrokeColor() Resets the StrokeColor attribute to an unset state.
boolean	hasStrokeColor() Checks whether the optional StrokeColor attribute is present.
void	setStrokeWidth(float value, boolean validate) Sets the value of the StrokeWidth attribute.
void	setStrokeWidth(float value) Sets the value of the StrokeWidth attribute.
float	getStrokeWidth() Returns the value of the StrokeWidth attribute.
void	resetStrokeWidth() Resets the StrokeWidth attribute to an unset state.
boolean	hasStrokeWidth() Checks whether the StrokeWidth attribute is present.
void	setStrokeWidthUnit(UnitsLength_Type value, boolean validate) Sets the value of the StrokeWidthUnit attribute.
void	setStrokeWidthUnit(UnitsLength_Type value) Sets the value of the StrokeWidthUnit attribute.
UnitsLength_Type	getStrokeWidthUnit() Returns the value of the StrokeWidthUnit attribute.
void	resetStrokeWidthUnit() Resets the StrokeWidthUnit attribute to an unset state.
boolean	hasStrokeWidthUnit() Checks whether the optional StrokeWidthUnit attribute is present.
void	setStrokeDashArray(String value, boolean validate) Sets the value of the StrokeDashArray attribute.
void	setStrokeDashArray(String value) Sets the value of the StrokeDashArray attribute.
String	getStrokeDashArray() Returns the value of the StrokeDashArray attribute.
void	resetStrokeDashArray() Resets the StrokeDashArray attribute to an unset state.
boolean	hasStrokeDashArray() Checks whether the StrokeDashArray attribute is present.
void	setText(String value, boolean validate) Sets the value of the Text attribute.
void	setText(String value) Sets the value of the Text attribute.
String	getText() Returns the value of the Text attribute.
void	resetText() Resets the Text attribute to an unset state.
boolean	hasText() Checks whether the Text attribute is present.
void	setFontFamily(String value, boolean validate) Sets the value of the FontFamily attribute.
void	setFontFamily(String value) Sets the value of the FontFamily attribute.
String	getFontFamily() Returns the value of the FontFamily attribute.
void	resetFontFamily() Resets the FontFamily attribute to an unset state.
boolean	hasFontFamily() Checks whether the FontFamily attribute is present.
void	setFontSize(NonNegativeInt_Type value, boolean validate) Sets the value of the FontSize attribute.
void	setFontSize(NonNegativeInt_Type value) Sets the value of the FontSize attribute.
NonNegativeInt_Type	getFontSize() Returns the value of the FontSize attribute.
void	resetFontSize() Resets the FontSize attribute to an unset state.
boolean	hasFontSize() Checks whether the optional FontSize attribute is present.
void	setFontSizeUnit(UnitsLength_Type value, boolean validate) Sets the value of the FontSizeUnit attribute.
void	setFontSizeUnit(UnitsLength_Type value) Sets the value of the FontSizeUnit attribute.
UnitsLength_Type	getFontSizeUnit() Returns the value of the FontSizeUnit attribute.
void	resetFontSizeUnit() Resets the FontSizeUnit attribute to an unset state.
boolean	hasFontSizeUnit() Checks whether the optional FontSizeUnit attribute is present.
void	setFontStyle(String value, boolean validate) Sets the value of the FontStyle attribute.
void	setFontStyle(String value) Sets the value of the FontStyle attribute.
String	getFontStyle() Returns the value of the FontStyle attribute.
void	resetFontStyle() Resets the FontStyle attribute to an unset state.
boolean	hasFontStyle() Checks whether the FontStyle attribute is present.
void	setLocked(boolean value, boolean validate) Sets the value of the Locked attribute.
void	setLocked(boolean value) Sets the value of the Locked attribute.
boolean	getLocked() Returns the value of the Locked attribute.
void	resetLocked() Resets the Locked attribute to an unset state.
boolean	hasLocked() Checks whether the Locked attribute is present.
void	setID(ShapeID_Type value, boolean validate) Sets the value of the ID attribute.
void	setID(ShapeID_Type value) Sets the value of the ID attribute.
ShapeID_Type	getID() Returns the value of the ID attribute.
void	resetID() Resets the ID attribute to an unset state.
boolean	hasID() Checks whether the optional ID attribute is present.
void	setTheZ(NonNegativeInt_Type value, boolean validate) Sets the value of the TheZ attribute.
void	setTheZ(NonNegativeInt_Type value) Sets the value of the TheZ attribute.
NonNegativeInt_Type	getTheZ() Returns the value of the TheZ attribute.
void	resetTheZ() Resets the TheZ attribute to an unset state.
boolean	hasTheZ() Checks whether the optional TheZ attribute is present.
void	setTheT(NonNegativeInt_Type value, boolean validate) Sets the value of the TheT attribute.
void	setTheT(NonNegativeInt_Type value) Sets the value of the TheT attribute.
NonNegativeInt_Type	getTheT() Returns the value of the TheT attribute.
void	resetTheT() Resets the TheT attribute to an unset state.
boolean	hasTheT() Checks whether the optional TheT attribute is present.
void	setTheC(NonNegativeInt_Type value, boolean validate) Sets the value of the TheC attribute.
void	setTheC(NonNegativeInt_Type value) Sets the value of the TheC attribute.
NonNegativeInt_Type	getTheC() Returns the value of the TheC attribute.
void	resetTheC() Resets the TheC attribute to an unset state.
boolean	hasTheC() Checks whether the optional TheC attribute is present.
void	setTransform(AffineTransform_Type value, boolean validate) Sets the value of the Transform element.
void	setTransform(AffineTransform_Type value) Sets the value of the Transform element.
AffineTransform_Type	getTransform() Returns the value of the Transform element.
void	resetTransform() Resets the Transform element to an unset state.
boolean	hasTransform() Checks whether the optional Transform element is present.
void	setAnnotationRef_List(AnnotationRefVector value, boolean validate) Sets the list of AnnotationRef elements.
void	setAnnotationRef_List(AnnotationRefVector value) Sets the list of AnnotationRef elements.
AnnotationRefVector	getAnnotationRef_List() Returns the list of AnnotationRef elements.
void	addToAnnotationRef_List(AnnotationRef value, boolean validate) Adds a new AnnotationRef element to this object.
void	addToAnnotationRef_List(AnnotationRef value) Adds a new AnnotationRef element to this object.
void	clearAnnotationRef_List() Clear the list of AnnotationRef.
Shape_Type	__internal_create(long cPtr, boolean own)
Shape_Type	fromBase(NBOBaseClass base) Cast a NBOBaseClass to a Shape_Type.
StringSet	getFillRuleAllowedValues() Returns the allowed values for this attribut.
StringSet	getStrokeDashArrayAllowedValues() Returns the allowed values for this attribut.
StringSet	getTextAllowedValues() Returns the allowed values for this attribut.
StringSet	getFontFamilyAllowedValues() Returns the allowed values for this attribut.
StringSet	getFontStyleAllowedValues() Returns the allowed values for this attribut.

Protected Functions¶

	Name
	Shape_Type(long cPtr, boolean cMemoryOwn)
void	swigSetCMemOwn(boolean own)
void	finalize()
long	getCPtr(Shape_Type obj)

Additional inherited members¶

Protected Functions inherited from com.inscoper.nbo.NBOBaseClass

	Name
	NBOBaseClass(long cPtr, boolean cMemoryOwn)

Detailed Description¶

public class com.inscoper.nbo.Shape_Type;

Represents the XML complex type Shape.

The shape element contains a single specific ROI shape and links that to any channels, and a timepoint and a z-section. It also records any transform applied to the ROI shape.

Public Functions Documentation¶

function delete¶

public synchronized void delete()

Reimplements: com.inscoper.nbo.NBOBaseClass.delete

Reimplemented by: com.inscoper.nbo.Ellipse.delete, com.inscoper.nbo.Label.delete, com.inscoper.nbo.Line.delete, com.inscoper.nbo.Mask.delete, com.inscoper.nbo.Point.delete, com.inscoper.nbo.Polygon.delete, com.inscoper.nbo.Polyline.delete, com.inscoper.nbo.Rectangle.delete

function Shape_Type¶

function getTypeName¶

public String getTypeName()

Returns the class type name.

Return: The class type name

Reimplements: com.inscoper.nbo.NBOBaseClass.getTypeName

Reimplemented by: com.inscoper.nbo.Ellipse.getTypeName, com.inscoper.nbo.Label.getTypeName, com.inscoper.nbo.Line.getTypeName, com.inscoper.nbo.Mask.getTypeName, com.inscoper.nbo.Point.getTypeName, com.inscoper.nbo.Polygon.getTypeName, com.inscoper.nbo.Polyline.getTypeName, com.inscoper.nbo.Rectangle.getTypeName

function getXMLName¶

public String getXMLName()

Returns the XML element name corresponding to this class.

Return: The XML element name

Reimplements: com.inscoper.nbo.NBOBaseClass.getXMLName

Reimplemented by: com.inscoper.nbo.Ellipse.getXMLName, com.inscoper.nbo.Label.getXMLName, com.inscoper.nbo.Line.getXMLName, com.inscoper.nbo.Mask.getXMLName, com.inscoper.nbo.Point.getXMLName, com.inscoper.nbo.Polygon.getXMLName, com.inscoper.nbo.Polyline.getXMLName, com.inscoper.nbo.Rectangle.getXMLName

function getNBOType¶

public ENBOType getNBOType()

Returns the NBO Type corresponding to this class.

Return: The NBO Type value

Reimplements: com.inscoper.nbo.NBOBaseClass.getNBOType

Reimplemented by: com.inscoper.nbo.Ellipse.getNBOType, com.inscoper.nbo.Label.getNBOType, com.inscoper.nbo.Line.getNBOType, com.inscoper.nbo.Mask.getNBOType, com.inscoper.nbo.Point.getNBOType, com.inscoper.nbo.Polygon.getNBOType, com.inscoper.nbo.Polyline.getNBOType, com.inscoper.nbo.Rectangle.getNBOType

function getChildren¶

public NBOBaseClassVector getChildren()

Returns a list of all classes derived from this class.

Return: The list of derived classes

Reimplements: com.inscoper.nbo.NBOBaseClass.getChildren

Reimplemented by: com.inscoper.nbo.Ellipse.getChildren, com.inscoper.nbo.Label.getChildren, com.inscoper.nbo.Line.getChildren, com.inscoper.nbo.Mask.getChildren, com.inscoper.nbo.Point.getChildren, com.inscoper.nbo.Polygon.getChildren, com.inscoper.nbo.Polyline.getChildren, com.inscoper.nbo.Rectangle.getChildren

function getSubElements¶

public NBOBaseClassVector getSubElements()

Returns a list of all child elements contained in this class.

Return: The list of child classes

Reimplements: com.inscoper.nbo.NBOBaseClass.getSubElements

Reimplemented by: com.inscoper.nbo.Ellipse.getSubElements, com.inscoper.nbo.Label.getSubElements, com.inscoper.nbo.Line.getSubElements, com.inscoper.nbo.Mask.getSubElements, com.inscoper.nbo.Point.getSubElements, com.inscoper.nbo.Polygon.getSubElements, com.inscoper.nbo.Polyline.getSubElements, com.inscoper.nbo.Rectangle.getSubElements

function fromJsonFile¶

public void fromJsonFile(
    String path,
    boolean validate
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file
validate If true, validates constraints on value. Default is true.

Reimplemented by: com.inscoper.nbo.Ellipse.fromJsonFile, com.inscoper.nbo.Label.fromJsonFile, com.inscoper.nbo.Line.fromJsonFile, com.inscoper.nbo.Mask.fromJsonFile, com.inscoper.nbo.Point.fromJsonFile, com.inscoper.nbo.Polygon.fromJsonFile, com.inscoper.nbo.Polyline.fromJsonFile, com.inscoper.nbo.Rectangle.fromJsonFile

function fromJsonFile¶

public void fromJsonFile(
    String path
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file

Reimplemented by: com.inscoper.nbo.Ellipse.fromJsonFile, com.inscoper.nbo.Label.fromJsonFile, com.inscoper.nbo.Line.fromJsonFile, com.inscoper.nbo.Mask.fromJsonFile, com.inscoper.nbo.Point.fromJsonFile, com.inscoper.nbo.Polygon.fromJsonFile, com.inscoper.nbo.Polyline.fromJsonFile, com.inscoper.nbo.Rectangle.fromJsonFile

function fromJsonString¶

public void fromJsonString(
    String json_string,
    boolean validate
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string
validate If true, validates constraints on value. Default is true.

Reimplemented by: com.inscoper.nbo.Ellipse.fromJsonString, com.inscoper.nbo.Label.fromJsonString, com.inscoper.nbo.Line.fromJsonString, com.inscoper.nbo.Mask.fromJsonString, com.inscoper.nbo.Point.fromJsonString, com.inscoper.nbo.Polygon.fromJsonString, com.inscoper.nbo.Polyline.fromJsonString, com.inscoper.nbo.Rectangle.fromJsonString

function fromJsonString¶

public void fromJsonString(
    String json_string
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string

Reimplemented by: com.inscoper.nbo.Ellipse.fromJsonString, com.inscoper.nbo.Label.fromJsonString, com.inscoper.nbo.Line.fromJsonString, com.inscoper.nbo.Mask.fromJsonString, com.inscoper.nbo.Point.fromJsonString, com.inscoper.nbo.Polygon.fromJsonString, com.inscoper.nbo.Polyline.fromJsonString, com.inscoper.nbo.Rectangle.fromJsonString

function fromXmlFile¶

public void fromXmlFile(
    String path,
    boolean validate
)

Populates this object from a XML file.

Parameters:

path The path to the XML file
validate If true, validates constraints on value. Default is true.

Reimplemented by: com.inscoper.nbo.Ellipse.fromXmlFile, com.inscoper.nbo.Label.fromXmlFile, com.inscoper.nbo.Line.fromXmlFile, com.inscoper.nbo.Mask.fromXmlFile, com.inscoper.nbo.Point.fromXmlFile, com.inscoper.nbo.Polygon.fromXmlFile, com.inscoper.nbo.Polyline.fromXmlFile, com.inscoper.nbo.Rectangle.fromXmlFile

function fromXmlFile¶

public void fromXmlFile(
    String path
)

Populates this object from a XML file.

Parameters:

path The path to the XML file

Reimplemented by: com.inscoper.nbo.Ellipse.fromXmlFile, com.inscoper.nbo.Label.fromXmlFile, com.inscoper.nbo.Line.fromXmlFile, com.inscoper.nbo.Mask.fromXmlFile, com.inscoper.nbo.Point.fromXmlFile, com.inscoper.nbo.Polygon.fromXmlFile, com.inscoper.nbo.Polyline.fromXmlFile, com.inscoper.nbo.Rectangle.fromXmlFile

function fromXmlString¶

public void fromXmlString(
    String xml_string,
    boolean validate
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string
validate If true, validates constraints on value. Default is true.

Reimplemented by: com.inscoper.nbo.Ellipse.fromXmlString, com.inscoper.nbo.Label.fromXmlString, com.inscoper.nbo.Line.fromXmlString, com.inscoper.nbo.Mask.fromXmlString, com.inscoper.nbo.Point.fromXmlString, com.inscoper.nbo.Polygon.fromXmlString, com.inscoper.nbo.Polyline.fromXmlString, com.inscoper.nbo.Rectangle.fromXmlString

function fromXmlString¶

public void fromXmlString(
    String xml_string
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string

Reimplemented by: com.inscoper.nbo.Ellipse.fromXmlString, com.inscoper.nbo.Label.fromXmlString, com.inscoper.nbo.Line.fromXmlString, com.inscoper.nbo.Mask.fromXmlString, com.inscoper.nbo.Point.fromXmlString, com.inscoper.nbo.Polygon.fromXmlString, com.inscoper.nbo.Polyline.fromXmlString, com.inscoper.nbo.Rectangle.fromXmlString

function toXmlFile¶

public void toXmlFile(
    String filename,
    boolean validate
)

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file
validate If true, validates constraints on value. Default is true.

Reimplemented by: com.inscoper.nbo.Ellipse.toXmlFile, com.inscoper.nbo.Label.toXmlFile, com.inscoper.nbo.Line.toXmlFile, com.inscoper.nbo.Mask.toXmlFile, com.inscoper.nbo.Point.toXmlFile, com.inscoper.nbo.Polygon.toXmlFile, com.inscoper.nbo.Polyline.toXmlFile, com.inscoper.nbo.Rectangle.toXmlFile

function toXmlFile¶

public void toXmlFile(
    String filename
)

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file

Reimplemented by: com.inscoper.nbo.Ellipse.toXmlFile, com.inscoper.nbo.Label.toXmlFile, com.inscoper.nbo.Line.toXmlFile, com.inscoper.nbo.Mask.toXmlFile, com.inscoper.nbo.Point.toXmlFile, com.inscoper.nbo.Polygon.toXmlFile, com.inscoper.nbo.Polyline.toXmlFile, com.inscoper.nbo.Rectangle.toXmlFile

function toXmlString¶

public String toXmlString(
    boolean validate
)

Serializes this object to an XML string.

Parameters:

validate If true, validates constraints on value. Default is true.

Return: A string containing the XML representation of this object

Reimplemented by: com.inscoper.nbo.Ellipse.toXmlString, com.inscoper.nbo.Label.toXmlString, com.inscoper.nbo.Line.toXmlString, com.inscoper.nbo.Mask.toXmlString, com.inscoper.nbo.Point.toXmlString, com.inscoper.nbo.Polygon.toXmlString, com.inscoper.nbo.Polyline.toXmlString, com.inscoper.nbo.Rectangle.toXmlString

function toXmlString¶

public String toXmlString()

Serializes this object to an XML string.

Return: A string containing the XML representation of this object

Reimplemented by: com.inscoper.nbo.Ellipse.toXmlString, com.inscoper.nbo.Label.toXmlString, com.inscoper.nbo.Line.toXmlString, com.inscoper.nbo.Mask.toXmlString, com.inscoper.nbo.Point.toXmlString, com.inscoper.nbo.Polygon.toXmlString, com.inscoper.nbo.Polyline.toXmlString, com.inscoper.nbo.Rectangle.toXmlString

function setFillColor¶

public void setFillColor(
    Color_Type value,
    boolean validate
)

Sets the value of the FillColor attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

The color of the fill - encoded as RGBA The value "-1" is #FFFFFFFF so solid white (it is a signed 32 bit value) NOTE: Prior to the 2012-06 schema the default value was incorrect and produced a transparent red not solid white.

function setFillColor¶

public void setFillColor(
    Color_Type value
)

Sets the value of the FillColor attribute.

Parameters:

value The value to set

The color of the fill - encoded as RGBA The value "-1" is #FFFFFFFF so solid white (it is a signed 32 bit value) NOTE: Prior to the 2012-06 schema the default value was incorrect and produced a transparent red not solid white.

function getFillColor¶

public Color_Type getFillColor()

Returns the value of the FillColor attribute.

Return: The value of the attribute

The color of the fill - encoded as RGBA The value "-1" is #FFFFFFFF so solid white (it is a signed 32 bit value) NOTE: Prior to the 2012-06 schema the default value was incorrect and produced a transparent red not solid white.

function resetFillColor¶

public void resetFillColor()

Resets the FillColor attribute to an unset state.

The color of the fill - encoded as RGBA The value "-1" is #FFFFFFFF so solid white (it is a signed 32 bit value) NOTE: Prior to the 2012-06 schema the default value was incorrect and produced a transparent red not solid white.

function hasFillColor¶

public boolean hasFillColor()

Checks whether the optional FillColor attribute is present.

Return: true if the optional attribute has been set, false otherwise

The color of the fill - encoded as RGBA The value "-1" is #FFFFFFFF so solid white (it is a signed 32 bit value) NOTE: Prior to the 2012-06 schema the default value was incorrect and produced a transparent red not solid white.

function setFillRule¶

public void setFillRule(
    String value,
    boolean validate
)

Sets the value of the FillRule attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

The rule used to decide which parts of the shape to fill. [enumeration]

function setFillRule¶

public void setFillRule(
    String value
)

Sets the value of the FillRule attribute.

Parameters:

value The value to set

The rule used to decide which parts of the shape to fill. [enumeration]

function getFillRule¶

function resetFillRule¶

function hasFillRule¶

public boolean hasFillRule()

Checks whether the FillRule attribute is present.

Return: true if the attribute has been set, false otherwise

The rule used to decide which parts of the shape to fill. [enumeration]

function setStrokeColor¶

public void setStrokeColor(
    Color_Type value,
    boolean validate
)

Sets the value of the StrokeColor attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

The color of the stroke - encoded as RGBA The value "-1" is #FFFFFFFF so solid white (it is a signed 32 bit value) NOTE: Prior to the 2012-06 schema the default value was incorrect and produced a transparent red not solid white.

function setStrokeColor¶

public void setStrokeColor(
    Color_Type value
)

Sets the value of the StrokeColor attribute.

Parameters:

value The value to set

The color of the stroke - encoded as RGBA The value "-1" is #FFFFFFFF so solid white (it is a signed 32 bit value) NOTE: Prior to the 2012-06 schema the default value was incorrect and produced a transparent red not solid white.

function getStrokeColor¶

public Color_Type getStrokeColor()

Returns the value of the StrokeColor attribute.

Return: The value of the attribute

The color of the stroke - encoded as RGBA The value "-1" is #FFFFFFFF so solid white (it is a signed 32 bit value) NOTE: Prior to the 2012-06 schema the default value was incorrect and produced a transparent red not solid white.

function resetStrokeColor¶

public void resetStrokeColor()

Resets the StrokeColor attribute to an unset state.

The color of the stroke - encoded as RGBA The value "-1" is #FFFFFFFF so solid white (it is a signed 32 bit value) NOTE: Prior to the 2012-06 schema the default value was incorrect and produced a transparent red not solid white.

function hasStrokeColor¶

public boolean hasStrokeColor()

Checks whether the optional StrokeColor attribute is present.

Return: true if the optional attribute has been set, false otherwise

The color of the stroke - encoded as RGBA The value "-1" is #FFFFFFFF so solid white (it is a signed 32 bit value) NOTE: Prior to the 2012-06 schema the default value was incorrect and produced a transparent red not solid white.

function setStrokeWidth¶

public void setStrokeWidth(
    float value,
    boolean validate
)

Sets the value of the StrokeWidth attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

The width of the stroke. Units are set by StrokeWidthUnit.

function setStrokeWidth¶

function getStrokeWidth¶

function resetStrokeWidth¶

function hasStrokeWidth¶

public boolean hasStrokeWidth()

Checks whether the StrokeWidth attribute is present.

Return: true if the attribute has been set, false otherwise

The width of the stroke. Units are set by StrokeWidthUnit.

function setStrokeWidthUnit¶

public void setStrokeWidthUnit(
    UnitsLength_Type value,
    boolean validate
)

Sets the value of the StrokeWidthUnit attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

The units used for the stroke width.

function setStrokeWidthUnit¶

function getStrokeWidthUnit¶

function resetStrokeWidthUnit¶

function hasStrokeWidthUnit¶

public boolean hasStrokeWidthUnit()

Checks whether the optional StrokeWidthUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

The units used for the stroke width.

function setStrokeDashArray¶

public void setStrokeDashArray(
    String value,
    boolean validate
)

Sets the value of the StrokeDashArray attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

e.g....................... "none", "10 20 30 10"

function setStrokeDashArray¶

function getStrokeDashArray¶

function resetStrokeDashArray¶

function hasStrokeDashArray¶

public boolean hasStrokeDashArray()

Checks whether the StrokeDashArray attribute is present.

Return: true if the attribute has been set, false otherwise

e.g....................... "none", "10 20 30 10"

function setText¶

public void setText(
    String value,
    boolean validate
)

Sets the value of the Text attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setText¶

function getText¶

function resetText¶

function hasText¶

function setFontFamily¶

public void setFontFamily(
    String value,
    boolean validate
)

Sets the value of the FontFamily attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

The font family used to draw the text. [enumeration] Note: these values are all lower case so they match the standard HTML/CSS values. "fantasy" has been included for completeness; we do not recommend its regular use. This attribute is under consideration for removal from the OME-XML schema.

function setFontFamily¶

public void setFontFamily(
    String value
)

Sets the value of the FontFamily attribute.

Parameters:

value The value to set

The font family used to draw the text. [enumeration] Note: these values are all lower case so they match the standard HTML/CSS values. "fantasy" has been included for completeness; we do not recommend its regular use. This attribute is under consideration for removal from the OME-XML schema.

function getFontFamily¶

public String getFontFamily()

Returns the value of the FontFamily attribute.

Return: The value of the attribute

The font family used to draw the text. [enumeration] Note: these values are all lower case so they match the standard HTML/CSS values. "fantasy" has been included for completeness; we do not recommend its regular use. This attribute is under consideration for removal from the OME-XML schema.

function resetFontFamily¶

public void resetFontFamily()

Resets the FontFamily attribute to an unset state.

The font family used to draw the text. [enumeration] Note: these values are all lower case so they match the standard HTML/CSS values. "fantasy" has been included for completeness; we do not recommend its regular use. This attribute is under consideration for removal from the OME-XML schema.

function hasFontFamily¶

public boolean hasFontFamily()

Checks whether the FontFamily attribute is present.

Return: true if the attribute has been set, false otherwise

The font family used to draw the text. [enumeration] Note: these values are all lower case so they match the standard HTML/CSS values. "fantasy" has been included for completeness; we do not recommend its regular use. This attribute is under consideration for removal from the OME-XML schema.

function setFontSize¶

public void setFontSize(
    NonNegativeInt_Type value,
    boolean validate
)

Sets the value of the FontSize attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

Size of the font. Units are set by FontSizeUnit.

function setFontSize¶

function getFontSize¶

function resetFontSize¶

function hasFontSize¶

public boolean hasFontSize()

Checks whether the optional FontSize attribute is present.

Return: true if the optional attribute has been set, false otherwise

Size of the font. Units are set by FontSizeUnit.

function setFontSizeUnit¶

public void setFontSizeUnit(
    UnitsLength_Type value,
    boolean validate
)

Sets the value of the FontSizeUnit attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

The units used for the font size.

function setFontSizeUnit¶

function getFontSizeUnit¶

function resetFontSizeUnit¶

function hasFontSizeUnit¶

public boolean hasFontSizeUnit()

Checks whether the optional FontSizeUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

The units used for the font size.

function setFontStyle¶

public void setFontStyle(
    String value,
    boolean validate
)

Sets the value of the FontStyle attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

The style and weight applied to the text. [enumeration] This is a simplified combination of the HTML/CSS attributes font-style AND font-weight.

function setFontStyle¶

public void setFontStyle(
    String value
)

Sets the value of the FontStyle attribute.

Parameters:

value The value to set

The style and weight applied to the text. [enumeration] This is a simplified combination of the HTML/CSS attributes font-style AND font-weight.

function getFontStyle¶

public String getFontStyle()

Returns the value of the FontStyle attribute.

Return: The value of the attribute

The style and weight applied to the text. [enumeration] This is a simplified combination of the HTML/CSS attributes font-style AND font-weight.

function resetFontStyle¶

public void resetFontStyle()

Resets the FontStyle attribute to an unset state.

The style and weight applied to the text. [enumeration] This is a simplified combination of the HTML/CSS attributes font-style AND font-weight.

function hasFontStyle¶

public boolean hasFontStyle()

Checks whether the FontStyle attribute is present.

Return: true if the attribute has been set, false otherwise

The style and weight applied to the text. [enumeration] This is a simplified combination of the HTML/CSS attributes font-style AND font-weight.

function setLocked¶

public void setLocked(
    boolean value,
    boolean validate
)

Sets the value of the Locked attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

Controls whether the shape is locked and read only, true is locked, false is editable.

function setLocked¶

public void setLocked(
    boolean value
)

Sets the value of the Locked attribute.

Parameters:

value The value to set

Controls whether the shape is locked and read only, true is locked, false is editable.

function getLocked¶

function resetLocked¶

function hasLocked¶

public boolean hasLocked()

Checks whether the Locked attribute is present.

Return: true if the attribute has been set, false otherwise

Controls whether the shape is locked and read only, true is locked, false is editable.

function setID¶

public void setID(
    ShapeID_Type value,
    boolean validate
)

Sets the value of the ID attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setID¶

function getID¶

function resetID¶

function hasID¶

function setTheZ¶

public void setTheZ(
    NonNegativeInt_Type value,
    boolean validate
)

Sets the value of the TheZ attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setTheZ¶

function getTheZ¶

function resetTheZ¶

function hasTheZ¶

function setTheT¶

public void setTheT(
    NonNegativeInt_Type value,
    boolean validate
)

Sets the value of the TheT attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

The timepoint the ROI applies to. If not specified then the ROI applies to all the timepoints of the Image. [units:none] This is numbered from 0.

function setTheT¶

public void setTheT(
    NonNegativeInt_Type value
)

Sets the value of the TheT attribute.

Parameters:

value The value to set

The timepoint the ROI applies to. If not specified then the ROI applies to all the timepoints of the Image. [units:none] This is numbered from 0.

function getTheT¶

public NonNegativeInt_Type getTheT()

Returns the value of the TheT attribute.

Return: The value of the attribute

The timepoint the ROI applies to. If not specified then the ROI applies to all the timepoints of the Image. [units:none] This is numbered from 0.

function resetTheT¶

public void resetTheT()

Resets the TheT attribute to an unset state.

The timepoint the ROI applies to. If not specified then the ROI applies to all the timepoints of the Image. [units:none] This is numbered from 0.

function hasTheT¶

public boolean hasTheT()

Checks whether the optional TheT attribute is present.

Return: true if the optional attribute has been set, false otherwise

The timepoint the ROI applies to. If not specified then the ROI applies to all the timepoints of the Image. [units:none] This is numbered from 0.

function setTheC¶

public void setTheC(
    NonNegativeInt_Type value,
    boolean validate
)

Sets the value of the TheC attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

The Channel the ROI applies to. If not specified then the ROI applies to all the channels of the Image. [units:none] This is numbered from 0.

function setTheC¶

public void setTheC(
    NonNegativeInt_Type value
)

Sets the value of the TheC attribute.

Parameters:

value The value to set

The Channel the ROI applies to. If not specified then the ROI applies to all the channels of the Image. [units:none] This is numbered from 0.

function getTheC¶

public NonNegativeInt_Type getTheC()

Returns the value of the TheC attribute.

Return: The value of the attribute

The Channel the ROI applies to. If not specified then the ROI applies to all the channels of the Image. [units:none] This is numbered from 0.

function resetTheC¶

public void resetTheC()

Resets the TheC attribute to an unset state.

The Channel the ROI applies to. If not specified then the ROI applies to all the channels of the Image. [units:none] This is numbered from 0.

function hasTheC¶

public boolean hasTheC()

Checks whether the optional TheC attribute is present.

Return: true if the optional attribute has been set, false otherwise

The Channel the ROI applies to. If not specified then the ROI applies to all the channels of the Image. [units:none] This is numbered from 0.

function setTransform¶

public void setTransform(
    AffineTransform_Type value,
    boolean validate
)

Sets the value of the Transform element.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This is a matrix used to transform the shape. The element has 6 xsd:float attributes. If the element is present then all 6 values must be included.

function setTransform¶

public void setTransform(
    AffineTransform_Type value
)

Sets the value of the Transform element.

Parameters:

value The value to set

This is a matrix used to transform the shape. The element has 6 xsd:float attributes. If the element is present then all 6 values must be included.

function getTransform¶

public AffineTransform_Type getTransform()

Returns the value of the Transform element.

Return: The value of the element

This is a matrix used to transform the shape. The element has 6 xsd:float attributes. If the element is present then all 6 values must be included.

function resetTransform¶

public void resetTransform()

Resets the Transform element to an unset state.

This is a matrix used to transform the shape. The element has 6 xsd:float attributes. If the element is present then all 6 values must be included.

function hasTransform¶

public boolean hasTransform()

Checks whether the optional Transform element is present.

Return: true if the optional attribute has been set, false otherwise

This is a matrix used to transform the shape. The element has 6 xsd:float attributes. If the element is present then all 6 values must be included.

function setAnnotationRef_List¶

public void setAnnotationRef_List(
    AnnotationRefVector value,
    boolean validate
)

Sets the list of AnnotationRef elements.

Parameters:

value The new list of AnnotationRef elements
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setAnnotationRef_List¶

public void setAnnotationRef_List(
    AnnotationRefVector value
)

Sets the list of AnnotationRef elements.

Parameters:

value The new list of AnnotationRef elements

No description available in the XSD standard.

function getAnnotationRef_List¶

function addToAnnotationRef_List¶

public void addToAnnotationRef_List(
    AnnotationRef value,
    boolean validate
)

Adds a new AnnotationRef element to this object.

Parameters:

value The element to add
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function addToAnnotationRef_List¶

public void addToAnnotationRef_List(
    AnnotationRef value
)

Adds a new AnnotationRef element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearAnnotationRef_List¶

function __internal_create¶

public static Shape_Type __internal_create(
    long cPtr,
    boolean own
)

Reimplements: com.inscoper.nbo.NBOBaseClass.__internal_create

Reimplemented by: com.inscoper.nbo.Ellipse.__internal_create, com.inscoper.nbo.Label.__internal_create, com.inscoper.nbo.Line.__internal_create, com.inscoper.nbo.Mask.__internal_create, com.inscoper.nbo.Point.__internal_create, com.inscoper.nbo.Polygon.__internal_create, com.inscoper.nbo.Polyline.__internal_create, com.inscoper.nbo.Rectangle.__internal_create

function fromBase¶

public static Shape_Type fromBase(
    NBOBaseClass base
)

Cast a NBOBaseClass to a Shape_Type.

Parameters:

base The base class to cast

Return: The casted element, or nullptr if the cast fails

Reimplemented by: com.inscoper.nbo.Ellipse.fromBase, com.inscoper.nbo.Label.fromBase, com.inscoper.nbo.Line.fromBase, com.inscoper.nbo.Mask.fromBase, com.inscoper.nbo.Point.fromBase, com.inscoper.nbo.Polygon.fromBase, com.inscoper.nbo.Polyline.fromBase, com.inscoper.nbo.Rectangle.fromBase

function getFillRuleAllowedValues¶

public static StringSet getFillRuleAllowedValues()

Returns the allowed values for this attribut.

Return: The list of allowed values

The rule used to decide which parts of the shape to fill. [enumeration]

function getStrokeDashArrayAllowedValues¶

function getTextAllowedValues¶

function getFontFamilyAllowedValues¶

public static StringSet getFontFamilyAllowedValues()

Returns the allowed values for this attribut.

Return: The list of allowed values

The font family used to draw the text. [enumeration] Note: these values are all lower case so they match the standard HTML/CSS values. "fantasy" has been included for completeness; we do not recommend its regular use. This attribute is under consideration for removal from the OME-XML schema.

function getFontStyleAllowedValues¶

public static StringSet getFontStyleAllowedValues()

Returns the allowed values for this attribut.

Return: The list of allowed values

The style and weight applied to the text. [enumeration] This is a simplified combination of the HTML/CSS attributes font-style AND font-weight.

Protected Functions Documentation¶

function Shape_Type¶

function swigSetCMemOwn¶

protected void swigSetCMemOwn(
    boolean own
)

Reimplements: com.inscoper.nbo.NBOBaseClass.swigSetCMemOwn

Reimplemented by: com.inscoper.nbo.Ellipse.swigSetCMemOwn, com.inscoper.nbo.Label.swigSetCMemOwn, com.inscoper.nbo.Line.swigSetCMemOwn, com.inscoper.nbo.Mask.swigSetCMemOwn, com.inscoper.nbo.Point.swigSetCMemOwn, com.inscoper.nbo.Polygon.swigSetCMemOwn, com.inscoper.nbo.Polyline.swigSetCMemOwn, com.inscoper.nbo.Rectangle.swigSetCMemOwn

function finalize¶

protected void finalize()

Reimplements: com.inscoper.nbo.NBOBaseClass.finalize

Reimplemented by: com.inscoper.nbo.Ellipse.finalize, com.inscoper.nbo.Label.finalize, com.inscoper.nbo.Line.finalize, com.inscoper.nbo.Mask.finalize, com.inscoper.nbo.Point.finalize, com.inscoper.nbo.Polygon.finalize, com.inscoper.nbo.Polyline.finalize, com.inscoper.nbo.Rectangle.finalize