new SpwBaseTemplatedWidget()
- Source:
Héritage
Overview
Membres
-
_loadingPane :dijit/layout/ContentPane
-
Référence vers le loader du widget.
Type:
- dijit/layout/ContentPane
- Inherited From:
- Source:
-
_panel :dojox/layout/FloatingPane
-
[pré-requis : position = panel OR panel-light]. Référence vers l'objet "fenêtre".
Type:
- dojox/layout/FloatingPane
- Inherited From:
- Source:
-
activated :Boolean
-
Détermine si le widget est activé ou non lors de chargement du GeoViewer
Type:
- Boolean
- Inherited From:
- Source:
-
closable :Boolean
-
Indique si le widget peut être fermé par l'utilisateur.
Type:
- Boolean
- Inherited From:
- Source:
-
defaultSelected :Boolean
-
Permet de définir si le widget sera celui sélectionné par défaut dans une même région contenant plusieurs widgets.
Type:
- Boolean
- Inherited From:
- Source:
-
floatingConfig :Object
-
[pré-requis : position = floating]. Positionne le widget sur la carte.
Type:
- Object
- Inherited From:
- Source:
Propriétés:
Nom Type Description floatingConfig.open
String distance par rapport au dessus de la carte floatingConfig.width
String distance par rapport au dessus de la carte floatingConfig.minWidth
String distance par rapport au dessus de la carte floatingConfig.pinned
String distance par rapport au dessus de la carte floatingConfig.pinnable
String distance par rapport au dessus de la carte floatingConfig.unpinnedCloseTimeout
String distance par rapport au dessus de la carte -
height :String
-
[pré-requis : position = panel OR panel-light]. Hauteur de la fenêtre. Exemple : "300px" ou "50%".
Type:
- String
- Inherited From:
- Source:
-
helpContent :String
-
Contenu de la bulle d'aide en HTML, null si aucune aide ne doit être affichée
Type:
- String
- Inherited From:
- Source:
-
iconClass :String
-
[pré-requis : inToolbar = true]. Classe css de l'icone à appliquer pour ce widget dans la toolbar (propriété background-image, dimension image 16px*16px).
Type:
- String
- Inherited From:
- Source:
-
imagesPath
-
Lien vers le répertoire "images" du widget. Ce dossier doit se trouver dans le même répertoire que le fichier du widget.
- Inherited From:
- Source:
-
inToolbar :Boolean
-
Détermine si le widget a un bouton d'activation/désactivation dans la toolbar.
Type:
- Boolean
- Inherited From:
- Source:
-
isOneShot :Boolean
-
[pré-requis : inToolbar = true]. Détermine si la widget est uniquement activable et non désactivable.
Type:
- Boolean
- Inherited From:
- Source:
-
left :String
-
[pré-requis : position = panel OR panel-light]. Distance par rapport à la gauche du container. Exemple : "300px" ou "50%".
Type:
- String
- Inherited From:
- Source:
-
mapPosition :Object
-
[pré-requis : position = map]. Positionne le widget sur la carte.
Type:
- Object
- Inherited From:
- Source:
Propriétés:
Nom Type Description mapPosition.top
String distance par rapport au dessus de la carte mapPosition.bottom
String distance par rapport au bas de la carte mapPosition.left
String distance par rapport à la gauche de la carte mapPosition.right
String distance par rapport à la droite de la carte -
maxable :Boolean
-
[pré-requis : position = panel OR panel-light]. Indique si la fenêtre est maximizable par l'utilisateur (prends toute la taille du container).
Type:
- Boolean
- Inherited From:
- Source:
-
maximized :Boolean
-
[pré-requis : position = panel OR panel-light]. Indique si la fenêtre est maximizée.
Type:
- Boolean
- Inherited From:
- Source:
-
openPanelOnActivate :Boolean
-
Indique si la fenêtre contenant le widget s'ouvre lors de l'activation de ce dernier.
Type:
- Boolean
- Inherited From:
- Source:
-
orderInRegion :Number
-
Permet de définir l'ordre du widget au sein d'une même région (propriété "position").
Type:
- Number
- Inherited From:
- Source:
-
position :String
-
Permet de définir le positionnement du widget. Les régions possibles sont : "none", "left", "right", "top", "bottom", "map", "panel", "panel-light", "floating", "toolbar", "left-top", "left-bottom", "right-top", "right-bottom", "top-left", "top-right", "bottom-left", "bottom-right", "center".
Type:
- String
- Inherited From:
- Source:
-
reactive :Boolean
-
[pré-requis : position = panel OR panel-light]. Indique si la fenêtre est "réactive". Dans ce cas, la fenêtre est légèrement transparente et devient opaque lorsque l'utilisateur passe son curseur au dessus.
Type:
- Boolean
- Inherited From:
- Source:
-
resizable :Boolean
-
[pré-requis : position = panel OR panel-light]. Indique si la fenêtre est redimensionnable par l'utilisateur.
Type:
- Boolean
- Inherited From:
- Source:
-
showOnActivate :Boolean
-
Indique si la le widget s'affiche lors de l'activation de ce dernier. Ne fonctionne pas avec la position "panel", voir openPanelOnActivate. Il est alors à la charge du widget de s'afficher via l'appel à la méthode "show()".
Type:
- Boolean
- Inherited From:
- Source:
-
showTitleInRegion :String
-
Permet d'afficher le titre du widget (widgetTitle) dans la région (left ou right) si ce dernier est seul et si widgetTitle est défini.
Type:
- String
- Inherited From:
- Source:
-
solitary :Boolean
-
[pré-requis : inToolbar = true]. Détermine si l'activation de ce widget désactive les autres widgets actif de la toolbar.
Type:
- Boolean
- Inherited From:
- Source:
-
spwViewer :spw.api.SpwViewer
-
Référence vers l'instance unique du Viewer.
Type:
- Inherited From:
- Source:
-
toolBarButton :dijit/form/ToggleButton
-
Référence vers le bouton dans la toolbar.
Type:
- dijit/form/ToggleButton
- Inherited From:
- Source:
-
toolBarIndex :Number
-
Index d'ordre d'affichage du bouton dans la toolbar.
Type:
- Number
- Inherited From:
- Source:
-
top :String
-
[pré-requis : position = panel OR panel-light]. Distance par rapport au dessus du container. Exemple : "300px" ou "50%".
Type:
- String
- Inherited From:
- Source:
-
widgetsInTemplate :Boolean
-
Tous les templates acceptent les widgets
Type:
- Boolean
- Source:
-
widgetTitle :String
-
Titre du widget
Type:
- String
- Inherited From:
- Source:
-
width :String
-
[pré-requis : position = panel OR panel-light]. Largeur de la fenêtre. Exemple : "300px" ou "50%".
Type:
- String
- Inherited From:
- Source:
Méthodes
-
_createLoadingPane()
-
Crée le contentPane contenant le loader du widget.
- Inherited From:
- Source:
-
blockClosing()
-
Bloque la fermeture du widget
- Inherited From:
- Source:
-
destroy()
-
Appelé à la destruction du widget
- Inherited From:
- Source:
-
displayInFloating()
-
Affiche le widget dans un conteneur flottant
- Inherited From:
- Source:
-
displayInPanel()
-
Affiche le widget dans une fenêtre.
- Inherited From:
- Source:
-
hide()
-
Permet de cacher la fenêtre contenant le widget sans pour autant la fermer et désactiver le widget.
- Inherited From:
- Source:
-
hideLoading()
-
Cache le loader du widget.
- Inherited From:
- Source:
-
onActivate(selected)
-
Méthode appelée à l'activation du widget. C'est dans cette méthode que s'effectue le positionnement du widget en fonction de son attribut "position". De plus, elle maintient l'état de la propriété "ativated" et gère l'affichage du bouton dans la toolbar si applicable.
Paramètres:
Nom Type Description selected
Boolean détermine si le widget doit être sélectionné si plusieurs widget sont présents dans la même région. - Inherited From:
- Source:
-
onClose()
-
Méthode callback appelée à la fermeture de la fenêtre. Par défaut, cache la fenêtre et appel la méthode deactivate() du widget.
- Inherited From:
- Source:
-
onDeactivate()
-
Méthode appelée à la désactivation du widget. Elle maintient l'état de la propriété "activated", synchronise le bouton dans la toolbar si applicable et retire le widget du viewer.
- Inherited From:
- Source:
-
overrideForMultipleScreens()
-
Configuration particulière pour le mode double écran
- Inherited From:
- Source:
-
postCreate()
-
Appelé après la création du widget
- Inherited From:
- Source:
-
show(forceSelect)
-
Montre la fenêtre contenant le widget et l'amène au premier plan.
Paramètres:
Nom Type Description forceSelect
Boolean détermine si le widget doit être sélectionné si plusieurs widget sont présents dans la même région. - Inherited From:
- Source:
-
showLoading()
-
Affiche le loader du widget.
- Inherited From:
- Source:
-
unblockClosing()
-
Débloque la fermeture du widget
- Inherited From:
- Source: