1. Home
  2. Classes
  3. Accessory.BaseAccessory

new BaseAccessory()

Description

Classe de base des accessoires.
Elle est accessible par n'importe quel acteur dans le champ BaseAccessory.

Un accessoire permet de définir des comportements à reproduire sur des acteurs en se greffant sur leurs évènements et leur cycle de vie.

Un accessoire hérite du contexte de donnée de l'acteur auquel il appartient.

Details

Members

<static, readonly> 'prototypeSetup :Object

Description

Le setup du prototype de l'accessoire.

<readonly> actor :Actor.BaseActor

Description

Obtient l'acteur qu'il décore.

dataContext :any

Description

Obtient ou définit le contexte de donnée.

Le contexte de donnée est obtenu par ruissellement si rien n'est définit au niveau de l'objet.

Details
any

Behavior.DataContextual#dataContext

<readonly> dataContextualParent :any

Description

Parent de donnée qui participe au ruissellement.

Details
any

Behavior.DataContextual#dataContextualParent

<readonly> inBindingsRegister :Register

Description

Obtient le registre des liaisons qui utilisent l'objet comme source.

Details
Register

Behavior.SourceOfInternalBinding#inBindingsRegister

<readonly> inheritedDataContext :any

Description

Contexte de donnée ruisselé.

Details
any

Behavior.DataContextual#inheritedDataContext

<readonly> isDataContextual :Boolean

Description

Est-ce un objet qui participe au ruissellement de donnée.

Details
Boolean

Behavior.DataContextual#isDataContextual

<readonly> isDestroyed :Boolean

Description

Vrai quand l'objet est détruit.

Details
Boolean

false

Behavior.Destroyable#isDestroyed

<readonly> isDestroying :Boolean

Description

Vrai quand l'objet est en train d'être détruit.

Details
Boolean

false

Behavior.Destroyable#isDestroying

<readonly> key :String

Description

Obtient la clé unique de l'accessoire qui l'identifie parmi les autres accessoires de l'acteur.

<readonly> properties :Synapps.PrototypedBase

Description

Obtient les propriétés.

Details
Synapps.PrototypedBase

Behavior.WithProperties#properties

<readonly> scene :Stage

Description

Première scène parente de l'acteur de l'accessoire.

Ce n'est pas forcément la scène parente directe de l'acteur ni même la scène racine.

<readonly> stage :Stage

Description

Scene ou Composite parent directe de l'acteur.

<readonly> uniqPath :String

Description

Obtient le chemin unique vers l'accessoire.

Methods

<static> registerInAccessoryDefs( definition )

Description

Enregistre la définition de l'accessoire dans le dictionnaire des accessoires pour le rendre accessible à la création par setup JSON.

Parameters
Name Type Description
definition Object
Name Type Attributes Default Description
type string

La clé unique du type de l'accessoire (ex: "data-source/wos-relative-variable");
prototypeSetup string

Object qui contient les définitions des propriétés de l'accessoire.
platform string <optional>
 native

Nom de la plateforme à laquelle l'accessoire appartient.
Examples
class TestAccessory extends BaseAccessory {
  onActorDoComputeStyle({ style }) {
    style.color = this.properties.color;
  }
}

TestAccessory.registerInAccessoryDefs({
  type: 'test',
  prototypeSetup: {
    color: { value: RED, modifier: 'css' },
    coco: { value: 'default' },
    machin: { value: null },
    machin2: { value: null }
  }
});

destroy()

Description

Détruit l'objet.

Details

Behavior.Destroyable#destroy

<abstract> onActorBindingReadTransform( args )

Description

Se produit lors de la lecture de la valeur d'une source de liaison de l'acteur.

Parameters
Name Type Description
args Objet

Arguments.

Name Type Description
value any

La valeur lue.
binding Binding.BasicBinding

La liaison concernée.
propertyPath String

Chemin de la cible de la liaison.
Returns

la valeur lue.

<abstract> onActorBindingWriteTransform( args )

Description

Se produit lors de l'écriture d'une valeur dans une source de liaison de l'acteur.

Parameters
Name Type Description
args Objet

Arguments.

Name Type Description
value any

La valeur écrite.
binding Binding.BasicBinding

La liaison concernée.
propertyPath String

Chemin de la cible de la liaison.
Returns

la valeur écrite.

<abstract> onActorClick( args )

Description

Se produit à chaque clic souris sur l'acteur.

Parameters
Name Type Description
args Object

Paramètre.

Name Type Description
mouseEvent MouseEvent

Évènement souris

<abstract> onActorComputeLayout()

Description

Se produit à chaque fois que l'acteur calcule son gabarit.

<abstract> onActorContextMenu( args )

Description

Se produit à chaque demande d'ouverture du menu contextuel.

Parameters
Name Type Description
args Object

Paramètre.

Name Type Description
mouseEvent MouseEvent

Évènement souris

<abstract> onActorCssStyling()

Description

Se produit à chaque définition du style css de l'acteur.

<abstract> onActorDestroy()

Description

Se produit lors de la destruction de l'acteur.

<abstract> onActorDoComputeStyle( args )

Description

