Versions Compared

Old Version 23

changes.mady.by.user Grzegorz Konowalczyk

Saved on

compared with

New Version 24

changes.mady.by.user Grzegorz Konowalczyk

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • pojedynczy parametr zadania zaplanowanego - typ parametru musi być zgodny ze zdefiniowanym typem oraz musi być poprzedzony adnotacją @Param. Obsługiwane typy parametrów:
    • STRING
    • BOOLEAN
    • INTEGER
    • FLOAT
    • DATE - mapowane do org.joda.time.LocalDate (format yyyy-MM-dd)
    • DATETIME - mapowane do org.joda.time.LocalDateTime (format yyyy-MM-dd HH:mm:ss)
    • FILE - mapowanie do com.suncode.pwfl.customfile.CustomFileComponentFile
    • STRING_ARRAY
    • BOOLEAN_ARRAY
    • INTEGER_ARRAY
    • FLOAT_ARRAY
    • DATE_ARRAY
    • DATETIME_ARRAY
    • FILE_ARRAY
  • Javadoc
    displayValueParameters
    propertyjavadoc.plusworkflow
    classNamecom.suncode.pwfl.component.Parameters
     - zawiera wszystkie zdefiniowane parametry zadania zaplanowanego wraz z ich wartościami, jest to alternatywa dla pobierania parametru za pomocą wyżej wspomnianej adnotacji @Param,
  • Javadoc
    displayValueTranslator
    propertyjavadoc.plusworkflow
    classNamecom.suncode.pwfl.translation.Translator
     - translator dla tego komponentu. Więcej informacji tutaj,
  • Javadoc
    displayValueCancelationHandler
    propertyjavadoc.plusworkflow
    classNamecom.suncode.pwfl.administration.scheduledtask.context.CancelationHandler
     - przechowuje informację o tym, czy użytkownik w GUI kliknął przycisk Anuluj wykonywanie. Sam mechanizm anulowania zadania musi zaimplementować twórca komponentu. Przycisk Anuluj wykonywanie pokaże się tylko, jeżeli w builderze została wywołana metoda cancelable,
  • Logger - logger do logowania własnych komunikatów w komponencie. Komunikaty są zapisywane do plików (skonfigurowanych w Log4j) oraz zostaną wyświetlone w historii wykonywania zadania.
  • Javadoc
    displayValueProgressHolder
    propertyjavadoc.plusworkflow
    classNamecom.suncode.pwfl.administration.scheduledtask.context.ProgressHolder
     - obiekt, w którym ustawić można aktualny progress wykonywania zadania zaplanowanego (liczba między 0 a 1). Progress ten zostanie wyświetlony w GUI.
  • Javadoc
    propertyjavadoc.plusworkflow
    classNamecom.suncode.pwfl.administration.scheduledtask.ScheduledTaskInstanceInfo
     - obiekt przechowujący informacje o danej instancji zadania zaplanowanego.

...

Tip

Jeżeli podczas dodawania elementu do formularza zdefiniujemy mu id i ta wartość będzie odnosić się do id parametru zdefiniowanego w komponencie, to wszystkie właściwości dla pola zostaną odczytane z definicji parametru (nazwa, opis, wymagalność, typ).

Jeżeli natomiast chcemy dodać pole, które nie jest związane z żadnym parametrem (nie będzie ono zapisane w deklaracji źródła), to powinniśmy określić nazwę, opis, typ oraz wymagalność.

...

FunkcjaParametryOpis
addField(definition, [position])

definition - identyfikator dodawanego parametru

lub obiekt zawierający definicję pola

position - pozycja na której dodany mam zostać parametr.

Gdy position nie zostanie podany, parametr zostanie

dodany na końcu formularza.

listeners- obiekt definiujacy funkcje zdarzeń na zmiennej

  • change - funkcja wywoływana, gdy zmieni się
    wartość pola.
    Funkcja może korzystać z następujących parametrów:
    • field- pole Combobox dla którego nastąpiła zmiana
    • newValue - nowa wartość pola


Dodanie parametru.

Przykład:

Code Block
languagejs
...
form.addField('param-1');
...

Jeżeli dodajemy pole niezwiązane z parametrem komponentu, to możemy określić jakiego typu ma być to pole.

Dostępne są następujące typy: string, integer, float, date, datetime, boolean, string[], integer[], float[], date[], datetime[], boolean[].

Code Block
languagejs
...
form.addField({
	id: 'custom',
	fieldType: 'date',
	...
});
...
 addTextArea(definition, [position])definition - identyfikator dodawanego parametru

lub obiekt zawierający definicję pola

position - pozycja na której dodany mam zostać parametr.

Gdy position nie zostanie podany, parametr zostanie dodany na końcu formularza.

listeners- obiekt definiujacy funkcje zdarzeń na zmiennej

  • change - funkcja wywoływana, gdy zmieni się
    wartość pola.
    Funkcja może korzystać z następujących parametrów:
    • field- pole dla którego nastąpiła zmiana
    • newValue - nowa wartość pola

Dodanie parametru jako pole typu `TextArea`.

Note

Parametr musi być typu

Javadoc
displayValueString
propertyjavadoc.plusworkflow
classNamecom.suncode.pwfl.core.type.Types
.

 

Przykład:

Code Block
languagejs
...
form.addTextArea('param-1');
...

lub

Code Block
languagejs
...
form.addTextArea({
	id: 'param-1',
	...
});
...
addCombobox(definition, [position])definition - obiekt zawierający definicję pola

Definicja powinna zawierać nastepujące pola:

  • id - identyfikator parametru (opcjonalne)
  • valueField - nazwa pola, ustawiającego
    wartość pola
  • displayField - nazwa pola, którego wartość
    zostanie wyświetlona w polu
  • minChars - minimalna liczba wpisanych znaków,
    po której Combobox rozpoczyna filtrowanie.
    Domyślnie: 0.
  • values - ((info) dla typu lokalnego) tablica rekordów wartości wyświetlanych pola; rekordem może być:
    • obiekt z polami valueField i displayField zdefiniowanymi w konfiguracji
    • tablica 2-elementowa z wartością oraz tekstem wyświetlanym
  • remote - ((info) dla typu zdalnego) obiekt zawierający
    definicję zdalnego pobierania danych. Obiekt zawiera
    następujące pola:
    • url - adres URL
    • remoteSort - określa czy dane powinny
      być sortowane po stronie serwera (wartość true)
      czy po stronie przeglądarki (wartość false).
      Domyslnie false.
    • pageSize - liczba wyświetlanych wyników na stronie.
      Domyslnie 25.
  • sort - tablica obiektów definiujących sposób sortowania.
    Obiekt zawiera następujące pola:
    • field - pole po jakim chcemy sortować
    • direction - kierunek po jakim chcemy sortować.
      ASC dla kierunku rosnącego,
      DESC dla kierunku malejącego.
  • onChange - listeners- obiekt definiujacy funkcje zdarzeń na zmiennej
    • change - funkcja wywoływana, gdy zmieni się
      wartość pola.
      Funkcja może korzystać z następujących parametrów:
      combo
      • field- pole
      Combox
      • dla którego nastąpiła zmiana
      • newValue - nowa wartość pola
    • oldValue - stara wartość pola

position - pozycja na której dodany mam zostać parametr.

Gdy position nie zostanie podany, parametr zostanie dodany na końcu formularza

 

Dodanie parametru jako pole typu `Combobox`.

Przykład dodania pola typu 'Combobox' lokalnego (local):

Code Block
languagejs
...
form.addCombobox({
	id: 'param-1',
	values : [
        ['activity', 'Zadanie'],
		['stage', 'Etap'],
	    ['process', 'Proces']
    ],
	sort: [{
		field: 'display',
		direction: 'DESC'
	}],
	onChangelisteners: {
        change: function (combofield, newValue, oldValue){
		    ...
	    }
    }
});
...

Przykład dodania pola typu 'Combobox' zdalnego (remote):

Code Block
languagejs
...
form.addCombobox({
	id: 'param-1',
	valueField: 'id',
	displayField: 'display',
	remote: {
		url: Suncode.getAbsolutePath('plugin/com.suncode.example-plugin/example-combo/get'),
		remoteSort: false,
		pageSize: 20
	},
	sort: [{
		property: 'display',
		direction: 'DESC'
	}],
	onChangelisteners: {
        change: function (combofield, newValue, oldValue){
		    ...
	    }
    }
});
...
addCheckbox(definition, [position])definition - identyfikator dodawanego parametru

lub obiekt zawierający definicję pola

position - pozycja na której dodany mam zostać parametr.

Gdy position nie zostanie podany, parametr zostanie dodany na końcu formularza.

listeners- obiekt definiujacy funkcje zdarzeń na zmiennej

  • change - funkcja wywoływana, gdy zmieni się
    wartość pola.
    Funkcja może korzystać z następujących parametrów:
    • field- pole dla którego nastąpiła zmiana
    • newValue - nowa wartość pola

Przykład:

Code Block
languagejs
...
form.addCheckbox('param-1');
...

Jeżeli podpinamy to pod parametr komponentu, to typ tego parametru musi być boolean.

addRow( [definition] )

definition - definicja wiersza.

Zawiera następujące pola:

  • id - identyfikator wiersza (opcjonalny)
  • fieldsSpace - odstęp w pikselach pomiędzy elementami wiersza. Domyślnie 5,
  • fieldLabel - nazwa (label) wiersza. Domyślnie nazwa wiersza tworzona jest na podstawie nazw elementów zawartych w wierszu.

Dodaje i zwraca "pusty" wiersz. Zwrócony wiersz umożliwia dodanie do niego pol. Pola będą dodawane obok siebie.

Przykład:

Code Block
languagejs
var row = form.addRow();
row.addField('param-1');
row.addField('param-2');
row.addCombobox(...);
addButton(definition, [position] )

definition - definicja przycisku.
Zawiera następujące pola:

  • id - identyfikator przycisku
  • text - wyświetlany tekst przycisku
  • handler - funkcja wywołująca się po kliknieciu przycisku

position - pozycja na której dodany mam zostać parametr.

Gdy position nie zostanie podany, parametr zostanie dodany na końcu formularza

Dodanie przycisku na formularzu.

Przykład:

Code Block
languagejs
form.addButton({
	id: 'btn-1',
	text: 'Przycisk',
	handler: function(){
	...
	}
})
addPassword(definition, [position])definition - identyfikator dodawanego parametru lub obiekt zawierający definicję pola

position - pozycja na której dodany mam zostać parametr.

Gdy position nie zostanie podany, parametr zostanie dodany na końcu formularza.

listeners- obiekt definiujacy funkcje zdarzeń na zmiennej

  • change - funkcja wywoływana, gdy zmieni się
    wartość pola.
    Funkcja może korzystać z następujących parametrów:
    • field- pole dla którego nastąpiła zmiana
    • newValue - nowa wartość pola

Dodanie parametru jako pole typu 'Password'.

Note

Parametr musi być typu

Javadoc
displayValueString
propertyjavadoc.plusworkflow
classNamecom.suncode.pwfl.core.type.Types
.

Przykład:

Code Block
languagejs
...
form.addPassword('param-1');
...

lub

Code Block
languagejs
...
form.addPassword({
	id: 'param-1',
	...
});
...
hide(elementId)elementId - identyfikator elementu

Ukrywa pole o podanym id.

Przykład

Code Block
languagejs
...
form.hide('param-1');
...
show(elementId)elementId - identyfikator elementu

Pokazuje pole o podanym id.

Przykład:

Code Block
languagejs
...
form.show('param-1');
...
disable(elementId)elementId - identyfikator elementu

Wyłącza możliwość edycji pola o podanym id.

Przykład:

Code Block
languagejs
...
form.disable('param-1');
...
enable(elementId)elementId - identyfikator elementu

Włącza możliwość edycji pola o podanym id.

Przykład:

Code Block
languagejs
...
form.enable('param-1');
...
getValue(elementId)elementId - identyfikator elementu

Pobiera wartość parametru o podanym id.

Przykład:

Code Block
languagejs
...
form.getValue('param-1');
...
setValue(elementId, value)

elementId - identyfikator elementu

value - wartość do ustawienia

Ustawia przekazaną wartość do parametru o podanym id.

Dla typów tablicowych wartością jest tablica wartości.

Przykład:

Code Block
languagejs
...
form.setValue('param-1', 'value');
...
mask(onlyForm)

onlyForm - prawda by nałożyć maskę tylko na formularz parametrów, fałsz by nałożyć maskę na zawartość całego okna.

Nakłada maskę na formularz parametrów lub zawartość okna.

Przykład:

Code Block
languagejs
...
form.mask(false);
...
unmask(onlyForm)

onlyForm - prawda by usunąć maskę tylko z formularza parametrów, fałsz by usunąć maskę z zawartości całego okna

Usuwa maskę z formularza parametrów lub zawartości okna.

Przykład:

Code Block
languagejs
...
form.unmask(false);
...

...