org.xith3d.ui.hud.theming
Class WidgetTheme

java.lang.Object
  org.xith3d.ui.hud.theming.WidgetTheme

All Implemented Interfaces:

org.jagatoo.datatypes.NamedObject

Direct Known Subclasses:

FallbackTheme, TestTheme

public class WidgetTheme
extends java.lang.Object
implements org.jagatoo.datatypes.NamedObject

Extend this class when you create a Widget-theme for your HUD.

Field Summary

protected ThemeProperties

themeProps

Constructor Summary

	WidgetTheme(java.io.File zipFile) Creates the desired WidgetTheme.
	WidgetTheme(java.lang.String name) Creates the desired built-in WidgetTheme.
protected	WidgetTheme(ThemeProperties themeProps)
	WidgetTheme(java.net.URL url) Creates the desired WidgetTheme.

Method Summary

Button.Description	getButtonDescription()
void	getButtonDescription(Button.Description desc)
LabeledStateButton.Description	getCheckBoxDescription()
void	getCheckBoxDescription(LabeledStateButton.Description desc)
ComboBox.Description	getComboBoxDescription()
void	getComboBoxDescription(ComboBox.Description desc)
CursorSet	getCursorSet()
void	getCursorSet(CursorSet cs)
java.awt.Font	getFont(boolean disabled)
org.openmali.vecmath2.Colorf	getFontColor(boolean disabled)
Border.Description	getFrameBorderDescription()
void	getFrameBorderDescription(Border.Description desc)
Label.Description	getLabelDescription()
void	getLabelDescription(Label.Description desc)
List.Description	getListDescription()
void	getListDescription(List.Description desc)
Border.Description	getLoweredBevelBorderDescription()
void	getLoweredBevelBorderDescription(Border.Description desc)
java.lang.String	getName()
Panel.Description	getPanelDescription()
void	getPanelDescription(Panel.Description desc)
ProgressBar.Description	getProgressBarDescription()
void	getProgressBarDescription(ProgressBar.Description desc)
java.awt.Font	getProgressBarLabelFont()
org.openmali.vecmath2.Colorf	getProgressBarLabelFontColor()
LabeledStateButton.Description	getRadioButtonDescription()
void	getRadioButtonDescription(LabeledStateButton.Description desc)
Border.Description	getRaisedBevelBorderDescription()
void	getRaisedBevelBorderDescription(Border.Description desc)
Border.Description	getRoundedCornersBorderDescription()
void	getRoundedCornersBorderDescription(Border.Description desc)
Scrollbar.Description	getScrollbarDescriptionHorizontal()
void	getScrollbarDescriptionHorizontal(Scrollbar.Description desc)
Scrollbar.Description	getScrollbarDescriptionVertical()
void	getScrollbarDescriptionVertical(Scrollbar.Description desc)
Texture	getScrollPanelSpaceTexture()
Slider.Description	getSliderDescription()
void	getSliderDescription(Slider.Description desc)
Border.Description	getStandardBorderDescription()
void	getStandardBorderDescription(Border.Description desc)
Texture	getTextCaretTexture(java.lang.String suffix)
TextField.Description	getTextFieldDescription()
void	getTextFieldDescription(TextField.Description desc)
WindowHeaderWidget.Description	getWindowHeaderDescription()
void	getWindowHeaderDescription(WindowHeaderWidget.Description desc)
protected static ThemeProperties	loadThemeProps(java.io.InputStream in)
void	setButtonDescription(Button.Description desc) Sets the default Button.Description.
void	setCheckBoxDescription(LabeledStateButton.Description desc) Sets the default CheckBox.Description.
void	setComboBoxDescription(ComboBox.Description desc) Sets the default ComboBox.Description.
void	setFont(java.awt.Font font, boolean disabled) Sets the default Font of this theme.
void	setFontColor(org.openmali.vecmath2.Colorf color, boolean disabled) Sets the default font-color of this theme.
void	setFrameBorderDescription(Border.Description desc) Sets the default Border.Description for a Frame.
void	setLabelDescription(Label.Description desc) Sets the default Label.Description.
void	setListDescription(List.Description desc) Sets the default List.Description.
void	setLoweredBevelBorderDescription(Border.Description desc) Sets the default Border.Description.
void	setPanelDescription(Panel.Description desc) Sets the default Panel.Description.
void	setProgressBarDescription(ProgressBar.Description desc) Sets the default ProgressBar.Description.
void	setProgressBarLabelFont(java.awt.Font font) Sets the default Font of this theme.
void	setProgressBarLabelFontColor(org.openmali.vecmath2.Colorf color) Sets the default font-color of this theme.
void	setRadioButtonDescription(LabeledStateButton.Description desc) Sets the default RadioButton.Description.
void	setRaisedBevelBorderDescription(Border.Description desc) Sets the default Border.Description.
void	setRoundedCornersBorderDescription(Border.Description desc) Sets the RoundedCorners Border.Description.
void	setScrollbarDescriptionHorizontal(Scrollbar.Description desc) Sets the default Scrollbar.Description for a HORIZONTAL Scrollbar.
void	setScrollbarDescriptionVertical(Scrollbar.Description desc) Sets the default Scrollbar.Description for a VERTICAL Scrollbar.
void	setSliderDescription(Slider.Description desc) Sets the default Slider.Description.
void	setTextFieldDescription(TextField.Description desc) Sets the default TextField.Description.
void	setWindowHeaderDescription(WindowHeaderWidget.Description desc) Sets the default WindowHeaderWidget.Description.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

themeProps

protected ThemeProperties themeProps

Constructor Detail

WidgetTheme

protected WidgetTheme(ThemeProperties themeProps)

WidgetTheme

public WidgetTheme(java.net.URL url)
            throws java.io.IOException

Creates the desired WidgetTheme.

Parameters:

url - a URL pointing to the theme-zip-archive

Throws:

java.io.IOException

WidgetTheme

public WidgetTheme(java.lang.String name)
            throws java.io.IOException

Creates the desired built-in WidgetTheme.

The theme is loaded from classpath as a resource from path "resources/xith3d/hud/themes/[THEME_NAME].xwt".

Parameters:

name - the name of the WidgetTheme. Default-Theme: "GTK"

Throws:

java.io.IOException

WidgetTheme

public WidgetTheme(java.io.File zipFile)
            throws java.io.IOException

Creates the desired WidgetTheme.

Parameters:

zipFile - A File representation of the zip-archive of the theme

Throws:

java.io.IOException

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in interface org.jagatoo.datatypes.NamedObject

Returns:

the name of this WidgetTheme

setFont

public void setFont(java.awt.Font font,
                    boolean disabled)

Sets the default Font of this theme.

getFont

public java.awt.Font getFont(boolean disabled)

Returns:

the default Font of this theme

setFontColor

public void setFontColor(org.openmali.vecmath2.Colorf color,
                         boolean disabled)

Sets the default font-color of this theme.

getFontColor

public org.openmali.vecmath2.Colorf getFontColor(boolean disabled)

Returns:

the default font-color of this theme

setLabelDescription

public void setLabelDescription(Label.Description desc)

Sets the default Label.Description.

getLabelDescription

public Label.Description getLabelDescription()

Returns:

the default Label.Description

getLabelDescription

public void getLabelDescription(Label.Description desc)

Parameters:

desc - the default Label.Description

getTextCaretTexture

public Texture getTextCaretTexture(java.lang.String suffix)

setTextFieldDescription

public void setTextFieldDescription(TextField.Description desc)

Sets the default TextField.Description.

getTextFieldDescription

public TextField.Description getTextFieldDescription()

Returns:

the default TextField.Description

getTextFieldDescription

public void getTextFieldDescription(TextField.Description desc)

Parameters:

desc - the default TextField.Description

setScrollbarDescriptionHorizontal

public void setScrollbarDescriptionHorizontal(Scrollbar.Description desc)

Sets the default Scrollbar.Description for a HORIZONTAL Scrollbar.

getScrollbarDescriptionHorizontal

public Scrollbar.Description getScrollbarDescriptionHorizontal()

Returns:

the default Scrollbar.Description for a HORIZONTAL Scrollbar

getScrollbarDescriptionHorizontal

public void getScrollbarDescriptionHorizontal(Scrollbar.Description desc)

Parameters:

desc - the default Scrollbar.Description for a HORIZONTAL Scrollbar

setScrollbarDescriptionVertical

public void setScrollbarDescriptionVertical(Scrollbar.Description desc)

Sets the default Scrollbar.Description for a VERTICAL Scrollbar.

getScrollbarDescriptionVertical

public Scrollbar.Description getScrollbarDescriptionVertical()

Returns:

the default Scrollbar.Description for a VERTICAL Scrollbar

getScrollbarDescriptionVertical

public void getScrollbarDescriptionVertical(Scrollbar.Description desc)

Parameters:

desc - the default Scrollbar.Description for a VERTICAL Scrollbar

getScrollPanelSpaceTexture

public Texture getScrollPanelSpaceTexture()

Returns:

the texture to use for the space in the lower-right corner of a ScrollPane

setSliderDescription

public void setSliderDescription(Slider.Description desc)

Sets the default Slider.Description.

getSliderDescription

public Slider.Description getSliderDescription()

Returns:

the default Slider.Description

getSliderDescription

public void getSliderDescription(Slider.Description desc)

Parameters:

desc - the default Slider.Description

setButtonDescription

public void setButtonDescription(Button.Description desc)

Sets the default Button.Description.

getButtonDescription

public Button.Description getButtonDescription()

Returns:

the default Button.Description

getButtonDescription

public void getButtonDescription(Button.Description desc)

Parameters:

desc - the default Button.Description

setRadioButtonDescription

public void setRadioButtonDescription(LabeledStateButton.Description desc)

Sets the default RadioButton.Description.

getRadioButtonDescription

public LabeledStateButton.Description getRadioButtonDescription()

Returns:

the default RadioButton.Description

getRadioButtonDescription

public void getRadioButtonDescription(LabeledStateButton.Description desc)

Parameters:

