com.threerings.miso.client

Class SceneObjectTip

java.lang.Object

com.samskivert.swing.LabelSausage

com.threerings.miso.client.SceneObjectTip

All Implemented Interfaces:

SceneObjectIndicator

public class SceneObjectTip
extends LabelSausage
implements SceneObjectIndicator

A lightweight tooltip used by the MisoScenePanel. The tip foreground and background are controlled by the following UIManager properties:

 SceneObjectTip.background
 SceneObjectTip.foreground
 SceneObjectTip.font (falls back to Label.font)
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SceneObjectTip.TipLayout Used to position a scene tip in relation to the object with which it is associated.

Field Summary

Fields

Modifier and Type	Field and Description
Rectangle	bounds The bounding box of this tip, or null prior to layout().

Constructor Summary

Constructors

Constructor and Description
SceneObjectTip(String text, Icon icon) Construct a SceneObjectTip.

Method Summary

Modifier and Type	Method and Description
Rectangle	getBounds() Returns the bounds of the indicator when drawn.
boolean	isLaidOut() Returns whether the indicator has already been laid out (and thus doesn't need to be again)
void	layout(Graphics2D gfx, SceneObject tipFor, Rectangle boundary) Called to initialize the tip so that it can be painted.
void	paint(Graphics2D gfx) Paints the indicator in the scene.
static void	registerTipLayout(String prefix, SceneObjectTip.TipLayout layout) It may be desirable to layout object tips specially depending on what sort of actions they represent, so we allow different tip layout algorithms to be registered for particular object prefixes.
void	removed() Called when the indicator is removed from the scene.
String	toString() Generates a string representation of this instance.
void	update(Icon icon, String tiptext) Updates the Icon and text for the indicator.

Methods inherited from class java.lang.Object

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

Field Detail

bounds

public Rectangle bounds

The bounding box of this tip, or null prior to layout().

Constructor Detail

SceneObjectTip

public SceneObjectTip(String text,
                      Icon icon)

Construct a SceneObjectTip.

Method Detail

isLaidOut

public boolean isLaidOut()

Description copied from interface: SceneObjectIndicator

Returns whether the indicator has already been laid out (and thus doesn't need to be again)

Specified by:

isLaidOut in interface SceneObjectIndicator

layout

public void layout(Graphics2D gfx,
                   SceneObject tipFor,
                   Rectangle boundary)

Called to initialize the tip so that it can be painted.

Specified by:

layout in interface SceneObjectIndicator

Parameters:

tipFor - the scene object that we're a tip for.

boundary - the boundary of all displayable space.

paint

public void paint(Graphics2D gfx)

Description copied from interface: SceneObjectIndicator

Paints the indicator in the scene. Always called after SceneObjectIndicator.layout(Graphics2D, SceneObject, Rectangle)

Specified by:

paint in interface SceneObjectIndicator

getBounds

public Rectangle getBounds()

Description copied from interface: SceneObjectIndicator

Returns the bounds of the indicator when drawn.

Specified by:

getBounds in interface SceneObjectIndicator

removed

public void removed()

Description copied from interface: SceneObjectIndicator

Called when the indicator is removed from the scene.

Specified by:

removed in interface SceneObjectIndicator

update

public void update(Icon icon,
                   String tiptext)

Description copied from interface: SceneObjectIndicator

Updates the Icon and text for the indicator.

Specified by:

update in interface SceneObjectIndicator

toString

public String toString()

Generates a string representation of this instance.

Overrides:

toString in class Object

registerTipLayout

public static void registerTipLayout(String prefix,
                                     SceneObjectTip.TipLayout layout)

It may be desirable to layout object tips specially depending on what sort of actions they represent, so we allow different tip layout algorithms to be registered for particular object prefixes. The registration is simply a list searched from longest string to shortest string for the first match to an object's action.