1. Home
  2. Classes
  3. Actor.BaseActor

new <private> BaseActor()

Description

Acteur de base.

Details

Members

<readonly> accessories :Object

Description

Obtient la liste des accessoires.

Chaque accessoire est accessible par sa clé :

this.accessories.log.properties.onActorPropertyChanged = true;

pour accéder à l'accessoire log préalablement créé et activer la journalisation au changement de propriété de l'acteur.

La gestion des accessoires s'effectue avec les méthodes : Actor.BaseActor#createAccessory et Actor.BaseActor#removeAccessory

<readonly> actor :Element

Description

L'élément DOM de l'acteur.


Attention! L'élément n'est pas accessible dans tous les scripts.

Details
Element

décrire les évènements

<readonly> additionals :Synapps.PrototypedBase

Description

Obtient les propriétés additionnelles.

Details
Synapps.PrototypedBase

Behavior.WithAdditionals#additionals

Behavior.WithAdditionals#additionals

<readonly> BaseAccessory :BaseAccessory

Description

Obtient la classe de base des accessoire pour en définir des nouveaux

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

Behavior.DataContextual#dataContext

<readonly> dataContextualParent :any

Description

Parent de donnée qui participe au ruissellement.

Details
any

Behavior.DataContextual#dataContextualParent

Behavior.DataContextual#dataContextualParent

<readonly> dataStores :REDY.Synapps.DataStores|HW.Synapps.DataStores

Description

Obtient les magasins de données de la synapp.

<readonly> events' :Object

Description

Obtient les évènements

Details
Object

Behavior.WithEvents#events'

Behavior.WithEvents#events'

<readonly> inBindingsRegister :Register

Description

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

Details
Register

Behavior.SourceOfInternalBinding#inBindingsRegister

Behavior.SourceOfInternalBinding#inBindingsRegister

<readonly> inheritedDataContext :any

Description

Contexte de donnée ruisselé.

Details
any

Behavior.DataContextual#inheritedDataContext

Behavior.DataContextual#inheritedDataContext

<readonly> isDataContextual :Boolean

Description

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

Details
Boolean

Behavior.DataContextual#isDataContextual

Behavior.DataContextual#isDataContextual

<readonly> isDestroyed :Boolean

Description

Vrai quand l'acteur est détruit.

<readonly> isDestroying :Boolean

Description

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

<readonly> isLeadActor :Boolean

Description

Est-ce un acteur principal ?

<readonly> key :string

Description

La clé unique de l'acteur.

Son unicité est valable dans le contexte de la scène ou du composite parent direct de l'acteur.

<readonly> leadActor :Actor.BaseActor

Description

Obtient l'acteur principal de la scène ou composite présentant l'acteur.

<readonly> parent :Actor.BaseActor

Description

Acteur parent.

Peut être absent si l'acteur est le principal.

<readonly> properties :Actor.BaseActorProperties

Description

Obtient les propriétés de l'acteur.

<readonly> rootScene :Synapps.Scene

Description

Obtient la scène racine.

Ce n'est pas forcément la scène parente directe de l'acteur.

<readonly> scene :Synapps.Scene

Description

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

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> styleName :String

Description

Le nom du style de l'acteur.


Pour changer de style, il faut utiliser Actor.BaseActor#changeStyleName

<readonly> synapp :Synapps.Synapp

Description

Obtient la Synapp.

<readonly> type :string

Description

Type de l'acteur.

<readonly> uniqClass :string

Description

Classe CSS unique de l'acteur.

Elle permet de sélectionner l'élément du DOM de l'acteur.

<readonly> uniqPath :string

Description

Chemin unique de l'acteur.

Methods

changeStyleName( styleName )

Description

Changer le nom du style de l'acteur.

Parameters
Name Type Description
styleName String

Nom du style à appliquer.
Details

Que se passe t il si le nom de style ne correspond à aucun défini ?

createAccessory( key, setup, saveInSetup ) → {Accessory}