desc - the default RadioButton.Description

setCheckBoxDescription

public void setCheckBoxDescription(LabeledStateButton.Description desc)

Sets the default CheckBox.Description.

getCheckBoxDescription

public LabeledStateButton.Description getCheckBoxDescription()

Returns:

the default CheckBox.Description

getCheckBoxDescription

public void getCheckBoxDescription(LabeledStateButton.Description desc)

Parameters:

desc - the default CheckBox.Description

setRoundedCornersBorderDescription

public void setRoundedCornersBorderDescription(Border.Description desc)

Sets the RoundedCorners Border.Description.

getRoundedCornersBorderDescription

public Border.Description getRoundedCornersBorderDescription()

Returns:

the RoundedCorners Border.Description

getRoundedCornersBorderDescription

public void getRoundedCornersBorderDescription(Border.Description desc)

Parameters:

desc - the RoundedCorners Border.Description

getStandardBorderDescription

public Border.Description getStandardBorderDescription()

Returns:

the standard Border.Description By default this is "rounded courners".

getStandardBorderDescription

public void getStandardBorderDescription(Border.Description desc)

Parameters:

desc - the standard Border.Description By default this is "rounded courners".

setLoweredBevelBorderDescription

public void setLoweredBevelBorderDescription(Border.Description desc)

Sets the default Border.Description.

getLoweredBevelBorderDescription

public Border.Description getLoweredBevelBorderDescription()

Returns:

the default Border.Description

getLoweredBevelBorderDescription

public void getLoweredBevelBorderDescription(Border.Description desc)

Parameters:

desc - the default Border.Description

setRaisedBevelBorderDescription

public void setRaisedBevelBorderDescription(Border.Description desc)

Sets the default Border.Description.

getRaisedBevelBorderDescription

public Border.Description getRaisedBevelBorderDescription()

Returns:

the default Border.Description

getRaisedBevelBorderDescription

public void getRaisedBevelBorderDescription(Border.Description desc)

Parameters:

desc - the default Border.Description

setWindowHeaderDescription

public void setWindowHeaderDescription(WindowHeaderWidget.Description desc)

Sets the default WindowHeaderWidget.Description.

getWindowHeaderDescription

public WindowHeaderWidget.Description getWindowHeaderDescription()

Returns:

the default WindowHeaderWidget.Description

getWindowHeaderDescription

public void getWindowHeaderDescription(WindowHeaderWidget.Description desc)

Parameters:

desc - the default WindowHeaderWidget.Description

setFrameBorderDescription

public void setFrameBorderDescription(Border.Description desc)

Sets the default Border.Description for a Frame.

getFrameBorderDescription

public Border.Description getFrameBorderDescription()

Returns:

the default Border.Description for a Frame

getFrameBorderDescription

public void getFrameBorderDescription(Border.Description desc)

Parameters:

desc - the default Border.Description for a Frame

setProgressBarLabelFont

public void setProgressBarLabelFont(java.awt.Font font)

Sets the default Font of this theme.

getProgressBarLabelFont

public java.awt.Font getProgressBarLabelFont()

Returns:

the default Font of this theme

setProgressBarLabelFontColor

public void setProgressBarLabelFontColor(org.openmali.vecmath2.Colorf color)

Sets the default font-color of this theme.

getProgressBarLabelFontColor

public org.openmali.vecmath2.Colorf getProgressBarLabelFontColor()

Returns:

the default font-color of this theme

setListDescription

public void setListDescription(List.Description desc)

Sets the default List.Description.

getListDescription

public List.Description getListDescription()

Returns:

the default List.Description

getListDescription

public void getListDescription(List.Description desc)

Parameters:

desc - the default List.Description

setComboBoxDescription

public void setComboBoxDescription(ComboBox.Description desc)

Sets the default ComboBox.Description.

getComboBoxDescription

public ComboBox.Description getComboBoxDescription()

Returns:

the default ComboBox.Description

getComboBoxDescription

public void getComboBoxDescription(ComboBox.Description desc)

Parameters:

desc - the default ComboBox.Description

setProgressBarDescription

public void setProgressBarDescription(ProgressBar.Description desc)

Sets the default ProgressBar.Description.

getProgressBarDescription

public ProgressBar.Description getProgressBarDescription()

Returns:

the default ProgressBar.Description

getProgressBarDescription

public void getProgressBarDescription(ProgressBar.Description desc)

Parameters:

desc - the default ProgressBar.Description

setPanelDescription

public void setPanelDescription(Panel.Description desc)

Sets the default Panel.Description.

getPanelDescription

public Panel.Description getPanelDescription()

Returns:

the default Panel.Description

getPanelDescription

public void getPanelDescription(Panel.Description desc)

Parameters:

desc - the default Panel.Description

getCursorSet

public CursorSet getCursorSet()

Returns:

the default CursorSet.

getCursorSet

public void getCursorSet(CursorSet cs)

Parameters:

cs - the default CursorSet

loadThemeProps

protected static ThemeProperties loadThemeProps(java.io.InputStream in)
                                         throws java.io.IOException

Throws:

java.io.IOException