org.xith3d.ui.hud.menusystem
Interface Menu

All Known Implementing Classes:
FPIHInputBindingsSettingsMenu, FPIHMainSettingsMenu, GraphicsMainSettingsMenu, InputBindingsSettingsMenu, MenuBase

public interface Menu

A Menu can be added to a MenuGroup instance.


Method Summary
 MenuGroup getMenuGroup()
           
 MenuSystem getMenuSystem()
           
 java.lang.String getName()
           
 boolean onActionConsumed(java.lang.String action)
          This event notifies a Menu, that an action has been consumed in user-space.
 boolean prepareAction(java.lang.String action)
          This method is called my the MenuGroup prepare an action and to ask the current active Menu, if it accepts the given action.
 void setMenuGroup(MenuGroup menuGroup)
          This method is used by the MenuGroup to populate itself to the Menu.
 void setMenuSystem(MenuSystem menuSystem)
          This method is used by the MenuSystem to populate itself to the Menu.
 

Method Detail

getName

java.lang.String getName()
Returns:
this Menu's unique name.

setMenuSystem

void setMenuSystem(MenuSystem menuSystem)
This method is used by the MenuSystem to populate itself to the Menu.

Parameters:
menuSystem -

getMenuSystem

MenuSystem getMenuSystem()
Returns:
the MenuSystem, this Menu belongs to.

setMenuGroup

void setMenuGroup(MenuGroup menuGroup)
This method is used by the MenuGroup to populate itself to the Menu.

Parameters:
menuGroup -

getMenuGroup

MenuGroup getMenuGroup()
Returns:
the MenuGroup, this Menu belongs to.

prepareAction

boolean prepareAction(java.lang.String action)
This method is called my the MenuGroup prepare an action and to ask the current active Menu, if it accepts the given action.

Parameters:
action -
Returns:
true, if the action is accepted

onActionConsumed

boolean onActionConsumed(java.lang.String action)
This event notifies a Menu, that an action has been consumed in user-space.

Parameters:
action -
Returns:
true, of the consume was accepted.