All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.micronova.mnfc.IToolTipManager

java.lang.Object
   |
   +----com.micronova.mnfc.IToolTipManager

public class IToolTipManager

extends Object

implements Target

Version:

1.01

Author:

Makoto Nagata, MicroNova

dismissDelay

The delay before the current tooltip is dismissed if the mouse pointer does not move.

enabled

Set to true if this IToolTipManager is enabled.

initialDelay

The delay before which a tooltip will appear after the mouse enters a tooltip view.

isToolTipSource

Set to true if the View under the mouse pointer is an instance of IToolTipSource (for dynamic tooltip).

maxRows

Maximal number of text rows.

mouseEvent

Current MouseEvent.

reshowDelay

The delay within which a tooltip will be reshown at once if the mouse pointer exits and enters another tooltip view.

state

Current state.

STATE_IDLE

Idle state (the mouse is not in any tooltip view).

STATE_INITWAIT

The Mouse has entered a tooltip view and waiting for initialDelay timer.

STATE_RESHOWWAIT

The mouse has exited a tooltip view and waiting for reshowDelay timer.

STATE_TIPDISMISSED

The tooltip is dismissed but the mouse is still inside the tooltip view.

STATE_TIPSHOWN

The tooltip is shown and waiting for dismissDelay timer.

table

Holds registered IToolTips.

timer

Delay timer.

TIMER

Delay timer command.

toolTip

IToolTip to be displayed.

toolTipBackgroundColor

Default TextView background color.

toolTipBorder

Default tooltip border.

toolTipFont

Default TextView font.

toolTipForegroundColor

Default TextView foreground color.

toolTipView

Default TextView that displays tooltip text.

toolTipWindow

InternalWindow that displays tooltip.

toolTipWindowLayer

InternalWindow layer for the tooltip window.

toolTipWindowWidth

Default tooltip window width.

view

Current View under mouse pointer.

xOffset

X-offset from the mouse pointer for the tooltip window.

yOffset

Y-offset from the mouse pointer for the tooltip window.

IToolTipManager()

Constructs an IToolTipManager.

createToolTipView()

Creates a View for tooltip.

createToolTipWindow(View)

Creates an InternalWindow for tooltip using the given toolTipView.

getDismissDelay()

Returns the current dismiss delay in microseconds.

getInitialDelay()

Returns current initial delay in microseconds.

getReshowDelay()

Returns the reshow delay in microseconds.

getToolTip(View)

Returns the IToolTip registered for the view.

getToolTipText(IToolTip, MouseEvent)

Returns dynamic tooltip text for an IToolTipSource.

hideToolTip()

Hides the tooltip window.

isEnabled()

Returns true if this tooltip manager is enabled.

mouseEntered(View, MouseEvent)

Called when the mouse enters a tooltip view.

mouseExited(View, MouseEvent)

Called when the mouse exists a tooltip view.

mouseMoved(View, MouseEvent)

Called when the mouse is moved within a tooltip view.

performCommand(String, Object)

Overridden to handle timer events.

prepareToolTip(IToolTip)

Prepares tooltip to be shown.

registerToolTip(IToolTip)

Registers an IToolTip.

registerToolTip(View, String)

Registers a tooltip 'toolTipText' for a 'view'.

setDismissDelay(int)

Sets the dismiss delay in microseconds.

setEnabled(boolean)

Enables/disables this tooltip manager.

setInitialDelay(int)

Sets the initial delay in microseconds.

setReshowDelay(int)

Sets the reshow delay in microseconds.

showToolTip(IToolTip)

Shows the tooltip window.

startTimer(int)

Starts the delay timer.

stopTimer()

Stops the delay timer if running.

timerUp()

Called when the delay timer expires.

toolTipEntered(View, MouseEvent)

Called when the mouse enters a tooltip area of a view.

toolTipExited(View, MouseEvent)

Called when the mouse exits the tooltip area of the view.

unregisterToolTip(IToolTip)

Unregisters an IToolTip.

unregisterToolTip(View)

Unregisters tooltip for a view.

unregisterToolTipForDescendents(View)

Unregisters tooltips for all descendents of the given view (including the view itself).

 public static final String TIMER

Delay timer command.

 public static final int STATE_IDLE

Idle state (the mouse is not in any tooltip view).

 public static final int STATE_INITWAIT

The Mouse has entered a tooltip view and waiting for initialDelay timer.

 public static final int STATE_TIPSHOWN

The tooltip is shown and waiting for dismissDelay timer.

 public static final int STATE_TIPDISMISSED

The tooltip is dismissed but the mouse is still inside the tooltip view.

 public static final int STATE_RESHOWWAIT

The mouse has exited a tooltip view and waiting for reshowDelay timer.

 public Hashtable table

Holds registered IToolTips.

 public int initialDelay

The delay before which a tooltip will appear after the mouse enters a tooltip view.

 public int dismissDelay

The delay before the current tooltip is dismissed if the mouse pointer does not move.

 public int reshowDelay

The delay within which a tooltip will be reshown at once if the mouse pointer exits and enters another tooltip view.

 public boolean enabled

Set to true if this IToolTipManager is enabled.

 public Timer timer

Delay timer.

 public boolean isToolTipSource

Set to true if the View under the mouse pointer is an instance of IToolTipSource (for dynamic tooltip).

 public int state

Current state.

 public InternalWindow toolTipWindow

InternalWindow that displays tooltip.

 public int toolTipWindowLayer

InternalWindow layer for the tooltip window.

 public TextView toolTipView

Default TextView that displays tooltip text.

 public Color toolTipBackgroundColor

Default TextView background color.

 public Color toolTipForegroundColor

Default TextView foreground color.

 public Font toolTipFont

Default TextView font.

 public Border toolTipBorder

Default tooltip border.

 public int xOffset

X-offset from the mouse pointer for the tooltip window.

 public int yOffset

Y-offset from the mouse pointer for the tooltip window.

 public int toolTipWindowWidth

Default tooltip window width.

 public int maxRows

Maximal number of text rows. If the tooltip text exceeds this number of rows with the given toolTipWindowWidth, the window is expanded horizontally.

 public MouseEvent mouseEvent

Current MouseEvent.

 public View view

Current View under mouse pointer.

 public IToolTip toolTip

IToolTip to be displayed.

 public IToolTipManager()

Constructs an IToolTipManager.

 public void registerToolTip(IToolTip toolTip)

Registers an IToolTip.

 public void unregisterToolTip(IToolTip toolTip)

Unregisters an IToolTip.

 public void registerToolTip(View view,
                             String toolTipText)

Registers a tooltip 'toolTipText' for a 'view'.

 public void unregisterToolTip(View view)

Unregisters tooltip for a view.

 public void unregisterToolTipForDescendents(View view)

Unregisters tooltips for all descendents of the given view (including the view itself).

 public IToolTip getToolTip(View view)

Returns the IToolTip registered for the view. Returns null if there is no tooltip registered.

 public View createToolTipView()

Creates a View for tooltip. The default implementation creates a TextView. This is called once on initialization.

 public InternalWindow createToolTipWindow(View toolTipView)

Creates an InternalWindow for tooltip using the given toolTipView. This is called once on initialization. The tooltip window contains a ContainerView that holds toolTipView (created by createToolTipView()).

 public boolean isEnabled()

Returns true if this tooltip manager is enabled.

 public void setEnabled(boolean flag)

Enables/disables this tooltip manager.

 public void setInitialDelay(int microSeconds)

Sets the initial delay in microseconds. This is the delay before which a tooltip will appear after the mouse enters a tooltip view.

 public int getInitialDelay()

Returns current initial delay in microseconds.

 public void setDismissDelay(int microSeconds)

Sets the dismiss delay in microseconds. This is the time a tooltip stays visible if the mouse does not move.

 public int getDismissDelay()

Returns the current dismiss delay in microseconds.

 public void setReshowDelay(int microSeconds)

Sets the reshow delay in microseconds. This is the time within which a tooltip will be reshown immediately when the mouse re-enters a tooltip view.

 public int getReshowDelay()

Returns the reshow delay in microseconds.

 public void prepareToolTip(IToolTip toolTip)

Prepares tooltip to be shown.

 public void showToolTip(IToolTip toolTip)

Shows the tooltip window.

 public void hideToolTip()

Hides the tooltip window.

 public String getToolTipText(IToolTip toolTip,
                              MouseEvent event)

Returns dynamic tooltip text for an IToolTipSource.

 public void startTimer(int delay)

Starts the delay timer.

 public void stopTimer()

Stops the delay timer if running.

 public void toolTipEntered(View view,
                            MouseEvent event)

Called when the mouse enters a tooltip area of a view.

 public void toolTipExited(View view,
                           MouseEvent event)

Called when the mouse exits the tooltip area of the view.

 public void mouseEntered(View view,
                          MouseEvent event)

Called when the mouse enters a tooltip view.

 public void mouseExited(View view,
                         MouseEvent event)

Called when the mouse exists a tooltip view.

 public void mouseMoved(View view,
                        MouseEvent event)

Called when the mouse is moved within a tooltip view.

 public void timerUp()

Called when the delay timer expires.

 public void performCommand(String command,
                            Object object)

Overridden to handle timer events.

All Packages  Class Hierarchy  This Package  Previous  Next  Index