Page History

Podstawowe informacje

 Formularz zadania udostępnia API, które ułatwia wykonywanie podstawowych operacji na potrzeby dostosowania go do potrzeb klienta.

Serwisy

Wszystkie serwisy są dostępne bezpośrednio na globalnym scope (na podstawie ich nazwy) - od wersji systemu 3.2.5 lub do poprania za pomocą ServiceFactory.

• ActivityInfoService - odpowiedzialny za przechowywanie podstawowych informacji o zadaniu, dostępny z globalnego scope za pomocą wywołania:

var activityInfoService = ServiceFactory.getActivityInfoService();

• CommentService - odpowiedzialny za komentarze zadania, dostępny z globalnego scope za pomocą wywołania:

var commentsService = ServiceFactory.getCommentsService();

• FormService - odpowiedzialny za zakładkę formularza ze zmiennymi formularza, dostępny z globalnego scope za pomocą wywołania:

var formService = ServiceFactory.getFormService();

• MessageService - odpowiedzialny za wyświetlanie wiadomości w postaci animowanych "chmurek" dla użytkownika aktualnie korzystającego z formularza, dostępny z globalnego scope za pomocą wywołania:

var messageService = ServiceFactory.getMessageService();

• VariableService - odpowiedzialny za zarządzanie zmiennymi formularza nie znajdującymi się w tabelach dynamicznych, dostępny z globalnego scope za pomocą wywołania:

var variableService = ServiceFactory.getVariableService();

• VariableSetService - odpowiedzialny za zarządzanie tabelami dynamicznymi i zmiennymi znajdującymi się w nich, dostępny z globalnego scope za pomocą wywołania:

var variableSetService = ServiceFactory.getVariableSetService();

SuncodeFormService

API formularza posiada także dodatkowy serwis SuncodeFormService. Jest on również dostępny na globalnym scope (window) i jest obsługiwany niezależnie od pozostałych serwisów.

Zdarzenia gotowości formularza

Funkcja addOnReadyEvent daje możliwość dodania dowolnej ilości akcji, jakie zostaną wykonane po zbudowaniu formularza (wszystkie komponenty na formularzu będą już dostępne). Funkcja ta ma nazwę addOnReadyEvent. Przykładowe wykorzystanie jest następujące:

SuncodeFormService.addOnReadyEvent( function() {
 alert( 'Pierwsza akcja' );
} );

SuncodeFormService.addOnReadyEvent( function() {
 alert( 'Druga akcja' );
} );

Użycie serwisu w powyższy sposób spowoduje, że po zbudowaniu formularza zostaną kolejno wyświetlone wiadomości: 'Pierwsza akcja' i 'Druga akcja'. Kolejność wykonywania akcji jest zależna od ładowania skryptów, a w ramach jednego pliku od kolejności dodawania akcji.

Funkcja addOnReadyEvent przyjmuje jeden parametr:

• event (typ Function) - funkcja JavaScript wykonana po zbudowaniu formularza
  
  

Funkcja ta nie zwraca żadnych rezultatów.

Grupowanie akcji obliczania wyglądu formularza

Od wersji 3.1.6 możliwe jest dodatkowe grupowanie akcji zmieniających układ formularza (layout). Takie grupowanie zmian układu jest znacznie szybsze niż wykonywanie tych akcji osobno.

SuncodeFormService.suspendLayouts();
try {
	// wiele akcji
	variableService.hide('a');
	variableSetService.hide('a');
}
finally {
	SuncodeFormService.resumeLayouts();
}

Od wersji 3.1.22 możliwe jest wywołanie grupowych akcji bez konieczności użycia bloków try oraz finally poprzez podanie parametrów w wywołaniu. W miejsce function należy podać funkcje, która zostanie wywołana, a następnie scope wywołania tej funkcji.

SuncodeFormService.suspendLayouts(function, scope);

Ustawienia konfiguracyjne formularza

W wersji 3.1.10 wprowadzono mechanizm ustawień formularza. Umożliwia on dynamiczne ustawienie danych właściwości poprzez API:

// ustawienie właściwości
SuncodeFormService.setConfig('config.key', 'value');
 
// pobranie właściwości
var conf = SuncodeFormService.getConfig('config.key');
 