Parameters
Name Type Description
key *

Clé unique.
setup *
saveInSetup *
Returns

L'accessoire créé.

Details

à documenter. Création d'une instance d'accessoire.

createBasicBinding( targetValuePath, setup [, saveInSetup ] ) → {Binding.BasicBinding}

Description

Création d'une liaison basique.

La source est prise dans le contexte de donnée.

Parameters
Name Type Attributes Default Description
targetValuePath string

Chemin de la cible de la liaison.
setup JSON.BasicBinding
saveInSetup Boolean <optional>
 true
Returns

la liaison créée.

Examples
Le `setup` est un objet
```
actor.createBasicBinding('properties.width, { path: 'widthOfPanel' });
```
La propriété largeur de l'acteur est maintenant liée au champ `widthOfPanel` de son contexte de donnée.

createEvent( eventName, eventScriptLines ) → {any}

Description

Crée un évènement dans les events.

Parameters
Name Type Description
eventName String

Nom de l'évènement
eventScriptLines Array.<String> | function

implémentation de l'évènement. Peut être un tableau de ligne de code ou une callback function(context).
Returns

Le retour éventuel dans la définition de l'évènement.

Examples
// avec un tableau de code
this.createEvent('onInit', ['const test = "test!";', 'console.log(context.eventName, test);']);

// avec une fonction
this.createEvent('onInit', context => {
  const test = "test!";
  console.log(context.eventName, test);
});
Details

Behavior.WithEvents#createEvent

Behavior.WithEvents#createEvent

createInternalBinding( targetValuePath, setup [, saveInSetup ] )

Description

Création d'une liaison interne.

Le type de source permet à la liaison d'aller cherche la bonne source à placer dans le contexte de donnée de la liaison.

Parameters
Name Type Attributes Default Description
targetValuePath string

Chemin de la cible de la liaison.
setup Object
saveInSetup Boolean <optional>
 true
Examples
Le `setup` est un objet différent en fonction du type de source.

Pour un acteur :
```
{ sourceKey: '<clé acteur>', path: 'le chemin de la valeur de la source' }
```

getBinding( targetValuePath ) → {Binding}

Description

Obtient une liaison de l'acteur par son chemin de la cible.

Parameters
Name Type Description
targetValuePath string

Chemin de la cible ex.: properties.content
Returns

la liaison demandée ou null si non trouvée.

removeAccessory( key )

Description

Suppression d'un accessoire

Parameters
Name Type Description
key string

removeBinding( targetValuePath )

Description

Suppression d'une liaison sur un chemin cible.

Parameters
Name Type Description
targetValuePath string

Chemin vers la cible de la liaison

removeEvent( eventName )

Description

Supprime un évènement dans les events.

Parameters
Name Type Description
eventName String

Nom de l'évènement à supprimer.
Details

Behavior.WithEvents#removeEvent

Behavior.WithEvents#removeEvent

runEvent( eventName, args ) → {any}

Description

Exécute un évènement s'il existe dans les events.

Parameters
Name Type Description
eventName String

Nom de l'évènement
args Object

Arguments à passer dans l'objet de contexte.
Returns

Le retour éventuel dans la définition de l'évènement.

Details

Behavior.WithEvents#runEvent

Behavior.WithEvents#runEvent

Events

additionals/[additionalName]/binding/onReadTransform

Description

Se produit à la lecture de la source d'une liaison vers une additionnelle additionalName.
Il est possible de transformer la valeur lue pour écrire autre chose dans la cible.


Par exemple l'évènement additionals/myText/binding/onReadTransform se produit lorsque la source de la liaison vers l'additionnelle myText est lue.

Parameters
Name Type Description
context Event.OnBindingTransformContext

Le contexte de l'évènement.
Returns

la valeur lue par défaut.

additionals/[additionalName]/binding/onWriteTransform

Description

Se produit à écriture de la source d'une liaison vers une additionnelle additionalName.
Il est possible de transformer la valeur lue pour écrire autre chose dans la source.


