org.xith3d.ui.hud.menusystem.menus
Class MenuBase

java.lang.Object
  org.xith3d.ui.hud.base.WidgetBase
      org.xith3d.ui.hud.base.RectangularWidget
          org.xith3d.ui.hud.base.WidgetContainerBase
              org.xith3d.ui.hud.widgets.Panel
                  org.xith3d.ui.hud.menusystem.menus.MenuBase

All Implemented Interfaces:

org.jagatoo.datatypes.NamableObject, org.jagatoo.datatypes.NamedObject, org.openmali.types.twodee.Positioned2f, org.openmali.types.twodee.Positioned2fRO, org.openmali.types.twodee.Sized2f, org.openmali.types.twodee.Sized2fRO, BackgroundSettable, BackgroundSettableWidget, BorderSettable, PaddingSettable, Widget, WidgetContainer, ScrollbarListener, Menu

Direct Known Subclasses:

FPIHInputBindingsSettingsMenu, FPIHMainSettingsMenu, GraphicsMainSettingsMenu, InputBindingsSettingsMenu

public abstract class MenuBase
extends Panel
implements Menu

A base implementation of the Menu interface

Nested Class Summary

Nested classes/interfaces inherited from class org.xith3d.ui.hud.widgets.Panel

Panel.Description

Nested classes/interfaces inherited from interface org.xith3d.ui.hud.base.Widget

Widget.DescriptionBase

Nested classes/interfaces inherited from interface org.xith3d.ui.hud.base.WidgetContainer

WidgetContainer.FocusMoveDirection

Field Summary

protected boolean

minimalHeightSet

Fields inherited from class org.xith3d.ui.hud.base.WidgetContainerBase

childrenTG

Fields inherited from class org.xith3d.ui.hud.base.WidgetBase

containerListeners, transformGroup, translation, Z_INDEX_UNIT, Z_INDEX_UNIT_ASSEMBLER

Constructor Summary

MenuBase(float width, float height, int zIndex, java.lang.String name, java.lang.String[] acceptedActions)

MenuBase(float width, float height, java.lang.String name, java.lang.String[] acceptedActions)

MenuBase(float width, int zIndex, java.lang.String name, java.lang.String[] acceptedActions)

MenuBase(float width, java.lang.String name, java.lang.String[] acceptedActions)

Method Summary

protected java.lang.String[]	getAcceptedActions()
MenuGroup	getMenuGroup()
MenuSystem	getMenuSystem()
protected void	init() This method is called when the WidgetContainer is set.
protected abstract void	initWidgets()
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.
void	setMinimalHeight()

Methods inherited from class org.xith3d.ui.hud.widgets.Panel

getBackground, getBackgroundColor, getBackgroundTileHeight, getBackgroundTileSize, getBackgroundTileWidth, getBorder, getForeground, getTransparency, setBackground, setBackground, setBackground, setBackgroundTileSize, setBackgroundTileSize, setBorder, setBorder, setForeground, setForeground, setSize, update

Methods inherited from class org.xith3d.ui.hud.base.WidgetContainerBase

addContainerScrollListener, addWidget, addWidget, addWidget, addWidget, addWidget, addWidget, addWidget, addWidget, addWidget, addWidget, addWidgetCentered, addWidgetCentered, clear, focus, getChildrenOffset, getChildrenOffsetX, getChildrenOffsetY, getCurrentFocusedWidget, getCurrentFocusedWidget, getEqualHeight, getEqualWidth, getInnerAspect, getInnerHeight, getInnerSize, getInnerWidth, getLayout, getLocationCanvas2HUD, getLocationHUD2Canvas, getLocationHUD2SG, getLocationSG2HUD, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getResAspect, getResolution, getResX, getResY, getScrollScale, getScrollScaleX, getScrollScaleY, getSGGroup, getSGPixelHeight, getSGPixelSize, getSGPixelWidth, getSizeCanvas2HUD, getSizeHUD2Canvas, getSizeHUD2SG, getSizeOfPixels, getSizeOnHUD, getSizeSG2HUD, getWidgets, isClippingEnbaled, moveFocus, onControllerAxisChanged, onControllerButtonPressed, onControllerButtonReleased, onDetached, onFocusGained, onFocusLost, onInputStateChanged, onKeyPressed, onKeyReleased, onKeyTyped, onMouseUnbound, onScrollbarValueChanged, pick, removeContainerScrollListener, removeWidget, setChildrenOffset, setClippingEnabled, setContainer, setLayout, setPadding, setPadding, setScrollScale, setScrollScale, setTransparency, setVisible, updateTranslation

Methods inherited from class org.xith3d.ui.hud.base.RectangularWidget

getPickHeight, getPickSGZPosition, getPickWidth

Methods inherited from class org.xith3d.ui.hud.base.WidgetBase

