Page History

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.

Dodanie parametru.

Przykład:

...
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[].

...
form.addField({
	id: 'custom',
	fieldType: 'date',
	...
});
...

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.

Dodanie parametru jako pole typu `TextArea`.

Przykład:

...
form.addTextArea('param-1');
...

lub

...
form.addTextArea({
	id: 'param-1',
	...
});
...

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 - ( 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 - ( dla typu zdalnego) obiekt zawierający
  definicję zdalnego pobierania danych. Obiekt zawiera
  następujące pola:
  • url - adres URL
    
  • fields - definicja pól Comboboxa w postaci tablicy obiektów zawierających następujące pola:
    • name - nazwa pola
    • type - typ pola
     
  • 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 - funkcja wywoływana, gdy zmieni się
  wartość pola.
  Funkcja może korzystać z następujących parametrów:
  
  • combo - 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

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

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

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

...
form.addCombobox({
	id: 'param-1',
	valueField: 'id',
	displayField: 'display',
	remote: {
		url: Suncode.getAbsolutePath('plugin/com.suncode.example-plugin/example-combo/get'),
		fields: [
			{name: 'id', type: 'string'},
			{name: 'display', type: 'string'}
		],
		remoteSort: false,
		pageSize: 20
	},
	sort: [{
		property: 'display',
		direction: 'DESC'
	}],
	onChange: function(combo, newValue, oldValue){
		...
	}
});
...

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.

Przykład:

...
form.addCheckbox('param-1');
...

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

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:

var row = form.addRow();
row.addField('param-1');
row.addField('param-2');
row.addCombobox(...);

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:

form.addButton({
	id: 'btn-1',
	text: 'Przycisk',
	handler: function(){
	...
	}
})

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 'Password'.

Przykład:

...
form.addPassword('param-1');
...

lub

...
form.addPassword({
	id: 'param-1',
	...
});
...

Ukrywa pole o podanym id.

Przykład

...
form.hide('param-1');
...

Pokazuje pole o podanym id.

Przykład:

...
form.show('param-1');
...

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

Przykład:

...
form.disable('param-1');
...

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

Przykład:

...
form.enable('param-1');
...

Pobiera wartość parametru o podanym id.

Przykład:

...
form.getValue('param-1');
...

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:

...
form.setValue('param-1', 'value');
...

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:

...
form.mask(false);
...

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:

...
form.unmask(false);
...