StateWithToggleValueSelector

public class
feathers.skins.StateWithToggleValueSelector

Description

Maps a component's states to values, perhaps for one of the component's properties such as a skin or text format.

API overview

Constructor

StateWithToggleValueSelector ()
Constructor.

Attributes

Public attributes

defaultSelectedValue: Object

If the target is a selected IToggle instance, and if there is no value for the specified state, a default value may be used as a fallback (with a higher priority than the regular default fallback)

defaultValue: Object

If there is no value for the specified state, a default value can be used as a fallback

Functions

Public functions

clearValueForState ( state: Object , isSelected: Boolean = false ): Object

Clears the value stored for a specific state

getValueForState ( state: Object , isSelected: Boolean = false ): Object

Returns the value stored for a specific state

setValueForState ( value: Object , state: Object , isSelected: Boolean = false ): Void

Stores a value for a specified state to be returned from getValueForState()

updateValue ( target: Object , state: Object , oldValue: Object = null ): Object

Returns the value stored for a specific state

Constructor

StateWithToggleValueSelector ()

Constructor.

Attributes

defaultSelectedValue: Object

If the target is a selected IToggle instance, and if there is no value for the specified state, a default value may be used as a fallback (with a higher priority than the regular default fallback).

See also:
feathers.core.IToggle

defaultValue: Object

If there is no value for the specified state, a default value can be used as a fallback.

Functions

clearValueForState ( state: Object , isSelected: Boolean = false ): Object

Clears the value stored for a specific state.

Parameters

state: Object
isSelected: Boolean = false


getFullTypeName (): String
Inherited from Object

native

Gets the fully qualified type name of the Object. The fully qualified type name includes the package of the type.


Returns

String fully qualified type name of the Object.

getType (): Type
Inherited from Object

native

Gets the Type that describes the Object.


Returns

Type The Type that describes the object.

getTypeName (): String
Inherited from Object

native

Gets the type name of the Object.


Returns

String type name of the Object.

getValueForState ( state: Object , isSelected: Boolean = false ): Object

Returns the value stored for a specific state.

Parameters

state: Object
isSelected: Boolean = false


setValueForState ( value: Object , state: Object , isSelected: Boolean = false ): Void

Stores a value for a specified state to be returned from getValueForState().

Parameters

value: Object
state: Object
isSelected: Boolean = false


toString (): String
Inherited from Object

native

Returns a String that describes the Object. This can be overriden to provide extra details when printing objects using trace().


Returns

String String that described the Object.

updateValue ( target: Object , state: Object , oldValue: Object = null ): Object

Returns the value stored for a specific state. May generate a value, if none is present.

Parameters

target: Object The object receiving the stored value. The manager may query properties on the target to customize the returned value.
state: Object The current state.
oldValue: Object = null The previous value. May be reused for the new value.


: