org.xith3d.ui.hud.widgets
Class ScrollPanel

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.widgets.ScrollPanel
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

public class ScrollPanel
extends Panel


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
ScrollPanel(boolean isHeavyWeight, float width, float height)
          Creates a new Panel with the given width and height.
ScrollPanel(boolean isHeavyWeight, float width, float height, org.openmali.vecmath2.Colorf backgroundColor)
          Creates a new Panel with the given width and height.
ScrollPanel(boolean isHeavyWeight, float width, float height, org.openmali.vecmath2.Colorf backgroundColor, java.lang.String backgroundTex)
          Creates a new Panel with the given width and height.
ScrollPanel(boolean isHeavyWeight, float width, float height, org.openmali.vecmath2.Colorf backgroundColor, Texture2D backgroundTex)
          Creates a new Panel with the given width and height.
ScrollPanel(boolean isHeavyWeight, float width, float height, org.openmali.vecmath2.Colorf backgroundColor, Texture2D backgroundTex, TileMode backgroundTileMode)
          Creates a new Panel with the given width and height.
ScrollPanel(boolean isHeavyWeight, float width, float height, java.lang.String backgroundTex)
          Creates a new Panel with the given width and height.
ScrollPanel(boolean isHeavyWeight, float width, float height, Texture2D backgroundTex)
          Creates a new Panel with the given width and height.
ScrollPanel(float width, float height)
          Creates a new Panel with the given width and height.
ScrollPanel(float width, float height, org.openmali.vecmath2.Colorf backgroundColor)
          Creates a new Panel with the given width and height.
ScrollPanel(float width, float height, org.openmali.vecmath2.Colorf backgroundColor, java.lang.String backgroundTex)
          Creates a new Panel with the given width and height.
ScrollPanel(float width, float height, org.openmali.vecmath2.Colorf backgroundColor, Texture2D backgroundTex)
          Creates a new Panel with the given width and height.
ScrollPanel(float width, float height, java.lang.String backgroundTex)
          Creates a new Panel with the given width and height.
ScrollPanel(float width, float height, Texture2D backgroundTex)
          Creates a new Panel with the given width and height.
 
Method Summary
 void addContainerScrollListener(ContainerScrollListener l)
          Adds a ContainerScrollListener to the list of notified objects when the children-offset has changed.
protected  GroupNode createChildrenGroup()
          
static ScrollPanel createContentPane(float width, float height)
          Creates a new non scrollable Panel with the given width and height.
 float getLineHeight()
           
protected  void init()
          This method is called when the WidgetContainer is set.
 void removeContainerScrollListener(ContainerScrollListener l)
          Removes a ContainerScrollListener from the list of notified objects when the children-offset has changed.
 void setLineHeight(float lineHeight)
           
 
Methods inherited from class org.xith3d.ui.hud.widgets.Panel
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, 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

ScrollPanel

public ScrollPanel(boolean isHeavyWeight,
                   float width,
                   float height,
                   org.openmali.vecmath2.Colorf backgroundColor,
                   Texture2D backgroundTex,
                   TileMode backgroundTileMode)
Creates a new Panel with the given width and height. The Panel will can a differen coordinate system then it's parent WidgetContainer.

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

ScrollPanel

public ScrollPanel(boolean isHeavyWeight,
                   float width,
                   float height,
                   org.openmali.vecmath2.Colorf backgroundColor,
                   Texture2D backgroundTex)
Creates a new Panel with the given width and height. The Panel will can a differen coordinate system then it's parent WidgetContainer.

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

ScrollPanel

public ScrollPanel(boolean isHeavyWeight,
                   float width,
                   float height,
                   org.openmali.vecmath2.Colorf backgroundColor,
                   java.lang.String backgroundTex)
Creates a new Panel with the given width and height. The Panel will can a differen coordinate system then it's parent WidgetContainer.

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

ScrollPanel

public ScrollPanel(boolean isHeavyWeight,
                   float width,
                   float height,
                   org.openmali.vecmath2.Colorf backgroundColor)
Creates a new Panel with the given width and height. The Panel will can a differen coordinate system then it's parent WidgetContainer.

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

ScrollPanel

public ScrollPanel(boolean isHeavyWeight,
                   float width,
                   float height,
                   Texture2D backgroundTex)
Creates a new Panel with the given width and height. The Panel will can a differen coordinate system then it's parent WidgetContainer.

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

ScrollPanel

public ScrollPanel(boolean isHeavyWeight,
                   float width,
                   float height,
                   java.lang.String backgroundTex)
Creates a new Panel with the given width and height. The Panel will can a differen coordinate system then it's parent WidgetContainer.

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

ScrollPanel

public ScrollPanel(boolean isHeavyWeight,
                   float width,
                   float height)
Creates a new Panel with the given width and height. The Panel will can a differen coordinate system then it's parent WidgetContainer.

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

ScrollPanel

public ScrollPanel(float width,
                   float height,
                   org.openmali.vecmath2.Colorf backgroundColor,
                   Texture2D backgroundTex)
Creates a new Panel with the given width and height. The Panel will can a differen coordinate system then it's parent WidgetContainer.

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

ScrollPanel

public ScrollPanel(float width,
                   float height,
                   org.openmali.vecmath2.Colorf backgroundColor,
                   java.lang.String backgroundTex)
Creates a new Panel with the given width and height. The Panel will can a differen coordinate system then it's parent WidgetContainer.

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

ScrollPanel

public ScrollPanel(float width,
                   float height,
                   org.openmali.vecmath2.Colorf backgroundColor)
Creates a new Panel with the given width and height. The Panel will can a differen coordinate system then it's parent WidgetContainer.

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

ScrollPanel

public ScrollPanel(float width,
                   float height,
                   Texture2D backgroundTex)
Creates a new Panel with the given width and height. The Panel will can a differen coordinate system then it's parent WidgetContainer.

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

ScrollPanel

public ScrollPanel(float width,
                   float height,
                   java.lang.String backgroundTex)
Creates a new Panel with the given width and height. The Panel will can a differen coordinate system then it's parent WidgetContainer.

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

ScrollPanel

public ScrollPanel(float width,
                   float height)
Creates a new Panel with the given width and height. The Panel will can a differen coordinate system then it's parent WidgetContainer.

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

addContainerScrollListener

public final void addContainerScrollListener(ContainerScrollListener l)
Adds a ContainerScrollListener to the list of notified objects when the children-offset has changed.

Parameters:
l -

removeContainerScrollListener

public final void removeContainerScrollListener(ContainerScrollListener l)
Removes a ContainerScrollListener from the list of notified objects when the children-offset has changed.

Parameters:
l -

setLineHeight

public void setLineHeight(float lineHeight)

getLineHeight

public final float getLineHeight()

init

protected void init()
This method is called when the WidgetContainer is set.

Overrides:
init in class Panel

createChildrenGroup

protected GroupNode createChildrenGroup()

Overrides:
createChildrenGroup in class WidgetContainer

createContentPane

public static final ScrollPanel createContentPane(float width,
                                                  float height)
Creates a new non scrollable Panel with the given width and height.
The Panel will have the background defined in the current theme.

Parameters:
width - the new width of this Widget
height - the new height of this Widget
Returns:
a Panel.