addContainerListener, addFocusListener, addInputListener, addLocationListener, addSizeListener, addVisibilityListener, detach, detach, getAspect, getAssembly, getCachedToolTipWidget, getContainer, getContextMenu, getCursor, getHeight, getHUD, getInheritedCursor, getLeft, getLocation, getName, getSGNode, getSGZPosition, getSize, getToolTip, getTop, getUserObject, getWidgetAssembler, getWidth, getZIndex, hasFocus, hasFocus, hasToolTip, isClickable, isDraggable, isFocussable, isInitialized, isInitializing, isPickable, isVisible, onAddedToContainer, onAddedToHUD, onMouseButtonPressed, onMouseButtonReleased, onMouseEntered, onMouseLeft, onMouseMoved, onMouseStopped, onMouseWheelMoved, onRemovedFromContainer, pickWidgetAssembler, removeContainerListener, removeFocusListener, removeInputListener, removeLocationListener, removeSizeListener, removeVisibilityListener, requestFocus, setAssembly, setCachedToolTipWidget, setClickable, setContextMenu, setCursor, setDraggable, setFocussable, setHeight, setLocation, setLocation, setLocation, setName, setPickable, setSize, setSize, setSize, setToolTip, setTransparency, setUserObject, setWidth, setZIndex, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.xith3d.ui.hud.menusystem.Menu

getName

Methods inherited from interface org.xith3d.ui.hud.base.Widget

addContainerListener, addFocusListener, addInputListener, addLocationListener, addSizeListener, addVisibilityListener, detach, detach, getAspect, getAssembly, getCachedToolTipWidget, getContainer, getContextMenu, getCursor, getHeight, getHUD, getInheritedCursor, getLeft, getLocation, getSGNode, getSGZPosition, getSize, getToolTip, getTop, getTransparency, getUserObject, getWidth, getZIndex, hasFocus, hasFocus, hasToolTip, isClickable, isDraggable, isFocussable, isPickable, isVisible, onControllerAxisChanged, onControllerButtonPressed, onControllerButtonReleased, onDetached, onFocusGained, onFocusLost, onInputStateChanged, onKeyPressed, onKeyReleased, onKeyTyped, onMouseButtonPressed, onMouseButtonReleased, onMouseEntered, onMouseLeft, onMouseMoved, onMouseStopped, onMouseUnbound, onMouseWheelMoved, pick, removeContainerListener, removeFocusListener, removeInputListener, removeLocationListener, removeSizeListener, removeVisibilityListener, requestFocus, setAssembly, setCachedToolTipWidget, setClickable, setContainer, setContextMenu, setCursor, setDraggable, setFocussable, setLocation, setLocation, setName, setPickable, setSize, setSize, setSize, setToolTip, setTransparency, setUserObject, setVisible, setZIndex, update

Methods inherited from interface org.openmali.types.twodee.Sized2f

setHeight, setWidth

Field Detail

minimalHeightSet

protected boolean minimalHeightSet

Constructor Detail

MenuBase

public MenuBase(float width,
                float height,
                int zIndex,
                java.lang.String name,
                java.lang.String[] acceptedActions)

MenuBase

public MenuBase(float width,
                float height,
                java.lang.String name,
                java.lang.String[] acceptedActions)

MenuBase

public MenuBase(float width,
                int zIndex,
                java.lang.String name,
                java.lang.String[] acceptedActions)

MenuBase

public MenuBase(float width,
                java.lang.String name,
                java.lang.String[] acceptedActions)

Method Detail

getAcceptedActions

protected final java.lang.String[] getAcceptedActions()

setMenuSystem

public void setMenuSystem(MenuSystem menuSystem)

This method is used by the MenuSystem to populate itself to the Menu.

Specified by:

setMenuSystem in interface Menu

getMenuSystem

public final MenuSystem getMenuSystem()

Specified by:

getMenuSystem in interface Menu

Returns:

the MenuSystem, this Menu belongs to.

setMenuGroup

public void setMenuGroup(MenuGroup menuGroup)

This method is used by the MenuGroup to populate itself to the Menu.

Specified by:

setMenuGroup in interface Menu

getMenuGroup

public final MenuGroup getMenuGroup()

Specified by:

getMenuGroup in interface Menu

Returns:

the MenuGroup, this Menu belongs to.

prepareAction

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

Specified by:

prepareAction in interface Menu

Returns:

true, if the action is accepted

onActionConsumed

public boolean onActionConsumed(java.lang.String action)

This event notifies a Menu, that an action has been consumed in user-space.

Specified by:

onActionConsumed in interface Menu

Returns:

true, of the consume was accepted.

setMinimalHeight

public void setMinimalHeight()

initWidgets

protected abstract void initWidgets()

init

protected void init()

This method is called when the WidgetContainer is set.

Overrides:

init in class Panel