[ view source ]

class Theme

package elements

extends Model › Entity

@:directlyUsed@:build(tracker.macros.EventsMacro.build())@:autoBuild(tracker.macros.EventsMacro.build())@:build(ceramic.macros.EntityMacro.buildForCompletion())@:autoBuild(ceramic.macros.EntityMacro.buildForCompletion())@:build(tracker.macros.ObservableMacro.build())@:autoBuild(tracker.macros.ObservableMacro.build())@:build(tracker.macros.SerializableMacro.build())@:autoBuild(tracker.macros.SerializableMacro.build())

Available with elements plugin

Events

@:dox(show)backgroundInFormLayoutChange(current:Bool, previous:Bool):Void

Event when backgroundInFormLayout field changes.

@:dox(show)fieldTextColorChange(current:Color, previous:Color):Void

Event when fieldTextColor field changes.

@:dox(show)fieldPlaceholderColorChange(current:Color, previous:Color):Void

Event when fieldPlaceholderColor field changes.

@:dox(show)lightTextColorChange(current:Color, previous:Color):Void

Event when lightTextColor field changes.

@:dox(show)mediumTextColorChange(current:Color, previous:Color):Void

Event when mediumTextColor field changes.

@:dox(show)darkTextColorChange(current:Color, previous:Color):Void

Event when darkTextColor field changes.

@:dox(show)darkerTextColorChange(current:Color, previous:Color):Void

Event when darkerTextColor field changes.

@:dox(show)iconColorChange(current:Color, previous:Color):Void

Event when iconColor field changes.

@:dox(show)customMediumFontChange(current:BitmapFont, previous:BitmapFont):Void

Event when customMediumFont field changes.

@:dox(show)lighterBorderColorChange(current:Color, previous:Color):Void

Event when lighterBorderColor field changes.

@:dox(show)lightBorderColorChange(current:Color, previous:Color):Void

Event when lightBorderColor field changes.

@:dox(show)mediumBorderColorChange(current:Color, previous:Color):Void

Event when mediumBorderColor field changes.

@:dox(show)darkBorderColorChange(current:Color, previous:Color):Void

Event when darkBorderColor field changes.

@:dox(show)lightBackgroundColorChange(current:Color, previous:Color):Void

Event when lightBackgroundColor field changes.

@:dox(show)mediumBackgroundColorChange(current:Color, previous:Color):Void

Event when mediumBackgroundColor field changes.

@:dox(show)darkBackgroundColorChange(current:Color, previous:Color):Void

Event when darkBackgroundColor field changes.

@:dox(show)darkerBackgroundColorChange(current:Color, previous:Color):Void

Event when darkerBackgroundColor field changes.

@:dox(show)selectionBorderColorChange(current:Color, previous:Color):Void

Event when selectionBorderColor field changes.

@:dox(show)highlightColorChange(current:Color, previous:Color):Void

Event when highlightColor field changes.

@:dox(show)highlightPendingColorChange(current:Color, previous:Color):Void

Event when highlightPendingColor field changes.

@:dox(show)formItemSpacingChange(current:Float, previous:Float):Void

Event when formItemSpacing field changes.

@:dox(show)formPaddingChange(current:Float, previous:Float):Void

Event when formPadding field changes.

@:dox(show)focusedFieldSelectionColorChange(current:Color, previous:Color):Void

Event when focusedFieldSelectionColor field changes.

@:dox(show)focusedFieldBorderColorChange(current:Color, previous:Color):Void

Event when focusedFieldBorderColor field changes.

@:dox(show)overlayBackgroundColorChange(current:Color, previous:Color):Void

Event when overlayBackgroundColor field changes.

@:dox(show)overlayBackgroundAlphaChange(current:Float, previous:Float):Void

Event when overlayBackgroundAlpha field changes.

@:dox(show)overlayBorderColorChange(current:Color, previous:Color):Void

Event when overlayBorderColor field changes.

@:dox(show)overlayBorderAlphaChange(current:Float, previous:Float):Void

Event when overlayBorderAlpha field changes.

@:dox(show)buttonBackgroundColorChange(current:Color, previous:Color):Void

Event when buttonBackgroundColor field changes.

@:dox(show)buttonOverBackgroundColorChange(current:Color, previous:Color):Void

Event when buttonOverBackgroundColor field changes.

@:dox(show)buttonPressedBackgroundColorChange(current:Color, previous:Color):Void

Event when buttonPressedBackgroundColor field changes.

@:dox(show)buttonFocusedBorderColorChange(current:Color, previous:Color):Void

