com.softwarefx.chartfx.server.annotation

Class AnnotationPicture

java.lang.Object

com.softwarefx.chartfx.server.annotation.AnnotationObject

com.softwarefx.chartfx.server.annotation.AnnotationPicture

public final class AnnotationPicture
extends AnnotationObject

Provides access to the AnnotationPicture object.

The AnnotationPicture class allows you to add annotation picture objects to your charting applications. The supported members allow you to configure your custom images and select the rendering style (original, stretch and tile).

Below is an example of an annotation picture object:

Constructor Summary

Constructors

Constructor and Description
AnnotationPicture() Constructs a newly allocated AnnotationPicture object
AnnotationPicture(java.awt.Image pic) Constructs a newly allocated AnnotationPicture object

Method Summary

Methods

Modifier and Type	Method and Description
AnnImageMode	getMode() Sets the rendering style for the image used as the annotation picture.
java.awt.Image	getPicture() Allows you to set the image for an annotation picture object.
void	resetMode() Set the property Mode to its default value.
void	resetPicture() Set the property Picture to its default value.
void	setMode(AnnImageMode value) Sets the rendering style for the image used as the annotation picture.
void	setPicture(java.awt.Image value) Allows you to set the image for an annotation picture object.
void	sizeToFit() Instructs Chart FX to resize a selected annotation picture object to fit the configured image.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnotationPicture

public AnnotationPicture()

Constructs a newly allocated AnnotationPicture object

AnnotationPicture

public AnnotationPicture(java.awt.Image pic)

Constructs a newly allocated AnnotationPicture object

Parameters:

pic -

Method Detail

getMode

public AnnImageMode getMode()

Sets the rendering style for the image used as the annotation picture.

Use the setPicture method to set the image to be used for the annotation picture object.

To set the annotation picture mode to 'Stretch':

See Also:

resetMode

setMode

public void setMode(AnnImageMode value)

Sets the rendering style for the image used as the annotation picture.

Use the setPicture method to set the image to be used for the annotation picture object.

To set the annotation picture mode to 'Stretch':

Parameters:

value -

See Also:

resetMode

getPicture

public java.awt.Image getPicture()

Allows you to set the image for an annotation picture object.

The setMode method allows you to set the image mode for the annotation picture. The mode enumerations are Original, Tile and Stretch.

Please remember you can set the setWidth and setHeight methods to change size of the annotation object. If you do not set the size of the annotation object, it will not appear in the chart area.

You may also attach the annotation picture to the chart using the supported method.

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

Set an image for the annotation picture object:

See Also:

resetPicture

setPicture

public void setPicture(java.awt.Image value)

Allows you to set the image for an annotation picture object.

The setMode method allows you to set the image mode for the annotation picture. The mode enumerations are Original, Tile and Stretch.

Please remember you can set the setWidth and setHeight methods to change size of the annotation object. If you do not set the size of the annotation object, it will not appear in the chart area.

You may also attach the annotation picture to the chart using the supported method.

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

Set an image for the annotation picture object:

Parameters:

value -

See Also:

resetPicture

resetMode

public void resetMode()

Set the property Mode to its default value.

See Also:

setMode

resetPicture

public void resetPicture()

Set the property Picture to its default value.

See Also:

setPicture

sizeToFit

public void sizeToFit()

Instructs Chart FX to resize a selected annotation picture object to fit the configured image.

The setMode method allows you to set the style for the image displayed to Tile, Stretch or Original for the picture object.

You can set the image for the annotation picture object using the setPicture method.

Set an annotation picture object to resize to the configured image: