org.xith3d.ui.hud.base
Interface BackgroundSettable

All Known Subinterfaces:

AdvancedTextWidget, BackgroundSettableWidget, MenuGroupWidget, WidgetContainer

All Known Implementing Classes:

BackgroundSettableRectangularWidget, ButtonsLeftMenusCenterMenuGroupWidget, DefaultContextMenuItem, DynamicLabel, FPIHInputBindingsSettingsMenu, FPIHMainSettingsMenu, FPSCounter, GraphicsMainSettingsMenu, HUD, HUDConsole, InputBindingsSettingsMenu, Label, List, MenuBase, NumberLabel, Panel, TextField, TextList, WidgetContainerBase, WindowHeaderWidget

public interface BackgroundSettable

Any Widget class implementing this interface is able to receive and display background Textures.

Method Summary

Texture	getBackground()
org.openmali.vecmath2.Colorf	getBackgroundColor()
float	getBackgroundTileHeight()
org.openmali.types.twodee.Sized2fRO	getBackgroundTileSize()
float	getBackgroundTileWidth()
void	setBackground(org.openmali.vecmath2.Colorf color) Sets the background color of the Widget.
void	setBackground(java.lang.String texture) Sets the background Texture of the Widget.
void	setBackground(Texture texture) Sets the background texture of the Widget.
void	setBackgroundTileSize(float tileWidth, float tileHeight) Sets the background tile size.
void	setBackgroundTileSize(org.openmali.types.twodee.Sized2fRO tileSize) Sets the background tile size.

Method Detail

setBackground

void setBackground(org.openmali.vecmath2.Colorf color)

Sets the background color of the Widget.

Parameters:

color - the color to use

setBackground

void setBackground(Texture texture)

Sets the background texture of the Widget.

Parameters:

texture - the texture resource to use

setBackground

void setBackground(java.lang.String texture)

Sets the background Texture of the Widget.

Parameters:

texture - the texture resource to use

getBackground

Texture getBackground()

Returns:

the background Texture of the WidgetContainer.

getBackgroundColor

org.openmali.vecmath2.Colorf getBackgroundColor()

Returns:

the background color of the Widget.

setBackgroundTileSize

void setBackgroundTileSize(float tileWidth,
                           float tileHeight)

Sets the background tile size.
Use any negative value for no tiling.

Parameters:

tileWidth - the tile width (or negative for no tiling of width)

tileHeight - the tile height (or negative for no tiling of height)

setBackgroundTileSize

void setBackgroundTileSize(org.openmali.types.twodee.Sized2fRO tileSize)

Sets the background tile size.
Use any negative value for no tiling.

Parameters:

tileSize - the tile size (or null for no tiling)

getBackgroundTileSize

org.openmali.types.twodee.Sized2fRO getBackgroundTileSize()

Returns:

the background tile size (or null for no tiling)

getBackgroundTileWidth

float getBackgroundTileWidth()

Returns:

the background tile width (or negative for no tiling)

getBackgroundTileHeight

float getBackgroundTileHeight()

Returns:

the background tile width (or negative for no tiling)