Actor.Layout.Stack

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

Details

<readonly> actor :Element

Description

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

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

Details

<readonly> additionals :Synapps.PrototypedBase

Description

Obtient les propriétés additionnelles.

Details

<readonly> BaseAccessory :BaseAccessory

Description

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

Details

<readonly> canAddActor :boolean

Description

Pour savoir s'il est possible d'ajouter un acteur.

Details

<readonly> canClearActors :boolean

Description

Pour savoir s'il est possible de retirer tous les acteurs.

Details

<readonly> canRemoveActor :boolean

Description

Pour savoir s'il est possible de retirer un acteur.

Details

<readonly> childSetups :Array.<JSON.ActorSetup>

Description

Obtient les setups des acteur enfants.

Details

<readonly> childUis :Array.<Actor.BaseActor>

Description

Obtient les acteurs enfants.

Details

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

<readonly> dataContextualParent :any

Description

Parent de donnée qui participe au ruissellement.

Details

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

Description

Obtient les magasins de données de la synapp.

Details

<readonly> events' :Object

Description

Obtient les évènements

Details

<readonly> inBindingsRegister :Register

Description

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

Details

<readonly> inheritedDataContext :any

Description

Contexte de donnée ruisselé.

Details

<readonly> isDataContextual :Boolean

Description

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

Details

<readonly> isDestroyed :Boolean

Description

Vrai quand l'acteur est détruit.

Details

<readonly> isDestroying :Boolean

Description

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

Details

<readonly> isLeadActor :Boolean

Description

Est-ce un acteur principal ?

Details

<readonly> isParent :boolean

Description

Toujours vrai pour un parent.

Details

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

Details

<readonly> leadActor :Actor.BaseActor

Description

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

Details

<readonly> parent :Actor.BaseActor

Description

Acteur parent.

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

Details

<readonly> properties :Actor.Layout.StackProperties

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.

Details

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

Details

<readonly> stage :Stage

Description

Scene ou Composite parent directe de l'acteur.

Details

<readonly> styleName :String

Description

Le nom du style de l'acteur.

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

Details

<readonly> synapp :Synapps.Synapp

Description

Obtient la Synapp.

Details

<readonly> type :string

Description

Type de l'acteur.

Details

<readonly> uniqClass :string

Description

Classe CSS unique de l'acteur.

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

Details

<readonly> uniqPath :string

Description

Chemin unique de l'acteur.

Details

Methods

<async> addActor( actorSetup [, atIndex ] ) → {Promise.<Actor.BaseActor>}

Description

Ajoute un acteur enfant.
L'acteur est ajouté à la fin de la liste si atIndex n'est pas renseigné.
Note: C'est le seul moyen de créer un acteur.

Parameters

Name	Type	Attributes	Description
`actorSetup`	JSON.ActorSetup		Setup JSON de l'acteur à ajouter.
`atIndex`	Number	<optional>	Position à laquelle l'acteur doit être ajouté.

Returns

Details

<async> addActors( actorSetups ) → {Promise.<Array.<Actor.BaseActor>>}

Description

Ajoute une collection d'acteurs enfants.
Les acteurs sont ajoutés à la fin de la liste.

Parameters

Name	Type	Description
`actorSetups`	Array.<JSON.ActorSetup>	Tableau des Setups JSON des acteurs à ajouter.

Returns

Details

changeStyleName( styleName )

Description

Changer le nom du style de l'acteur.

Parameters

Name	Type	Description
`styleName`	String	Nom du style à appliquer.

Details

<async> clearActors()

Description

Retire tous les acteurs enfants.

Details

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

Parameters

Name	Type	Description
`key`	*	Clé unique.
`setup`	*
`saveInSetup`	*

Returns

Details

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

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.

Details

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

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

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' }
```

Details

getActor( key ) → {Actor.BaseActor}

Description

Obtient un acteur enfant par sa clé.

Parameters

Name	Type	Description
`key`	String \| null	Clé de l'acteur à trouver.

Returns

Details

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

Details

moveDownActor( key )

Description

Déplace vers le bas un acteur enfant obtenu par sa clé.

Parameters

Name	Type	Description
`key`	String	Clé de l'acteur enfant à déplacer.

Details

moveUpActor( key )

Description

Déplace vers le haut un acteur enfant obtenu par sa clé.

Parameters

Name	Type	Description
`key`	String	Clé de l'acteur enfant à déplacer.

Details

removeAccessory( key )

Description

Suppression d'un accessoire

Parameters

Name	Type	Description
`key`	string

Details

<async> removeActor( actorKey )

Description

Retire un acteur enfant.

Parameters

Name	Type	Description
`actorKey`	String	Clé de l'acteur enfant à retirer.

Details

removeBinding( targetValuePath )

Description

Suppression d'une liaison sur un chemin cible.

Parameters

Name	Type	Description
`targetValuePath`	string	Chemin vers la cible de la liaison

Details

removeEvent( eventName )

Description

Supprime un évènement dans les events.

Parameters

Name	Type	Description
`eventName`	String	Nom de l'évènement à supprimer.

Details

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

Details

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

Details

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

Details

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

Details

onClick

Description

Se produit au clic sur acteur.

Parameters

Name Type Description

context

Actor.Layout.Stack

new Stack()

Description

Details

Members

<readonly> accessories :Object

Description

Details

<readonly> actor :Element

Description

Details

<readonly> additionals :Synapps.PrototypedBase

Description

Details

<readonly> BaseAccessory :BaseAccessory

Description

Details

<readonly> canAddActor :boolean

Description

Details

<readonly> canClearActors :boolean

Description

Details

<readonly> canRemoveActor :boolean

Description

Details

<readonly> childSetups :Array.<JSON.ActorSetup>

Description

Details

<readonly> childUis :Array.<Actor.BaseActor>

Description

Details

dataContext :any

Description

Details

<readonly> dataContextualParent :any

Description

Details

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

Description

Details

<readonly> events' :Object

Description

Details

<readonly> inBindingsRegister :Register

Description

Details

<readonly> inheritedDataContext :any

Description

Details

<readonly> isDataContextual :Boolean

Description

Details

<readonly> isDestroyed :Boolean

Description

Details

<readonly> isDestroying :Boolean

Description

Details

<readonly> isLeadActor :Boolean

Description

Details

<readonly> isParent :boolean

Description

Details

<readonly> key :string

Description

Details

<readonly> leadActor :Actor.BaseActor

Description

Details

<readonly> parent :Actor.BaseActor

Description

Details

<readonly> properties :Actor.Layout.StackProperties

Description

<readonly> rootScene :Synapps.Scene

Description

Details

<readonly> scene :Synapps.Scene

Actor .Layout.Stack