org.xith3d.ui.hud.menusystem
Interface MenuSystemListener


public interface MenuSystemListener

A MenuSystemListener is notified of MenuGroup events.


Method Summary
 boolean beforeMenuStateChanged(MenuSystem menuSystem, java.lang.String currentMenu, java.lang.Object target)
          This event is fired before the MenuGroup's state has changed.
 boolean onMenuActionPerformed(MenuSystem menuSystem, MenuGroup menuGroup, Menu menu, java.lang.String action)
          This event is fired when a custom menu action was performed.
 void onMenuStateChanged(MenuSystem menuSystem, java.lang.String oldMenu, java.lang.Object target)
          This event is fired, if the MenuGroup's state has changed.
 void onMenuSystemEntered(MenuSystem menuSystem)
          This event is fired when the MenuSystem has been entered.
 void onMenuSystemExited(MenuSystem menuSystem)
          This event is fired when the MenuSystem has been exited.
 void onSettingChanged(MenuSystem menuSystem, Menu menu, java.lang.String setting, java.lang.Object value)
          This event is fired, when a setting has been changed in one of the Menus.
 

Method Detail

beforeMenuStateChanged

boolean beforeMenuStateChanged(MenuSystem menuSystem,
                               java.lang.String currentMenu,
                               java.lang.Object target)
This event is fired before the MenuGroup's state has changed.

Parameters:
menuSystem -
currentMenu -
target -
Returns:
true to skip the actual state-change.

onMenuStateChanged

void onMenuStateChanged(MenuSystem menuSystem,
                        java.lang.String oldMenu,
                        java.lang.Object target)
This event is fired, if the MenuGroup's state has changed.

Parameters:
menuSystem -
oldMenu -
target -

onSettingChanged

void onSettingChanged(MenuSystem menuSystem,
                      Menu menu,
                      java.lang.String setting,
                      java.lang.Object value)
This event is fired, when a setting has been changed in one of the Menus.

Parameters:
menuSystem -
menu -
setting -
value -

onMenuActionPerformed

boolean onMenuActionPerformed(MenuSystem menuSystem,
                              MenuGroup menuGroup,
                              Menu menu,
                              java.lang.String action)
This event is fired when a custom menu action was performed.

Parameters:
menuSystem -
menuGroup -
menu -
action -
Returns:
true, if the action was consumed.

onMenuSystemEntered

void onMenuSystemEntered(MenuSystem menuSystem)
This event is fired when the MenuSystem has been entered.

Parameters:
menuSystem -

onMenuSystemExited

void onMenuSystemExited(MenuSystem menuSystem)
This event is fired when the MenuSystem has been exited.

Parameters:
menuSystem -