sub_arctic.input
Interface pointable

All Known Subinterfaces:

display_help

public abstract interface pointable

extends input_protocol

This is an input protocol interface useful for performing actions on the interface when the mouse enters or leaves an object.

Warning: This protocol is based on the various mouse events that are dispatched by the system. If you modify an interface based on other types of events (e.g. animation), the pointable interface's mouse_exit() call will not be made immediately. In particular, such a call will not be made until the next mouse event is processed.

Method Summary

boolean	mouse_enter(event evt, java.lang.Object user_info) This method is called when the pointer enters you area and when no other agent has dispatched the event.
boolean	mouse_exit(event evt, java.lang.Object user_info) This method is called when the pointer leaves your area.

Method Detail

mouse_enter

public boolean mouse_enter(event evt,
                           java.lang.Object user_info)

This method is called when the pointer enters you area and when no other agent has dispatched the event.

Parameters:

event - evt the event to dispatch

Object - user_info the object you passed to the pick_collector at pick_time

Returns:

boolean return true if you dispatched this event. If you return false here you won't get a call to mouse_exit

mouse_exit

public boolean mouse_exit(event evt,
                          java.lang.Object user_info)

This method is called when the pointer leaves your area. Note that no user_info is given to you, you were not picked by this event! The return value here is primarily only useful to the event logging system since the event was likely to have been handled (properly speaking) elsewhere in the system. Return true if you handled the event (and thus it should be logged).

The user_info here is cached and is the same value that was passed to you at the time we called mouse_enter. Since the mouse exit command is called when you are not picked, its not clear what else to do for user_info.

Parameters:

event - evt the event to dispatch

Returns:

boolean return true if you dispatched this event