// można także sprecyzować wartość domyślną, zwróconą w przypadku, gdy właściwość nie zostanie ustawiona
var conf = SuncodeFormService.getConfig('config.key', 'default value');

Tabela zawiera wszystkie dostępne opcje konfiguracyjne formularza

autoupdate.blurifchange

Boolean

false

3.1.10

SuncodeFormService.setConfig('autoupdate.blurifchange', true);

variableset.copyrow.target

String

bottom

3.1.13

SuncodeFormService.setConfig('variableset.copyrow.target', 'below');

variable.variabletoview.genericformat

Boolean

false

3.2.0

VariableService.getValue('id');
// lub
VariableService.getValue('id', false);

SuncodeFormService.setConfig('variable.variabletoview.genericformat', true);

Basic information

 The task form provides an API that facilitates basic operations for adapt it to the client's needs.

Services

All services are available directly on the global scope (based on their name) - from the system version 3.2.5 or to be download by ServiceFactory.

• ActivityInfoService- responsible for storing basic information about the task, available from the global scope using a call:

var activityInfoService = ServiceFactory.getActivityInfoService();

• CommentService- responsible for task comments, available from the global scope using a call:

var commentsService = ServiceFactory.getCommentsService();

• FormService- responsible for the form tab with form variables, available from the global scope using a call:

var formService = ServiceFactory.getFormService();

• MessageService- responsible for displaying messages in the form of animated "clouds" for the user currently using the form, available from the global scope using a call:

var messageService = ServiceFactory.getMessageService();

• VariableService- responsible for managing form variables that are not in dynamic tables, available from the global scope using a call:

var variableService = ServiceFactory.getVariableService();

• VariableSetService- responsible for managing dynamic tables and variables located in them, available from the global scope using a call:

var variableSetService = ServiceFactory.getVariableSetService();

SuncodeFormService

The API form also has an additional SuncodeFormService service. It is also available on the global scope (window) and is supported independently of other services.

Form readiness events 

The addOnReadyEvent function gives ability to add any actions number that will be taken after the form has been built (all components on the form will be available). This function is called addOnReadyEvent. The exemple use is as follows:

SuncodeFormService.addOnReadyEvent( function() {
 alert( 'First action' );
} );

SuncodeFormService.addOnReadyEvent( function() {
 alert( 'Second action' );
} );

Using the service in the above way will result in the following messages being displayed successively after the form has been built: 'First action' and 'Second action'. The order in which actions are performed depends on the scripts loading, and within one file, from the order of adding actions.

Function addOnReadyEvent takes one parameter:

• event (Function type) - function JavaScript made after building the form 

This function does not return any results.

Grouping actions to calculate the appearance of a form 

From version 3.1.6 it is possible to additional group actions changing the layout of the form (layout). Such grouping of layout changes is much fasterthan performing these actions separately.

SuncodeFormService.suspendLayouts();
try {
	// many actions
	variableService.hide('a');
	variableSetService.hide('a');
}
finally {
	SuncodeFormService.resumeLayouts();
}

From version 3.1.22it is possible to call group actions without using tryand finally blocks by specifying parameters in the call. Instead of the function, you must specify the function which will be called, and then the scope of calling this function

SuncodeFormService.suspendLayouts(function, scope);

Configuration settings for the form 

In version 3.1.10 form setting mechanism has been introduced. It allows dynamic setting of property data through the API: 

// setting property 
SuncodeFormService.setConfig('config.key', 'value');
 
// getting property
var conf = SuncodeFormService.getConfig('config.key');
 
// you can also specify a default value, returned if the property is not set
var conf = SuncodeFormService.getConfig('config.key', 'default value');

The table contains all available configuration options for the form

autoupdate.blurifchange

Boolean

false

3.1.10

SuncodeFormService.setConfig('autoupdate.blurifchange', true);

variableset.copyrow.target

String

bottom

3.1.13

SuncodeFormService.setConfig('variableset.copyrow.target', 'below');

variable.variabletoview.genericformat

Boolean

false

3.2.0

VariableService.getValue('id');
// or
VariableService.getValue('id', false);

SuncodeFormService.setConfig('variable.variabletoview.genericformat', true);