com.swfm.mica.widgets
Class MiBrowsableGridEventHandler

java.lang.Object
  extended bycom.swfm.mica.events.MiEventHandler
      extended bycom.swfm.mica.widgets.MiBrowsableGridEventHandler
All Implemented Interfaces:
MiiCommandNames, MiiEventHandler, MiiEventTypes, MiiSimpleAnimator

public class MiBrowsableGridEventHandler
extends MiEventHandler
implements MiiSimpleAnimator, MiiCommandNames, MiiEventTypes

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

Field Summary
static java.lang.String ActivateEventName
           
static java.lang.String BrowseEventName
           
static java.lang.String BrowseHorizontalNextEventName
           
static java.lang.String BrowseHorizontalPreviousEventName
           
static java.lang.String BrowseVerticalNextEventName
           
static java.lang.String BrowseVerticalPreviousEventName
           
static java.lang.String DragBrowseEventName
           
static java.lang.String EndBrowseEventName
           
static java.lang.String SelectAdditionalEventName
           
static java.lang.String SelectBrowsedEventName
           
static java.lang.String SelectInterveningEventName
           
static java.lang.String SelectToggleEventName
           
static java.lang.String StartDragBrowseEventName
           
     
Constructor Summary
MiBrowsableGridEventHandler()
           
 
Method Summary
 long animate()
          Performs some task.
 MiiBrowsableGrid getBrowsableGrid()
           
 int processCommand()
           
 void setBrowsableGrid(MiiBrowsableGrid grid)
           
 java.lang.String toString()
          Returns information about this MiEventHandler.
 
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
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

ActivateEventName

public static final java.lang.String ActivateEventName
See Also:
Constant Field Values

BrowseEventName

public static final java.lang.String BrowseEventName
See Also:
Constant Field Values

EndBrowseEventName

public static final java.lang.String EndBrowseEventName
See Also:
Constant Field Values

DragBrowseEventName

public static final java.lang.String DragBrowseEventName
See Also:
Constant Field Values

StartDragBrowseEventName

public static final java.lang.String StartDragBrowseEventName
See Also:
Constant Field Values

SelectToggleEventName

public static final java.lang.String SelectToggleEventName
See Also:
Constant Field Values

SelectBrowsedEventName

public static final java.lang.String SelectBrowsedEventName
See Also:
Constant Field Values

SelectAdditionalEventName

public static final java.lang.String SelectAdditionalEventName
See Also:
Constant Field Values

SelectInterveningEventName

public static final java.lang.String SelectInterveningEventName
See Also:
Constant Field Values

BrowseVerticalNextEventName

public static final java.lang.String BrowseVerticalNextEventName
See Also:
Constant Field Values

BrowseVerticalPreviousEventName

public static final java.lang.String BrowseVerticalPreviousEventName
See Also:
Constant Field Values

BrowseHorizontalNextEventName

public static final java.lang.String BrowseHorizontalNextEventName
See Also:
Constant Field Values

BrowseHorizontalPreviousEventName

public static final java.lang.String BrowseHorizontalPreviousEventName
See Also:
Constant Field Values
Constructor Detail

MiBrowsableGridEventHandler

public MiBrowsableGridEventHandler()
Method Detail

setBrowsableGrid

public void setBrowsableGrid(MiiBrowsableGrid grid)

getBrowsableGrid

public MiiBrowsableGrid getBrowsableGrid()

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()

toString

public java.lang.String toString()
Description copied from class: MiEventHandler
Returns information about this MiEventHandler.

Overrides:
toString in class MiEventHandler
Returns:
textual information (class name + unique numerical id + [disabled])

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'.