Drag[en]gine Script Module DragonScript  1.23
Dragengine.Gui.Designers.DefaultLabelDesigner.LabelStateDesign Class Reference

Design for a particular widget state. More...

Inheritance diagram for Dragengine.Gui.Designers.DefaultLabelDesigner.LabelStateDesign:
Dragengine.Gui.Designers.DefaultWidgetDesigner.StateDesign

Public Member Functions

void apply (Widget widget)
 Apply state design to widget. More...
 
DefaultWidgetDesigner.StateDesign copyDesign ()
 Create copy of state. More...
 
Integer getAlignment ()
 Align.or null. More...
 
void merge (DefaultWidgetDesigner.StateDesign state)
 Merge states. More...
 
LabelStateDesign new ()
 Create state design. More...
 
LabelStateDesign new (LabelStateDesign stateDesign)
 Create copy of state design. More...
 
void setAlignment (Integer alignment)
 Set alignment or null. More...
 
void setAlignmentFromString (String string)
 Set alignment from string or null. More...
 
void setParameter (String name, Object value)
 Set parameter. More...
 
- Public Member Functions inherited from Dragengine.Gui.Designers.DefaultWidgetDesigner.StateDesign
BorderFactory getBorderFactory ()
 Border factory or null. More...
 
CanvasCreator getCanvasCreator ()
 Canvas creator or null. More...
 
Font getFont ()
 Font or null. More...
 
Point getMinimumSize ()
 Minimum widget size or null. More...
 
MousePointerFactory getMousePointerFactory ()
 Mouse pointer factory or null. More...
 
BorderSize getPadding ()
 Padding or null. More...
 
Color getTextColor ()
 Text color or null. More...
 
void merge (StateDesign state)
 Merge states. More...
 
StateDesign new (StateDesign stateDesign)
 Create copy of state design. More...
 
void setBorderFactory (BorderFactory borderFactory)
 Set border factory or null. More...
 
void setCanvasCreator (CanvasCreator creator)
 Set canvas creator or null. More...
 
void setFont (Font font)
 Set font or null. More...
 
void setMinimumSize (Point size)
 Set minimum widget size or null. More...
 
void setMousePointerFactory (MousePointerFactory factory)
 Mouse pointer factory or null. More...
 
void setPadding (BorderSize padding)
 Set padding or null. More...
 
void setTextColor (Color color)
 Set text color or null. More...
 

Detailed Description

Design for a particular widget state.

Member Function Documentation

◆ apply()

void Dragengine.Gui.Designers.DefaultLabelDesigner.LabelStateDesign.apply ( Widget  widget)

Apply state design to widget.

This is typically called on a merged design to find the first defined parameters.

Reimplemented from Dragengine.Gui.Designers.DefaultWidgetDesigner.StateDesign.

◆ copyDesign()

DefaultWidgetDesigner.StateDesign Dragengine.Gui.Designers.DefaultLabelDesigner.LabelStateDesign.copyDesign ( )

Create copy of state.

Reimplemented from Dragengine.Gui.Designers.DefaultWidgetDesigner.StateDesign.

◆ getAlignment()

Integer Dragengine.Gui.Designers.DefaultLabelDesigner.LabelStateDesign.getAlignment ( )

Align.or null.

◆ merge()

void Dragengine.Gui.Designers.DefaultLabelDesigner.LabelStateDesign.merge ( DefaultWidgetDesigner.StateDesign  state)

Merge states.

Updates state with parameters of this state if defined. Used to find the first defined parameter for a series of states acting as fallback for each other.

◆ new() [1/2]

LabelStateDesign Dragengine.Gui.Designers.DefaultLabelDesigner.LabelStateDesign.new ( )

Create state design.

Reimplemented from Dragengine.Gui.Designers.DefaultWidgetDesigner.StateDesign.

◆ new() [2/2]

LabelStateDesign Dragengine.Gui.Designers.DefaultLabelDesigner.LabelStateDesign.new ( LabelStateDesign  stateDesign)

Create copy of state design.

◆ setAlignment()

void Dragengine.Gui.Designers.DefaultLabelDesigner.LabelStateDesign.setAlignment ( Integer  alignment)

Set alignment or null.

◆ setAlignmentFromString()

void Dragengine.Gui.Designers.DefaultLabelDesigner.LabelStateDesign.setAlignmentFromString ( String  string)

Set alignment from string or null.

The input from the guitheme definition is a string composing of a comma separated list of identifiers. Allowed are up to two identifiers one from the vertical alignment group and one from the horizontal alignment group. These are the supported identifiers of the horizontal alignment group: "left", "center" and "right". These are the supported identifiers of the vertical alignment group: "top", "middle" and "bottom".

◆ setParameter()

void Dragengine.Gui.Designers.DefaultLabelDesigner.LabelStateDesign.setParameter ( String  name,
Object  value 
)

Set parameter.

Note about alignment parameter. The input from the guitheme definition is a string composing of a comma separated list of identifiers. Allowed are up to two identifiers one from the vertical alignment group and one from the horizontal alignment group. These are the supported identifiers of the horizontal alignment group: "left", "center" and *right". These are the supported identifiers of the vertical alignment group: "top", "middle" and "bottom".

Supported parameters: | name | value | Setter | | canvas | CanvasCreator | setCanvasCreator | | border | BorderFactory | setBorderFactory | | font | Font | setFont | | textColor | Color | setTextColor | | padding | BorderSize | setPadding | | alignment | String | setAlignmentFromString |

Reimplemented from Dragengine.Gui.Designers.DefaultWidgetDesigner.StateDesign.


The documentation for this class was generated from the following file: