Theme (Bonzai Engine bonzaiengine.com Copyright © 2007-2019 Jérôme Jouvie)

java.lang.Object
- com.bonzaiengine.ui.Theme

public class Theme
extends java.lang.Object

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`fontDefault`
`static java.lang.String`	`spriteWhite`
`static java.lang.String`	`styleButton`
`static java.lang.String`	`styleButtonDown`
`static java.lang.String`	`styleButtonLeft`
`static java.lang.String`	`styleButtonPin`
`static java.lang.String`	`styleButtonRight`
`static java.lang.String`	`styleButtonUp`
`static java.lang.String`	`styleCheckButtonCheck`
`static java.lang.String`	`styleCheckButtonRadio`
`static java.lang.String`	`styleComboBox`
`static java.lang.String`	`styleLabel`
`static java.lang.String`	`styleLabelList`
`static java.lang.String`	`styleLabelListPreSelected`
`static java.lang.String`	`styleLabelListSelected`
`static java.lang.String`	`styleLabelTree`
`static java.lang.String`	`styleLabelTreeSelected`
`static java.lang.String`	`styleLabelWithBorder`
`static java.lang.String`	`styleLabelWithButton`
`static java.lang.String`	`styleList`
`static java.lang.String`	`styleMenuBack`
`static java.lang.String`	`styleMenuBackOff`
`static java.lang.String`	`styleMenuCheckButton`
`static java.lang.String`	`styleMenuNoSubmenu`
`static java.lang.String`	`styleMenuRadioButton`
`static java.lang.String`	`styleMenuSeparator`
`static java.lang.String`	`styleMenuSubmenu`
`static java.lang.String`	`styleMenuText`
`static java.lang.String`	`stylePanelWithBackground`
`static java.lang.String`	`stylePanelWithBorder`
`static java.lang.String`	`styleScrollBarH`
`static java.lang.String`	`styleScrollBarV`
`static java.lang.String`	`styleSliderHorizontal`
`static java.lang.String`	`styleSliderVertical`
`static java.lang.String`	`styleTabPaneContents`
`static java.lang.String`	`styleTabPaneTabs`
`static java.lang.String`	`styleTabPaneTitle`
`static java.lang.String`	`styleTabPaneTitleSelected`
`static java.lang.String`	`styleTextArea`
`static java.lang.String`	`styleTextField`
`static java.lang.String`	`styleTree`
`static java.lang.String`	`styleTreeFile`
`static java.lang.String`	`styleTreeFolderClose`
`static java.lang.String`	`styleTreeFolderOpen`
`static java.lang.String`	`styleTreeNode`
`static java.lang.String`	`styleTreeNodeSelected`

Constructor Summary

Constructors
Constructor and Description

Theme()

Constructors
Constructor and Description
`Theme()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(Theme src)` Add all font, sprites and styles from the src `Theme` to this `Theme`
`void`	`addFont(java.lang.String fontName, IFont font)` Add a `IFont` to this `Theme`
`void`	`addSprite(java.lang.String name, Sprite sprite)` Add a `Sprite` to this `Theme`
`void`	`addStyle(Style style)` Add a {Style Style} to this `Theme`
`IFont`	`getFont(java.lang.String fontName)`
`int`	`getFontChangeId()` Internal use
`IFont`	`getFontIfLoaded(java.lang.String fontName)`
`java.lang.Iterable<IFont>`	`getFonts()`
`Sprite`	`getSprite(java.lang.String name)`
`int`	`getSpriteChangeId()` Internal use
`java.lang.String`	`getSpriteName(Sprite sprite)`
`java.lang.Iterable<Sprite>`	`getSprites()`
`Style`	`getStyle(java.lang.String name)`
`int`	`getStyleChangeId()` Internal use
`java.lang.Iterable<Style>`	`getStyles()`
`boolean`	`isUseSdFont()`
`void`	`setUseSdFont(boolean useSdFont)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - fontDefault
```
public static final java.lang.String fontDefault
```
    See Also:
    
    Constant Field Values
  - spriteWhite
```
public static final java.lang.String spriteWhite
```
    See Also:
    
    Constant Field Values
  - styleButton
```
public static final java.lang.String styleButton
```
    See Also:
    
    Constant Field Values
  - styleButtonDown
```
public static final java.lang.String styleButtonDown
```
    See Also:
    
    Constant Field Values
  - styleButtonLeft
```
public static final java.lang.String styleButtonLeft
```
    See Also:
    
    Constant Field Values
  - styleButtonRight
```
public static final java.lang.String styleButtonRight
```
    See Also:
    
    Constant Field Values
  - styleButtonUp
```
public static final java.lang.String styleButtonUp
```
    See Also:
    
    Constant Field Values
  - styleButtonPin
```
public static final java.lang.String styleButtonPin
```
    See Also:
    
    Constant Field Values
  - styleCheckButtonCheck
```
public static final java.lang.String styleCheckButtonCheck
```
    See Also:
    
    Constant Field Values
  - styleCheckButtonRadio
```
public static final java.lang.String styleCheckButtonRadio
```
    See Also:
    
    Constant Field Values
  - styleComboBox
```
public static final java.lang.String styleComboBox
```
    See Also:
    
    Constant Field Values
  - styleLabel
```
public static final java.lang.String styleLabel
```
    See Also:
    
    Constant Field Values
  - styleLabelWithBorder
```
public static final java.lang.String styleLabelWithBorder
```
    See Also:
    
    Constant Field Values
  - styleLabelWithButton
```
public static final java.lang.String styleLabelWithButton
```
    See Also:
    
    Constant Field Values
  - stylePanelWithBorder
```
public static final java.lang.String stylePanelWithBorder
```
    See Also:
    
    Constant Field Values
  - stylePanelWithBackground
```
public static final java.lang.String stylePanelWithBackground
```
    See Also:
    
    Constant Field Values
  - styleList
```
public static final java.lang.String styleList
```
    See Also:
    
    Constant Field Values
  - styleLabelList
```
public static final java.lang.String styleLabelList
```
    See Also:
    
    Constant Field Values
  - styleLabelListPreSelected
```
public static final java.lang.String styleLabelListPreSelected
```
    See Also:
    
    Constant Field Values
  - styleLabelListSelected
```
public static final java.lang.String styleLabelListSelected
```
    See Also:
    
    Constant Field Values
  - styleScrollBarH
```
public static final java.lang.String styleScrollBarH
```
    See Also:
    
    Constant Field Values
  - styleScrollBarV
```
public static final java.lang.String styleScrollBarV
```
    See Also:
    
    Constant Field Values
  - styleSliderHorizontal
```
public static final java.lang.String styleSliderHorizontal
```
    See Also:
    
    Constant Field Values
  - styleSliderVertical
```
public static final java.lang.String styleSliderVertical
```
    See Also:
    
    Constant Field Values
  - styleTabPaneTabs
```
public static final java.lang.String styleTabPaneTabs
```
    See Also:
    
    Constant Field Values
  - styleTabPaneContents
```
public static final java.lang.String styleTabPaneContents
```
    See Also:
    
    Constant Field Values
  - styleTabPaneTitle
```
public static final java.lang.String styleTabPaneTitle
```
    See Also:
    
    Constant Field Values
  - styleTabPaneTitleSelected
```
public static final java.lang.String styleTabPaneTitleSelected
```
    See Also:
    
    Constant Field Values
  - styleTextField
```
public static final java.lang.String styleTextField
```
    See Also:
    
    Constant Field Values
  - styleTextArea
```
public static final java.lang.String styleTextArea
```
    See Also:
    
    Constant Field Values
  - styleMenuBack
```
public static final java.lang.String styleMenuBack
```
    See Also:
    
    Constant Field Values
  - styleMenuBackOff
```
public static final java.lang.String styleMenuBackOff
```
    See Also:
    
    Constant Field Values
  - styleMenuText
```
public static final java.lang.String styleMenuText
```
    See Also:
    
    Constant Field Values
  - styleMenuSubmenu
```
public static final java.lang.String styleMenuSubmenu
```
    See Also:
    
    Constant Field Values
  - styleMenuNoSubmenu
```
public static final java.lang.String styleMenuNoSubmenu
```
    See Also:
    
    Constant Field Values
  - styleMenuSeparator
```
public static final java.lang.String styleMenuSeparator
```
    See Also:
    
    Constant Field Values
  - styleMenuCheckButton
```
public static final java.lang.String styleMenuCheckButton
```
    See Also:
    
    Constant Field Values
  - styleMenuRadioButton
```
public static final java.lang.String styleMenuRadioButton
```
    See Also:
    
    Constant Field Values
  - styleTree
```
public static final java.lang.String styleTree
```
    See Also:
    
    Constant Field Values
  - styleLabelTree
```
public static final java.lang.String styleLabelTree
```
    See Also:
    
    Constant Field Values
  - styleLabelTreeSelected
```
public static final java.lang.String styleLabelTreeSelected
```
    See Also:
    
    Constant Field Values
  - styleTreeFile
```
public static final java.lang.String styleTreeFile
```
    See Also:
    
    Constant Field Values
  - styleTreeFolderOpen
```
public static final java.lang.String styleTreeFolderOpen
```
    See Also:
    
    Constant Field Values
  - styleTreeFolderClose
```
public static final java.lang.String styleTreeFolderClose
```
    See Also:
    
    Constant Field Values
  - styleTreeNode
```
public static final java.lang.String styleTreeNode
```
    See Also:
    
    Constant Field Values
  - styleTreeNodeSelected
```
public static final java.lang.String styleTreeNodeSelected
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Theme
```
public Theme()
```
- Method Detail
  - setUseSdFont
