← Powrót do listy dostępnych hook'ów | Jeśli masz problem ze zrozumieniem jak działają hook'i, sprawdź opis: Mechanizm hook'ów |
Hook pełni funkcję umieszczania znaku wodnego na dokumencie w czasie jego wyświetlania. Jest on zaimplementowany na podstawie definicji hook'a systemowego ReadFileHookAdapter, który umożliwia zmianę strumienia binarnego wyświetlanego dokumentu z archiwum lub w podglądzie w procesie. Konfiguracja hook'a wstawiającego znak wodny jest określana w formacie JSON pod postacią listy i zarządzana jest przez wtyczkę PCM (Plugin Configuration Manager). |
| Nazwa parametru w konfiguracji JSON | | Od wersji | Opis | Typ parametru | Uwagi i ograniczenia |
|---|
| documentClass | | 1.0.0 | Klasa dokumentów wskazuje dla których dokumentów ma być uruchamiany mechanizm wstawiania znaku wodnego. | Tekstowy | | | type | | 1.0.0 | Określa jakiego typu jest znak wodny.
| Tekstowy | | Wartość | Znaczenie |
|---|
| BARCODE | Zamieszcza znak wodny w postaci kodu kreskowego | | TEXT | Zamieszcza znak wodny w postaci |
| | format | | 1.0.0 | Określa standard kodów kreskowych w postaci jednowymiarowej (zapis informacji w jednej linii, w formie kresek). | Tekstowy | | Wartość | Znaczenie |
|---|
| CODE_39 | Jednowymiarowy kod kreskowy zawierający znaki alfanumeryczne o zmiennej długości, w którym występują paski o dwóch różnych szerokościach. Do kodowania CODE_39 używane są 43 znaki plus dodatkowe znaki, które są ogranicznikami i znakami start/stop. Znak start/stop zawsze występuje jako pierwszy i ostatni znak kodu i jest nim znak '*'. Ten format nie pozwala na zakodowanie małych liter. | Znak | Wartość | Znak | Wartość | Znak | Wartość | Znak | Wartość |
|---|
| 0 | 0 | B | 11 | M | 22 | X | 33 | | 1 | 1 | C | 12 | N | 23 | Y | 34 | | 2 | 2 | D | 13 | O | 24 | Z | 35 | | 3 | 3 | E | 14 | P | 25 | - | 36 | | 4 | 4 | F | 15 | Q | 26 | . | 37 | | 5 | 5 | G | 16 | R | 27 | space | 38 | | 6 | 6 | H | 17 | S | 28 | $ | 39 | | 7 | 7 | I | 18 | T | 29 | / | 40 | | 8 | 8 | J | 19 | U | 30 | + | 41 | | 9 | 9 | K | 20 | V | 31 | % | 42 | | A | 10 | L | 21 | W | 32 | | |
| | CODE_93 | Jednowymiarowy kod kreskowy będący udoskonaleniem formatu CODE_39. Występują w nim paski o czterech różnych szerokościach. Podobnie jak swój pierwowzór przechowuje 43 znaki alfanumeryczne, ale dodatkowo posiada 4 znaki sterujące (($), (%), (/), (+)), które są używane do kodowania wszystkich 128 znaków ASCII (CODE_93 Extended). Kod przyjmuje wyłącznie wielkie litery, chyba że zostaną użyte znaki sterujące. | Znak | Wartość | Znak | Wartość | Znak | Wartość | Znak | Wartość |
|---|
| 0 | 0 | C | 12 | O | 24 | - | 36 | | 1 | 1 | D | 13 | P | 25 | . | 37 | | 2 | 2 | E | 14 | Q | 26 | space | 38 | | 3 | 3 | F | 15 | R | 27 | $ | 39 | | 4 | 4 | G | 16 | S | 28 | / | 40 | | 5 | 5 | H | 17 | T | 29 | + | 41 | | 6 | 6 | I | 18 | U | 30 | % | 42 | | 7 | 7 | J | 19 | V | 31 | ($) | 43 | | 8 | 8 | K | 20 | W | 32 | (%) | 44 | | 9 | 9 | L | 21 | X | 33 | (/) | 45 | | A | 10 | M | 22 | Y | 34 | (+) | 46 | | B | 11 | N | 23 | Z | 35 | | |
| | CODE_128 | Kod alfanumeryczny o zmiennej długości i wysokiej gęstości. Potrafi kodować znaki z całego zakresu ASCII. 
|
| | indexId | | 1.0.0 | Wskazuje na indeks, z którego jest pobierana wartość do zakodowania w znaku wodnym. | Całkowity | Wartość indeksu musi być typu tekstowego. | | codeWidth | | 1.0.0 | Definiuje szerokość znaku wodnego w pikselach. | Całkowity | Parametr nie definiuje maksymalnej szerokości kodu kreskowego - w przypadku, gdy podstawiana wartość okaże się zbyt długa, szerokość automatycznie zostanie zwiększona. | | codeHeight | | 1.0.0 | Definiuje długość znaku wodnego w pikselach. | Całkowity | | | position | | | Pozycjonuje znak wodny w odpowiedniej części strony. Do wykorzystania jest 9 predefiniowanych pozycji. | Tekstowy | | Wartość | Znaczenie |
|---|
| TOP_RIGHT | Górny prawy róg | | TOP_LEFT | Górny lewy róg | | BOTTOM_RIGHT | Dolny prawy róg | | BOTTOM_LEFT | Dolny lewy róg | | TOP | U góry na środku | | BOTTOM | Na dole na środku | | LEFT | Na środku po lewej stronie | | RIGHT | Na środku po prawej stronie | | CENTER | Na środku |
| | margin | | 1.0.0 | Definiuje odstęp znaku wodnego od określonej krawędzi strony w zależności od wartości parametru Umiejscowienie np. gdy wspomniany parametr ma wartość TOP, to margines odnosi się do górnej krawędzi strony dokumentu.
| Zmiennoprzecinkowy | | | opacity | | 1.0.0 | Określa przezroczystość wstawianego znaku wodnego na stronach dokumentu. | Zmiennoprzecinkowy | Wartość z przedziału 0-1. | permissions | | 1.0.0 | Uprawnienia określające dla jakich zalogowanych użytkowników w systemie przy próbie otwarcia dokumentu zostanie uruchomiony hook. | Obiekt | Parametr opcjonalny, gdy nie jest uzupełniony to znak wodny widzą wszyscy. | | groups | | 1.0.0 | Wskazuje na grupy użytkowników systemowych. | Tablica tekstowa | |
|
 "type": "BARCODE",
"format": "CODE_128", "groups": ["Users", "Administrators"] "type": "BARCODE",
"format": "CODE_128", |
|
|