gwClassDetail funzioni esposte

Il gwClassDetail rappresenta il dettaglio di classe. In qualunque forma esso sia aperto (tab, dialog, floatingPane), l'oggetto dojo contenitore del gwClassDetail (AKA detailContainer) espone tutta una serie di function di utilità, che servono per interagire con il gwClassDetail o conoscerne lo stato corrente.

• getGwWidgets()
• getGwWidget()
• setFormValues()
• getFormValues()
• getFormValuesWithGwidAsKey()
• getFormValuesToShow()
• createMapWithGwidAsKey()
• createMapWithNameAsKey()
• isSomeFormValueChanged()
• hideGwActionInToolbarButton()
• showGwActionInToolbarButton()
• disableGwActionInToolbarButton()
• enableGwActionInToolbarButton()
• isGwFormValid()
• notifyGwFormNotValidToUser()
• validateGwForm()

Ritorna un array di oggetti gwWidget (array vuoto, [], nel caso niente venga trovato). Di norma la ricerca viene effettuata solo all'interno dei dettagli di classe dove detailMode=='edit'. Si può opzionalmente includere nella ricerca anche i widget contenuti dentro i dettagli di classe dove detailMode=='visualization', agendo sul flag includeAll.

• params: Object, richiesto. Oggetto contenente le seguenti proprietà:
  • name: String, optionale. Il name del gwAttribute collegato al gwWidget. Se fornito è usato come criterio di ricerca. Se omesso, verrà ritornato il primo widget disponibile.
  • gwid: Integer, optionale. Il gwid del gwAttribute collegato al gwWidget. Se fornito è usato come criterio di ricerca. Se omesso, verrà ritornato il primo widget disponibile.
  • includeAll: Boolean, optionale, default false. Se posto a true, includere nella ricerca anche i widget contenuti dentro form di classe dove detailMode=='visualization'.
  • queryContext: String|domNode, optionale, default null. Se fornito questo verrà usato come nodo di restrizione per eseguire la query. (Usato internamente a Geoweb per il funzionamento delle schede Procedure del workflow.

Recupera tutti i widget in edit del gwClassDetail

var widgets = detailContainer.getGwWidgets();

Recupera tutti i widget del gwClassDetail, cercando anche fra quelli contenuti in form di classe dove detailMode=='visualization'.

var widgets = detailContainer.getGwWidgets({includeAll: true});

Ritorna un singolo gwWidget (array vuoto, [], nel caso niente venga trovato). Di norma la ricerca viene effettuata solo all'interno dei dettagli di classe dove detailMode=='edit'. Si può opzionalmente includere nella ricerca anche i widget contenuti dentro i dettagli di classe dove detailMode=='visualization', agendo sul flag includeAll.

• params: Object, richiesto. Oggetto contenente le seguenti proprietà:
  • name: String, optionale. Il name del gwAttribute collegato al gwWidget. Se fornito è usato come criterio di ricerca. Se omesso, verrà ritornato il primo widget disponibile.
  • gwid: Integer, optionale. Il gwid del gwAttribute collegato al gwWidget. Se fornito è usato come criterio di ricerca. Se omesso, verrà ritornato il primo widget disponibile.
  • includeAll: Boolean, optionale, default false. Se posto a true, includere nella ricerca anche i widget contenuti dentro form di classe dove detailMode=='visualization'.
  • queryContext: String|domNode, optionale, default null. Se fornito questo verrà usato come nodo di restrizione per eseguire la query. (Usato internamente a Geoweb per il funzionamento delle schede Procedure del workflow.

Recupera il primo widget trovato in edit del gwClassDetail.

var widget = detailContainer.getGwWidget({name: 'gw_attribtue_name'});

Recupera il primo widget trovato del gwClassDetail, cercando anche fra quelli contenuti in form di classe dove detailMode=='visualization'.

var widget = detailContainer.getGwWidget({name: 'gw_attribtue_name', includeAll: true);

Ritorna un singolo gwWidget (array vuoto, [], nel caso niente venga trovato). Di norma la ricerca viene effettuata solo all'interno dei dettagli di classe dove detailMode=='edit'. Si può opzionalmente includere nella ricerca anche i widget contenuti dentro i dettagli di classe dove detailMode=='visualization', agendo sul flag includeAll.

• mapWithNameAsKey: Object, richiesto. Oggetto mappa che ha per chiavi i name dei gwAttribute e valori i valori da settare nelle form di dettaglio di classe

detailContainer.setFormValues({attr_name_1: 'value1', attr_name_2: 2: attr_name_3: new Date()});

Ritorna una Object javascript che ha per chiavi i name dei gwAttribute e valori i valori attualmente presenti nelle form di dettaglio di classe

• onlyModified: Boolean, opzionale, default true. Se posto a true viene ritornata una mappa contenente solo i valori dei gwWidget che sono stati modificati

var onlyModified = true;
var formValues = detailContainer.getFormValues(onlyModified);
var attr_1_value = formValue.attr_1_name; //if 'attr_1_name' is the name of a gwAttribute inside the form

Ritorna una Object javascript che ha per chiavi i gwid dei gwAttribute e valori i valori attualmente presenti nelle form di dettaglio di classe

• onlyModified: Boolean, opzionale, default true. Se posto a true viene ritornata una mappa contenente solo i valori dei gwWidget che sono stati modificati

var onlyModified = true;
var formValues = detailContainer.getFormValuesWithGwidAsKey(onlyModified);
var attr_1_value = formValue.attr_1_name; //if 'attr_1_name' is the name of a gwAttribute inside the form

Ritorna una Object javascript che ha per chiavi i name dei gwAttribute e valori i valueToShow attualmente presenti nelle form di dettaglio di classe. In alcuni widget valueToShow, valore in visualizzazione, si differenzia dal valueToStore, valore da persistere. Negli altri widget, non c'è tale distinzione ed i due coincidono in value.

• onlyModified: Boolean, opzionale, default true. Se posto a true viene ritornata una mappa contenente solo i valori dei gwWidget che sono stati modificati

var onlyModified = true;
var formValuesToShow= detailContainer.getFormValuesToShow(onlyModified);
var attr_1_valueToShow = formValuesToShow.attr_1_name; //if 'attr_1_name' is the name of a gwAttribute inside the form

Ritorna una Object javascript che ha per chiavi i name dei gwAttribute e valori gli stessi valori dell' Object javascript in ingresso (indicizzato per gwid).

• nameAsKeyMap: Boolean, richiesto. Object javascript, mappa chiave valore, che ha per chiavi i name dei gwAttribute

var nameAsKeyMap = {
	attr_1_name: 'value1',
	attr_2_name: 2,
	attr_3_name: new Date()
};
var gwidAsKeyMap = detailContainer.createMapWithGwidAsKey(nameAsKeyMap);

Ritorna una Object javascript che ha per chiavi i gwid dei gwAttribute e valori gli stessi valori dell' Object javascript in ingresso (indicizzato per name).

• gwidAsKeyMap: Boolean, richiesto. Object javascript, mappa chiave valore, che ha per chiavi i gwid dei gwAttribute

var gwidAsKeyMap = {
	123: 'value1', //123 is attr_1_gwid
	456: 2, //456 is attr_2_gwid
	789: new Date() //789 is attr_3_gwid
};
var nameAsKeyMap = detailContainer.createMapWithGwidAsKey(gwidAsKeyMap);

Ritorna true se il dettaglio corrente ha subito dei cambiamenti negli input delle form, ad opera dell'utente od automatismi, false altrimenti.

var isSomeFormValueChanged = detailContainer.isSomeFormValueChanged();

Dato il name della gwAction, nasconde il button corrispondente.

• gwActionName: String, richiesto. Il name della gwAction del gwActionButton

var gwActionName = 'gw_action_name';
detailContainer.hideGwActionInToolbarButton(gwActionName);

Dato il name della gwAction, mostra il button corrispondente.

• gwActionName: String, richiesto. Il name della gwAction del gwActionButton

var gwActionName = 'gw_action_name';
detailContainer.showGwActionInToolbarButton(gwActionName);

Dato il name della gwAction, disabilita il button corrispondente.

• gwActionName: String, richiesto. Il name della gwAction del gwActionButton

var gwActionName = 'gw_action_name';
detailContainer.disableGwActionInToolbarButton(gwActionName);

Dato il name della gwAction, abilita il button corrispondente.

• gwActionName: String, richiesto. Il name della gwAction del gwActionButton

var gwActionName = 'gw_action_name';
detailContainer.enableGwActionInToolbarButton(gwActionName);

Ritorna un true se tutti gli eventuali gwForms nel detailContainer passano la validazione

var isValid = detailContainer.isGwFormValid();
if(isValid){
	//do stuff
}

Notifica il gwUser riguardo ai widget che non hanno passato la validazione. La notifica comprende:

• evidenziare di rosso (contorno del widget) tutti i widget required non valorizzati
• In caso di una struttura di layout complessa, selezionare i figli dei TabContaine/AccordionContainer in maniera tale da visualizzare il primo widget non valido
• mostrare al gwUser, in concomitanza del primo widget non valido, un tooltip con le istruzioni per la corretta compilazione

detailContainer.notifyGwFormNotValidToUser();

In caso qualche widget della form non passi la validazione, notifica l'utente. Di fatto, nella sua implementazione, utilizza internamente le js API isGwFormValid() e notifyGwFormNotValidToUser().

detailContainer.validateGwForm();