custom:api_js_closegwcontainer [GeowebFramework]

Questa pagina è in sola lettura. Puoi visualizzare il sorgente, ma non puoi modificarlo. Contatta l'amministratore se pensi che ci sia un errore.
====== Chiusura generica componente - closeGwContainer() ======
E' una function di utilità che serve per chiudere iL contenitore di un qualsiasi componente aperto con le API javascript di Geoweb.
Esso prende in ingresso un solo parametro, gwContainerRef, che in qualche modo referenzia il contenitore che deve essere chiuso.
Sono supportate le seguenti modaltà di referenziazione del container da chiudere:
  * **widget**, Object, istanza di una classe dojo o derivata del contenitore da chiudere (gwContainer). In generale, un qualsiasi metodo di apertura tab/dialog in Geoweb, è una function con nome aderente al pattern: //open[Content-Type][Container-Type]()// (Esempio: //openGwClassDetailTab()//). L'invocazione di una qualsiasi di queste function, restituisce l'istanza del contenitore appena aperto, e può essere in seguito usata come parametro per invocare la function di chiusura closeGwContainer().
  * **id**, String, id globale del widget. Se il contenitore era stato aperto tramite API js, questo è il contenuto della proprietà //id// (Esempio: //gwContainer.id//). In caso di gwContainer dichiarati declarativamente in file .jsp contenuti in plugin custom (o comunque sia hard-coded), id è il contenuto dell'attribute //data-dojo-id=""// o dell'attribute //id=""// del tag declarativo del gwContainer
  * **dom node**, //domNode// del componente. Ottenibile in varia maniera gwContainer.domNode, o come risultato dell'invocazione della funzione di query su nodi dom di dojo (Esempio: //var domNode = query('.myGwContainerCustomClass', restrictionDomNode)[0];// )

===== Esempi =====
Chiudere un container data l'istanza:
<code>
var gwContainer = openXY(); //gwContainer opened using one of the open[Content-Type][Container-Type]() js API
..
closeGwContainer(gwContainer);
</code>
Chiudere un container dato l'id:
<code>
var gwContainerId = gwContainer.id;
closeGwContainer(gwContainerId);
</code>
Chiudere un container dato il nodo dom:
<code>
var gwContainerDomNode = gwContainer.domNode;
closeGwContainer(gwContainerDomNode);
</code>

<code>
//when the gwContainer is marked with 'myGwContainerCustomClass' as html class
require(['dojo/query'], function(query){
..
	var domNode = query('.myGwContainerCustomClass', optionalRestrictionDomNode)[0];
	closeGwContainer(domNode);
..
});
</code>