com.softwarefx.chartfx.server.annotation

Class AnnotationBalloon

java.lang.Object

com.softwarefx.chartfx.server.annotation.AnnotationObject

com.softwarefx.chartfx.server.annotation.AnnotationText

com.softwarefx.chartfx.server.annotation.AnnotationBalloon

public final class AnnotationBalloon
extends AnnotationText

Provides access to the AnnotationBalloon object.

The AnnotationBalloon class enables you to add balloon objects in your charts. Balloon objects are like a Text objects, but the text is enclosed in a balloon type shape.

Note: Remember you can assign negative values to both the Width and Height methods. This will allow you to set the appropriate orientation to the balloon and the balloon tip.

Constructor Summary

Constructors

Constructor and Description
AnnotationBalloon() Constructs a newly allocated AnnotationBalloon object

Method Summary

Methods

Modifier and Type	Method and Description
AdjustableArrowCap	getArrowCap() Allows you to control the arrow head height, width and style when used with the annotation balloon object.
int	getArrowX() Sets the X coordinate value for the balloon tip when set to be an arrow.
int	getArrowY() Sets the Y coordinate value for the balloon tip when set to be an arrow.
int	getCornerRadius() Used to set the corner radius for a selected balloon annotation object.
int	getShadow() Allows you to set a shadow for balloon annotation object.
BalloonTailCorner	getTailCorner() Gets or sets the corner of the balloon the tip or arrow.
int	getTailFactor() Used to get or set the annotation balloon tip size.
boolean	isUseArrow() Instructs Chart FX to use an arrow instead of the balloon tip.
void	resetArrowX() Set the property ArrowX to its default value.
void	resetArrowY() Set the property ArrowY to its default value.
void	resetCornerRadius() Set the property CornerRadius to its default value.
void	resetShadow() Set the property Shadow to its default value.
void	resetTailCorner() Set the property TailCorner to its default value.
void	resetTailFactor() Set the property TailFactor to its default value.
void	resetUseArrow() Set the property UseArrow to its default value.
void	setArrowCap(AdjustableArrowCap value) Allows you to control the arrow head height, width and style when used with the annotation balloon object.
void	setArrowX(int value) Sets the X coordinate value for the balloon tip when set to be an arrow.
void	setArrowY(int value) Sets the Y coordinate value for the balloon tip when set to be an arrow.
void	setCornerRadius(int value) Used to set the corner radius for a selected balloon annotation object.
void	setShadow(int value) Allows you to set a shadow for balloon annotation object.
void	setTailCorner(BalloonTailCorner value) Gets or sets the corner of the balloon the tip or arrow.
void	setTailFactor(int value) Used to get or set the annotation balloon tip size.
void	setUseArrow(boolean value) Instructs Chart FX to use an arrow instead of the balloon tip.

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

getAlign, getFont, getLineAlignment, getOrientation, getText, getTextColor, isClip, isWordWrap, resetAlign, resetFont, resetLineAlignment, resetOrientation, resetText, resetTextColor, resetTextStyle, setAlign, setClip, setFont, setLineAlignment, setOrientation, setText, setTextColor, setWordWrap, sizeToFit

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

AnnotationBalloon

public AnnotationBalloon()

Constructs a newly allocated AnnotationBalloon object

Method Detail

getArrowCap

public AdjustableArrowCap getArrowCap()

Allows you to control the arrow head height, width and style when used with the annotation balloon object.

setArrowCap

public void setArrowCap(AdjustableArrowCap value)

Allows you to control the arrow head height, width and style when used with the annotation balloon object.

Parameters:

value -

getArrowX

public int getArrowX()

Sets the X coordinate value for the balloon tip when set to be an arrow.

See Also:

resetArrowX

setArrowX

public void setArrowX(int value)

Sets the X coordinate value for the balloon tip when set to be an arrow.

Parameters:

value -

See Also:

resetArrowX

getArrowY

public int getArrowY()

Sets the Y coordinate value for the balloon tip when set to be an arrow.

See Also:

resetArrowY

setArrowY

public void setArrowY(int value)

Sets the Y coordinate value for the balloon tip when set to be an arrow.

Parameters:

value -

See Also:

resetArrowY

getCornerRadius

public int getCornerRadius()

Used to set the corner radius for a selected balloon annotation object.

The greater value you set to this method, the more the balloon annotation object begins to look like a circle. Setting a radius value greater than 5 makes the balloon object appear more round in shape.

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.

The attach method may be used to set the location in the chart for annotation objects.

To make the annotation balloon look more round in shape:

See Also:

resetCornerRadius

setCornerRadius

public void setCornerRadius(int value)

Used to set the corner radius for a selected balloon annotation object.

The greater value you set to this method, the more the balloon annotation object begins to look like a circle. Setting a radius value greater than 5 makes the balloon object appear more round in shape.

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.

The attach method may be used to set the location in the chart for annotation objects.

To make the annotation balloon look more round in shape:

Parameters:

value -

See Also:

resetCornerRadius

getShadow

public int getShadow()

Allows you to set a shadow for balloon annotation object.

This method is set using an integer value. When the setShadow method is set to zero (0), no shadow is applied to the balloon annotation object. When the setShadow method is set to a value greater that one (1), the shadow will be greater than the default.

The larger the configured value, the higher the balloon annotation object appears to be lifted off the chart (showing a larger shadow).

Please remember you to 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.

Do not show a shadow for the balloon annotation object:

See Also:

resetShadow

setShadow

public void setShadow(int value)

Allows you to set a shadow for balloon annotation object.

This method is set using an integer value. When the setShadow method is set to zero (0), no shadow is applied to the balloon annotation object. When the setShadow method is set to a value greater that one (1), the shadow will be greater than the default.

The larger the configured value, the higher the balloon annotation object appears to be lifted off the chart (showing a larger shadow).

Please remember you to 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.

Do not show a shadow for the balloon annotation object:

Parameters:

value -

See Also:

resetShadow

getTailCorner

public BalloonTailCorner getTailCorner()

Gets or sets the corner of the balloon the tip or arrow.

See Also:

resetTailCorner

setTailCorner

public void setTailCorner(BalloonTailCorner value)

Gets or sets the corner of the balloon the tip or arrow.

Parameters:

value -

See Also:

resetTailCorner

getTailFactor

public int getTailFactor()

Used to get or set the annotation balloon tip size.

See Also:

resetTailFactor

setTailFactor

public void setTailFactor(int value)

Used to get or set the annotation balloon tip size.

Parameters:

value -

See Also:

resetTailFactor

isUseArrow

public boolean isUseArrow()

Instructs Chart FX to use an arrow instead of the balloon tip.

See Also:

resetUseArrow

setUseArrow

public void setUseArrow(boolean value)

Instructs Chart FX to use an arrow instead of the balloon tip.

Parameters:

value -

See Also:

resetUseArrow

resetArrowX

public void resetArrowX()

Set the property ArrowX to its default value.

See Also:

setArrowX

resetArrowY

public void resetArrowY()

Set the property ArrowY to its default value.

See Also:

setArrowY

resetCornerRadius

public void resetCornerRadius()

Set the property CornerRadius to its default value.

See Also:

setCornerRadius

resetShadow

public void resetShadow()

Set the property Shadow to its default value.

See Also:

setShadow

resetTailCorner

public void resetTailCorner()

Set the property TailCorner to its default value.

See Also:

setTailCorner

resetTailFactor

public void resetTailFactor()

Set the property TailFactor to its default value.

See Also:

setTailFactor

resetUseArrow

public void resetUseArrow()

Set the property UseArrow to its default value.

See Also:

isUseArrow