custom:api_js_gw_attribute_widget_exposed_fx

gwAttributeWidget funzioni esposte

Il gwAttributeWidget rappresenta il widget che rappresenta nel gwClassDetail il gwAttribute. Il gwAttributeWidget espone tutta una serie di function di utilità, che servono per interagire con esso o conoscerne lo stato corrente.

Nei metodi .gwSet*() è opzionalmente contemplato l'utilizzo del parametro eventChain. Esso è si opzionale, ma va specificato in particolari contesti, come il codice js scritto negli handler degli Eventi Attributi (EventAttributes, [ndr: permettono di eseguire codice in risposta all'accadere di determinati eventi legati al widget dell'attributo]). Questo è utilizzato per permettere al sistema di evitare eventuali cicli infiniti che l'utente configuratore potrebbe creare mettendo insieme più Eventi Attributi. Negli handler degli Eventi Attributi, il parametro eventChain è sempre reso disponibile nel contesto di esecuzione della function. Quando un ciclo è rilevato, un messaggio di warning è loggato ed il ciclo è interrotto. In certe situazioni l'utente configuratore potrebbe intenzionalmente creare cicli che coinvolgono due o più widgtes, con logiche che legano in varia maniera: questa è una possibilità segnalata, ma ammessa.

Ritorna il valore corrente della proprietà 'value' del widget. Nel caso il widget gestisca valueToStore/valueToShow, ad essere ritornato è il valueToStore.

Parametri

Nessuno

Esempi

var value = gwAttributeWidget.gwGetValue();

Imposta il valore della proprietà 'value' per il widget. Nel caso il widget gestisca valueToStore/valueToShow, ad essere ritornato è il valueToStore.

Parametri

  • value: Object, required, null è un valore ammesso. A seconda della tipologia del widget esso potrebbe essere di tipo string, number, Date, object
  • eventChain: Object, optional, default null. Questa parametro dovrebbe essere fornito solo quando questa function è utilizzata nel codice js degli Eventi Attributi (EventAttribute). In quell'ambito il nome di questa variabile è esattamente eventChain, e va semplicemente riversata nell'utilizzo della js api, al fine di evitare cicli

Esempi

var newValue = 'new value';
gwAttributeWidget.gwSetValue(newValue);

Ritorna il valore corrente della proprietà 'hidden' del widget. Nel caso il widget gestisca valueToStore/valueToShow, ad essere ritornato è il valueToStore.

Parametri

Nessuno

Esempi

var hidden = gwAttributeWidget.gwGetHidden();

Lavora come gwGetHidden(). Ritorna il valore corrente della proprietà 'hidden' del widget. Nel caso il widget gestisca valueToStore/valueToShow, ad essere ritornato è il valueToStore.

Parametri

Nessuno

Esempi

var hidden = gwAttributeWidget.gwIsHidden();

Imposta il valore della proprietà 'hidden' per il widget. 'hidden' true ha l'effetto di nascondere il widget. Il widget di fatto esiste ancora e risponde all'invocazione di tutte le altre function esposte. Può essere reso di nuovo visibile con le apposite function esposte.

Parametri

  • hidden: Boolean, required. Se posto a true il widget viene nascosto.
  • eventChain: Object, optional, default null. Questa parametro dovrebbe essere fornito solo quando questa function è utilizzata nel codice js degli Eventi Attributi (EventAttribute). In quell'ambito il nome di questa variabile è esattamente eventChain, e va semplicemente riversata nell'utilizzo della js api, al fine di evitare cicli

Esempi

var hidden = true;
gwAttributeWidget.gwSetHidden(hidden);

Nasconde il widget. Il widget di fatto esiste ancora e risponde all'invocazione di tutte le altre function esposte. Può essere reso di nuovo visibile con le apposite function esposte.

Parametri

Nessuno

Esempi

gwAttributeWidget.gwHide();

Mostra il widget. Può essere di nuovo nascosto con le apposite function esposte.

Parametri

Nessuno

Esempi

gwAttributeWidget.gwShow();

Mostra il widget se è attualmente nascondo. Nasconde il widget se è attualmente visibile.

Parametri

Nessuno

Esempi

gwAttributeWidget.gwToggleHidden();

Ritorna il valore corrente della proprietà 'readonly ' del widget.

Parametri

Nessuno

Esempi

var readonly = gwAttributeWidget.gwGetReadonly();

Imposta il valore della proprietà 'readonly' per il widget. 'readonly' a true ha l'effetto di porre il widget in sola lettura. 'readonly' a false ha l'effetto di rendere il widget editabile.

Parametri

  • readonly: Boolean, required. Se posto a true il widget viene posto in sola lettura.
  • eventChain: Object, optional, default null. Questa parametro dovrebbe essere fornito solo quando questa function è utilizzata nel codice js degli Eventi Attributi (EventAttribute). In quell'ambito il nome di questa variabile è esattamente eventChain, e va semplicemente riversata nell'utilizzo della js api, al fine di evitare cicli

Esempi

var readonly = true;
gwAttributeWidget.gwSetReadonly(readonly);

Ritorna il valore corrente della proprietà 'required' del widget.

Parametri

Nessuno

Esempi

var required = gwAttributeWidget.gwGetRequired();

Imposta il valore della proprietà 'required' per il widget. 'required' a true ha l'effetto che widget non permetterà il salvataggio in assenza di un valore impostato.

Parametri

  • required: Boolean, required. Se posto a true il widget non permetterà il salvataggio in assenza di un valore impostato.
  • eventChain: Object, optional, default null. Questa parametro dovrebbe essere fornito solo quando questa function è utilizzata nel codice js degli Eventi Attributi (EventAttribute). In quell'ambito il nome di questa variabile è esattamente eventChain, e va semplicemente riversata nell'utilizzo della js api, al fine di evitare cicli

Esempi

var required = true;
gwAttributeWidget.gwSetRequired(required);

Ritorna il valore corrente della proprietà 'disabled' del widget.

Parametri

Nessuno

Esempi

var disabled = gwAttributeWidget.gwGetDisabled();

Imposta il valore della proprietà 'required' per il widget. 'required' a true ha l'effetto di rendere il widget non utilizzabile, seppur ancora visibile.

Parametri

  • disabled: Boolean, required. Se posto a true il widget verrà disabilitato. Cioè non utilizzabile, seppur ancora visibile.
  • eventChain: Object, optional, default null. Questa parametro dovrebbe essere fornito solo quando questa function è utilizzata nel codice js degli Eventi Attributi (EventAttribute). In quell'ambito il nome di questa variabile è esattamente eventChain, e va semplicemente riversata nell'utilizzo della js api, al fine di evitare cicli

Esempi

var disabled= true;
gwAttributeWidget.gwSetDisabled(disabled);
  • custom/api_js_gw_attribute_widget_exposed_fx.txt
  • Ultima modifica: 2019/12/18 10:21
  • da giorgio.scali