Se produit à chaque fois que l'acteur calcule son style CSS.

Parameters
Name Type Description
args Objet

Paramètres

Name Type Description
style Object

Object de style CSS.

<abstract> onActorDoubleClick( args )

Description

Se produit à chaque double clic souris sur l'acteur.

Parameters
Name Type Description
args Object

Paramètre.

Name Type Description
mouseEvent MouseEvent

Évènement souris

<abstract> onActorFocusIn( args )

Description

Se produit à chaque fois que l'acteur est sur le point d'obtenir le focus.

Parameters
Name Type Description
args Object

Paramètre.

Name Type Description
focusEvent FocusEvent

Évènement focus

<abstract> onActorFocusOut( args )

Description

Se produit à chaque fois que l'acteur est sur le point de perdre le focus.

Parameters
Name Type Description
args Object

Paramètre.

Name Type Description
focusEvent FocusEvent

Évènement focus

<abstract> onActorInit()

Description

Se produit lors de l'initialisation de l'acteur.

<abstract> onActorKeyDown( args )

Description

Se produit à chaque pression sur le clavier.

Parameters
Name Type Description
args Object

Paramètre.

Name Type Description
keyboardEvent KeyboardEvent

Évènement clavier

<abstract> onActorKeyUp( args )

Description

Se produit à chaque relâchement d'une touche du clavier.

Parameters
Name Type Description
args Object

Paramètre.

Name Type Description
keyboardEvent KeyboardEvent

Évènement clavier

<abstract> onActorMouseDown( args )

Description

Se produit à chaque enfoncement de bouton de souris sur l'acteur.

Parameters
Name Type Description
args Object

Paramètre.

Name Type Description
mouseEvent MouseEvent

Évènement souris

<abstract> onActorMouseEnter( args )

Description

Se produit à chaque entrée de souris sur l'acteur.

Parameters
Name Type Description
args Object

Paramètre.

Name Type Description
mouseEvent MouseEvent

Évènement souris

<abstract> onActorMouseLeave( args )

Description

Se produit à chaque sortie de souris sur l'acteur.

Parameters
Name Type Description
args Object

Paramètre.

Name Type Description
mouseEvent MouseEvent

Évènement souris

<abstract> onActorMouseMove( args )

Description

Se produit à chaque mouvement de souris sur l'acteur.

Parameters
Name Type Description
args Object

Paramètre.

Name Type Description
mouseEvent MouseEvent

Évènement souris

<abstract> onActorMouseOut( args )

Description

Se produit à chaque survol de souris sur autre chose que l'acteur.

Parameters
Name Type Description
args Object

Paramètre.

Name Type Description
mouseEvent MouseEvent

Évènement souris

<abstract> onActorMouseOver( args )

Description

Se produit à chaque survol de souris sur l'acteur.

Parameters
Name Type Description
args Object

Paramètre.

Name Type Description
mouseEvent MouseEvent

Évènement souris

<abstract> onActorMouseUp( args )

Description

Se produit à chaque relâchement de bouton de souris sur l'acteur.

Parameters
Name Type Description
args Object

Paramètre.

Name Type Description
mouseEvent MouseEvent

Évènement souris

<abstract> onActorPostInit()

Description

Se produit juste avant le premier rendu de l'acteur mais après que tous les acteurs de la scène soient initialisés.

<abstract> onActorPropertyChanged( args )

Description

Se produit lorsque n'importe quelle propriété ou additionnelle de l'acteur, d'un accessoire de l'acteur voit sa valeur changer.

Parameters
Name Type Description
args Objet

Arguments.

Name Type Description
modifier 'css' | 'render' | 'layout' | 'other'

Type de modification entraînée par le changement.
propertyPath String

Chemin de la propriété concernée.
name String

Nom de la propriété concernée.
oldValue any

Valeur avant changement.
newValue any

Valeur après changement.

<abstract> onActorRender()

Description

Se produit à chaque rendu de l'acteur.

<abstract> onActorTouchEnd( args )

Description

Se produit à chaque relâchement d'un point tactile.

Parameters
Name Type Description
args Object

Paramètre.

Name Type Description
touchEvent MouseEvent

Évènement tactile

<abstract> onActorTouchMove( args )

Description

Se produit à chaque déplacement d'un point tactile.

Parameters
Name Type Description
args Object

Paramètre.

Name Type Description
touchEvent MouseEvent

Évènement tactile

<abstract> onActorTouchStart( args )

Description

Se produit à chaque application d'un point tactile.

Parameters
Name Type Description
args Object

Paramètre.

Name Type Description
touchEvent MouseEvent

Évènement tactile

<abstract> onActorValueChanged( args )

Description

Se produit lorsque n'importe une propriété ou additionnelle de l'acteur, d'un accessoire de l'acteur voit sa valeur changer.

Parameters
Name Type Description
args Objet

Arguments.

Name Type Description
modifier 'css' | 'render' | 'layout' | 'other'

Type de modification entraînée par le changement.
propertyPath String

Chemin de la propriété concernée.
name String

Nom de la propriété concernée.
oldValue any

Valeur avant changement.
newValue any

Valeur après changement.