definition - identyfikator dodawanego parametru

lub obiekt zawierający definicję pola

• id - identyfikator dodawanego parametru
  

   

• 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

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

Gdy position nie zostanie podany, parametr zostanie

dodany na końcu formularza.

Przykład dodania parametru:

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

Przykład dodania parametru z reagowaniem na zmianę wartości:

...
form.addField({
  id: "param-1",
  listeners: {
    change: function (field, newValue) {
      console.log(`Changed textfield to ${newValue}`);
    },
  },
});
...

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`.

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
    

  • params - obiekt zawierający pola z dokładanymi parametrami do żądań http

    • nazwa pola jest nazwą parametru żądania http
    • wartość pola jest wartością parametru żądania http
  • 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 - obiekt definiujących sposób sortowania.
  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.
• 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

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

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

Endpoint zdalnego comboboxa ma następującą strukturę:

Parametry wysyłane:

• query  - tekst wpisany w combobox (wymagany)
• start - pozycja od której należy dokonywać szukania strony (wymagany)
• limit - wielkość strony (wymagany)
• sort - nazwa pola, po którym następuje sortowanie (gdy remoteSort jest włączone)
• dir - kierunek sortowania po polu (gdy remoteSort jest włączone)

Dane zwracane:

• data - tablica obiektów, któe mają strukturę zdefiniowaną parametrami valueField i displayField
• total - liczba wszystkich dostępnych elementów

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'
	},
	listeners: {
        change: function (field, newValue){
		    ...
	    }
    }
});
...

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'),
        params: {
            userId: 'jankowalski'
        },
		remoteSort: false,
		pageSize: 20
	},
	sort: {
		field: 'display',
		direction: 'DESC'
	},
	listeners: {
        change: function (field, newValue){
		    ...
	    }
    }
});
...

elementId - identyfikator elementu

url - ades URL

Docelowy element musi być combobox'em typu zdalnego.

Przykład:

...
form.setComboboxRemoteUrl('param-1', Suncode.getAbsolutePath('plugin/com.suncode.example-plugin/example-combo/get'));
...

elementId - identyfikator elementu

params - obiekt zawierający pola z dokładanymi parametrami do żądań http

• nazwa pola jest nazwą parametru żądania http
• wartość pola jest wartością parametru żądania http

Docelowy element musi być combobox'em typu zdalnego.

Przykład:

...
form.setComboboxRemoteParams('param-1', {
    userId: 'jankowalski'
});
...

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:

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

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

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');
...

setRequired(elementId, value)

Dostępne od wersji 4.1.3

elementId - identyfikator elementu

value - wymagalność parametru

Dostępne od wersji 4.1.3.

Ustawia wymagalność parametru o podanym id.

Tylko parametry zadeklarowane wstępnie jako opcjonalne mogą mieć zmienioną wymagalność na formularzu.

Przykład:

...
form.setRequired('param-1', true);
...

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);
...

definition - identifier of the added parameter

or object containing the definition of the field

position - the position at which the parameter is to be added.

listeners- an object that defines the function of events on the variable

• change - a function called when the value of a field changes.
  
  The function can use the following parameters:
  
  • field- the Combobox field for which the change occurred
    
  • newValue - the new value of the field

Adding parameter.

Example:

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

If we add a field unrelated to the component parameter, we can specify what type the field should be.

The following types are available: string, integer, float, date, datetime, boolean, string[], integer[], float[], date[], datetime[], boolean[].

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

or object containing the definition of the field

position - the position at which the parameter is to be added.

When position is not specified, the paramter will be added at the end of the form.

listeners- an object that defines the function of events on the variable

• change - a function called when the value of a field changes.
  
  The function can use the following parameters:
  
  • field - the field for which the change occurred
    
  • newValue - the new value of the field

Adding a parameter as a field of type `TextArea`.

Example

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

or

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

The definition should contain the following fields:

• id - identifier of the parameter (optional)
• valueField -  name of the field, setting the the value of the field
• displayField - the name of the field whose value will be displayed in the field
• minChars - the minimum number of entered characters, after which Combobox starts filtering.
  Default: 0.
• values - ( for local type) an array of records of field display values; a record can be:
  
  • an object with valueField and displayField fields defined in the configuration
  • a 2-element array with value and display text
• remote - ( for remote type) object containing the definition of remote data retrieval. The object contains the following fields:
  
  • url - URL address
    
  • remoteSort - determines whether the data should be sorted on the server side (value true) or on the browser side (value false).
    The default is false.
  • pageSize - amount of displayed results per page.
    Default is 25.
• sort - object defining the method of sorting.
  It contains the following fields:
  • field - the field by which we want to sort
    
  • direction - the direction by which we want to sort.
    ASC for ascending direction,
    DESC for descending direction.
    
• listeners- an object that defines the function of events on the variable
  
  • change - a function called when the value of a field changes.
    The function can use the following parameters:
    
    • field - the field for which the change occurred
      
    • newValue - the new value of the field

position - The position on which the parameter is to be added.

When position is not specified, the parameter will be added to the end of the form

Adding a parameter as a field of type `Combobox`.

Example of adding a field of type `Combobox` local (local):

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

Example of adding a field of type 'Combobox' remote (remote):

...
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: {
		field: 'display',
		direction: 'DESC'
	},
	listeners: {
        change: function (field, newValue){
		    ...
	    }
    }
});
...

or object containing the definition of the field

position - the position at which the parameter is to be added.

When position is not specified, the paramter will be added at the end of the form.

listeners- an object that defines the function of events on the variable

Example:

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

If we pin this to a component parameter, the type of this parameter must be boolean.

definition - definition of a row.

It contains the following fields:

• id - row identifier (optional).
• fieldsSpace -space in pixels between elements of the row. The default is 5
• fieldLabel - the name (label) of the row. By default, the row name is created based on the names of the elements contained in the row.

Adds and returns an "empty" row. The returned row allows you to add fields to it. The fields will be added side by side.

Example:

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

definition - button definition.
It contains the following fields:

• id - button identifier
• text - the displayed text of the button
• handler - function that is called when the button is clicked

position - the position at which the parameter is to be added.

When position is not specified, the paramter will be added at the end of the form.

Adding a button on the form.

Example:

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

position - the position at which the parameter is to be added

If position is not specified, the parameter will be added at the end of the form.

listeners- an object that defines event functions on the variable

• change - a function called when the value of the value of the field.
  
  Funkcja może korzystać z następujących parametrów:
  
  • The function can use the following parameters:
    
    • field - the field for which the change occurred
      
    • newValue - the new value of the field

Adding a parameter as a field of type 'Password'.

Example

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

or

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

Hides the field with the specified id.

Example

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

Hides the field with the specified id.

Example

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

Hides the field with the specified id.

Example

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

Hides the field with the specified id.

Example

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

Hides the field with the specified id.

Example

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

elementId - element identifier

value - value to be set

Sets the forwarded value to the parameter with the specified id.

For array types, the value is an array of values.

Example

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

onlyForm - true - to apply the mask only to the parameter form, false - to apply the mask to the contents of the entire window.

Applies a mask to a parameter form or window content.

Example

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

onlyForm - true - to apply the mask only to the parameter form, false - to apply the mask to the contents of the entire window.

Applies a mask to a parameter form or window content.

Example

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