Class: spw.api.SpwWidgetsManager

▲

Description

Cette classe est un singleton et permet d'instancier les widgets déclarés dans le fichier widgets.json. De plus, elle offre des méthode permettant d'accéder aux widgets.

new SpwWidgetsManager()

Source:

Overview

MembresMéthodes

Membres

<private> _widgets :spw.api.SpwBaseWidget[]

Tableau des différents outils chargés
Type:
  • spw.api.SpwBaseWidget[]
Source:

spwViewer

Référence vers le viewer.
Source:

widgetClassesLoaded :Boolean

Indique si toutes les classes des widgets sont chargées.
Type:
  • Boolean
Source:

widgetsCreated :Boolean

Indique si tous les widgets sont instanciés.
Type:
  • Boolean
Source:

Méthodes

calculateToolbarIndexes()

Calcul l'index de position dans la toolbar pour les widgets placés dans la toolbar.
Source:

destroy()

Appelé à la destruction du Manager
Source:

destroyWidgets()

Détruit tous les widgets du viewer.
Source:

getWidget(id)

Accède à un widget sur base de son id
Paramètres:
Nom Type Description
id l'id du widget auquel accéder
Source:

getWidgets(queryObject) → {Array}

Récupère le(s) widget(s) sur base d'un objet clé-valeur. Par exemple: récupérer les widgets actifs : getWidgets({activated:true}) ; récupérer un widget par son id : getWidgets({widgetId:'monWidget'}); ... Toutes les propriétés d'un widget peuvent être interrogées via ce query object. Un Query object vide ({}) permet de récupérer tous les widgets.
Paramètres:
Nom Type Description
queryObject
Source:
Retourne:
Tableau contenant les widgets correspondants à la query.
Type
Array

instanciateWidget(w)

Instancie un widget
Paramètres:
Nom Type Description
w le widget à créer
Source:

instanciateWidgets()

Instancie les widgets chargés.
Source:

loadWidgetClasses()

Charge dynamiquement les classes (code javascript) des widgets déclarés dans widgets.json.
Source:

Evènements

widgetClassesLoaded

Les classes des widgets présents dans la configuration (widgets.json) sont chargées (!= instanciées).
Source:

widgetsCreated

Les widgets sont créés et placé dans le Viewer.
Source: