View Source

Serwis VariableService pozwala zarządzać nietabelarycznymi zmiennymi formularza. Posiada następujące funkcje:

get - pobiera komponent zmiennej formularza.
- Parametry funkcji:
  
  Nazwa Typ
  Wartość domyślna
  Opis
  id String null Identyfikator zmiennej formularza (identyfikator zmiennej procesu)
- Rezultat funkcji:
  
  Typ Opis
  Ext.Component Komponent zmiennej procesu lub undefined, jeśli nie znaleziono
getValue - zwraca wartość zmiennej formularza.
- Parametry funkcji:
  
  Nazwa Typ
  Wartość domyślna
  Opis
  id String null Identyfikator zmiennej formularza (identyfikator zmiennej procesu)
- Rezultat funkcji:
  
  Typ Opis
  Object Wartość zmiennej formularza lub undefined, jeśli nie znaleziono zmiennej formularza
setValue - ustawia wartość zmiennej formularza.
- Parametry funkcji:
  
  Nazwa Typ
  Wartość domyślna
  Opis
  id String null Identyfikator zmiennej formularza (identyfikator zmiennej procesu)
  value Object null Wartość zmiennej formularza
- Rezultat funkcji: brak

hide - ukrywa zmienne formularza (w tym tabele dynamiczne, które mają identyfikatory postaci variable_set_x, gdzie x - numer tabeli w kolejności licząc od 0).
- Parametry funkcji:
  
  Nazwa Typ
  Wartość domyślna
  Opis
  variables String/String[] null Identyfikator lub tablica identyfikatorów zmiennych formularza (identyfikatory zmiennych procesu)
- Rezultat funkcji: brak

show - pokazuje zmienne formularza (w tym tabele dynamiczne, które mają identyfikatory postaci variable_set_x, gdzie x - numer tabeli w kolejności licząc od 0).
- Parametry funkcji:
  
  Nazwa Typ
  Wartość domyślna
  Opis
  variables String/String[] null Identyfikator lub tablica identyfikatorów zmiennych formularza (identyfikatory zmiennych procesu)
- Rezultat funkcji: brak

disable - blokuje możliwość wpisywania wartości do pola.
- Parametry funkcji:
  
  Nazwa Typ
  Wartość domyślna
  Opis
  id String null Identyfikator zmiennej formularza (identyfikator zmiennej procesu)
  silent Boolean false Informuje, czy wywoływać zdarzenie dla zablokowania pola
- Rezultat funkcji: brak

enable - odblokowuje możliwość wpisywania wartości do pola.
- Parametry funkcji:
  
  Nazwa Typ
  Wartość domyślna
  Opis
  id String null Identyfikator zmiennej formularza (identyfikator zmiennej procesu)
  silent Boolean false Informuje, czy wywoływać zdarzenie dla odblokowania pola
- Rezultat funkcji: brak

showLoadingIndicator - maskuje pole wyświetlając informację, że wykonywane jest na nim zdarzenie, możliwe jest podanie także dodatkowej informacji tekstowej.
- Parametry funkcji:
  
  Nazwa Typ
  Wartość domyślna
  Opis
  id String null Identyfikator zmiennej formularza (identyfikator zmiennej procesu)
  message String 'Loading...' Dodatkowa informacja tekstowa
- Rezultat funkcji: brak

hideLoadingIndicator - usuwa maskę z pola informującą o wykonywaniu zdarzenia na tym polu.
- Parametry funkcji:
  
  Nazwa Typ
  Wartość domyślna
  Opis
  id String null Identyfikator zmiennej formularza (identyfikator zmiennej procesu)
- Rezultat funkcji: brak

markError - dodaje pod polem informacje o błędach.
- Parametry funkcji:
  
  Nazwa Typ
  Wartość domyślna
  Opis
  id String null Identyfikator zmiennej formularza (identyfikator zmiennej procesu)
  errors String/String[] null Treść błędu/błędów
- Rezultat funkcji: brak

unmarkError - usuwa spod pola informacje o błędach.
- Parametry funkcji:
  
  Nazwa Typ
  Wartość domyślna
  Opis
  id String null Identyfikator zmiennej formularza (identyfikator zmiennej procesu)
- Rezultat funkcji: brak

