Sommaire

• Acteur
• Informations
  • accessories
  • additionals
  • dataContext
  • dataStores
  • elementDOM
  • events
  • isDestroyed
  • isDestroying
  • isLeadActor
  • key
  • parent
  • properties
  • rootScene
  • scene
  • slotComposite
  • stage
  • styleName
  • synapp
  • type
  • uniqClass
  • uniqPath
• Méthodes
  • changeStyleName(styleName)
  • createEvent(eventName, eventScriptLines)
  • getAdditional(key)
  • getBinding(targetValuePath)
  • getProperty(key)
  • removeEvent(eventName)
  • runEvent(eventName, args)
• Événements
  • onClick
  • onComputeLayout
  • onContextMenu
  • onCssStyling
  • onDestroy
  • onDoubleClick
  • onFocusIn
  • onFocusOut
  • onInit
  • onKeyDown
  • onKeyUp
  • onLeadActorDidRender
  • onMouseDown
  • onMouseEnter
  • onMouseLeave
  • onMouseMove
  • onMouseOut
  • onMouseOver
  • onMouseUp
  • onPostInit
  • onPropertyChanged
  • onRender
  • onTouchEnd
  • onTouchMove
  • onTouchStart
• Propriétés et additionnelles
  • reset(name)
• Évènements des propriétés et additionnelles
  • additionals/<nom>/binding/onReadTransform
  • additionals/<nom>/binding/onWriteTransform
  • additionals/<nom>/onValueChanged
  • properties/<nom>/binding/onReadTransform
  • properties/<nom>/binding/onWriteTransform
  • properties/<nom>/onValueChanged

Acteur

📖 Concept : Acteur

Informations, méthodes et évènements communs à tous les acteurs, accessibles par script via this dans un script de l’acteur ou context.getActor('clé') depuis un autre acteur. Les propriétés communes sont décrites par catégorie dans les pages Aspect, Texte, Disposition, Tailles, Espaces, Bordures et Effets ; celles propres à un type d’acteur, sur la page de ce type d’acteur.

🔧 propriété · ℹ️ information · ⚙️ méthode · ⚡ évènement · 🔒 lecture seule

Informations

accessories

this.accessories · 🔒 lecture seule · Object

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

additionals

this.additionals · 🔒 lecture seule · Propriétés et additionnelles

Obtient les propriétés additionnelles.

dataContext

this.dataContext · any

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.

dataStores

this.dataStores · 🔒 lecture seule · Magasins de données

Obtient les magasins de données de la synapp (dataStores.redy : le magasin REDY).

elementDOM

this.elementDOM · 🔒 lecture seule · Element

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

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

events

this.events · 🔒 lecture seule · Object

Obtient les évènements

isDestroyed

this.isDestroyed · 🔒 lecture seule · Boolean

Vrai quand l’acteur est détruit.

isDestroying

this.isDestroying · 🔒 lecture seule · Boolean

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

isLeadActor

this.isLeadActor · 🔒 lecture seule · Boolean

Est-ce un acteur principal ?

key

this.key · 🔒 lecture seule · string

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.

parent

this.parent · 🔒 lecture seule · Actor.BaseActor

Acteur parent.
Peut être absent si l’acteur est le principal.

properties

this.properties · 🔒 lecture seule · Propriétés et additionnelles

Obtient les propriétés.

rootScene

this.rootScene · 🔒 lecture seule · Scène

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

scene

this.scene · 🔒 lecture seule · Scène

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.

slotComposite

this.slotComposite · 🔒 lecture seule · Composite

Composite auquel appartient l’emplacement contenant l’acteur.

stage

this.stage · 🔒 lecture seule · Stage

Scene ou Composite parent directe de l’acteur.

styleName

this.styleName · 🔒 lecture seule · String

Le nom du style de l’acteur.
Pour changer de style, il faut utiliser Actor.BaseActor#changeStyleName

