org.nuiton.widget.tooltip
Class TipWindow

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              javax.swing.JWindow
                  org.nuiton.widget.tooltip.TipWindow

All Implemented Interfaces:

ActionListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, RootPaneContainer

public class TipWindow
extends JWindow
implements ActionListener

The actual tool tip component.

Version:

1.0

Author:

Robert Futrell

See Also:

Serialized Form

Nested Class Summary

protected class

TipWindow.TipListener Listens for events in this window.

Nested classes/interfaces inherited from class javax.swing.JWindow

JWindow.AccessibleJWindow

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

Window.AccessibleAWTWindow

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

Container.AccessibleAWTContainer

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

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

protected Component	component
protected FocusableTip	ft
protected String	text
protected TipWindow.TipListener	tipListener
protected HyperlinkListener	userHyperlinkListener
protected static TipWindow	visibleInstance

Fields inherited from class javax.swing.JWindow

accessibleContext, rootPane, rootPaneCheckingEnabled

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

TipWindow(Window owner, FocusableTip ft, Component component)
To specify component to display

TipWindow(Window owner, FocusableTip ft, String msg)
Constructor, by default, is JEditorPane will be used for toolTip.

Method Summary

void	actionPerformed(ActionEvent e)
void	dispose() Disposes of this window.
void	fixSize(int width, int height) Workaround for JEditorPane not returning its proper preferred size when rendering HTML until after layout already done.
Component	getComponent() Return textArea of TipWindow
String	getText()
protected void	init(FocusableTip ft, Component component)
protected void	setBottomPanel()
void	setHyperlinkListener(HyperlinkListener listener) Sets the listener for hyperlink events in this tip window.

Methods inherited from class javax.swing.JWindow

addImpl, createRootPane, getAccessibleContext, getContentPane, getGlassPane, getGraphics, getLayeredPane, getRootPane, getTransferHandler, isRootPaneCheckingEnabled, paramString, remove, repaint, setContentPane, setGlassPane, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update, windowInit

Methods inherited from class java.awt.Window

addNotify, addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOwnedWindows, getOwner, getOwnerlessWindows, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, paint, postEvent, processEvent, processWindowEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setVisible, show, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, setBackground, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

ft

protected FocusableTip ft

component

protected Component component

text

protected String text

tipListener

protected TipWindow.TipListener tipListener

userHyperlinkListener

protected HyperlinkListener userHyperlinkListener

visibleInstance

protected static TipWindow visibleInstance

Constructor Detail

TipWindow

public TipWindow(Window owner,
                 FocusableTip ft,
                 String msg)

Constructor, by default, is JEditorPane will be used for toolTip.

Parameters:

owner - The parent window.

ft - Focusable tip

msg - The text of the tool tip. This can be HTML.

TipWindow

public TipWindow(Window owner,
                 FocusableTip ft,
                 Component component)

To specify component to display

Parameters:

owner - The parent window.

ft - Focusable tip

component - custom component to display

Method Detail

init

protected void init(FocusableTip ft,
                    Component component)

getComponent

public Component getComponent()

Return textArea of TipWindow

Returns:

textArea

actionPerformed

public void actionPerformed(ActionEvent e)

Specified by:

actionPerformed in interface ActionListener

dispose

public void dispose()

Disposes of this window.

Overrides:

dispose in class Window

fixSize

public void fixSize(int width,
                    int height)

Workaround for JEditorPane not returning its proper preferred size when rendering HTML until after layout already done. See http://forums.sun.com/thread.jspa?forumID=57&threadID=574810 for a discussion.

Parameters:

width - min width

height - min height

getText

public String getText()

setBottomPanel

protected void setBottomPanel()

setHyperlinkListener

public void setHyperlinkListener(HyperlinkListener listener)

Sets the listener for hyperlink events in this tip window.

Parameters:

listener - The new listener. The old listener (if any) is removed. A value of null means "no listener."