Możliwe jest dodanie do systemu akcji zmiennych formularza (AUTO_UPDATE), data chooser'ów (dynamiczne listy), zadań automatycznych, narzędzi systemowych, walidatorów przycisków akceptacji, klas ustawiających zmienne, które zostaną wykryte podczas uruchamiania modułu edytora procesów. Dodatkowo moduł próbuje zaczytać pliki js z biblioteki CUF, które definiują parametryzowane funkcje dla przycisków tabeli dynamicznej, przycisków akceptacji. Możliwe będzie ich wykorzystanie podczas definiowania poszczególnych komponentów. Konieczne wtedy będzie uzupełnienie tylko konkretnych wartości (najczęściej wybranie zmiennych procesu/formularza z listy).
1. Data chooser (dynamiczna lista)
Klasę będącą data chooser'em umieszczamy w classpath projektu. Oznaczamy ją adnotacją @StandardDataChooser:
@StandardDataChooser( conf = DataChooserExampleConf.class ) public class DataChooserExample implements DataChooser { ... }
Adnotacja ta posiada właściwość conf, która przechowuje informację o klasie opisującej definicję danego data chooser'a w zależności od wersji językowej (pochodzącej z java.util.Locale np. pl, en). Klasa ta musi implementować interface StandardDataChooserDef. Posiada on następujące metody:
- getIds - identyfikator data chooser'a, musi być unikalny w ramach wszystkich definicji
- getDef - zwraca definicję data chooser'a, czyli nazwę, opis, ścieżkę do klasy
- getFormCriteria - zwraca kryteria formalne (zmienne przekazywane z formularza), zawiera także ich opisy w celu ułatwienia użytkownikowi wyboru odpowiednich zmiennych procesu
- getMappings - zwraca mappingi data chooser'a (id w implementacji, mapowaną zmienną z formularza itd.), zawiera także ich opisy w celu ułatwienia użytkownikowi wyboru odpowiednich zmiennych procesu
- getCustomKeys - zwraca klucze własne, zawiera także ich opisy w celu ułatwienia użytkownikowi podania właściwych wartości
2. Auto update (akcja zmiennej formularza)
Klasę będącą auto update'em umieszczamy w classpath projektu. Oznaczamy ją adnotacją @StandardAutoUpdate:
@StandardAutoUpdate( conf = AutoUpdateExampleConf.class ) public class AutoUpdateExample extends HttpServlet { ... }
Adnotacja ta posiada właściwość conf, która przechowuje informację o klasie opisującej definicję danego auto update'u w zależności od wersji językowej (pochodzącej z java.util.Locale np. pl, en). Klasa ta musi implementować interface StandardAutoUpdateDef. Posiada on następujące metody:
- getId - identyfikator auto update'u, musi być unikalny w ramach wszystkich definicji
- getDef - zwraca definicję data chooser'a, czyli nazwę, opis, typ, ścieżkę do servletu
- getDataSources - zwraca źródła danych (zmienne z formularza, których wartości są przekazywane jako parametry wywołania), zawiera także ich opisy w celu ułatwienia użytkownikowi wyboru odpowiednich zmiennych procesu
getDestinations - zwraca zmienne docelowe (zmienne formularza, których wartości mają zostać ustawione na podstawie danych zwróconych przez servlet), zawiera także ich opisy w celu ułatwienia użytkownikowi wyboru odpowiednich zmiennych procesu
3. Akcje przycisków tabeli dynamicznej
Ich definicja znajduje się w pliku CUFdefs.js w projekcie CUF w lokalizacji scripts/external/CommonUsedFunctions. Plik js zawiera zmienną CUF, która jest obiektem. Posiada on właściwość DTButtons, który także jest obiektem. Kolejne właściwości definiują obiekty zawierające tłumaczenia (np. pl, en). Wewnątrz nich znajdują się właściwości określające akcje przycisków przycisków (nazwa właściwości jest identyfikatorem przycisku). Obiekt definicji akcji przycisku tabeli dynamicznej zawiera następujące pola:
- name - typ String, nazwa akcji przycisku, wartość domyślna: ""
- descr - typ String, opis akcji przycisku, wartość domyślna: ""
- buttonId - typ String, id przycisku na formularzu, wartość domyślna: ""
- text - typ String, tekst umieszczony na przycisku, wartość domyślna: ""
- icon - typ String, ścieżka na serwerze do ikony, która zostanie umieszczona na przycisku, wartość domyślna: ""
- tooltip - typ String, tekst podpowiedzi wyświetlany po umieszczeniu kursora myszki nad przyciskiem, wartość domyślna: ""
- handler - typ String, nazwa funkcji js wykonywanej po kliknięciu na przycisk, wartość domyślna: ""
- params- typ array, lista parametrów akcji przycisku, parametry są podawane w formie obiektu o następujących właściwościach, wartość domyślna: []:
- viewName - typ String, nazwa parametru (etykieta pola), wartość domyślna: ""
- realName - typ String, identyfikator parametru, wartość domyślna: ""
- type - typ String, typ parametru (typ pola), dozwolone wartości to: string, boolean, int, docclass, wartość domyślna: string
- defaultValue - typ zależny od wartości parametru type, wartość początkowa pola wartości parametru, wartość domyślna zależna od wartości parametru type
var CUF = { DTButtons: { pl: { importFromXls: { name: 'Import pliku Excel', descr: 'Import linii tabeli z pliku Excel', buttonId: 'CUF_import_from_xls_button', text: 'Importuj', icon: 'style/img/fam/page_excel.png', tooltip: 'Importuj linie z pliku', handler: 'CUF.table.service.TableButton.importFromExcel', params: [ { viewName: 'Uwzględnij ukryte kolumny', realName: 'showHidden', type: 'boolean', defaultValue: false },{ viewName: 'Zapisz dane po wczytaniu', realName: 'saveData', type: 'boolean', defaultValue: true }, { viewName: 'Przycisk wyboru pliku', realName: 'fileButtonLabel', type: 'string', defaultValue: 'Wybierz plik' }, { viewName: 'Przycisk importowania', realName: 'loadButtonLabel', type: 'string', defaultValue: 'Importuj' }, { viewName: 'Tytuł okna', realName: 'windowTitle', type: 'string', defaultValue: 'Import pliku Excel' }, { viewName: 'Dodatkowa funkcja', realName: 'functionName', type: 'string', defaultValue: '' } ] } } } };
4. Akcje przycisków akceptacji
Ich definicja znajduje się w pliku CUFdefs.js w projekcie CUF w lokalizacji scripts/external/CommonUsedFunctions. Plik js zawiera zmienną CUF, która jest obiektem. Posiada on właściwość AcceptButtonFunctions, który także jest obiektem. Kolejne właściwości definiują obiekty zawierające tłumaczenia (np. pl, en). Wewnątrz nich znajdują się właściwości określające akcje przycisków (nazwa właściwości jest identyfikatorem przycisku). Obiekt definicji akcji przycisku tabeli dynamicznej zawiera następujące pola:
- descr - typ String, opis akcji przycisku, wartość domyślna: ""
- handler - typ String, nazwa funkcji js wykonywanej po kliknięciu na przycisk, wartość domyślna: ""
var CUF = { AcceptButtonFunctions: { pl: { checkComment: { handler: 'CUF_checkComment', descr: 'Sprawdza, czy w obecnym zadaniu został dodany komentarz' } } } };
setFieldStoreParameter
Add Comment