Indice

Creazione di un gwWidget

Supponiamo di voler creare un nuovo widget di Geoweb: NeoWidget. Ecco i passi necessari:

Creazione class Java

Per prima cosa serve una class Java che definisca le caratteristiche del widget. Questa deve: 

     package com.geowebframework.transfer.model.widget;
     ...
     @XStreamAlias("NeoWidget")
     public class NeoWidget extends WidgetBase { 
         @XStreamOmitField public final static int CTRL_TYPE = 1000; //unique
         private String customProperty;
         public NeoWidget () {
             super();
         }
         ...
         //setters and getters customProperty, and eventual ovverrides
       }

Al bisogno si possono ovviamente fare gli override di variabili e metodi della superclasse. La classe puo trovarsi in un package qualsiasi. Per convenzione, i widget del modulo base di Geoweb, sono posizionati sotto com.geowebframework.tranfer.model.widget. In caso di widget definito dentro un plugin la convenzione è di metterlo sotto com.geowebframework.plugin_name.model.widget.

Per la scelta del CTRL_TYPE di widget sul modulo base, aumentare di 1 unita il valore presente nella riga commentata / / max ctrlTypeStandard=X, ed aggiornarlo.Per i widget dei plugin esistono intere serie dedicate (Es: 100-199 per plugin gwenterprice[ex calendar]; 200-299 per plugin ThreeDVisualizer). Comunque sia in caso si stia tentando di gestrare un widget con un CTRL_TYPE gia usato, viene generata un'opportuna eccezione.

Registrazione del gwWidget

Una volta creata la class del widget, dobbiamo registrarlo in un'apposita class di registro: gwRegistry. 

     @Autowired
     private GwRegistry gwRegistry;
     ...
     gwRegistry.registerWidget(
         new CtrlTypeInfo(
             NeoWidget.CTRL_TYPE, "NeoWidget", "NEO_WIDGET",
             com.geowebframework.transfer.model.widget.NeoWidget.class,
             "neoWidgetVisualize","neoWidgetEdit",
             new Boolean(false), new Boolean(false), 650, 300
         ),
         new ArrayList<GwAttributeDataType>(
             Arrays.asList(new GwAttributeDataType[]GwAttributeDataType.UNDEFINED}))
         )
     );

Questo viene fatto tramite il metodo registerWidget(CtrlTypeInfo ctrlTypeInfo, ArrayList<GwAttributeDataType> relatedDataType). Questo ha due argomenti:

I widget del progetto base (webclient) di Geoweb vengono registrati dentro il costruttore di gwRegistry. Se il widget sta invece in un plugin di Geoweb tale operazione va fatta in una class java di servizio annotata @Service, precisamente in un metodo annotato @PostConstruct. [La covenzione è che il nome della classe sia camelCase(nome_plugin)+“InitializerService”, ed la signature del metodo sia public void init()]. 

     @Service
     public class NameOfPluginInitializerService{
         ...
         @PostConstruct
         public void init(){
             ...
         }
     }

Creazione pagine .jsp di visualizzazione e di modifica

E' necessario ora creare le pagine detailJspName e editJspName dichiarate nel costructor del CtrlTypeInfo alla registrazione del widget. Il contenuto di tali pagine jsp è libero, ma sono considerate buone prassi:

Aggiunta eventuali risorse .css e .js usate nelle .jsp

Per il modulo base le classi css sono generalmente poste sotto il file /css/gwClassDetail.css, mentre i js sono sparsi in vari file, essendo richiamate spesso function di carattere generale. Per quanto riguarda risorse .css e .js ad uso esclusivo di un plugin, esistono due metodi di utilità per importarele in automatico. Metodi che vanno in fase di inizializzazione del plugin. 

   @Service
   public class NameOfPluginInitializerService{
       ...
       @PostConstruct
       public void init(){
       ...
           gwRegistry.addJsResource("debug/js/plugin.js");
           gwRegistry.addCssResource("css/pluginRules.css");
       }
    }

Le risorse importate in tale modo vengono aggiunte all'inizio all'apertura del progetto Geoweb. Vengono però aggiunte solo dopo le risorse usate dal modulo base (e dopo il caricamento del modulo dojo, per quanto concerne i js).

Creazione eventuali Controller java di supporto

In generale un widget non ha bisogno di Controller java per il suo funzionamento. Talvolta capita che un widget, per necessità di recuperare ulteriori dati, sia costretto a fare un passaggio lato server per poter renderizzare una qualche sua parte. Tali controller sono per convenzione messi in apposite classi sotto com.geowebframework.webclient.controller.widget per il modulo base, mentre com.geowebframework.plugin_name.controller.widget per i plugin.

Integrare il widget nelle logiche del gwClassDetail

I passi necessari sono:

Tutti questi passaggi sono trattati nello specifico qui: EventAttributes Guidelines