Event when buttonFocusedBorderColor field changes.

@:dox(show)tabsBackgroundColorChange(current:Color, previous:Color):Void

Event when tabsBackgroundColor field changes.

@:dox(show)tabsBackgroundAlphaChange(current:Float, previous:Float):Void

Event when tabsBackgroundAlpha field changes.

@:dox(show)tabsHoverBackgroundColorChange(current:Color, previous:Color):Void

Event when tabsHoverBackgroundColor field changes.

@:dox(show)tabsHoverBackgroundAlphaChange(current:Float, previous:Float):Void

Event when tabsHoverBackgroundAlpha field changes.

@:dox(show)tabsBorderColorChange(current:Color, previous:Color):Void

Event when tabsBorderColor field changes.

@:dox(show)windowBackgroundColorChange(current:Color, previous:Color):Void

Event when windowBackgroundColor field changes.

@:dox(show)windowBackgroundAlphaChange(current:Float, previous:Float):Void

Event when windowBackgroundAlpha field changes.

@:dox(show)windowBorderColorChange(current:Color, previous:Color):Void

Event when windowBorderColor field changes.

@:dox(show)windowBorderAlphaChange(current:Float, previous:Float):Void

Event when windowBorderAlpha field changes.

Constructor

new()

Variables

@:value(false)@serializebackgroundInFormLayout:Bool = false

@:value(0xFFFFFF)@serializefieldTextColor:Color = 0xFFFFFF

@:value(0x888888)@serializefieldPlaceholderColor:Color = 0x888888

@:value(0xF3F3F3)@serializelightTextColor:Color = 0xF3F3F3

@:value(0xCCCCCC)@serializemediumTextColor:Color = 0xCCCCCC

@:value(0x888888)@serializedarkTextColor:Color = 0x888888

@:value(0x555555)@serializedarkerTextColor:Color = 0x555555

@:value(0xFFFFFF)@serializeiconColor:Color = 0xFFFFFF

@:value(null)@serializecustomMediumFont:BitmapFont = null

read onlymediumFont:BitmapFont

@:value(0x999999)@serializelighterBorderColor:Color = 0x999999

@:value(0x636363)@serializelightBorderColor:Color = 0x636363

@:value(0x464646)@serializemediumBorderColor:Color = 0x464646

@:value(0x383838)@serializedarkBorderColor:Color = 0x383838

@:value(0x4F4F4F)@serializelightBackgroundColor:Color = 0x4F4F4F

@:value(0x4A4A4A)@serializemediumBackgroundColor:Color = 0x4A4A4A

@:value(0x424242)@serializedarkBackgroundColor:Color = 0x424242

@:value(0x282828)@serializedarkerBackgroundColor:Color = 0x282828

@:value(0x4392E0)@serializeselectionBorderColor:Color = 0x4392E0

@:value(0x4392E0)@serializehighlightColor:Color = 0x4392E0

@:value(0xFE5134)@serializehighlightPendingColor:Color = 0xFE5134

@:value(6)@serializeformItemSpacing:Float = 6

@:value(6)@serializeformPadding:Float = 6

@:value(0x3073C6)@serializefocusedFieldSelectionColor:Color = 0x3073C6

@:value(0x4392E0)@serializefocusedFieldBorderColor:Color = 0x4392E0

@:value(0x1C1C1C)@serializeoverlayBackgroundColor:Color = 0x1C1C1C

@:value(0.925)@serializeoverlayBackgroundAlpha:Float = 0.925

@:value(0x636363)@serializeoverlayBorderColor:Color = 0x636363

@:value(1)@serializeoverlayBorderAlpha:Float = 1

@:value(0x515151)@serializebuttonBackgroundColor:Color = 0x515151

@:value(0x5A5A5A)@serializebuttonOverBackgroundColor:Color = 0x5A5A5A

@:value(0x4798EB)@serializebuttonPressedBackgroundColor:Color = 0x4798EB

@:value(0x4798EB)@serializebuttonFocusedBorderColor:Color = 0x4798EB

@:value(0x888888)@serializetabsBackgroundColor:Color = 0x888888

@:value(0.1)@serializetabsBackgroundAlpha:Float = 0.1

@:value(0x888888)@serializetabsHoverBackgroundColor:Color = 0x888888

@:value(0.2)@serializetabsHoverBackgroundAlpha:Float = 0.2

@:value(0x636363)@serializetabsBorderColor:Color = 0x636363

@:value(0x1C1C1C)@serializewindowBackgroundColor:Color = 0x1C1C1C