```
public void setUseSdFont(boolean useSdFont)
```
    Parameters:
    
    useSdFont - use SdFont by default if supported. Default value: true
    Highest SDFont quality rendering is available with the extension GLApiExt.shaderDerivative is supported, otherwise a faster but still good quality rendering will be used.
    To rely only on SD font when highest rendering quality is available, and fall back to standard font, use: ui.getTheme().setUseSdFont(gl.isSupported(GLApiExt.shaderGlslDerivatives));
    
    See Also:
    
    GLApiExt.shaderDerivative, IGL.isSupported(GLApiExt)
  - isUseSdFont
```
public final boolean isUseSdFont()
```
    Returns:
    
    true of SdFont are used by default
  - add
```
public final void add(Theme src)
```
    Add all font, sprites and styles from the src Theme to this Theme
    
    Parameters:
    
    src - source Theme
  - addFont
```
public final void addFont(java.lang.String fontName,
                          IFont font)
```
    Add a IFont to this Theme
    
    Parameters:
    
    fontName - identifier of the font
    
    font - font to add, or null to remove
  - getFont
```
public final IFont getFont(java.lang.String fontName)
```
    Parameters:
    
    fontName - of the IFont to get
    
    Returns:
    
    the IFont reference by the name specified
  - getFontIfLoaded
```
public final IFont getFontIfLoaded(java.lang.String fontName)
```
    Parameters:
    
    fontName - of the IFont to get
    
    Returns:
    
    the IFont reference by the name specified
  - getFonts
```
public final java.lang.Iterable<IFont> getFonts()
```
    Returns:
    
    the list of IFont
  - addSprite
```
public final void addSprite(java.lang.String name,
                            Sprite sprite)
```
    Add a Sprite to this Theme
    
    Parameters:
    
    name - identifier of the font
    
    sprite - sprite to add
  - getSprite
```
public final Sprite getSprite(java.lang.String name)
```
    Parameters:
    
    name - of the Sprite to get
    
    Returns:
    
    the Sprite reference by the name specified
  - getSpriteName
```
public final java.lang.String getSpriteName(Sprite sprite)
```
  - getSprites
```
public final java.lang.Iterable<Sprite> getSprites()
```
    Returns:
    
    the list of Sprite
  - addStyle
```
public final void addStyle(Style style)
```
    Add a {Style Style} to this Theme
    
    Parameters:
    
    style - style to add, the identifier of the Style is its name
  - getStyle
```
public final Style getStyle(java.lang.String name)
```
    Parameters:
    
    name - of the Style to get
    
    Returns:
    
    the Style reference by the name specified
  - getStyles
```
public final java.lang.Iterable<Style> getStyles()
```
    Returns:
    
    the list of Style
  - getSpriteChangeId
```
public final int getSpriteChangeId()
```
    Internal use
  - getFontChangeId
```
public final int getFontChangeId()
```
    Internal use
  - getStyleChangeId
```
public final int getStyleChangeId()
```
    Internal use

Class Theme

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

fontDefault

spriteWhite

styleButton

styleButtonDown

styleButtonLeft

styleButtonRight

styleButtonUp

styleButtonPin

styleCheckButtonCheck

styleCheckButtonRadio

styleComboBox

styleLabel

styleLabelWithBorder

styleLabelWithButton

stylePanelWithBorder

stylePanelWithBackground

styleList

styleLabelList

styleLabelListPreSelected

styleLabelListSelected

styleScrollBarH

styleScrollBarV

styleSliderHorizontal

styleSliderVertical

styleTabPaneTabs

styleTabPaneContents

styleTabPaneTitle

styleTabPaneTitleSelected

styleTextField

styleTextArea

styleMenuBack

styleMenuBackOff

styleMenuText

styleMenuSubmenu

styleMenuNoSubmenu

styleMenuSeparator

styleMenuCheckButton

styleMenuRadioButton

styleTree

styleLabelTree

styleLabelTreeSelected

styleTreeFile

styleTreeFolderOpen

styleTreeFolderClose

styleTreeNode

styleTreeNodeSelected

Constructor Detail

Theme

Method Detail

setUseSdFont

isUseSdFont

add

addFont

getFont

getFontIfLoaded

getFonts

addSprite

getSprite

getSpriteName

getSprites

addStyle

getStyle

getStyles

getSpriteChangeId

getFontChangeId

getStyleChangeId