.. _tablehandler/ViewResource/base_hooks/th_options_method:

Metodo th_options
=================




Opzioni che regolano il comportamento
-------------------------------------

Il metodo th_options permette di gestire una serie di comportamenti relativi al comportamento della griglia. I parametri sono dei più disparati, ma possono essere raggruppati nelle seguenti categorie:

1) caricamento dei dati (virtualStore, limit, liveUpdate)

2) modalità di lettura dei record (widget, readOnly, dialog_parentRatio)

3) comportamento della *toolbar* (fileImport, addrow, extendedQuery)

La sintassi del metodo è la seguente::

  def th_options(self):
        return dict(virtualStore=False, liveUpdate=True, widget='dialog')

Si segnala che tutti i parametri che possono essere utilizzati all'interno del metodo th_options possono essere **passati anche direttamente** quando si utilizzano i vari  :ref:`Tipi di Tablehandler<tablehandler/tipi_tablehandler>` . Quindi ad esempio::

  dialogTableHandler(relation='@mu_tracks_albumid', liveUpdate=True)

permetterà di attivare il *liveUpdate* anche se nella risorsa invocata dalla relazione questo non è utilizzato nel th_options. Questo permette di personalizzare notevolmente le varie risorse a seconda delle pagine in cui vengono utilizzate.

Si riportano a titolo esemplificativo i principali parametri e le loro modalità di utilizzo.

.. raw:: html

 <hr>

**Parametri:**

+------------------------+------+--------------------------------------------------+
|     Nome parametro     | Tipo |                   Descrizione                    |
+========================+======+==================================================+
|addrow                  |B     |Se impostato a "False", viene disattivata la      |
|                        |      |possibilità di aggiungere un ulteriore record     |
|                        |      |tramite il pulsante +. Se impostato a "auto"      |
|                        |      |permette invece l'inserimento di record in serie  |
|                        |      |con il tabulatore.                                |
+------------------------+------+--------------------------------------------------+
|delrow                  |B     |Se impostato a "False", viene disattivata la      |
|                        |      |possibilità di rimuovere i record tramite il      |
|                        |      |pulsante -                                        |
+------------------------+------+--------------------------------------------------+
|searchOn                |B     |Se impostato a "False" disabilita la casella di   |
|                        |      |testo per effettuare la ricerca quando questa è   |
|                        |      |già in sostituzione alla query classica (es:      |
|                        |      |quando virtualStore=False)                        |
+------------------------+------+--------------------------------------------------+
|extendedQuery           |B     |Se impostato a "True" disabilita nella view la    |
|                        |      |funzione di export, import, stampe, invio mail,   |
|                        |      |lasciando solo le funzionalità legate alla query  |
+------------------------+------+--------------------------------------------------+
|widget                  |T     |Se impostato a "stack" si aprirà nella stessa     |
|                        |      |finestra; "dialog" visualizzerà i record in una   |
|                        |      |finestra di dialogo; "palette" in una finestra di |
|                        |      |dialogo in cui è però ancora possibile selezionare|
|                        |      |i record con la finestra aperta; "border" in una  |
|                        |      |schermata sottostante la view; "page" in una nuova|
|                        |      |pagina.                                           |
+------------------------+------+--------------------------------------------------+
|dialog_parentRatio      |T     |Permette di esprimere la grandezza della finestra |
|                        |      |di dialogo in percentuale rispetto alla finestra  |
|                        |      |genitore                                          |
+------------------------+------+--------------------------------------------------+
|groupable               |B     |Di default True, se impostato a False permette di |
|                        |      |disattivare la Grouped View                       |
+------------------------+------+--------------------------------------------------+
|grid_autoSelect         |B     |Se impostato a True, verrà selezionato            |
|                        |      |automaticamente il primo record al caricamento    |
+------------------------+------+--------------------------------------------------+
|grid_rowCustomClassesCb |T     |Permette di aggiungere un DataController per      |
|                        |      |assegnare una classe css personalizzata alla riga |
|                        |      |al verificarsi di particolari condizioni          |
+------------------------+------+--------------------------------------------------+
|grid_showLineNumber     |B     |Se impostato a True permette di aggiungere        |
|                        |      |all'inizio della view una colonna con un contatore|
|                        |      |progressivo delle righe                           |
+------------------------+------+--------------------------------------------------+
|grid_selfDragRows       |B     |Se impostato a True permette il trascinamento     |
|                        |      |delle righe per ordinarle in modo personalizzato  |
+------------------------+------+--------------------------------------------------+
|grid_footer             |B     |Se impostato a False il footer della griglia verrà|
|                        |      |nascosto                                          |
+------------------------+------+--------------------------------------------------+
|view_preview_tpl        |T     |Permette di indicare un template da utilizzare per|
|                        |      |le righe della vista (es:                         |
|                        |      |view_preview_tpl='cliente_row'). Può anche essere |
|                        |      |omesso, in quel caso verrà usato di default il    |
|                        |      |template denominato "preview.xml"                 |
+------------------------+------+--------------------------------------------------+
|isMain                  |T     |Nel caso di presenza di più th_struct permette di |
|                        |      |stabilire quella di default                       |
+------------------------+------+--------------------------------------------------+
|hardQueryLimit          |L     |Permette di indicare un limite massimo di record  |
|                        |      |visualizzabili nella griglia (es:                 |
|                        |      |hardQueryLimit=1000)                              |
+------------------------+------+--------------------------------------------------+
|liveUpdate              |B     |Permette di forzare l'aggiornamento della         |
|                        |      |schermata (e dei relativi dati al suo interno)    |
|                        |      |automaticamente al caricamento                    |
+------------------------+------+--------------------------------------------------+
|partitioned             |B     |Se impostata a "True" permette di attivare il     |
|                        |      |partizionamento della tabella. Per funzionare     |
|                        |      |dovranno essere state precedentemente effettuate  |
|                        |      |le opportune modifiche al model                   |
+------------------------+------+--------------------------------------------------+
|readOnly                |B     |Se impostato a "True" renderà i record di sola    |
|                        |      |lettura e quindi la form non sarà editabile ma di |
|                        |      |sola visualizzazione.                             |
+------------------------+------+--------------------------------------------------+
|virtualStore            |B     |Se impostato a "False" scomparirà il bottone per  |
|                        |      |il lancio della query che verrà avviata           |
|                        |      |automaticamente e i dati saranno caricati tutti   |
|                        |      |simultaneamente.                                  |
+------------------------+------+--------------------------------------------------+
|excludeDraft            |B     |Di default False, se impostato a True permette di |
|                        |      |includere nella vista anche i record in status    |
|                        |      |Bozza                                             |
+------------------------+------+--------------------------------------------------+
|excludeLogicalDeleted   |B     |Di default True, se impostato a False permette di |
|                        |      |includere nella vista i record archiviati         |
+------------------------+------+--------------------------------------------------+

.. sectionauthor:: Valter Vettorello