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

java.lang.Object
  org.xith3d.ui.hud.base.Widget
      org.xith3d.ui.hud.base.BackgroundSettableWidget
          org.xith3d.ui.hud.base.WidgetContainer
              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, PaddingSettable, 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.base.BackgroundSettableWidget

BackgroundSettableWidget.BackgroundSettableDescriptionBase

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

Widget.DescriptionBase

Field Summary

protected boolean

minimalHeightSet

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

DEFAULT_HEAVYWEIGHT

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

childrenOffset_HUD, childrenOffset_PX

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

transformHeight_Pixels2HUD, transformWidth_Pixels2HUD

Constructor Summary

MenuBase(float width, float height, 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

createContentPane, createContentPane, drawForeground, drawWidget, getForegroundTexture, setForegroundTexture, setForegroundTexture

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

addWidget, addWidget, addWidget, addWidget, addWidget, addWidget, addWidgetCentered, addWidgetCentered, calculateTransformHeight_Pixels2HUD, calculateTransformWidth_Pixels2HUD, clear, createChildrenGroup, drawChildWidgets, focus, getCurrentFocusedWidget, getCurrentFocusedWidget, getCurrentHoveredWidget, getCurrentHoveredWidget, getEqualHeight, getEqualWidth, getLayout, getLocationHUD2Pixels, getLocationHUD2SG, getLocationPixels2HUD, getLocationSG2HUD, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getParentWindow, getRelLocationHUD2Pixels, getResAspect, getResolution, getResX, getResY, getSGGroup, getSizeHUD2Pixels, getSizeHUD2SG, getSizeOfPixels, getSizePixels2HUD, getSizeSG2HUD, getWidget, getWidgets, getWidgetsCount, hasCustomResolution, isClippingEnbaled, isContentPane, onAttachedToHUD, onControllerAxisChanged, onControllerButtonPressed, onControllerButtonReleased, onFocusGained, onFocusLost, onInputStateChanged, onKeyPressed, onKeyReleased, onKeyTyped, onMouseExited, onSizeChanged, onVisibilityChanged, pick, removeWidget, resetCurrentHoveredWidget, setClippingEnabled, setLayout, setPadding, setPadding, setResolution, setTransparency, setWidgetDirty, setZIndexSortingDirty, update, updateAbsZIndex, updateTranslation

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

drawBackground, getBackgroundColor, getBackgroundTexture, getBackgroundTileMode, setBackground, setBackground, setBackground, setBackgroundColor, setBackgroundTexture, setBackgroundTexture, setBackgroundTexture, setBackgroundTexture, setBackgroundTileMode, setNoBackground

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

addContainerListener, addControllerListener, addFocusListener, addInputListener, addKeyboardListener, addLocationListener, addMouseListener, addSizeListener, addVisibilityListener, bindToGlobalMouseMovement, blocksFocusMoveDeviceComponent, compareAbsZIndex, createShape, detach, drawAndUpdateWidget, drawBorder, drawWidgetAfterWidgetAssembler, drawWidgetContents, getAbsoluteLocationOnHUD_, getAspect, getAssembly, getBorder, getContainer, getContentAspect, getContentHeight, getContentHeightPX, getContentLeftPX, getContentOffset, getContentTopPX, getContentWidth, getContentWidthPX, getContextMenu, getCursor, getEqualHeight_, getEqualWidth_, getForcedRedrawFrequency, getHeight, getHeightPX, getHUD, getLeft, getLevel, getLocation, getLocation, getLocationHUD2Pixels_, getLocationHUD2SG_, getLocationPixels2HUD_, getLocationSG2HUD_, getMaxRedrawFrequency, getMinHeight, getMinWidth, getName, getPickHeight, getPickWidth, getRelLocationHUD2Pixels_, getRootHostWidget, getShape, getSize, getSizeHUD2Pixels_, getSizeHUD2SG_, getSizeOfPixels_, getSizePixels2HUD_, getSizeSG2HUD_, getToolTip, getTop, getTransparency, getUserObject, getWidgetAssembler, getWidth, getWidthPX, getZIndex, hasDropShadow, hasFocus, hasFocus, hasToolTip, initSize, isAHostedWidgetDirty, isClickable, isDraggable, isFocussable, isHeavyWeight, isHovered, isInitialized, isInitializing, isPickable, isThisWidgetDirty, isVisible, notifyOnDragStopped, onAttachedToContainer, onDetachedFromContainer, onDetachedFromHUD, onLocationChanged, onMouseButtonPressed, onMouseButtonReleased, onMouseEntered, onMouseMoved, onMouseStopped, onMouseWheelMoved, pickConditionsMatch, removeContainerListener, removeControllerListener, removeFocusListener, removeInputListener, removeKeyboardListener, removeLocationListener, removeMouseListener, removeSizeListener, removeVisibilityListener, requestFocus, resetWidgetDirty, setBorder, setBorder, setClickable, setContentClipRect, setContextMenu, setCursor, setDraggable, setFocussable, setForcedRedrawFrequency, setHasDropShadow, setHeight, setHostedWidgetDirty, setHostTextureDirty, setHostTextureDirty, setHostWidget, setLocation, setLocation, setLocation, setMaxRedrawFrequency, setName, setPickable, setSize, setSize, setSize, setSize, setTextureDirty, setTextureDirty, setToolTip, setTransparency, setUserObject, setVisible, setWidth, setZIndex, startDragging, toString, updateSizeFactors

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

Field Detail

minimalHeightSet

protected boolean minimalHeightSet

Constructor Detail

MenuBase

public MenuBase(float width,
                float height,
                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