synapp

this.synapp · 🔒 lecture seule · Synapp

Obtient la Synapp.

type

this.type · 🔒 lecture seule · string

Type de l’acteur.

uniqClass

this.uniqClass · 🔒 lecture seule · string

Classe CSS unique de l’acteur.
Elle permet de sélectionner l’élément du DOM de l’acteur.

uniqPath

this.uniqPath · 🔒 lecture seule · string

Chemin unique de l’acteur.

Méthodes

changeStyleName(styleName)

this.changeStyleName(styleName)

Changer le nom du style de l’acteur. Échoue si l’acteur n’est pas encore rendu (par exemple dans onInit).

• styleName : Nom du style à appliquer.

createEvent(eventName, eventScriptLines)

this.createEvent(eventName, eventScriptLines)

Crée un évènement de l’acteur à partir d’un tableau de lignes de code ou d’une fonction function(context).

getAdditional(key)

this.getAdditional(key) · renvoie any

Obtient la valeur de l’additionnelle de clé key (comme this.additionals[key]).

• key : Clé de l’additionnelle.

getBinding(targetValuePath)

this.getBinding(targetValuePath) · renvoie Binding

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

• targetValuePath : Chemin de la cible ex.: properties.content

getProperty(key)

this.getProperty(key) · renvoie any

Obtient la valeur de la propriété key (comme this.properties[key]).

• key : Nom de la propriété.

removeEvent(eventName)

this.removeEvent(eventName)

Supprime un évènement de l’acteur.

runEvent(eventName, args)

this.runEvent(eventName, args)

Exécute un évènement de l’acteur s’il existe, avec le contexte de l’acteur (scène, synapp, magasins de données) complété des arguments donnés.

Événements

onClick

Se produit au clic sur acteur.

context : contexte d’évènement, avec en plus :

Membre de context	Type	Description
mouseEvent

onComputeLayout

Se produit lorsque l’acteur calcul son gabarit.

context : contexte d’évènement

onContextMenu

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

context : contexte d’évènement, avec en plus :

Membre de context	Type	Description
mouseEvent

onCssStyling

Se produit lorsque l’acteur applique son style CSS.

context : contexte d’évènement

onDestroy

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

context : contexte d’évènement

onDoubleClick

Se produit au double clic sur acteur.

context : contexte d’évènement, avec en plus :

Membre de context	Type	Description
mouseEvent

onFocusIn

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

context : contexte d’évènement, avec en plus :

Membre de context	Type	Description
focusEvent

onFocusOut

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

context : contexte d’évènement, avec en plus :

Membre de context	Type	Description
focusEvent

onInit

Se produit lorsque l’acteur est initialisé.

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

context : contexte d’évènement

onKeyDown

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

context : contexte d’évènement, avec en plus :

Membre de context	Type	Description
keyboardEvent

onKeyUp

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

context : contexte d’évènement, avec en plus :

Membre de context	Type	Description
keyboardEvent

onLeadActorDidRender

Se produit une seule fois sur l’acteur principal d’une scène ou d’un composite, après son premier rendu, une fois les fournisseurs de données démarrés (déclenché par la scène ou le composite).

context : contexte d’évènement

onMouseDown

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

context : contexte d’évènement, avec en plus :

Membre de context	Type	Description
mouseEvent

onMouseEnter

Se produit lorsque la souris entre dans acteur.

context : contexte d’évènement, avec en plus :

Membre de context	Type	Description
mouseEvent

onMouseLeave

Se produit lorsque la souris sort de l’ acteur.

context : contexte d’évènement, avec en plus :

Membre de context	Type	Description
mouseEvent

onMouseMove

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

context : contexte d’évènement, avec en plus :

Membre de context	Type	Description
mouseEvent

onMouseOut

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

context : contexte d’évènement, avec en plus :

Membre de context	Type	Description
mouseEvent

onMouseOver

