com.swfm.mica.events
Class MiIDisplayToolHints

java.lang.Object
  com.swfm.mica.events.MiEventHandler
      com.swfm.mica.events.MiEventMonitor
          com.swfm.mica.events.MiIDisplayToolHints

All Implemented Interfaces:

MiiCommandNames, MiiEventHandler, MiiEventTypes, MiiTypes

public class MiIDisplayToolHints

extends MiEventMonitor

implements MiiTypes

Version:

%I% %G%

Author:

Michael L. Davis

Field Summary

Constructor Summary

MiIDisplayToolHints()

Method Summary

boolean	getAllowToolHintsRunningMode()
boolean	getHideToolHintWhenMousePaused()
MiPart	getToolHintPopup()
boolean	getWaitUntilPausedToStartShowingToolHints()
int	processEvent(MiEvent event) Processes the given event.
void	setAllowToolHintsRunningMode(boolean flag) After a Hint is displayed, allows Hints to be displayed without the user pausing.
void	setHideToolHintWhenMousePaused(boolean flag) Whether or not to hide toolhint after user is paused while showing a toolHint
void	setWaitUntilPausedToStartShowingToolHints(boolean flag) Whether or not to wait until user is paused before showing a toolHint

Methods inherited from class com.swfm.mica.events.MiEventHandler

addEventToCommandTranslation, addEventToCommandTranslation, addEventToCommandTranslation, copy, getAlwaysConsumeTriggerEvents, getCommand, getEvent, getEventToCommandTranslation, getName, getNameForType, getObject, getRequestedCommands, getRequestedEvents, getTarget, getType, isCommand, isEnabled, isPositionDependent, isSingleton, isType, processCommand, processCommand, removeAllEventToCommandTranslations, removeEventToCommandTranslation, removeEventToCommandTranslation, removeEventToCommandTranslation, removeEventToCommandTranslation, setAlwaysConsumeTriggerEvents, setCommand, setEnabled, setEventToCommandTranslation, setEventToCommandTranslation, setEventToCommandTranslation, setIsSingleton, setName, setObject, setPositionDependent, setPropertyValue, setTarget, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

MiIDisplayToolHints

public MiIDisplayToolHints()

Method Detail

getToolHintPopup

public MiPart getToolHintPopup()

setHideToolHintWhenMousePaused

public void setHideToolHintWhenMousePaused(boolean flag)

Whether or not to hide toolhint after user is paused while showing a toolHint

getHideToolHintWhenMousePaused

public boolean getHideToolHintWhenMousePaused()

setAllowToolHintsRunningMode

public void setAllowToolHintsRunningMode(boolean flag)

After a Hint is displayed, allows Hints to be displayed without the user pausing. This mode is terminated when the user pauses again.

getAllowToolHintsRunningMode

public boolean getAllowToolHintsRunningMode()

setWaitUntilPausedToStartShowingToolHints

public void setWaitUntilPausedToStartShowingToolHints(boolean flag)

Whether or not to wait until user is paused before showing a toolHint

getWaitUntilPausedToStartShowingToolHints

public boolean getWaitUntilPausedToStartShowingToolHints()

processEvent

public int processEvent(MiEvent event)

Description copied from class: MiEventHandler

Processes the given event.

Specified by:

processEvent in interface MiiEventHandler

Overrides:

processEvent in class MiEventHandler

Parameters:

event - The event to process

Returns:

Mi_CONSUME_EVENT if no other event handlers should see this event Mi_PROPOGATE_EVENT if other event handlers can also see this event