com.swfm.mica.widgets
Class MiTwoStateWidgetEventHandler

java.lang.Object
  extended bycom.swfm.mica.events.MiEventHandler
      extended bycom.swfm.mica.widgets.MiTwoStateWidgetEventHandler
All Implemented Interfaces:
MiiActionTypes, MiiCommandNames, MiiEventHandler, MiiEventTypes, MiiLookProperties, MiiSimpleAnimator
Direct Known Subclasses:
MiToggleEventHandler

public class MiTwoStateWidgetEventHandler
extends MiEventHandler
implements MiiActionTypes, MiiSimpleAnimator, MiiLookProperties

Version:
%I% %G%
Author:
Michael L. Davis

Field Summary
         
Constructor Summary
MiTwoStateWidgetEventHandler(boolean toGrabWhenSelected, boolean repeatSelectWhenHeld, boolean activateWhenSelect)
           
 
Method Summary
 long animate()
          Performs some task.
 MiEditor getEditor()
           
 int getRepeatInterval()
           
 boolean getRepeatSelectWhenHeld()
           
 int getRepeatStartDelay()
           
 int processCommand()
           
 void setEditor(MiEditor editor)
           
 void setRepeatInterval(int millisecs)
           
 void setRepeatSelectWhenHeld(boolean flag)
           
 void setRepeatStartDelay(int millisecs)
           
 
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, processEvent, 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

MiTwoStateWidgetEventHandler

public MiTwoStateWidgetEventHandler(boolean toGrabWhenSelected,
                                    boolean repeatSelectWhenHeld,
                                    boolean activateWhenSelect)
Method Detail

setRepeatSelectWhenHeld

public void setRepeatSelectWhenHeld(boolean flag)

getRepeatSelectWhenHeld

public boolean getRepeatSelectWhenHeld()

setRepeatStartDelay

public void setRepeatStartDelay(int millisecs)

getRepeatStartDelay

public int getRepeatStartDelay()

setRepeatInterval

public void setRepeatInterval(int millisecs)

getRepeatInterval

public int getRepeatInterval()

setEditor

public void setEditor(MiEditor editor)

getEditor

public MiEditor getEditor()

processCommand

public int processCommand()
Returns:
Mi_CONSUME_EVENT if no other event handlers should see the event that generated the command Mi_PROPOGATE_EVENT if other event handlers can also see the event that generated the command
See Also:
MiEventHandler.isCommand(java.lang.String), MiEventHandler.setCommand(java.lang.String), MiEventHandler.getCommand()

animate

public long animate()
Description copied from interface: MiiSimpleAnimator
Performs some task.

Specified by:
animate in interface MiiSimpleAnimator
Returns:
number of microseconds until next call to animate(). Return -1 for 'forever'.