Se produit lorsque la souris survol l’ acteur.

context : contexte d’évènement, avec en plus :

Membre de context	Type	Description
mouseEvent

onMouseUp

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

context : contexte d’évènement, avec en plus :

Membre de context	Type	Description
mouseEvent

onPostInit

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, …

context : contexte d’évènement

onPropertyChanged

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

context : contexte d’évènement, avec en plus :

Membre de context	Type	Description
newValue	any	Nouvelle valeur.
oldValue	any	Ancienne valeur.
propertyPath	string	Chemin de la propriété.
name	string	Nom de la propriété.
modifier	'css' ou 'render' ou 'layout' ou 'resize' ou 'other'	Type de modification entraînée par le changement.

onRender

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

context : contexte d’évènement, avec en plus :

Membre de context	Type	Description
isFirstRender

onTouchEnd

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

context : contexte d’évènement, avec en plus :

Membre de context	Type	Description
touchEvent

onTouchMove

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

context : contexte d’évènement, avec en plus :

Membre de context	Type	Description
touchEvent

onTouchStart

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

context : contexte d’évènement, avec en plus :

Membre de context	Type	Description
touchEvent

Propriétés et additionnelles

Les propriétés (this.properties) et les additionnelles (this.additionals) d’un acteur donnent accès à chaque propriété ou additionnelle par son nom (this.properties.width), et offrent :

reset(name)

this.properties.reset(name)

Réinitialise à sa valeur par défaut une propriété par son nom.

• name : Nom de la propriété à réinitialiser.

Évènements des propriétés et additionnelles

Scripts définis dans l’inspecteur sur une propriété ou une additionnelle donnée (<nom> est son nom) : changement de valeur et transformations de liaison.

additionals/<nom>/binding/onReadTransform

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.

context : contexte d’évènement, avec en plus :

Membre de context	Type	Description
value	any	La valeur lue.
binding	Liaison	La liaison.
propertyPath	string	Chemin de la propriété.

Valeur renvoyée (any) : la valeur lue par défaut.

additionals/<nom>/binding/onWriteTransform

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.

context : contexte d’évènement, avec en plus :

Membre de context	Type	Description
value	any	La valeur écrite.
binding	Liaison	La liaison.
propertyPath	string	Chemin de la propriété.

Valeur renvoyée (any) : la valeur lue par défaut.

additionals/<nom>/onValueChanged

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é.

context : contexte d’évènement, avec en plus :

Membre de context	Type	Description
newValue	any	Nouvelle valeur.
oldValue	any	Ancienne valeur.
propertyPath	string	Chemin de la propriété.
name	string	Nom de la propriété.
modifier	'css' ou 'render' ou 'layout' ou 'resize' ou 'other'	Type de modification entraînée par le changement.

properties/<nom>/binding/onReadTransform

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.

context : contexte d’évènement, avec en plus :

Membre de context	Type	Description
value	any	La valeur lue.
binding	Liaison	La liaison.
propertyPath	string	Chemin de la propriété.

Valeur renvoyée (any) : la valeur lue par défaut.

properties/<nom>/binding/onWriteTransform

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.

context : contexte d’évènement, avec en plus :

Membre de context	Type	Description
value	any	La valeur écrite.
binding	Liaison	La liaison.
propertyPath	string	Chemin de la propriété.

Valeur renvoyée (any) : la valeur lue par défaut.

properties/<nom>/onValueChanged

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.

context : contexte d’évènement, avec en plus :

Membre de context	Type	Description
newValue	any	Nouvelle valeur.
oldValue	any	Ancienne valeur.
propertyPath	string	Chemin de la propriété.
name	string	Nom de la propriété.
modifier	'css' ou 'render' ou 'layout' ou 'resize' ou 'other'	Type de modification entraînée par le changement.

---

✔️ FR IT

❔ Posez une Question 💡 Proposez une Suggestion 💬 Venez discuter

made by