com.softwarefx.chartfx.server.annotation

Class AnnotationGroup

java.lang.Object

com.softwarefx.chartfx.server.annotation.AnnotationObject

com.softwarefx.chartfx.server.annotation.AnnotationGroup

public final class AnnotationGroup
extends AnnotationObject

Provides access to the AnnotationGroup object.

The AnnotationGroup class allows you to group individual annotation objects together. Because the group object exposes all the common methods, you can change visual attributes of objects in a group with just one method call. For example, if you create a group of 10 circles, you can change the background color of all circles by invoking the setColor method. The AnnotationListBase class exposes members that allow you to Add, Remove and Count objects in a group.

To create a group, first create an annotation extension object. Once you have created and added the extension object to your application you may begin creating the individual objects to be included in the group and the group object itself. Once you have created all the objects, you must add the individual objects to the group and the group to the annotation list.

Below is an example of creating a group of 3 circles:

Constructor Summary

Constructors

Constructor and Description
AnnotationGroup() Constructs a newly allocated AnnotationGroup object
AnnotationGroup(AnnotationObject[] annotationObjects) Constructs a newly allocated AnnotationGroup object

Method Summary

Methods

Modifier and Type	Method and Description
Line	getBorder() Allows you to apply border attributes to a selected annotation group.
java.awt.Color	getColor() Sets the inside fill color for the objects included in an annotation group.
com.softwarefx.server.Link	getLink() Gets the Link object for a selected AnnotationGroup.
AnnotationListBase	getList() Allows you to access the CollectionBase members used modify the annotation group.
HatchStyle	getPattern() Used to set a pattern style for a group of annotation objects.
void	recalcBounds() Used to recalculate the bounding rectangle for a group of objects.
void	setBorder(Line value) Allows you to apply border attributes to a selected annotation group.
void	setColor(java.awt.Color value) Sets the inside fill color for the objects included in an annotation group.
void	setPattern(HatchStyle value) Used to set a pattern style for a group of annotation objects.

Methods inherited from class com.softwarefx.chartfx.server.annotation.AnnotationObject

attach, attach, attach, attach, attach, attach, attach, detach, flip, getAnchor, getHeight, getLeft, getObjectBounds, getTag, getTop, getWidth, isAllowModify, isAllowMove, isPaintBefore, isPlotAreaOnly, isVisible, refresh, resetAllowModify, resetAllowMove, resetAnchor, resetBoundsNormalized, resetColor, resetPaintBefore, resetPattern, resetPlotAreaOnly, resetVisible, rotate, setAllowModify, setAllowMove, setAnchor, setHeight, setLeft, setObjectBounds, setPaintBefore, setPlotAreaOnly, setTag, setTop, setVisible, setWidth

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AnnotationGroup

public AnnotationGroup()

Constructs a newly allocated AnnotationGroup object

AnnotationGroup

public AnnotationGroup(AnnotationObject[] annotationObjects)

Constructs a newly allocated AnnotationGroup object

Parameters:

annotationObjects -

Method Detail

getBorder

public Line getBorder()

Allows you to apply border attributes to a selected annotation group.

Overrides:

getBorder in class AnnotationObject

setBorder

public void setBorder(Line value)

Allows you to apply border attributes to a selected annotation group.

Overrides:

setBorder in class AnnotationObject

Parameters:

value -

getColor

public java.awt.Color getColor()

Sets the inside fill color for the objects included in an annotation group.

When setting this method for an annotation group, all objects included in the group will be set the configured color of this method. The border of the annotation objects can be modified using the setBorder method.

For more information regarding the Color type, please refer to the Documentation.

Set the color for the annotation group to green:

Overrides:

getColor in class AnnotationObject

See Also:

resetColor

setColor

public void setColor(java.awt.Color value)

Sets the inside fill color for the objects included in an annotation group.

When setting this method for an annotation group, all objects included in the group will be set the configured color of this method. The border of the annotation objects can be modified using the setBorder method.

For more information regarding the Color type, please refer to the Documentation.

Set the color for the annotation group to green:

Overrides:

setColor in class AnnotationObject

Parameters:

value -

See Also:

resetColor

getLink

public com.softwarefx.server.Link getLink()

Gets the Link object for a selected AnnotationGroup.

Overrides:

getLink in class AnnotationObject

getList

public AnnotationListBase getList()

Allows you to access the CollectionBase members used modify the annotation group.

getPattern

public HatchStyle getPattern()

Used to set a pattern style for a group of annotation objects.

Overrides:

getPattern in class AnnotationObject

See Also:

resetPattern

setPattern

public void setPattern(HatchStyle value)

Used to set a pattern style for a group of annotation objects.

Overrides:

setPattern in class AnnotationObject

Parameters:

value -

See Also:

resetPattern

recalcBounds

public void recalcBounds()

Used to recalculate the bounding rectangle for a group of objects.

This method should be invoked every time an object is added to a group or when any of the objects contained in a group is resized or moved.

To recalculate the bounding rectangle for a annotation group called 'group1':