org.xith3d.ui.hud.widgets
Class TextList

java.lang.Object
  org.xith3d.ui.hud.base.WidgetBase
      org.xith3d.ui.hud.base.RectangularWidget
          org.xith3d.ui.hud.widgets.List<Label>
              org.xith3d.ui.hud.widgets.TextList

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, AbstractList<Label>, AbstractTextList<Label>, BackgroundSettable, BackgroundSettableWidget, BorderSettable, PaddingSettable, Widget

public class TextList
extends List<Label>
implements AbstractTextList<Label>

This is a very simple List-Widget extension, that forces the List to take Labels as items.
It is simply an alias for "List<Label>".

Nested Class Summary

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

List.Description

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

Widget.DescriptionBase

Field Summary

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

containerListeners, transformGroup, translation, Z_INDEX_UNIT, Z_INDEX_UNIT_ASSEMBLER

Constructor Summary

TextList(float width, float height)
Creates a new List Widget.

TextList(float width, float height, int zIndex)
Creates a new List Widget.

TextList(float width, float height, int zIndex, List.Description listDesc)
Creates a new List Widget.

TextList(float width, float height, List.Description listDesc)
Creates a new List Widget.

TextList(org.openmali.types.twodee.Sized2fRO size)
Creates a new List Widget.

TextList(org.openmali.types.twodee.Sized2fRO size, int zIndex)
Creates a new List Widget.

TextList(org.openmali.types.twodee.Sized2fRO size, int zIndex, List.Description listDesc)
Creates a new List Widget.

TextList(org.openmali.types.twodee.Sized2fRO size, List.Description listDesc)
Creates a new List Widget.

Method Summary

Label	addItem(int index, java.lang.String text) Creates a Label and adds it to the List (at the given position).
Label	addItem(int index, java.lang.String text, org.openmali.vecmath2.Colorf color) Creates a Label and adds it to the List (at the given position).
Label	addItem(int index, java.lang.String text, java.awt.Font font, org.openmali.vecmath2.Colorf color) Creates a Label and adds it to the List (at the given position).
Label	addItem(java.lang.String text) Creates a Label and adds it to the List (at the end).
Label	addItem(java.lang.String text, org.openmali.vecmath2.Colorf color) Creates a Label and adds it to the List (at the given position).
Label	addItem(java.lang.String text, java.awt.Font font, org.openmali.vecmath2.Colorf color) Creates a Label and adds it to the List (at the given position).
Label	createItem(java.lang.String text) Creates a Label and adds it to the List (at the end).
Label	createItem(java.lang.String text, org.openmali.vecmath2.Colorf color) Creates a Label and adds it to the List (at the given position).
Label	createItem(java.lang.String text, java.awt.Font font, org.openmali.vecmath2.Colorf color) Creates a Label from the parameters.

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

addItem, addItem, addItemSetsSelectedItem, addSelectionListener, clear, cullItems, getBackground, getBackgroundColor, getBackgroundTileHeight, getBackgroundTileSize, getBackgroundTileWidth, getBorder, getBottomIndex, getBottomItem, getFixAlignment, getHeightByItems, getItem, getItem, getItems, getItemsCount, getMaxHeight, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getSelectedIndex, getSelectedItem, getSelectionBackgroundColor, getSelectionForegroundColor, getTopIndex, getTopItem, getTransparency, init, isFixedToBottom, isScrollBarForced, isScrollBarVisible, isScrolledToBottom, onKeyPressed, onMouseButtonPressed, onMouseWheelMoved, removeItem, removeItem, removeItem, removeItem, removeSelectionListener, scrollToBottom, selectNextItem, selectPreviousItem, setAddItemSetsSelectedItem, setBackground, setBackground, setBackground, setBackgroundTileSize, setBackgroundTileSize, setBorder, setBorder, setFixAlignment, setFixedToBottom, setHeightByItems, setMaxHeight, setPadding, setPadding, setScrollBarForced, setScrollBarVisible, setSelectedItem, setSelectedItem, setSelectionBackgroundColor, setSelectionForegroundColor, setSize, setTopIndex, setTopItem, setTopItem, setVerticalScrollbarValue, update

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

getPickHeight, getPickSGZPosition, getPickWidth, pick

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, onControllerAxisChanged, onControllerButtonPressed, onControllerButtonReleased, onDetached, onFocusGained, onFocusLost, onInputStateChanged, onKeyReleased, onKeyTyped, onMouseButtonReleased, onMouseEntered, onMouseLeft, onMouseMoved, onMouseStopped, onMouseUnbound, onRemovedFromContainer, pickWidgetAssembler, removeContainerListener, removeFocusListener, removeInputListener, removeLocationListener, removeSizeListener, removeVisibilityListener, requestFocus, setAssembly, setCachedToolTipWidget, setClickable, setContainer, setContextMenu, setCursor, setDraggable, setFocussable, setHeight, setLocation, setLocation, setLocation, setName, setPickable, setSize, setSize, setSize, setToolTip, setTransparency, setUserObject, setVisible, setWidth, setZIndex, toString, updateTranslation

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.base.AbstractList