addEvent - dodaje zdarzenie (akcję) do pola na formularzu.

Parametry funkcji:

Nazwa	Typ	Wartość domyślna	Opis
id	String	null	Identyfikator zmiennej formularza (identyfikator zmiennej procesu)
eventName	String	null	Nazwa zdarzenia (patrz dokumentacja Ext JS)
handler	Function	null	Funkcja obsługująca zdarzenie
scope	Object	Ext.Component reprezentujący pole na formularzu, dla którego wystąpiło zdarzenie	Scope w funkcji podanej w parametrze handler

Rezultat funkcji: brak

removeEvent - usuwa zdarzenie (akcję) z pola na formularzu. Należy przekazać do funkcji takie same parametry jak do funkcji addEvent w celu poprawnego usunięcia zdarzenia (akcji) z pola formularza.

Parametry funkcji:

Nazwa	Typ	Wartość domyślna	Opis
id	String	null	Identyfikator zmiennej formularza (identyfikator zmiennej procesu)
eventName	String	null	Nazwa zdarzenia (patrz dokumentacja Ext JS)
handler	Function	null	Funkcja obsługująca zdarzenie
scope	Object	Ext.Component reprezentujący pole na formularzu, dla którego wystąpiło zdarzenie	Scope w funkcji podanej w parametrze handler

Rezultat funkcji: brak

addAutoUpdate - dodaje definicję akcji AUTO_UPDATE do pola na formularzu. Wymaga przygotowania servletu, który opiera się na takim samym działaniu jak podczas wykonywania akcji AUTO_UPDATE określonej w mapie procesu.

Parametry funkcji:

Nazwa

Typ

Wartość domyślna

Opis

id

String

null

Identyfikator zmiennej formularza (identyfikator zmiennej procesu)

config

Object

{ }

Obiekt definicji akcji AUTO_UPDATE. Posiada następujące pola:
- override (Typ: Boolean) - informuje, czy nadpisać istniejącą definicję akcji AUTO_UPDATE, jeżeli pole już ją posiada, wartość domyślna: false
- destinations (Typ: tablica obiektów) - zmienne wynikowe, których wartość jest ustawiana po wykonaniu akcji serwerowej, obiekty w tablicy posiadają pola: id - identyfikator zmiennej na formularzu, errorMessage - tekst wyświetlany przy zmiennej formularza, gdy nie uda się ustawić jej wartości, wartość domyślna: pusta tablica)
- errorMessage (Typ: String) - tekst wiadomości o globalnym błędzie podczas wykonywania akcji, wartość domyślna: null
- eventType (Typ: String) - typ zdarzenia, który spowoduje wywołanie się akcji dla danej zmiennej na formularzu, możliwe jest wykorzystanie trzech typów zdarzeń: blur (wyjście z pola), change (zmiana wartości w polu), select (wybranie wartości z listy rozwijanej), wartość domyślna: 'blur'
- loadingText (Typ: String) - treść informacji wyświetlana na zmiennej formularza, której dotyczy wywołanie akcji oraz na wszystkich zmiennych określonych w destinations, wartość domyślna: 'Loading...'

- dataSources (Typ: tablica stringów) - zmienne, których wartości są przekazywane do serwera, wartość domyślna: pusta tablica

- taskName (Typ: String) - nazwa wykonywanego servletu, wartość domyślna: null

Rezultat funkcji: brak

ServiceFactory.getVariableService().addAutoUpdate( 'kwota_netto', {

dataSources: [ 'kwota_netto', 'kwota_vat', '\'ADD\'' ],

destinations: [ {

id: 'kwota_brutto',

errorMessage: 'Błąd ustawiania wartości kwoty brutto.'

} ],

taskName: 'com.plusmpm.servlet.extension.CUF.AmountCalculator.customServlet',

errorMessage: 'Wystąpił błąd.',

eventType: 'blur',

loadingText: 'Trwa przeliczanie...'

} );

removeAutoUpdate - usuwa definicję akcji AUTO_UPDATE z pola na formularzu.
- Parametry funkcji:
  
  Nazwa Typ
  Wartość domyślna
  Opis
  id String null Identyfikator zmiennej formularza (identyfikator zmiennej procesu)
- Rezultat funkcji: brak