org.xith3d.ui.hud.menusystem
Class MenuGroupWidget

java.lang.Object
  extended by org.xith3d.ui.hud.base.Widget
      extended by org.xith3d.ui.hud.base.BackgroundSettableWidget
          extended by org.xith3d.ui.hud.base.WidgetContainer
              extended by org.xith3d.ui.hud.widgets.Panel
                  extended by org.xith3d.ui.hud.menusystem.MenuGroupWidget
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
Direct Known Subclasses:
ButtonsLeftMenusCenterMenuGroupWidget

public abstract class MenuGroupWidget
extends Panel

A MenuGroupWidget is a Widget, that handles the visualization part of a MenuGroup.


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
 
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
MenuGroupWidget(boolean isHeavyWeight, float width, float height)
          Creates a new MenuGroupWidget with the given width and height.
MenuGroupWidget(boolean isHeavyWeight, float width, float height, org.openmali.vecmath2.Colorf backgroundColor)
          Creates a new MenuGroupWidget with the given width, height and background color.
MenuGroupWidget(boolean isHeavyWeight, float width, float height, org.openmali.vecmath2.Colorf backgroundColor, Texture2D backgroundTex)
          Creates a new MenuGroupWidget with the given width, height, background color and texture.
MenuGroupWidget(boolean isHeavyWeight, float width, float height, java.lang.String backgroundTex)
          Creates a new MenuGroupWidget with the given width, height and background texture.
MenuGroupWidget(boolean isHeavyWeight, float width, float height, Texture2D backgroundTex)
          Creates a new MenuGroupWidget with the given width, height and background texture.
MenuGroupWidget(float width, float height)
          Creates a new MenuGroupWidget with the given width and height.
MenuGroupWidget(float width, float height, org.openmali.vecmath2.Colorf backgroundColor)
          Creates a new MenuGroupWidget with the given width, height and background color.
MenuGroupWidget(float width, float height, org.openmali.vecmath2.Colorf backgroundColor, java.lang.String backgroundTex)
          Creates a new MenuGroupWidget with the given width, height, background color and texture.
MenuGroupWidget(float width, float height, org.openmali.vecmath2.Colorf backgroundColor, Texture2D backgroundTex)
          Creates a new MenuGroupWidget with the given width, height, background color and texture.
MenuGroupWidget(float width, float height, java.lang.String backgroundTex)
          Creates a new MenuGroupWidget with the given width, height and background texture.
MenuGroupWidget(float width, float height, Texture2D backgroundTex)
          Creates a new MenuGroupWidget with the given width, height and background texture.
 
Method Summary
abstract  Button addAccessorWidget(java.lang.String caption, Button.Description buttonDesc)
           
abstract  void addMenu(MenuSystem menuSystem, java.lang.String caption, Menu menu)
           
abstract  WidgetContainer getAccessorPanel()
           
abstract  MenuGroup getMenuGroup()
           
abstract  WidgetContainer getMenuPanel()
           
abstract  boolean isMenuVisible(Menu menu)
           
abstract  void setMenuGroup(MenuGroup menuGroup)
           
abstract  void setMenuVisible(Menu menu, boolean visible)
           
 
Methods inherited from class org.xith3d.ui.hud.widgets.Panel
createContentPane, createContentPane, drawForeground, drawWidget, getForegroundTexture, init, 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
 

Constructor Detail

MenuGroupWidget

public MenuGroupWidget(boolean isHeavyWeight,
                       float width,
                       float height,
                       org.openmali.vecmath2.Colorf backgroundColor,
                       Texture2D backgroundTex)
Creates a new MenuGroupWidget with the given width, height, background color and texture.

Parameters:
isHeavyWeight - indicator to make this widget heavyweight or not
width - the new width of this Widget
height - the new height of this Widget
backgroundColor - the background color of this Widget
backgroundTex - the background texture of this Widget

MenuGroupWidget

public MenuGroupWidget(boolean isHeavyWeight,
                       float width,
                       float height,
                       org.openmali.vecmath2.Colorf backgroundColor)
