net.xoetrope.awt
Class XToolTip

java.lang.Object
  java.awt.Component
      java.awt.Canvas
          net.xoetrope.awt.XToolTip

All Implemented Interfaces:

java.awt.event.MouseListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible

public class XToolTip
extends java.awt.Canvas
implements java.awt.event.MouseListener

A Tooltip class for AWT components. Unlike other XUI-AWT components the tooltips are not added via the component factory. In this initial implementation tooltips must be added explicitly.

Copyright (c) Xoetrope Ltd., 2002-2004

$Revision: 2.6 $

License: see License.txt

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.awt.Canvas

java.awt.Canvas.AccessibleAWTCanvas

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

protected java.awt.Font	font
protected static int	HORIZONTAL_ENLARGE
protected int	lag
protected java.awt.Container	mainContainer
protected java.awt.Component	owner
protected boolean	shown
protected boolean	showTip
protected java.lang.String	tip
protected net.xoetrope.awt.XToolTip.TooltipThread	tooltipThread
protected static int	VERTICAL_OFFSET

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

XToolTip(java.lang.String tip, java.awt.Component owner)
Create anew tooltip

Method Summary

protected void	addToolTip(java.awt.Point pt)
protected void	calcsize()
java.lang.String	getTip() Get the tip's text
void	mouseClicked(java.awt.event.MouseEvent e) Invoked when the mouse button has been clicked (pressed and released) on a component.
void	mouseEntered(java.awt.event.MouseEvent e) Invoked when the mouse enters a component.
void	mouseExited(java.awt.event.MouseEvent e) Invoked when the mouse exits a component.
void	mousePressed(java.awt.event.MouseEvent e) Invoked when a mouse button has been pressed on a component.
void	mouseReleased(java.awt.event.MouseEvent e) Invoked when a mouse button has been released on a component.
void	paint(java.awt.Graphics g) Render the tooltip
protected void	removeToolTip()
void	setTip(java.lang.String newTip) Get the tip's text
protected void	setToolTipLocation(java.awt.Point pt)
protected void	showTip(java.awt.Point pt) Show the tooltip at the specified point

Methods inherited from class java.awt.Canvas

addNotify, createBufferStrategy, createBufferStrategy, getAccessibleContext, getBufferStrategy, update

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAlignmentX, getAlignmentY, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeys, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMinimumSize, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusCycleRoot, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, paramString, postEvent, preferredSize, prepareImage, prepareImage, print, printAll, processComponentEvent, processEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeys, setFocusTraversalKeysEnabled, setFont, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle, validate

Methods inherited from class java.lang.Object

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

Field Detail

tip

protected java.lang.String tip

owner

protected java.awt.Component owner

mainContainer

protected java.awt.Container mainContainer

shown

protected boolean shown

VERTICAL_OFFSET

protected static final int VERTICAL_OFFSET

See Also:

Constant Field Values

HORIZONTAL_ENLARGE

protected static final int HORIZONTAL_ENLARGE

See Also:

Constant Field Values

font

protected java.awt.Font font

showTip

protected boolean showTip

lag

protected int lag

tooltipThread

protected net.xoetrope.awt.XToolTip.TooltipThread tooltipThread

Constructor Detail

XToolTip

public XToolTip(java.lang.String tip,
                java.awt.Component owner)

Create anew tooltip

Parameters:

tip - the tip text

owner - the owner component

Method Detail

getTip

public java.lang.String getTip()

Get the tip's text

Returns:

the tooltip text

setTip

public void setTip(java.lang.String newTip)

Get the tip's text

Parameters:

newTip - the new text

paint

public void paint(java.awt.Graphics g)

Render the tooltip

Overrides:

paint in class java.awt.Canvas

Parameters:

g - the graphics context

addToolTip

protected void addToolTip(java.awt.Point pt)

calcsize

protected void calcsize()

setToolTipLocation

protected void setToolTipLocation(java.awt.Point pt)

removeToolTip

protected void removeToolTip()

showTip

protected void showTip(java.awt.Point pt)

Show the tooltip at the specified point

Parameters:

pt -

mouseExited

public void mouseExited(java.awt.event.MouseEvent e)

Invoked when the mouse exits a component.

Specified by:

mouseExited in interface java.awt.event.MouseListener

Parameters:

e - the event

mouseEntered

public void mouseEntered(java.awt.event.MouseEvent e)

Invoked when the mouse enters a component.

Specified by:

mouseEntered in interface java.awt.event.MouseListener

Parameters:

e - the event

mouseReleased

public void mouseReleased(java.awt.event.MouseEvent e)

Invoked when a mouse button has been released on a component.

Specified by:

mouseReleased in interface java.awt.event.MouseListener

Parameters:

e - the event

mousePressed

public void mousePressed(java.awt.event.MouseEvent e)

Invoked when a mouse button has been pressed on a component.

Specified by:

mousePressed in interface java.awt.event.MouseListener

Parameters:

e - the event

mouseClicked

public void mouseClicked(java.awt.event.MouseEvent e)

Invoked when the mouse button has been clicked (pressed and released) on a component.

Specified by:

mouseClicked in interface java.awt.event.MouseListener

Parameters:

e - the event