com.jidesoft.tooltip
Interface BalloonShape

All Known Implementing Classes:

OvalShape, RectangularBalloonShape, RectangularShape, RoundedRectangularBalloonShape, RoundedRectangularShape

public interface BalloonShape

BalloonShape is the interface to provide BalloonTip additional shapes.

Method Summary

Shape	createOutline(Dimension balloonSize, Dimension contentSize) Create the outline shape of the balloon.
double	getEdgeDistance(Point pixel, BalloonTip balloonTip) Get the closest distance between the current pixel and the edge of the balloon outline.
Point	getHotSpot(Dimension balloonSize) Gets the arrow vertex position.
Insets	getInsets(Dimension size) Get the insets around the content component.

Method Detail

createOutline

Shape createOutline(Dimension balloonSize,
                    Dimension contentSize)

Create the outline shape of the balloon.

Parameters:

balloonSize - the preferred size of the balloon.

contentSize - the preferred size of the content

Returns:

the balloon the shape

getInsets

Insets getInsets(Dimension size)

Get the insets around the content component.

Parameters:

size - the preferred size of the content component.

Returns:

the insets around the content component, including the outline shape.

getEdgeDistance

double getEdgeDistance(Point pixel,
                       BalloonTip balloonTip)

Get the closest distance between the current pixel and the edge of the balloon outline. Used to determin the edge light effect.

Parameters:

pixel - current point in the balloon coordinate system.

balloonTip - the balloon tip.

Returns:

the closest or effective distance of the pixel to the balloon outline.

getHotSpot

Point getHotSpot(Dimension balloonSize)

Gets the arrow vertex position. BalloonTip has an arrow pointing out. The vertex should point to the place that needs the tooltip.

Parameters:

balloonSize - the preferred size of the balloon.

Returns:

the arrow vertex position.