Package docking.util.image

Class CalloutComponentInfo

java.lang.Object

docking.util.image.CalloutComponentInfo

public class CalloutComponentInfo
extends Object

An object that describes a component to be 'called-out'. A callout is a way to emphasize a widget (usually this is only needed for small GUI elements, like an action or icon).

The given component info is used to render a magnified image of the given component onto another image. For this to work, the rendering engine will need to know how to translate the component's location to that of the image space onto which the callout will be drawn. This is the purpose of requiring the 'destination component'. That component provides the bounds that will be used to move the component's relative position (which is relative to the components parent).

Constructor Summary

Constructors

Constructor	Description
CalloutComponentInfo(Component destinationComponent, Component component)
CalloutComponentInfo(Component destinationComponent, Component component, Point locationOnScreen, Point relativeLocation, Dimension size)

Method Summary

Modifier and Type	Method	Description
Point	convertPointToParent(Point location)
void	setMagnification(double magnification)

Methods inherited from class java.lang.Object

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

Constructor Details

CalloutComponentInfo

public CalloutComponentInfo(Component destinationComponent,
 Component component)

CalloutComponentInfo

public CalloutComponentInfo(Component destinationComponent,
 Component component,
 Point locationOnScreen,
 Point relativeLocation,
 Dimension size)

Method Details

convertPointToParent

public Point convertPointToParent(Point location)

setMagnification

public void setMagnification(double magnification)