addItem, addItem, addItemSetsSelectedItem, addSelectionListener, clear, getHeightByItems, getItem, getItem, getItems, getItemsCount, getMaxHeight, getSelectedIndex, getSelectedItem, isScrollBarForced, isScrollBarVisible, removeItem, removeItem, removeSelectionListener, selectNextItem, selectPreviousItem, setAddItemSetsSelectedItem, setHeightByItems, setMaxHeight, setScrollBarForced, setScrollBarVisible, setSelectedItem, setSelectedItem

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, getName, getSGNode, getSGZPosition, getSize, getToolTip, getTop, getUserObject, getWidth, getZIndex, hasFocus, hasFocus, hasToolTip, isClickable, isDraggable, isFocussable, isPickable, isVisible, onControllerAxisChanged, onControllerButtonPressed, onControllerButtonReleased, onDetached, onFocusGained, onFocusLost, onInputStateChanged, onKeyReleased, onKeyTyped, onMouseButtonReleased, onMouseEntered, onMouseLeft, onMouseMoved, onMouseStopped, onMouseUnbound, 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

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

setHeight, setWidth

Constructor Detail

TextList

public TextList(float width,
                float height,
                int zIndex,
                List.Description listDesc)

Creates a new List Widget.

Parameters:

width - the new (outer) width

height - the new (outer) height

zIndex - the new z-index

listDesc - the List.Description to describe this new List Widget

TextList

public TextList(float width,
                float height,
                List.Description listDesc)

Creates a new List Widget.

Parameters:

width - the new (outer) width

height - the new (outer) height

listDesc - the List.Description to describe this new List Widget

TextList

public TextList(org.openmali.types.twodee.Sized2fRO size,
                int zIndex,
                List.Description listDesc)

Creates a new List Widget.

Parameters:

size - the new (outer) size

zIndex - the new z-index

listDesc - the List.Description to describe this new List Widget

TextList

public TextList(org.openmali.types.twodee.Sized2fRO size,
                List.Description listDesc)

Creates a new List Widget.

Parameters:

size - the new (outer) size

listDesc - the List.Description to describe this new List Widget

TextList

public TextList(float width,
                float height,
                int zIndex)

Creates a new List Widget.

Parameters:

width - the new (outer) width

height - the new (outer) height

zIndex - the new z-index

TextList

public TextList(float width,
                float height)

Creates a new List Widget.

Parameters:

width - the new (outer) width

height - the new (outer) height

TextList

public TextList(org.openmali.types.twodee.Sized2fRO size,
                int zIndex)

Creates a new List Widget.

Parameters:

size - the new (outer) size

zIndex - the new z-index

TextList

public TextList(org.openmali.types.twodee.Sized2fRO size)

Creates a new List Widget.

Parameters:

size - the new (outer) size

Method Detail

createItem

public Label createItem(java.lang.String text,
                        java.awt.Font font,
                        org.openmali.vecmath2.Colorf color)

Creates a Label from the parameters.

Specified by:

createItem in interface AbstractTextList<Label>

Parameters:

text - the text content for the new Item

Returns:

the created Label

createItem

public final Label createItem(java.lang.String text,
                              org.openmali.vecmath2.Colorf color)

Creates a Label and adds it to the List (at the given position).

Specified by:

createItem in interface AbstractTextList<Label>

Parameters:

text - the text content for the new Item

Returns:

the created Label

createItem

public final Label createItem(java.lang.String text)

Creates a Label and adds it to the List (at the end).

Specified by:

createItem in interface AbstractTextList<Label>

Parameters:

text - the text content for the new Item

Returns:

the created Label

addItem

public Label addItem(int index,
                     java.lang.String text,
                     java.awt.Font font,
                     org.openmali.vecmath2.Colorf color)

Creates a Label and adds it to the List (at the given position).

Specified by:

addItem in interface AbstractTextList<Label>

Parameters:

index - the position to add the Item at

text - the text content for the new Item

Returns:

the created Label

addItem

public final Label addItem(java.lang.String text,
                           java.awt.Font font,
                           org.openmali.vecmath2.Colorf color)

Creates a Label and adds it to the List (at the given position).

Specified by:

addItem in interface AbstractTextList<Label>

Parameters:

text - the text content for the new Item

Returns:

the created Label

addItem

public final Label addItem(int index,
                           java.lang.String text,
                           org.openmali.vecmath2.Colorf color)

Creates a Label and adds it to the List (at the given position).

Specified by:

addItem in interface AbstractTextList<Label>

Parameters:

index - the position to add the Item at

text - the text content for the new Item

Returns:

the created Label

addItem

public final Label addItem(java.lang.String text,
                           org.openmali.vecmath2.Colorf color)

Creates a Label and adds it to the List (at the given position).

Specified by:

addItem in interface AbstractTextList<Label>

Parameters:

text - the text content for the new Item

Returns:

the created Label

addItem

public final Label addItem(int index,
                           java.lang.String text)

Creates a Label and adds it to the List (at the given position).

Specified by:

addItem in interface AbstractTextList<Label>

Parameters:

index - the position to add the Item at

text - the text content for the new Item

Returns:

the created Label

addItem

public final Label addItem(java.lang.String text)

Creates a Label and adds it to the List (at the end).

Specified by:

addItem in interface AbstractTextList<Label>

Parameters:

text - the text content for the new Item

Returns:

the created Label