Creates a new MenuGroupWidget with the given width, height and background color.

Parameters:
isHeavyWeight - indicator to make this widget heavyweight or not
width - the new width of this Widget
height - the new height of this Widget
backgroundColor - the background color of this Widget

MenuGroupWidget

public MenuGroupWidget(boolean isHeavyWeight,
                       float width,
                       float height,
                       Texture2D backgroundTex)
Creates a new MenuGroupWidget with the given width, height and background texture.

Parameters:
isHeavyWeight - indicator to make this widget heavyweight or not
width - the new width of this Widget
height - the new height of this Widget
backgroundTex - the background texture of this Widget

MenuGroupWidget

public MenuGroupWidget(boolean isHeavyWeight,
                       float width,
                       float height,
                       java.lang.String backgroundTex)
Creates a new MenuGroupWidget with the given width, height and background texture.

Parameters:
isHeavyWeight - indicator to make this widget heavyweight or not
width - the new width of this Widget
height - the new height of this Widget
backgroundTex - the background texture of this Widget

MenuGroupWidget

public MenuGroupWidget(boolean isHeavyWeight,
                       float width,
                       float height)
Creates a new MenuGroupWidget with the given width and height.

Parameters:
isHeavyWeight - indicator to make this widget heavyweight or not
width - the new width of this Widget
height - the new height of this Widget

MenuGroupWidget

public MenuGroupWidget(float width,
                       float height,
                       org.openmali.vecmath2.Colorf backgroundColor,
                       Texture2D backgroundTex)
Creates a new MenuGroupWidget with the given width, height, background color and texture.

Parameters:
width - the new width of this Widget
height - the new height of this Widget
backgroundColor - the background color of this Widget
backgroundTex - the background texture of this Widget

MenuGroupWidget

public MenuGroupWidget(float width,
                       float height,
                       org.openmali.vecmath2.Colorf backgroundColor,
                       java.lang.String backgroundTex)
Creates a new MenuGroupWidget with the given width, height, background color and texture.

Parameters:
width - the new width of this Widget
height - the new height of this Widget
backgroundColor - the background color of this Widget
backgroundTex - the background texture of this Widget

MenuGroupWidget

public MenuGroupWidget(float width,
                       float height,
                       org.openmali.vecmath2.Colorf backgroundColor)
Creates a new MenuGroupWidget with the given width, height and background color.

Parameters:
width - the new width of this Widget
height - the new height of this Widget
backgroundColor - the background color of this Widget

MenuGroupWidget

public MenuGroupWidget(float width,
                       float height,
                       Texture2D backgroundTex)
Creates a new MenuGroupWidget with the given width, height and background texture.

Parameters:
width - the new width of this Widget
height - the new height of this Widget
backgroundTex - the background texture of this Widget

MenuGroupWidget

public MenuGroupWidget(float width,
                       float height,
                       java.lang.String backgroundTex)
Creates a new MenuGroupWidget with the given width, height and background texture.

Parameters:
width - the new width of this Widget
height - the new height of this Widget
backgroundTex - the background texture of this Widget

MenuGroupWidget

public MenuGroupWidget(float width,
                       float height)
Creates a new MenuGroupWidget with the given width and height.

Parameters:
width - the new width of this Widget
height - the new height of this Widget
Method Detail

getAccessorPanel

public abstract WidgetContainer getAccessorPanel()

getMenuPanel

public abstract WidgetContainer getMenuPanel()

addAccessorWidget

public abstract Button addAccessorWidget(java.lang.String caption,
                                         Button.Description buttonDesc)

addMenu

public abstract void addMenu(MenuSystem menuSystem,
                             java.lang.String caption,
                             Menu menu)

setMenuVisible

public abstract void setMenuVisible(Menu menu,
                                    boolean visible)

isMenuVisible

public abstract boolean isMenuVisible(Menu menu)

setMenuGroup

public abstract void setMenuGroup(MenuGroup menuGroup)

getMenuGroup

public abstract MenuGroup getMenuGroup()