@:value(0.925)@serializewindowBackgroundAlpha:Float = 0.925

@:value(0x636363)@serializewindowBorderColor:Color = 0x636363

@:value(1)@serializewindowBorderAlpha:Float = 1

Methods

invalidateBackgroundInFormLayout():Void

invalidateFieldTextColor():Void

invalidateFieldPlaceholderColor():Void

invalidateLightTextColor():Void

invalidateMediumTextColor():Void

invalidateDarkTextColor():Void

invalidateDarkerTextColor():Void

invalidateIconColor():Void

invalidateCustomMediumFont():Void

invalidateLighterBorderColor():Void

invalidateLightBorderColor():Void

invalidateMediumBorderColor():Void

invalidateDarkBorderColor():Void

invalidateLightBackgroundColor():Void

invalidateMediumBackgroundColor():Void

invalidateDarkBackgroundColor():Void

invalidateDarkerBackgroundColor():Void

invalidateSelectionBorderColor():Void

invalidateHighlightColor():Void

invalidateHighlightPendingColor():Void

invalidateFormItemSpacing():Void

invalidateFormPadding():Void

invalidateFocusedFieldSelectionColor():Void

invalidateFocusedFieldBorderColor():Void

invalidateOverlayBackgroundColor():Void

invalidateOverlayBackgroundAlpha():Void

invalidateOverlayBorderColor():Void

invalidateOverlayBorderAlpha():Void

invalidateButtonBackgroundColor():Void

invalidateButtonOverBackgroundColor():Void

invalidateButtonPressedBackgroundColor():Void

invalidateButtonFocusedBorderColor():Void

invalidateTabsBackgroundColor():Void

invalidateTabsBackgroundAlpha():Void

invalidateTabsHoverBackgroundColor():Void

invalidateTabsHoverBackgroundAlpha():Void

invalidateTabsBorderColor():Void

invalidateWindowBackgroundColor():Void

invalidateWindowBackgroundAlpha():Void

invalidateWindowBorderColor():Void

invalidateWindowBorderAlpha():Void

clone(?toTheme:Theme):Theme

applyTint(?baseTheme:Theme, tint:Color):Void

Apply the given tint color using baseTheme as lightness references

applyAltTint(?baseTheme:Theme, tint:Color):Void

Apply the given alt tint color using baseTheme as lightness references

applyBackgroundColor(color:Color):Void

applyTextColor(color:Color):Void

Inherited Events

Defined by Model

@:dox(show)observedDirty(instance:Model, fromSerializedField:Bool):Void

Event when any observable value as changed on this instance.

@:dox(show)_modelDirty(model:Model):Void

@:dox(show)serialize():Void

Event when this object gets serialized.

@:dox(show)deserialize():Void

Event when this object gets deserialized.

@:dox(show)dispose(entity:Entity):Void

@:dox(show)destroy(entity:Entity):Void

Inherited Variables

Defined by Model

@:value(false)observedDirty:Bool = false

Default is false, automatically set to true when any of this instance's observable variables has changed.

@componentserializer:SerializeModel

@:value(false)dirty:Bool = false

Defined by Entity

read onlyhasData:Bool

data:Dynamic

@:value(null)id:String = null

read onlydestroyed:Bool

read onlydisposed:Bool

@:value(null)read onlyautoruns:Array<Autorun> = null

@editablecomponents:ReadOnlyMap<String, Component>

Public components mapping. Contain components created separately with component() or macro-based components as well.

scriptContent:ScriptContent

Available with script plugin

script:Script

Available with script plugin

Inherited Methods

Defined by Model

Defined by Entity

destroy():Void

Destroy this entity. This method is automatically protected from duplicate calls. That means calling multiple times an entity's destroy() method will run the destroy code only one time. As soon as destroy() is called, the entity is marked destroyed=true, even when calling destroy() method on a subclass (a macro is inserting a code to mark the object as destroyed at the beginning of every destroy() override function.

dispose():Void

Schedules destroy, at the end of the current frame.

unbindEvents():Void

Remove all events handlers from this entity.

autorun(run:() ‑> Void, ?afterRun:() ‑> Void):Autorun

Creates a new Autorun instance with the given callback associated with the current entity.

Parameters:

run

The run callback

Returns:

The autorun instance

tween(?easing:Easing, duration:Float, fromValue:Float, toValue:Float, update:(Float, Float) ‑> Void):Tween

className():String

inlineclearComponents():Void

component<C>(?name:String, ?component:Null<C>):C

hasComponent(name:String):Bool

removeComponent(name:String):Void