Par exemple l'évènement additionals/myText/binding/onWriteTransform se produit lorsque l'additionnelle myText change et que sa valeur est écrite dans la source.

Parameters
Name Type Description
context Event.OnBindingTransformContext
Returns

la valeur lue par défaut.

additionals/[additionalName]/onValueChanged

Description

Se produit lorsque la valeur de l'additionnelle [additionalName] a changé.


Par exemple l'évènement additionals/myText/onValueChanged se produit lorsque l'additionnelle myText a changé.

Parameters
Name Type Description
context Event.PropertyChangedContext

onClick

Description

Se produit au clic sur acteur.

Parameters
Name Type Description
context Event.BaseContext

Le contexte de l'évènement.

Name Type Description
mouseEvent MouseEvent

L'évènement de souris.

onComputeLayout

Description

Se produit lorsque l'acteur calcul son gabarit.

Parameters
Name Type Description
context Event.BaseContext

Contexte de l'évènement.

onContextMenu

Description

Se produit lorsque un bouton droit est cliqué pour afficher le menu contextuel.

Parameters
Name Type Description
context Event.BaseContext

Le contexte de l'évènement.

Name Type Description
mouseEvent MouseEvent

L'évènement de souris.

onCssStyling

Description

Se produit lorsque l'acteur applique son style CSS.

Parameters
Name Type Description
context Event.BaseContext

Contexte de l'évènement.

onDestroy

Description

Se produit au moment de la destruction d'un acteur.

Parameters
Name Type Description
context Event.BaseContext

Le contexte de l'évènement

onDoubleClick

Description

Se produit au double clic sur acteur.

Parameters
Name Type Description
context Event.BaseContext

Le contexte de l'évènement.

Name Type Description
mouseEvent MouseEvent

L'évènement de souris.

onFocusIn

Description

Se produit lorsque l'acteur est sur le point d'obtenir le focus.

Parameters
Name Type Description
context Event.BaseContext

Le contexte de l'évènement.

Name Type Description
focusEvent FocusEvent

L'évènement de focus.

onFocusOut

Description

Se produit lorsque l'acteur est sur le point de perdre le focus.

Parameters
Name Type Description
context Event.BaseContext

Le contexte de l'évènement.

Name Type Description
focusEvent FocusEvent

L'évènement de clavier.

onInit

Description

Se produit lorsque l'acteur est initialisé.


Attention, l'élément DOM n'est pas encore accessible, ni les autres acteurs présents.

Parameters
Name Type Description
context Event.BaseContext

Contexte de l'évènement.

onKeyDown

Description

Se produit lorsque un touche de clavier est enfoncée dans l'acteur.

Parameters
Name Type Description
context Event.BaseContext

Le contexte de l'évènement.

Name Type Description
keyboardEvent KeyboardEvent

L'évènement de clavier.

onKeyUp

Description

Se produit lorsque un touche de clavier est relâchée dans l'acteur.

Parameters
Name Type Description
context Event.BaseContext

Le contexte de l'évènement.

Name Type Description
keyboardEvent KeyboardEvent

L'évènement de clavier.

onMouseDown

Description

Se produit lorsque un bouton de la souris est appuyé au dessus de l'acteur .

Parameters
Name Type Description
context Event.BaseContext

Le contexte de l'évènement.

Name Type Description
mouseEvent MouseEvent

L'évènement de souris.

onMouseEnter

Description

Se produit lorsque la souris entre dans acteur.

Parameters
Name Type Description
context Event.BaseContext

Le contexte de l'évènement.

Name Type Description
mouseEvent MouseEvent

L'évènement de souris.

onMouseLeave

Description

Se produit lorsque la souris sort de l' acteur.

Parameters
Name Type Description
context Event.BaseContext

Le contexte de l'évènement.

Name Type Description
mouseEvent MouseEvent

L'évènement de souris.

onMouseMove

