List element renderer showing a pre-define name for enumeration values. More...
Public Member Functions | |
| void | forEachName (Block ablock) |
| Visit name mappings with block. More... | |
| TranslationManager | getTranslationManager () |
| Translation manager to use or null. More... | |
| String | getTranslationPrefix () |
| Translation prefix to use or null. More... | |
| String | nameFor (Enumeration value) |
| Name for enumeration value or null if not set. More... | |
| EnumListElementRenderer | new () |
| Create list element renderer. More... | |
| void | removeAllNames () |
| Remove all enumeration value names. More... | |
| void | removeNameFor (Enumeration value) |
| Remove name for enumeration value if present. More... | |
| void | setNameFor (Enumeration value, String name) |
| Set name for enumeration value. More... | |
| void | setTranslationManager (TranslationManager manager) |
| Set translation manager to use or null. More... | |
| void | setTranslationPrefix (String prefix) |
| Set translation prefix to use or null. More... | |
| void | updateRenderer (ListBox listBox, Widget renderer, Object element, bool selected, bool focused) |
| Update renderer value. More... | |
 Public Member Functions inherited from Dragengine.Gui.DefaultListElementRenderer | |
| Widget | createRenderer (ListBox listBox) |
| Create renderer. More... | |
| Point | getDefaultMinimumSize () |
| Minimum size to use unless default element is larger. More... | |
| Object | getDefaultObject () |
| Object used to measure default size with. More... | |
| Point | getDefaultSize (ListBox listBox) |
| Default size of list element. More... | |
| String | getDesignerSelector () |
| Dsigner selector. More... | |
| DefaultListElementRenderer | new (Object defaultObject) |
| Create default list element renderer. More... | |
| void | setDefaultMinimumSize (Point size) |
| Set minimum size to use unless default element is larger. More... | |
| void | setDefaultObject (Object object) |
| Object used to measure default size with. More... | |
| void | setDesignerSelector (String selector) |
| Set designer selector. More... | |
Public Attributes | |
| Dictionary | pMap |
| TranslationManager | pTranslationManager |
| String | pTranslationPrefix |
Detailed Description
List element renderer showing a pre-define name for enumeration values.
- Version
- 1.9
Simple way to display a ListModel of Enumeration values with nice looking names. If an enumeration constant has no name assigned the value name without the class name is displayed.
- Version 1.20
Optionally a Translation prefix can be set. If not null this is used to construct a translation entry name using the following format: "{TranslationPrefix}{enumValue.name()}" Hence the enumeration constant name is appended to the translation prefix and looked up in the translation manager.
The following order is used to determine the name to display (first found name is used):
- Mapped name set with setNameFor()
- Translation if setTranslationPrefix() is not empty and entry is found
- Name of enumeration constant
Member Function Documentation
◆ forEachName()
| void Dragengine.Gui.EnumListElementRenderer.forEachName | ( | Block | ablock | ) |
Visit name mappings with block.
Block receives as first argument Enumeration value and as second argument String name.
◆ getTranslationManager()
| TranslationManager Dragengine.Gui.EnumListElementRenderer.getTranslationManager | ( | ) |
Translation manager to use or null.
- Version
- 1.20
Used if getTranslationPrefix() is not null. If translation manager is null TranslationManager.get() is used.
◆ getTranslationPrefix()
| String Dragengine.Gui.EnumListElementRenderer.getTranslationPrefix | ( | ) |
Translation prefix to use or null.
- Version
- 1.20
If not null the translation is looked up using the name "{prefix}{enumValue.name()}.
◆ nameFor()
| String Dragengine.Gui.EnumListElementRenderer.nameFor | ( | Enumeration | value | ) |
Name for enumeration value or null if not set.
◆ new()
| EnumListElementRenderer Dragengine.Gui.EnumListElementRenderer.new | ( | ) |
Create list element renderer.
Reimplemented from Dragengine.Gui.DefaultListElementRenderer.
◆ removeAllNames()
| void Dragengine.Gui.EnumListElementRenderer.removeAllNames | ( | ) |
Remove all enumeration value names.
◆ removeNameFor()
| void Dragengine.Gui.EnumListElementRenderer.removeNameFor | ( | Enumeration | value | ) |
Remove name for enumeration value if present.
◆ setNameFor()
| void Dragengine.Gui.EnumListElementRenderer.setNameFor | ( | Enumeration | value, |
| String | name | ||
| ) |
Set name for enumeration value.
◆ setTranslationManager()
| void Dragengine.Gui.EnumListElementRenderer.setTranslationManager | ( | TranslationManager | manager | ) |
Set translation manager to use or null.
- Version
- 1.20
Used if getTranslationPrefix() is not null. If translation manager is null TranslationManager.get() is used.
◆ setTranslationPrefix()
| void Dragengine.Gui.EnumListElementRenderer.setTranslationPrefix | ( | String | prefix | ) |
Set translation prefix to use or null.
- Version
- 1.20
If not null the translation is looked up using the name "{prefix}{enumValue.name()}.
◆ updateRenderer()
| void Dragengine.Gui.EnumListElementRenderer.updateRenderer | ( | ListBox | listBox, |
| Widget | renderer, | ||
| Object | element, | ||
| bool | selected, | ||
| bool | focused | ||
| ) |
Update renderer value.
Reimplemented from Dragengine.Gui.DefaultListElementRenderer.
Member Data Documentation
◆ pMap
| Dictionary Dragengine.Gui.EnumListElementRenderer.pMap |
◆ pTranslationManager
| TranslationManager Dragengine.Gui.EnumListElementRenderer.pTranslationManager |
◆ pTranslationPrefix
| String Dragengine.Gui.EnumListElementRenderer.pTranslationPrefix |
The documentation for this class was generated from the following file:
