org.xith3d.ui.hud.widgets
Class Frame

java.lang.Object
  extended by org.xith3d.ui.hud.base.Widget
      extended by org.xith3d.ui.hud.base.Window
          extended by org.xith3d.ui.hud.widgets.Frame
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
Direct Known Subclasses:
Dialog

public class Frame
extends Window

This class represents a simple Window above the HUD.


Nested Class Summary
 
Nested classes/interfaces inherited from class org.xith3d.ui.hud.base.Window
Window.CloseOperation
 
Nested classes/interfaces inherited from class org.xith3d.ui.hud.base.Widget
Widget.DescriptionBase
 
Field Summary
 
Fields inherited from class org.xith3d.ui.hud.base.Widget
transformHeight_Pixels2HUD, transformWidth_Pixels2HUD
 
Constructor Summary
Frame(float width, float height)
          Creates a new Frame.
Frame(float width, float height, java.lang.String title)
          Creates a new Frame.
Frame(WidgetContainer contentPane)
          Creates a new Frame.
Frame(WidgetContainer contentPane, java.lang.String title)
          Creates a new Frame.
Frame(WidgetContainer contentPane, WindowHeaderWidget.Description headerDesc, java.lang.String title)
          Creates a new Frame.
Frame(WidgetContainer contentPane, WindowHeaderWidget headerWidget)
          Creates a new Frame.
 
Method Summary
protected  WidgetContainer createContentPane(float width, float height)
          
static Panel createDefaultContentPane(float width, float height)
           
protected  WindowHeaderWidget createHeaderWidget(WindowHeaderWidget.Description headerDesc, java.lang.String title)
          Creates the header Widget for this decorated Window.
 
Methods inherited from class org.xith3d.ui.hud.base.Window
addWindowListener, checkDragStartCondition, detach, drawAndUpdateWidget, drawBorder, drawWidget, getContentHeightPX, getContentPane, getContentWidthPX, getDefaultCloseOperation, getHeaderHeight, getHeaderWidget, getResX, getResY, getTitle, init, isCloseButtonVisible, isDecorated, isPaneDraggingEnabled, onCloseButtonClicked, onDetachedFromHUD, onFocusLost, onKeyPressed, onKeyReleased, onKeyTyped, onMouseButtonPressed, onMouseButtonReleased, onMouseExited, onMouseMoved, onMouseWheelMoved, onSizeChanged, onVisibilityChanged, pick, removeWindowListener, setCloseButtonVisible, setContentSize, setDefaultCloseOperation, setHostTextureDirty, setPaneDraggingEnabled, setTextureDirty, setTitle, startDragging, toString
 
Methods inherited from class org.xith3d.ui.hud.base.Widget
addContainerListener, addControllerListener, addFocusListener, addInputListener, addKeyboardListener, addLocationListener, addMouseListener, addSizeListener, addVisibilityListener, bindToGlobalMouseMovement, blocksFocusMoveDeviceComponent, calculateTransformHeight_Pixels2HUD, calculateTransformWidth_Pixels2HUD, compareAbsZIndex, createShape, drawBackground, drawWidgetAfterWidgetAssembler, drawWidgetContents, getAbsoluteLocationOnHUD_, getAspect, getAssembly, getBorder, getContainer, getContentAspect, getContentHeight, getContentLeftPX, getContentOffset, getContentTopPX, getContentWidth, getContextMenu, getCursor, getEqualHeight_, getEqualWidth_, getForcedRedrawFrequency, getHeight, getHeightPX, getHUD, getLeft, getLevel, getLocation, getLocation, getLocationHUD2Pixels_, getLocationHUD2SG_, getLocationPixels2HUD_, getLocationSG2HUD_, getMaxRedrawFrequency, getMinHeight, getMinWidth, getName, getParentWindow, 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, onAttachedToHUD, onControllerAxisChanged, onControllerButtonPressed, onControllerButtonReleased, onDetachedFromContainer, onFocusGained, onInputStateChanged, onLocationChanged, onMouseEntered, onMouseStopped, 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, setHostWidget, setLocation, setLocation, setLocation, setMaxRedrawFrequency, setName, setPickable, setSize, setSize, setSize, setSize, setTextureDirty, setToolTip, setTransparency, setTransparency, setUserObject, setVisible, setWidgetDirty, setWidth, setZIndex, update, updateAbsZIndex, updateSizeFactors, updateTranslation
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Frame

public Frame(WidgetContainer contentPane,
             WindowHeaderWidget.Description headerDesc,
             java.lang.String title)
Creates a new Frame.

Parameters:
contentPane - the Widget that visually defines the Window.
headerDesc - the description of this Frame's header (or null for an undecorated Frame)
title - this Frame's title

Frame

public Frame(WidgetContainer contentPane,
             WindowHeaderWidget headerWidget)
Creates a new Frame.

Parameters:
contentPane - the Widget that visually defines the Window.
headerWidget - a Widget, that defines this Window's header (or null for an undecorated Window)

Frame

public Frame(WidgetContainer contentPane,
             java.lang.String title)
Creates a new Frame.

Parameters:
contentPane - the Widget that visually defines the Window.
title - this Frame's title

Frame

public Frame(WidgetContainer contentPane)
Creates a new Frame.

Parameters:
contentPane - the Widget that visually defines the Window.

Frame

public Frame(float width,
             float height,
             java.lang.String title)
Creates a new Frame.

Parameters:
width - the width of the Window
height - the height of the Window
title - this Frame's title

Frame

public Frame(float width,
             float height)
Creates a new Frame.

Parameters:
width - the width of the Window
height - the height of the Window
Method Detail

createHeaderWidget

protected WindowHeaderWidget createHeaderWidget(WindowHeaderWidget.Description headerDesc,
                                                java.lang.String title)
Creates the header Widget for this decorated Window. It is only called, if the Window is decorated. It MUST NOT return null. It MUST NOT add it to the WidgetAssembler.

Specified by:
createHeaderWidget in class Window
Parameters:
headerDesc - the description for the header Widget
title - the Window's title
Returns:
the create WindowHeaderWidget instance

createDefaultContentPane

public static Panel createDefaultContentPane(float width,
                                             float height)

createContentPane

protected WidgetContainer createContentPane(float width,
                                            float height)

Specified by:
createContentPane in class Window