Description

Se produit lorsque la souris se déplace au dessus de l' acteur.

Parameters
Name Type Description
context Event.BaseContext

Le contexte de l'évènement.

Name Type Description
mouseEvent MouseEvent

L'évènement de souris.

onMouseOut

Description

Se produit lorsque la souris survol autre chose que l' acteur.

Parameters
Name Type Description
context Event.BaseContext

Le contexte de l'évènement.

Name Type Description
mouseEvent MouseEvent

L'évènement de souris.

onMouseOver

Description

Se produit lorsque la souris survol l' acteur.

Parameters
Name Type Description
context Event.BaseContext

Le contexte de l'évènement.

Name Type Description
mouseEvent MouseEvent

L'évènement de souris.

onMouseUp

Description

Se produit lorsque un bouton de la souris est relâché au dessus de l'acteur .

Parameters
Name Type Description
context Event.BaseContext

Le contexte de l'évènement.

Name Type Description
mouseEvent MouseEvent

L'évènement de souris.

onPostInit

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.


On a accès à tous les éléments DOM, liaisons, ...

Parameters
Name Type Description
context Event.BaseContext

onPropertyChanged

Description

Se produit lorsque n'importe quelle propriété ou additionnelle de l'acteur ou de ses accessoires ou additionnelle voit sa valeur changer.

Parameters
Name Type Description
context Event.PropertyChangedContext

Le contexte de l'évènement.

onRender

Description

Se produit à chaque rendu de l'acteur dans l'interface.
Un champs isFirstRender est à true dans le contexte au premier rendu uniquement.

Parameters
Name Type Description
context Event.BaseContext

Le contexte de l'évènement. Avec en plus :

Name Type Description
isFirstRender Boolean

Vrai uniquement au premier rendu de l'acteur.

onTouchEnd

Description

Se produit lorsque un ou plusieurs points de contact ont été relâchés sur l'acteur .

Parameters
Name Type Description
context Event.BaseContext

Le contexte de l'évènement.

Name Type Description
mouseEvent MouseEvent

L'évènement tactile.

onTouchMove

Description

Se produit lorsque un ou plusieurs points de contact ont été déplacés sur l'acteur .

Parameters
Name Type Description
context Event.BaseContext

Le contexte de l'évènement.

Name Type Description
mouseEvent MouseEvent

L'évènement tactile.

onTouchStart

Description

Se produit lorsque un ou plusieurs points de contact ont été réalisés sur l'acteur .

Parameters
Name Type Description
context Event.BaseContext

Le contexte de l'évènement.

Name Type Description
mouseEvent MouseEvent

L'évènement tactile.

properties/[propertyName]/binding/onReadTransform

Description

Se produit à la lecture de la source d'une liaison vers une propriété propertyName.
Il est possible de transformer la valeur lue pour écrire autre chose dans la cible.


Par exemple l'évènement properties/width/binding/onReadTransform se produit lorsque la source de la liaison vers la propriété Actor.BaseActorProperties#width est lue.

Parameters
Name Type Description
context Event.OnBindingTransformContext

Le contexte de l'évènement.
Returns

la valeur lue par défaut.

properties/[propertyName]/binding/onWriteTransform

Description

Se produit à l'écriture de la source d'une liaison vers une propriété propertyName.
Il est possible de transformer la valeur lue pour écrire autre chose dans la source.


Par exemple l'évènement properties/width/binding/onWriteTransform se produit lorsque la propriété Actor.BaseActorProperties#width change et que sa valeur est écrite dans la source.

Parameters
Name Type Description
context Event.OnBindingTransformContext
Returns

la valeur lue par défaut.

properties/[propertyName]/onValueChanged

Description

Se produit lorsque la valeur de propriété [propertyName] change.


Par exemple l'évènement properties/width/onValueChanged se produit lorsque la propriété Actor.BaseActorProperties#width change.

Parameters
Name Type Description
context Event.PropertyChangedContext