palio.modules
Class IText

java.lang.Object
  palio.modules.core.Module
      palio.modules.IText

All Implemented Interfaces:

palio.Constants, palio.modules.core.CurrentModuleDataKeys

public final class IText
extends palio.modules.core.Module
implements palio.Constants

Moduł IText to próba przeniesienia funkcjonalności biblioteki iText do jPalio. Biblioteka iText powstała z myślą o prostym generowaniu dokumentów PDF z poziomu aplikacji JAVA.

Moduł jest dostępny w każdej instancji jPalio.

Version:

1.3.10

Author:

Mateusz Gembarzewski, Remigiusz Dejnarowicz (poprawki)

Field Summary

static java.lang.String

VERSION

Fields inherited from interface palio.Constants

DECIMAL_ZERO, INTEGER_ONE, LONG_MINUS_ONE, LONG_ONE, LONG_THREE, LONG_TWO, LONG_ZERO, STRING_EMPTY

Fields inherited from interface palio.modules.core.CurrentModuleDataKeys

DESIGNER_ACTIONS_BUFFER, HTML_FORM_BUILDER, HTML_MAP_BUILDER, HTML_MENU_BUILDER, HTML_TOOLTIPS_BUFFER, ITEXT_DOCUMENT, MAIL_MESSAGE, XLS_DOCUMENT, XML_DOCUMENT

Constructor Summary

IText(palio.Instance instance, java.util.Properties parameters)

Method Summary

void	addDocument(byte[] existingDocument) Wczytuje istniejący dokumant PDF.
void	addDocument(byte[] existingDocument, java.lang.String pageNumberParamName, palio.compiler.PalioCode pageCode) Wczytuje istniejący dokumant PDF.
void	addDocument(java.lang.String existingDocument) Wczytuje istniejący dokumant PDF.
void	addDocument(java.lang.String existingDocument, java.lang.String pageNumberParamName, palio.compiler.PalioCode pageCode) Wczytuje istniejący dokumant PDF.
void	addImage(byte[] image, java.lang.Object[] extraParams) Dodaje obrazek do dokumentu.
void	addImage(java.lang.String url, java.lang.Object[] extraParams) Dodaje obrazek do dokumentu.
void	addList(java.lang.String type, java.lang.Long symbolIndent, java.lang.Object[] extraParams, java.util.LinkedList elements) Tworzy listę.
void	addList(java.lang.String type, java.lang.Long symbolIndent, java.lang.Object[] extraParams, java.util.LinkedList elements, java.lang.Long elementIndex) Tworzy listę.
void	addList(java.lang.String type, java.lang.Long symbolIndent, java.lang.Object[] extraParams, java.lang.Object[] elements) Tworzy listę.
void	addList(java.lang.String type, java.lang.Long symbolIndent, java.lang.Object[] extraParams, palio.compiler.PalioCode innerCode) Tworzy listę.
void	addListItem(java.lang.Long alignment, java.lang.Object[] extraParams, palio.compiler.PalioCode innerCode) Dodaje element do aktualnie tworzonej listy.
void	addListItem(java.lang.Long alignment, java.lang.Object[] extraParams, java.lang.String text) Dodaje element do aktualnie tworzonej listy.
void	addListItem(java.lang.Long alignment, palio.compiler.PalioCode innerCode) Dodaje element do aktualnie tworzonej listy.
void	addListItem(java.lang.Long alignment, java.lang.String text) Dodaje element do aktualnie tworzonej listy.
void	addParagraph(java.lang.Long alignment, java.lang.Long leading, java.lang.String text) Tworzy nowy paragraf używając podanego tekstu.
void	addParagraph(java.lang.Long alignment, java.lang.Object[] extraParams, palio.compiler.PalioCode innerCode) Tworzy nowy paragraf używając kodu innerCode.
void	addParagraph(java.lang.Long alignment, java.lang.Object[] extraParams, java.lang.String text) Tworzy nowy paragraf używając podanego tekstu.
void	addParagraph(java.lang.Long alignment, palio.compiler.PalioCode innerCode) Tworzy nowy paragraf używając podanego kodu palio.
void	addParagraph(java.lang.Long alignment, java.lang.String text) Tworzy nowy paragraf używając podanego tekstu.
void	addParagraph(palio.compiler.PalioCode innerCode) Tworzy nowy paragraf używając podanego kodu palio.
void	addParagraph(java.lang.String text) Tworzy nowy paragraf używając podanego tekstu.
void	addPrintDialog() Dodaje kawałek kodu otwierający okienko drukowania po otwarciu dokumentu.
void	addTable(java.lang.Long columnCount, java.lang.Long alignment, java.lang.Long widthPercentage, palio.compiler.PalioCode innerCode) Tworzy nową tabelkę.
void	addTable(java.lang.Long columnCount, java.lang.Long alignment, java.lang.Object[] extraParams, palio.compiler.PalioCode innerCode) Tworzy nową tabelkę.
void	addTable(java.lang.Long columnCount, java.lang.Long alignment, palio.compiler.PalioCode innerCode) Tworzy nową tabelkę.
void	addTableCell(java.lang.Long border, java.lang.Long borderWidth, java.lang.Long colspan, palio.compiler.PalioCode innerCode) Dodaje do tabeli komórkę.
void	addTableCell(java.lang.Long border, java.lang.Long borderWidth, java.lang.Long colspan, java.lang.String text) Dodaje do tabeli komórkę poprzez wstawienie paragrafu z podanym tekstem.
void	addTableCell(java.lang.Long border, java.lang.Long borderWidth, java.lang.String text) Dodaje do tabeli komórkę poprzez wstawienie paragrafu z podanym tekstem.
void	addTableCell(java.lang.Long border, java.lang.String text) Dodaje do tabeli komórkę poprzez wstawienie paragrafu z podanym tekstem.
void	addTableCell(java.lang.Object[] params, palio.compiler.PalioCode innerCode) Dodaje do tabeli komórkę.
void	addTableCell(java.lang.Object[] params, java.lang.String text) Dodaje do tabeli komórkę poprzez wstawienie paragrafu z podanym tekstem.
void	addTableCell(java.lang.String text) Dodaje do tabeli komórkę poprzez wstawienie paragrafu z podanym tekstem.
void	addTableCells(java.lang.Long count, java.lang.Object[] params, java.lang.String text) Dodaje count komórek o treści text do aktualnej tabeli.
void	addTableCells(java.lang.Long count, java.lang.String text) Dodaje count komórek o treści text do aktualnej tabeli.
void	addTableCells(java.lang.Object[] params, java.lang.Object[] cells) Dodaje kilka komórek do aktualnej tabeli.
void	addTableRow(java.lang.Object[] params, java.lang.Object[] cells) Działa podobnie do funkcji addTableCells(java.lang.Long, java.lang.Object[], java.lang.String) z tym, że stara się zawsze dodać tylko jeden cały wiersz (nawet jak długość tablicy cells jest inna niż podana ilość kolumn w tabeli.
void	addTemplate(java.lang.Long x, java.lang.Long y, java.lang.Object template) Rysuje na aktualnej stronie dokumentu obiekt typu PdfTemplate, które można uzyskać wczytując inny dokument PDF za pomocą metody readDocument(String).
void	addTemplate(java.lang.Long x, java.lang.Long y, java.lang.Object[] transformMatrix, java.lang.Object template) Rysuje na aktualnej stronie dokumentu obiekt typu PdfTemplate, które można uzyskać wczytując inny dokument PDF za pomocą metody readDocument(String).
void	addText(java.lang.Long x, java.lang.Long y, java.lang.Object[] transformMatrix, java.lang.String text) Wstawia podany tekst w dowolnym miejscu dokumentu.
void	addText(java.lang.Long x, java.lang.Long y, java.lang.String text) Wstawia podany tekst w dowolnym miejscu dokumentu.
void	addText(java.lang.Long count, java.lang.String text) Dodaje count razy podany kawałek tekstu do elementu dokumentu, który jest aktualnym kontekstem (dokument, akapit, lista, komórka tabeli).
void	addText(java.lang.Long count, java.lang.String text, java.lang.Long textRise) Dodaje count razy podany kawałek tekstu do elementu dokumentu, który jest aktualnym kontekstem (dokument, akapit, lista, komórka tabeli).
void	addText(java.lang.String text) Dodaje kawałek tekstu do elementu dokumentu, który jest aktualnym kontekstem (dokument, akapit, lista, komórka tabeli).
void	addText(java.lang.String text, java.lang.Long textRise) Dodaje tekst do elementu dokumentu, który jest aktualnym kontekstem (dokument, akapit, lista, komórka tabeli).
void	addTextAligned(java.lang.Long x, java.lang.Long y, java.lang.String text, java.lang.Long alignment, java.lang.Long rotation, java.lang.Boolean kerned) Wstawia wyrównany tekst w dowolnym miejscu dokumentu.
byte[]	closeDocument() Zamyka tworzony dokument i zwraca jego zawartość.
java.lang.Object	createBarcode(java.lang.String code, java.lang.String type) Tworzy obiekt typu PdfTemplate z kodem kreskowym.
java.lang.Object	createBarcode(java.lang.String code, java.lang.String type, java.lang.Object[] barParams, java.lang.Object[] textParams) Tworzy obiekt typu PdfTemplate z kodem kreskowym.
void	createDocument() Tworzy nowy dokument formatu A4 z marginesem o szerokości 36 punktów.
void	createDocument(java.lang.Long width, java.lang.Long height) Tworzy nowy dokument o podanych wymiarach i z marginesem o szerokości 36 punktów.
void	createDocument(java.lang.Long width, java.lang.Long height, java.lang.Object backgroundColor) Tworzy nowy dokument o podanych wymiarach i z marginesem o szerokości 36 punktów.
void	createDocument(java.lang.String size, java.lang.Boolean portrait) Tworzy nowy dokument o podanym rozmiarze i z marginesem o szerokości 36 punktów.
void	createDocument(java.lang.String size, java.lang.Boolean portrait, java.lang.Object backgroundColor) Tworzy nowy dokument o podanym rozmiarze i z marginesem o szerokości 36 punktów.
void	createDocument(java.lang.String size, java.lang.Boolean portrait, java.lang.Object backgroundColor, java.lang.String type) Tworzy nowy dokument wybranego typu formatu A4 z marginesem o szerokości 36 punktów.
void	createDocument(java.lang.String size, java.lang.String orientation) Tworzy nowy dokument o podanym rozmiarze i z marginesem o szerokości 36 punktów.
void	createDocument(java.lang.String size, java.lang.String orientation, java.lang.Object backgroundColor) Tworzy nowy dokument o podanym rozmiarze i z marginesem o szerokości 36 punktów.
java.lang.String	getDefaultFontEncoding() Podaje domyślne kodowanie czcionek.
java.lang.Boolean	getFontEmbedding() Podaje domyślne zachowanie biblioteki przy zmianie aktywnej czcionki.
java.lang.Long	getPageNumber() Zwraca aktualny numer strony.
java.lang.Long	getTableTotalHeight() Zwraca aktualną wysokość tabeli.
java.lang.String	getVersion() Zwraca wersję modułu.
void	logDocumentEvents(java.lang.String serviceName, java.lang.String documentID) Dodaje listenera, który wpisuje do logów wszystkie zdarzenia związane z dokumentem.
byte[]	mergePDFs(java.util.LinkedList<byte[]> pdfs_byte)
void	newPage() Wstawia znacznik nowej strony do dokumentu.
void	openDocument() Otwiera dokument umożliwiając wprowadzanie do niego treści.
java.lang.Object[]	readDocument(byte[] existingDocument) Wczytuje istniejący dokument PDF i zwraca jego strony w postaci template'ów, które można rysować na aktualnym dokumencie używając metody addTemplate(Long, Long, Object[], Object).
java.lang.Object[]	readDocument(java.lang.String existingDocument) Wczytuje istniejący dokument PDF i zwraca jego strony w postaci template'ów, które można rysować na aktualnym dokumencie używając metody addTemplate(Long, Long, Object[], Object).
void	setColumnWidths(java.lang.Object[] relativeWidths) Ustawia względne szerokości kolumn w tabeli.
void	setCustomFont(java.lang.String fontPath, java.lang.String encoding, java.lang.Boolean embedded, java.lang.Long size, java.lang.Long style, java.lang.Object[] color) Ustawia dowolną czcionkę TTF (z pliku) dla aktualnego kontekstu dokumentu.
void	setDefaultEncoding(java.lang.String encoding) Ustawia domyślne kodowanie czcionek.
void	setFont(java.lang.String fontName, java.lang.Long size) Ustawia czcionkę dla aktualnego kontekstu dokumentu.
void	setFont(java.lang.String fontName, java.lang.Long size, java.lang.Long style) Ustawia czcionkę dla aktualnego kontekstu dokumentu.
void	setFont(java.lang.String fontName, java.lang.Long size, java.lang.Long style, java.lang.Object[] color) Ustawia czcionkę dla aktualnego kontekstu dokumentu.
void	setFont(java.lang.String fontName, java.lang.String encoding, java.lang.Boolean embedded, java.lang.Long size, java.lang.Long style, java.lang.Object[] color) Ustawia czcionkę dla aktualnego kontekstu dokumentu.
void	setFontEmbedding(java.lang.Boolean embedding) Ustawia domyślne zachowanie biblioteki przy zmianie aktywnej czcionki.
void	setFooter(java.lang.Long columnCount, palio.compiler.PalioCode innerCode) Tworzy stopkę dokumentu.
void	setHeader(java.lang.Long columnCount, palio.compiler.PalioCode innerCode) Tworzy nagłówek dokumentu.
void	setMargins(java.lang.Long leftMargin, java.lang.Long rightMargin, java.lang.Long topMargin, java.lang.Long bottomMargin, java.lang.Boolean mirroring) Ustawia marginesy dokumentu.
void	setMetaData(java.lang.String author, java.lang.String title) Ustawia meta-dane dokumentu.
void	setMetaData(java.lang.String author, java.lang.String title, java.lang.String subject, java.lang.String keywords) Ustawia meta-dane dokumentu.
void	setStrictImageSequence(java.lang.Boolean strict) Ustawia wewnętrzny parametr generatora, który decyduje o tym w którym momencie do danego dokumentu zostanie dodany obrazek niemieszczący się na aktualnej stronie.
void	setTableKeepTogether(java.lang.Boolean keepTogether) Ustawia dla tabeli flagę mówiaca o tym czy dana tabela ma byc w miare mozliwosci trzymana na jednej stronie czy nie.
void	setTextBackground(java.lang.Object[] color) Ustawia w aktualnym kontekście dokumentu podany kolor tła dla tekstu.

Methods inherited from class palio.modules.core.Module

getConfigParam, getDescription, getModuleTranslation

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VERSION

public static final java.lang.String VERSION

See Also:

Constant Field Values

Constructor Detail

IText

public IText(palio.Instance instance,
             java.util.Properties parameters)

Method Detail

getVersion

public java.lang.String getVersion()

Zwraca wersję modułu.

Specified by:

getVersion in class palio.modules.core.Module

createDocument

public final void createDocument()
                          throws DocumentException

Tworzy nowy dokument formatu A4 z marginesem o szerokości 36 punktów. Rozdzielczość dokumentu wynosi 72 dpi (czyli 72 punkty = 1 cal).

Throws:

com.lowagie.text.DocumentException - błąd biblioteki IText

DocumentException

createDocument

public final void createDocument(java.lang.String size,
                                 java.lang.Boolean portrait,
                                 java.lang.Object backgroundColor,
                                 java.lang.String type)
                          throws palio.PalioException

Tworzy nowy dokument wybranego typu formatu A4 z marginesem o szerokości 36 punktów. RozdzielczoÂść dokumentu wynosi 72 dpi (czyli 72 punkty = 1 cal). Przyjmuje typy "RTF" i "PDF"

Throws:

com.lowagie.text.DocumentException - błąd biblioteki IText

palio.PalioException

addDocument

public final void addDocument(byte[] existingDocument)
                       throws DocumentException,
                              java.io.IOException,
                              palio.PalioException

Wczytuje istniejący dokumant PDF. Funkcję należy wywołać bezpośrednio po otwarciu dokumentu openDocument().

Parameters:

existingDocument - istniejący dokument pdf

Throws:

com.lowagie.text.DocumentException - błąd biblioteki IText

java.io.IOException - błąd odczytu dokumentu PDF

palio.PalioException - błąd wykonania kodu strony

DocumentException

Since:

jPALIO 7.4.68

addDocument

public void addDocument(byte[] existingDocument,
                        java.lang.String pageNumberParamName,
                        palio.compiler.PalioCode pageCode)
                 throws java.io.IOException,
                        DocumentException,
                        palio.PalioException

Wczytuje istniejący dokumant PDF. Funkcję należy wywołać bezpośrednio po otwarciu dokumentu openDocument().

Parameters:

existingDocument - istniejący dokument pdf

pageNumberParamName - nazwa parametru pod którym będzie ustawiony kolejny numer strony wczytywanego dokumentu

pageCode - kod, który jest uruchamiany po wczytaniu każdej strony dokumentu

Throws:

com.lowagie.text.DocumentException - błąd biblioteki IText

java.io.IOException - błąd odczytu dokumentu PDF

palio.PalioException - błąd wykonania kodu strony

DocumentException

Since:

jPALIO 7.4.68

addDocument

public final void addDocument(java.lang.String existingDocument)
                       throws DocumentException,
                              java.io.IOException,
                              palio.PalioException

Wczytuje istniejący dokumant PDF. Funkcję należy wywołać bezpośrednio po otwarciu dokumentu openDocument().

Parameters:

existingDocument - URL lub ścieżka do istniejącego dokumentu

Throws:

com.lowagie.text.DocumentException - błąd biblioteki IText

java.io.IOException - błąd odczytu dokumentu PDF

palio.PalioException - błąd wykonania kodu strony

DocumentException

addDocument

public void addDocument(java.lang.String existingDocument,
                        java.lang.String pageNumberParamName,
                        palio.compiler.PalioCode pageCode)
                 throws java.io.IOException,
                        DocumentException,
                        palio.PalioException

Wczytuje istniejący dokumant PDF. Funkcję należy wywołać bezpośrednio po otwarciu dokumentu openDocument().

Parameters:

existingDocument - URL lub ścieżka do istniejącego dokumentu

pageNumberParamName - nazwa parametru pod którym będzie ustawiony kolejny numer strony wczytywanego dokumentu

pageCode - kod, który jest uruchamiany po wczytaniu każdej strony dokumentu

Throws:

com.lowagie.text.DocumentException - błąd biblioteki IText

java.io.IOException - błąd odczytu dokumentu PDF

palio.PalioException - błąd wykonania kodu strony

DocumentException

readDocument

public java.lang.Object[] readDocument(java.lang.String existingDocument)
                                throws java.io.IOException

Wczytuje istniejący dokument PDF i zwraca jego strony w postaci template'ów, które można rysować na aktualnym dokumencie używając metody addTemplate(Long, Long, Object[], Object).

Parameters:

existingDocument - adres URL lub ścieżka do istniejącego dokumentu

Returns:

tablica obiektów typu PdfTemplate odpowiadająca kolejnym stronom dokumentu

Throws:

java.io.IOException - błąd odczytu dokumentu PDF

readDocument

public java.lang.Object[] readDocument(byte[] existingDocument)
                                throws java.io.IOException

Wczytuje istniejący dokument PDF i zwraca jego strony w postaci template'ów, które można rysować na aktualnym dokumencie używając metody addTemplate(Long, Long, Object[], Object).

Parameters:

existingDocument - zawartość istniejącego dokumentu

Returns:

tablica obiektów typu PdfTemplate odpowiadająca kolejnym stronom dokumentu

Throws:

java.io.IOException - błąd odczytu dokumentu PDF

addTemplate

public void addTemplate(java.lang.Long x,
                        java.lang.Long y,
                        java.lang.Object[] transformMatrix,
                        java.lang.Object template)

Rysuje na aktualnej stronie dokumentu obiekt typu PdfTemplate, które można uzyskać wczytując inny dokument PDF za pomocą metody readDocument(String). Położenie template'u określa się względem dolnego lewego rogu strony.

Parameters:

x - położenie w poziomie

y - położenie w pionie

transformMatrix - dodatkowa matryca przekształcenia, jak w addText(Long, Long, Object[], String)

template - obiekt typu PdfTemplate

addTemplate

public void addTemplate(java.lang.Long x,
                        java.lang.Long y,
                        java.lang.Object template)

Rysuje na aktualnej stronie dokumentu obiekt typu PdfTemplate, które można uzyskać wczytując inny dokument PDF za pomocą metody readDocument(String). Położenie template'u określa się względem dolnego lewego rogu strony.

Parameters:

x - położenie w poziomie

y - położenie w pionie

template - obiekt typu PdfTemplate

createDocument

public final void createDocument(java.lang.String size,
                                 java.lang.Boolean portrait)
                          throws palio.PalioException

Tworzy nowy dokument o podanym rozmiarze i z marginesem o szerokości 36 punktów. Rozdzielczość dokumentu wynosi 72 dpi (czyli 72 punkty = 1 cal). Dostępne wielkości dokumentu: A0 do A10, B1 do B5, LETTER, HALFLETTER, ARCH_A do ARCH_E, _11x17, LEGAL, NOTE, LEDGER, FLSA, FLSE.

Parameters:

size - jedna z predefiniowanych wielkości

portrait - wyznacza orientację dokumentu: true = pionowa (portrait), false = pozioma (landscape)

Throws:

palio.PalioException - jeżeli podana wielkość nie jest zdefiniowana w klasie PageSize w bibliotece iText

createDocument

public final void createDocument(java.lang.String size,
                                 java.lang.Boolean portrait,
                                 java.lang.Object backgroundColor)
                          throws palio.PalioException

Tworzy nowy dokument o podanym rozmiarze i z marginesem o szerokości 36 punktów. Rozdzielczość dokumentu wynosi 72 dpi (czyli 72 punkty = 1 cal). Dostępne wielkości dokumentu: A0 do A10, B1 do B5, LETTER, HALFLETTER, ARCH_A do ARCH_E, _11x17, LEGAL, NOTE, LEDGER, FLSA, FLSE. Kolor tła dokumentu może być podany jako tablica [Long, Long, Long], gdzie wartości s z zakresu 0-256, lub jako prosta nazwa typu: red, blue, yellow.

Parameters:

size - jedna z predefiniowanych wielkości

portrait - wyznacza orientację dokumentu: true = pionowa (portrait), false = pozioma (landscape)

backgroundColor - kolor tła dokumentu

Throws:

palio.PalioException - jeżeli podany rozmiar nie istnieje

createDocument

public final void createDocument(java.lang.String size,
                                 java.lang.String orientation)
                          throws palio.PalioException

Tworzy nowy dokument o podanym rozmiarze i z marginesem o szerokości 36 punktów. Rozdzielczość dokumentu wynosi 72 dpi (czyli 72 punkty = 1 cal). Dostępne wielkości dokumentu: A0 do A10, B1 do B5, LETTER, HALFLETTER, ARCH_A do ARCH_E, _11x17, LEGAL, NOTE, LEDGER, FLSA, FLSE.

Parameters:

size - jedna z predefiniowanych wielkości

orientation - orientacja dokumentu: PORTRAIT lub LANDSCAPE

Throws:

palio.PalioException - jeżeli podana wielkość nie jest zdefiniowana w klasie PageSize w bibliotece iText, lub niepoprawna wartość dla orientacji

createDocument

public final void createDocument(java.lang.String size,
                                 java.lang.String orientation,
                                 java.lang.Object backgroundColor)
                          throws palio.PalioException

Tworzy nowy dokument o podanym rozmiarze i z marginesem o szerokości 36 punktów. Rozdzielczość dokumentu wynosi 72 dpi (czyli 72 punkty = 1 cal). Dostępne wielkości dokumentu: A0 do A10, B1 do B5, LETTER, HALFLETTER, ARCH_A do ARCH_E, _11x17, LEGAL, NOTE, LEDGER, FLSA, FLSE. Kolor tła dokumentu może być podany jako tablica [Long, Long, Long], gdzie wartości s z zakresu 0-256, lub jako prosta nazwa typu: red, blue, yellow.

Parameters:

size - jedna z predefiniowanych wielkości

orientation - orientacja dokumentu: PORTRAIT lub LANDSCAPE

backgroundColor - kolor tła dokumentu

Throws:

palio.PalioException - jeżeli podana wielkość nie jest zdefiniowana w klasie PageSize w bibliotece iText, lub niepoprawna wartość dla orientacji

createDocument

public final void createDocument(java.lang.Long width,
                                 java.lang.Long height)
                          throws DocumentException,
                                 palio.PalioException

Tworzy nowy dokument o podanych wymiarach i z marginesem o szerokości 36 punktów. Rozdzielczość dokumentu wynosi 72 dpi (czyli 72 punkty = 1 cal).

Parameters:

width - szerokość w punktach

height - wysokość w punktach

Throws:

com.lowagie.text.DocumentException - błąd biblioteki IText

palio.PalioException -

DocumentException

createDocument

public final void createDocument(java.lang.Long width,
                                 java.lang.Long height,
                                 java.lang.Object backgroundColor)
                          throws DocumentException,
                                 palio.PalioException

Tworzy nowy dokument o podanych wymiarach i z marginesem o szerokości 36 punktów. Rozdzielczość dokumentu wynosi 72 dpi (czyli 72 punkty = 1 cal). Kolor tła dokumentu może być podany jako tablica [Long, Long, Long], gdzie wartości s z zakresu 0-256, lub jako prosta nazwa typu: red, blue, yellow.

Parameters:

width - szerokość w punktach

height - wysokość w punktach

backgroundColor - kolor tła dokumentu

Throws:

com.lowagie.text.DocumentException - błąd biblioteki IText

palio.PalioException - jeżeli podano nieprawidłową wartość koloru

DocumentException

logDocumentEvents

public void logDocumentEvents(java.lang.String serviceName,
                              java.lang.String documentID)

Dodaje listenera, który wpisuje do logów wszystkie zdarzenia związane z dokumentem. Funkcję należy wywołać bezpośrednio po stworzeniu dokumentu.

Parameters:

serviceName - nazwa serwisu, jak w Log.info(String, String)

documentID - dodatkowy wyróżnik dokumentu (można podać null

openDocument

public void openDocument()

Otwiera dokument umożliwiając wprowadzanie do niego treści.

setMargins

public void setMargins(java.lang.Long leftMargin,
                       java.lang.Long rightMargin,
                       java.lang.Long topMargin,
                       java.lang.Long bottomMargin,
                       java.lang.Boolean mirroring)

Ustawia marginesy dokumentu. Funkcję należy wywołać przed otwarciem dokumentu.

Parameters:

leftMargin - lewy margines

rightMargin - prawy margines

topMargin - górny margines

bottomMargin - dolny margines

mirroring - odbicia lustrzane marginesów (zamiana lewego z prawym na nieparzystych stronach)

setMetaData

public void setMetaData(java.lang.String author,
                        java.lang.String title)

Ustawia meta-dane dokumentu. Funkcję należy wywołać przed otwarciem dokumentu.

Parameters:

author - autor

title - tytuł

setMetaData

public void setMetaData(java.lang.String author,
                        java.lang.String title,
                        java.lang.String subject,
                        java.lang.String keywords)

Ustawia meta-dane dokumentu. Funkcję należy wywołać przed otwarciem dokumentu.

Parameters:

author - autor

title - tytuł

subject - temat

keywords - słowa kluczowe

setFontEmbedding

public void setFontEmbedding(java.lang.Boolean embedding)

Ustawia domyślne zachowanie biblioteki przy zmianie aktywnej czcionki. Opcja jest początkowo ustawiona na true.

Parameters:

embedding - czy czcionki mają być domyślnie umieszczane wewnątrz dokumentu

getFontEmbedding

public java.lang.Boolean getFontEmbedding()

Podaje domyślne zachowanie biblioteki przy zmianie aktywnej czcionki. Opcja jest początkowo ustawiona na true.

setDefaultEncoding

public void setDefaultEncoding(java.lang.String encoding)

Ustawia domyślne kodowanie czcionek.

Parameters:

encoding - domyślne kodowanie czcionek

getDefaultFontEncoding

public java.lang.String getDefaultFontEncoding()

Podaje domyślne kodowanie czcionek. Początkowo parametr ma wartość Cp1250.

getPageNumber

public java.lang.Long getPageNumber()

Zwraca aktualny numer strony. Nie działa w nagłówku i stopce.

getTableTotalHeight

public java.lang.Long getTableTotalHeight()
                                   throws palio.PalioException,
                                          DocumentException

Zwraca aktualną wysokość tabeli.

Throws:

palio.PalioException

DocumentException

Since:

jPALIO 6.13.27, module 1.3.6

setFont

public final void setFont(java.lang.String fontName,
                          java.lang.Long size)
                   throws DocumentException,
                          java.io.IOException

Ustawia czcionkę dla aktualnego kontekstu dokumentu. Kontekst jest dziedziczony w głąb dokumentu. Można podać nazwę jednej ze standardowych czcionek dostępnych w bibliotece iText, lub nazwę (z katalogiem) pliku TTF, np: "C://windows/fonts//arial.ttf", "/opt/ttffonts/arial.ttf".
W tym wywołaniu zostanie użyte domyślne kodowanie, które można zmienić za pomocą funkcji setDefaultEncoding(String).
W tym wywołaniu zostanie użyta domyślna wartość parametru embedded, którą można zmienić za pomocą funkcji setFontEmbedding(Boolean). Dostępne standardowe fonty:

• Times-Roman
• Times-Bold
• Times-Italic
• Times-BoldItalic
• Courier
• Courier-Bold
• Courier-Oblique
• Courier-BoldOblique
• Helvetica
• Helvetica-Bold
• Helvetica-Oblique
• Helvetica-BoldOblique
• Symbol
• ZapfDingbats

Parameters:

fontName - nazwa czcionki

size - rozmiar czcionki w punktach

Throws:

DocumentException

java.io.IOException

setFont

public final void setFont(java.lang.String fontName,
                          java.lang.Long size,
                          java.lang.Long style)
                   throws DocumentException,
                          java.io.IOException

Ustawia czcionkę dla aktualnego kontekstu dokumentu. Kontekst jest dziedziczony w głąb dokumentu. Można podać nazwę jednej ze standardowych czcionek dostępnych w bibliotece iText, lub nazwę (z katalogiem) pliku TTF, np: "C://windows/fonts//arial.ttf", "/opt/ttffonts/arial.ttf".
W tym wywołaniu zostanie użyte domyślne kodowanie, które można zmienić za pomocą funkcji setDefaultEncoding(String).
W tym wywołaniu zostanie użyta domyślna wartość parametru embedded, którą można zmienić za pomocą funkcji setFontEmbedding(Boolean). Dostępne standardowe fonty:

• Times-Roman
• Times-Bold
• Times-Italic
• Times-BoldItalic
• Courier
• Courier-Bold
• Courier-Oblique
• Courier-BoldOblique
• Helvetica
• Helvetica-Bold
• Helvetica-Oblique
• Helvetica-BoldOblique
• Symbol
• ZapfDingbats

Parameters:

fontName - nazwa czcionki

size - rozmiar czcionki w punktach

style - styl czcionki, suma następujących wartości: 0 - normalna, 1 - wytłuszczona, 2 - italik, 4 - podkreślona, 8 - przekreślona

Throws:

DocumentException

java.io.IOException

setFont

public final void setFont(java.lang.String fontName,
                          java.lang.Long size,
                          java.lang.Long style,
                          java.lang.Object[] color)
                   throws DocumentException,
                          java.io.IOException

Ustawia czcionkę dla aktualnego kontekstu dokumentu. Kontekst jest dziedziczony w głąb dokumentu. Można podać nazwę jednej ze standardowych czcionek dostępnych w bibliotece iText, lub nazwę (z katalogiem) pliku TTF, np: "C://windows/fonts//arial.ttf", "/opt/ttffonts/arial.ttf".
W tym wywołaniu zostanie użyte domyślne kodowanie, które można zmienić za pomocą funkcji setDefaultEncoding(String).
W tym wywołaniu zostanie użyta domyślna wartość parametru embedded, którą można zmienić za pomocą funkcji setFontEmbedding(Boolean).
Składowe koloru to liczby typu Long od 0 do 255.
Dostępne standardowe fonty:

• Times-Roman
• Times-Bold
• Times-Italic
• Times-BoldItalic
• Courier
• Courier-Bold
• Courier-Oblique
• Courier-BoldOblique
• Helvetica
• Helvetica-Bold
• Helvetica-Oblique
• Helvetica-BoldOblique
• Symbol
• ZapfDingbats

Parameters:

fontName - nazwa czcionki

size - rozmiar czcionki w punktach

style - styl czcionki, suma następujących wartości: 0 - normalna, 1 - wytłuszczona, 2 - italik, 4 - podkreślona, 8 - przekreślona

color - kolor czcionki, tablica w formacie: [czerwony, zielony, niebieski]

Throws:

DocumentException

java.io.IOException

setFont

public final void setFont(java.lang.String fontName,
                          java.lang.String encoding,
                          java.lang.Boolean embedded,
                          java.lang.Long size,
                          java.lang.Long style,
                          java.lang.Object[] color)
                   throws DocumentException,
                          java.io.IOException

Ustawia czcionkę dla aktualnego kontekstu dokumentu. Kontekst jest dziedziczony w głąb dokumentu. Można podać nazwę jednej ze standardowych czcionek dostępnych w bibliotece iText, lub nazwę (z katalogiem) pliku TTF, np: "C://windows/fonts//arial.ttf", "/opt/ttffonts/arial.ttf".
Składowe koloru to liczby typu Long od 0 do 255.
Dostępne standardowe fonty:

• Times-Roman
• Times-Bold
• Times-Italic
• Times-BoldItalic
• Courier
• Courier-Bold
• Courier-Oblique
• Courier-BoldOblique
• Helvetica
• Helvetica-Bold
• Helvetica-Oblique
• Helvetica-BoldOblique
• Symbol
• ZapfDingbats

Parameters:

fontName - nazwa czcionki

encoding - kodowanie znaków

embedded - czy czcionka ma być osadzona w dokumencie

size - rozmiar czcionki w punktach

style - styl czcionki, suma następujących wartości: 0 - normalna, 1 - wytłuszczona, 2 - italik, 4 - podkreślona, 8 - przekreślona

color - kolor czcionki, tablica w formacie: [czerwony, zielony, niebieski]

Throws:

DocumentException

java.io.IOException

setCustomFont

public final void setCustomFont(java.lang.String fontPath,
                                java.lang.String encoding,
                                java.lang.Boolean embedded,
                                java.lang.Long size,
                                java.lang.Long style,
                                java.lang.Object[] color)
                         throws DocumentException,
                                java.io.IOException

Ustawia dowolną czcionkę TTF (z pliku) dla aktualnego kontekstu dokumentu. Kontekst jest dziedziczony w głąb dokumentu. Składowe koloru to liczby typu Long od 0 do 255.

Parameters:

fontPath - ścieżka do pliku ttf

encoding - kodowanie znaków, np: Cp1250

embedded - czy czcionka ma być dołączona do dokumentu

size - rozmiar czcionki w punktach

style - styl czcionki, suma następujących wartości: 0 - normalna, 1 - wytłuszczona, 2 - italik, 4 - podkreślona, 8 - przekreślona

color - kolor czcionki, tablica w formacie: [czerwony, zielony, niebieski]

Throws:

DocumentException

java.io.IOException

setTextBackground

public final void setTextBackground(java.lang.Object[] color)

Ustawia w aktualnym kontekście dokumentu podany kolor tła dla tekstu. Kontekst jest dziedziczony w głąb dokumentu. Składowe koloru to liczby typu Long od 0 do 255.

Parameters:

color - tablica określająca kolor w formacie: [czerwony, zielony, niebieski]

setTableKeepTogether

public void setTableKeepTogether(java.lang.Boolean keepTogether)
                          throws palio.PalioException,
                                 DocumentException

Ustawia dla tabeli flagę mówiaca o tym czy dana tabela ma byc w miare mozliwosci trzymana na jednej stronie czy nie. Standardowo wartosc tej flagi to false, przez co tabela bedzie lamana i kontynuowana od nastepnej strony jesli tylko nastepny jej wiersz sie nie zmiesci na danej stronie.

Parameters:

keepTogether - wartosc flagi

Throws:

palio.PalioException

DocumentException

Since:

jPALIO 6.13.27, module 1.3.8

addPrintDialog

public void addPrintDialog()

Dodaje kawałek kodu otwierający okienko drukowania po otwarciu dokumentu.

addParagraph

public final void addParagraph(palio.compiler.PalioCode innerCode)
                        throws DocumentException,
                               palio.PalioException

Tworzy nowy paragraf używając podanego kodu palio.

Parameters:

innerCode - kod tworzący treść akapitu

Throws:

DocumentException

palio.PalioException

addParagraph

public final void addParagraph(java.lang.String text)
                        throws DocumentException,
                               palio.PalioException

Tworzy nowy paragraf używając podanego tekstu.

Parameters:

text - treść akapitu

Throws:

DocumentException

palio.PalioException

addParagraph

public final void addParagraph(java.lang.Long alignment,
                               palio.compiler.PalioCode innerCode)
                        throws DocumentException,
                               palio.PalioException

Tworzy nowy paragraf używając podanego kodu palio.

Parameters:

alignment - wyrównanie {0 - do lewej, 1 - do środka, 2 - do prawej, 3 - wyjustowany, 4 - wyjustowany razem z ostatnią linią}

innerCode - kod tworzący treść akapitu

Throws:

DocumentException

palio.PalioException

addParagraph

public final void addParagraph(java.lang.Long alignment,
                               java.lang.String text)
                        throws DocumentException,
                               palio.PalioException

Tworzy nowy paragraf używając podanego tekstu.

Parameters:

alignment - wyrównanie {0 - do lewej, 1 - do środka, 2 - do prawej, 3 - wyjustowany, 4 - wyjustowany razem z ostatnią linią}

text - treść akapitu

Throws:

DocumentException

palio.PalioException

addParagraph

public final void addParagraph(java.lang.Long alignment,
                               java.lang.Long leading,
                               java.lang.String text)
                        throws DocumentException,
                               palio.PalioException

Tworzy nowy paragraf używając podanego tekstu.

Parameters:

alignment - wyrównanie {0 - do lewej, 1 - do środka, 2 - do prawej, 3 - wyjustowany, 4 - wyjustowany razem z ostatnią linią}

leading - przerwa poprzedzająca każdą linię akapitu

text - treść akapitu

Throws:

DocumentException

palio.PalioException

addParagraph

public final void addParagraph(java.lang.Long alignment,
                               java.lang.Object[] extraParams,
                               palio.compiler.PalioCode innerCode)
                        throws DocumentException,
                               palio.PalioException

Tworzy nowy paragraf używając kodu innerCode. Tablica extraParams, jeżeli nie jest null, zawiera następujące parametry (typu Long):

1. Leading - odstęp poprzedzający każdą linię paragrafu
2. FirstLineIndent - wcięcie pierwszej linii podane w punktach
3. SpacingBefore - przerwa przed akapitem
4. SpacingAfter - przerwa za akapitem
5. IndentationLeft - wcięcie całego akapitu z lewej
6. IndentationRight - wcięcie całego akapitu z prawej

W miejsce każdego parametru można wstawić wartość null. Tablica nie musi zawierać wszystkich parametrów (może być krótsza).

Parameters:

alignment - wyrównanie {0 - do lewej, 1 - do środka, 2 - do prawej, 3 - wyjustowany, 4 - wyjustowany razem z ostatnią linią}

extraParams - dodatkowe parametry elementu listy (opisane powyżej)

innerCode - kod budujący treść akapitu

Throws:

DocumentException

palio.PalioException

addParagraph

public final void addParagraph(java.lang.Long alignment,
                               java.lang.Object[] extraParams,
                               java.lang.String text)
                        throws DocumentException,
                               palio.PalioException

Tworzy nowy paragraf używając podanego tekstu. Tablica extraParams, jeżeli nie jest null, zawiera następujące parametry (typu Long):

1. Leading - odstęp poprzedzający każdą linię paragrafu
2. FirstLineIndent - wcięcie pierwszej linii podane w punktach
3. SpacingBefore - przerwa przed akapitem
4. SpacingAfter - przerwa za akapitem
5. IndentationLeft - wcięcie całego akapitu z lewej
6. IndentationRight - wcięcie całego akapitu z prawej

W miejsce każdego parametru można wstawić wartość null. Tablica nie musi zawierać wszystkich parametrów (może być krótsza).

Parameters:

alignment - wyrównanie {0 - do lewej, 1 - do środka, 2 - do prawej, 3 - wyjustowany, 4 - wyjustowany razem z ostatnią linią}

extraParams - dodatkowe parametry elementu listy (opisane powyżej)

text - treść akapitu

Throws:

DocumentException

palio.PalioException

addTable

public final void addTable(java.lang.Long columnCount,
                           java.lang.Long alignment,
                           palio.compiler.PalioCode innerCode)
                    throws DocumentException,
                           palio.PalioException

Tworzy nową tabelkę. Do budowy treści tabeli używa się funkcji addTableCell(java.lang.Long, java.lang.Long, java.lang.String).

Parameters:

alignment - wyrównanie {0 - do lewej, 1 - do środka, 2 - do prawej

columnCount - ilość kolumn w tabeli

innerCode - kod budujący treść tabeli

Throws:

DocumentException

palio.PalioException

addTable

public final void addTable(java.lang.Long columnCount,
                           java.lang.Long alignment,
                           java.lang.Long widthPercentage,
                           palio.compiler.PalioCode innerCode)
                    throws DocumentException,
                           palio.PalioException

Tworzy nową tabelkę. Do budowy treści tabeli używa się funkcji addTableCell(java.lang.Long, java.lang.Long, java.lang.String).

Parameters:

alignment - wyrównanie {0 - do lewej, 1 - do środka, 2 - do prawej

widthPercentage - szerokość tabeli podawana w procentach

columnCount - ilość kolumn w tabeli

innerCode - kod budujący treść tabeli

Throws:

DocumentException

palio.PalioException

addTable

public final void addTable(java.lang.Long columnCount,
                           java.lang.Long alignment,
                           java.lang.Object[] extraParams,
                           palio.compiler.PalioCode innerCode)
                    throws DocumentException,
                           palio.PalioException

Tworzy nową tabelkę. Do budowy treści tabeli używa się funkcji addTableCell(java.lang.Long, java.lang.Long, java.lang.String). Tablica extraParams, jeśli nie jest null, zawiera parametry:

1. Long WidthPercentage - szerokość tabeli w procentach
2. Long TotalWidth - szerokość tabeli w punktach
3. Long SpacingBefore - wolne miejsce przed tabelką
4. Long SpacingAfter - wolne miejsce za tabelką
5. Boolean SplitRow - czy wiersze mogą być dzielone gdy tabelka nie mieści się w całości na stronie
6. Boolean SplitLate - wiersz będzie dzielony tylko jeśli jest pierwszy na pustej stronie
7. Long HeaderRows - ile początkowych wierszy ma być traktowanych jako nagłówek (będą powtarzane na każdej stronie)
8. Long FooterRows - ile końcowych wierszy ma być traktowanych jako stopka (będą powtarzane na każdej stronie)

W miejsce każdego parametru można wstawić wartość null. Tablica nie musi zawierać wszystkich parametrów (może być krótsza).

Parameters:

alignment - wyrównanie {0 - do lewej, 1 - do środka, 2 - do prawej

columnCount - ilość kolumn w tabeli

extraParams - tablica dodatkowych parametrów

innerCode - kod budujący treść tabeli

Throws:

DocumentException

palio.PalioException

addTableCell

public final void addTableCell(java.lang.Long border,
                               java.lang.Long borderWidth,
                               java.lang.String text)
                        throws palio.PalioException

Dodaje do tabeli komórkę poprzez wstawienie paragrafu z podanym tekstem. Czcionka i kolor tła ustawiane według aktualnego kontekstu.

Parameters:

text - tekst do wstawienia w komórce

border - suma kodów poszczególnych elementów ramki {1 - górny, 2 - dolny, 4 - lewy, 8 - prawy}

borderWidth - szerokość ramki w punktach

Throws:

palio.PalioException

addTableCell

public final void addTableCell(java.lang.Long border,
                               java.lang.String text)
                        throws palio.PalioException

Dodaje do tabeli komórkę poprzez wstawienie paragrafu z podanym tekstem. Czcionka i kolor tła ustawiane według aktualnego kontekstu.

Parameters:

text - tekst do wstawienia w komórce

border - suma kodów poszczególnych elementów ramki {1 - górny, 2 - dolny, 4 - lewy, 8 - prawy}

Throws:

palio.PalioException

addTableCell

public final void addTableCell(java.lang.String text)
                        throws palio.PalioException

Dodaje do tabeli komórkę poprzez wstawienie paragrafu z podanym tekstem. Czcionka i kolor tła ustawiane według aktualnego kontekstu.

Parameters:

text - tekst do wstawienia w komórce

Throws:

palio.PalioException

addTableCell

public final void addTableCell(java.lang.Object[] params,
                               palio.compiler.PalioCode innerCode)
                        throws palio.PalioException

Dodaje do tabeli komórkę. Treść komórki budujemy wywołując funkcje addText(java.lang.Long, java.lang.Long, java.lang.String) lub addParagraph(palio.compiler.PalioCode). Czcionka i kolor tła ustawiane według aktualnego kontekstu. Tablica params, jeśli nie jest null, zawiera następujące parametry:

1. Long Border - suma kodów poszczególnych elementów ramki {1 - górny, 2 - dolny, 4 - lewy, 8 - prawy}
2. Long BorderWidth - szerokość ramki w punktach
3. Long Colspan - na ile komórek ma się rozciągać dana komórka
4. Long HorizontalAlignment - wyrównanie zawartości w poziomie {0 - do lewej, 1 - do środka, 2 - do prawej}
5. Long VerticalAlignment - wyrównanie zawartości w pionie {4 - do góry, 5 - do środka, 6 - do dołu}
6. Long FixedHeight - stała wysokość komórki
7. Long MinimumHeight - minimalna wysokość komórki
8. Boolean NoWrap - niezawijanie treści
9. Long Padding - przerwa między ramką a zawartością
10. Long Leading - przerwa między liniami tekstu
11. [Long,Long,Long] BorderColor - kolor ramki
12. [Long,Long,Long] BackgroundColor - kolor tla
13. Long Rowspan - na ile wierszy ma się rozciągać dana komórka

W miejsce każdego parametru można wstawić wartość null. Tablica nie musi zawierać wszystkich parametrów (może być krótsza).

Parameters:

innerCode - kod tworzący treść komórki

params - tablica dodatkowych parametrów

Throws:

palio.PalioException

addTableCell

public final void addTableCell(java.lang.Long border,
                               java.lang.Long borderWidth,
                               java.lang.Long colspan,
                               palio.compiler.PalioCode innerCode)
                        throws palio.PalioException

Dodaje do tabeli komórkę. Treść komórki budujemy wywołując funkcje addText(java.lang.Long, java.lang.Long, java.lang.String) lub addParagraph(palio.compiler.PalioCode). Czcionka i kolor tła ustawiane według aktualnego kontekstu.

Parameters:

innerCode - kod tworzący treść komórki

border - suma kodów poszczególnych elementów ramki {1 - górny, 2 - dolny, 4 - lewy, 8 - prawy}

borderWidth - szerokość ramki w punktach

colspan - na ile komórek ma się rozciągać dana komórka

Throws:

palio.PalioException

addTableCell

public final void addTableCell(java.lang.Object[] params,
                               java.lang.String text)
                        throws palio.PalioException

Dodaje do tabeli komórkę poprzez wstawienie paragrafu z podanym tekstem. Czcionka i kolor tła ustawiane według aktualnego kontekstu. Tablica params, jeśli nie jest null, zawiera następujące parametry:

1. Long Border - suma kodów poszczególnych elementów ramki {1 - górny, 2 - dolny, 4 - lewy, 8 - prawy}
2. Long BorderWidth - szerokość ramki w punktach
3. Long Colspan - na ile komórek ma się rozciągać dana komórka
4. Long HorizontalAlignment - wyrównanie zawartości w poziomie {0 - do lewej, 1 - do środka, 2 - do prawej}
5. Long VerticalAlignment - wyrównanie zawartości w pionie {4 - do góry, 5 - do środka, 6 - do dołu}
6. Long FixedHeight - stała wysokość komórki
7. Long MinimumHeight - minimalna wysokość komórki
8. Boolean NoWrap - niezawijanie treści
9. Long Padding - przerwa między ramką a zawartością
10. Long Leading - przerwa między liniami tekstu
11. [Long,Long,Long] BorderColor - kolor ramki
12. [Long,Long,Long] BackgroundColor - kolor tla
13. Long Rowspan - na ile wierszy ma się rozciągać dana komórka

W miejsce każdego parametru można wstawić wartość null. Tablica nie musi zawierać wszystkich parametrów (może być krótsza).

Parameters:

text - tekst do wstawienia w komórce

params - tablica dodatkowych parametrów

Throws:

palio.PalioException

addTableCell

public final void addTableCell(java.lang.Long border,
                               java.lang.Long borderWidth,
                               java.lang.Long colspan,
                               java.lang.String text)
                        throws palio.PalioException

Dodaje do tabeli komórkę poprzez wstawienie paragrafu z podanym tekstem. Czcionka i kolor tła ustawiane według aktualnego kontekstu.

Parameters:

text - tekst do wstawienia w komórce

border - suma kodów poszczególnych elementów ramki {1 - górny, 2 - dolny, 4 - lewy, 8 - prawy}

borderWidth - szerokość ramki w punktach

colspan - na ile komórek ma się rozciągać dana komórka

Throws:

palio.PalioException

addTableCells

public final void addTableCells(java.lang.Long count,
                                java.lang.Object[] params,
                                java.lang.String text)
                         throws palio.PalioException

Dodaje count komórek o treści text do aktualnej tabeli. Każda komórka zostanie dodana z parametrami params.

Parameters:

count - ile komórek dodać

params - parametry do przekazania każdej komórce, opisane w addTableCell(Object[], String)

text - treść komórek

Throws:

palio.PalioException

addTableCells

public final void addTableCells(java.lang.Long count,
                                java.lang.String text)
                         throws palio.PalioException

Dodaje count komórek o treści text do aktualnej tabeli. Każda komórka zostanie dodana z parametrami params.

Parameters:

count - ile komórek dodać

text - treść komórek

Throws:

palio.PalioException

addTableCells

public final void addTableCells(java.lang.Object[] params,
                                java.lang.Object[] cells)
                         throws palio.PalioException

Dodaje kilka komórek do aktualnej tabeli. Zostanie dodanych tyle komórek, ile jest elementów w tablicy cells. Każda komórka zostanie dodana z parametrami params.

Parameters:

params - parametry do przekazania poszczególnym komórkom, opisane w addTableCell(Object[], String)

cells - treść komórek

Throws:

palio.PalioException

addTableRow

public final void addTableRow(java.lang.Object[] params,
                              java.lang.Object[] cells)
                       throws palio.PalioException

Działa podobnie do funkcji addTableCells(java.lang.Long, java.lang.Object[], java.lang.String) z tym, że stara się zawsze dodać tylko jeden cały wiersz (nawet jak długość tablicy cells jest inna niż podana ilość kolumn w tabeli. Każda komórka zostanie dodana z parametrami params.

Parameters:

params - parametry do przekazania poszczególnym komórkom, opisane w addTableCell(Object[], String)

cells - treść komórek

Throws:

palio.PalioException

setColumnWidths

public final void setColumnWidths(java.lang.Object[] relativeWidths)
                           throws DocumentException,
                                  palio.PalioException

Ustawia względne szerokości kolumn w tabeli. Jeżeli mamy 3 kolumny i chcemy, żeby pierwsza z nich była dwa razy szersza od pozostałych to możemy wywołać funkcję z parametrami [50, 25, 25], ale także: [2, 1, 1].

Parameters:

relativeWidths - tablica względnych szerokości kolumn

Throws:

DocumentException

palio.PalioException

setHeader

public final void setHeader(java.lang.Long columnCount,
                            palio.compiler.PalioCode innerCode)
                     throws palio.PalioException

Tworzy nagłówek dokumentu. Nagłówek jest traktowany jak tabelka, czyli w kodzie innerCode należy wywoływać funkcje addTableCell(java.lang.Long, java.lang.Long, java.lang.String)

Parameters:

columnCount - ilość kolumn w tabeli nagłówka

innerCode - kod w którym tworzona jest zawartość nagłówka

Throws:

palio.PalioException

setFooter

public final void setFooter(java.lang.Long columnCount,
                            palio.compiler.PalioCode innerCode)
                     throws palio.PalioException

Tworzy stopkę dokumentu. Stopka jest traktowana jak tabelka, czyli w kodzie innerCode należy wywoływać funkcje addTableCell(java.lang.Long, java.lang.Long, java.lang.String)

Parameters:

columnCount - ilość kolumn w tabeli stopki

innerCode - kod w którym tworzona jest zawartość stopki

Throws:

palio.PalioException

addList

public void addList(java.lang.String type,
                    java.lang.Long symbolIndent,
                    java.lang.Object[] extraParams,
                    java.lang.Object[] elements)
             throws DocumentException,
                    palio.PalioException

Tworzy listę. Tablica extraParams, jeżeli nie jest null, zawiera następujące parametry:

1. Long/Long/Object First - numer litery w alfabecie od której ma zaczÂąc (np. 3 da "C") / pierwszy numer / symbol listy
2. Long IndentationLeft - wolne miejsce po lewel stronie listy
3. Long Indentation right - wolne miejsce po prawej stronie listy

W miejsce każdego parametru można wstawić wartość null. Tablica nie musi zawierać wszystkich parametrów (może być krótsza).

Parameters:

type - typ listy, możliwe wartości to: NUMBERS, LETTERS, LETTERS_SMALL, SYMBOLS

symbolIndent - miejsce na symbole listy (w punktach)

extraParams - dodatkowe parametry, opisane powyżej

elements - elementy listy typu String

Throws:

DocumentException

palio.PalioException

addList

public void addList(java.lang.String type,
                    java.lang.Long symbolIndent,
                    java.lang.Object[] extraParams,
                    java.util.LinkedList elements)
             throws DocumentException,
                    palio.PalioException

Tworzy listę. Tablica extraParams, jeżeli nie jest null, zawiera następujące parametry:

1. Long/Long/Object First - numer litery w alfabecie od której ma zaczÂąc (np. 3 da "C") / pierwszy numer / symbol listy
2. Long IndentationLeft - wolne miejsce po lewel stronie listy
3. Long Indentation right - wolne miejsce po prawej stronie listy

W miejsce każdego parametru można wstawić wartość null. Tablica nie musi zawierać wszystkich parametrów (może być krótsza).

Parameters:

type - typ listy, możliwe wartości to: NUMBERS, LETTERS, LETTERS_SMALL, SYMBOLS

symbolIndent - miejsce na symbole listy (w punktach)

extraParams - dodatkowe parametry, opisane powyżej

elements - lista z kolejnymi elementami tworzonej w dokumencie listy

Throws:

DocumentException

palio.PalioException

addList

public void addList(java.lang.String type,
                    java.lang.Long symbolIndent,
                    java.lang.Object[] extraParams,
                    palio.compiler.PalioCode innerCode)
             throws palio.PalioException,
                    DocumentException

Tworzy listę. W kodzie innerCode należy wywoływać funkcję addListItem(java.lang.Long, java.lang.Object[], java.lang.String)

Parameters:

type - typ listy, możliwe wartości to: NUMBERS, LETTERS, LETTERS_SMALL, SYMBOLS

symbolIndent - miejsce na symbole listy (w punktach)

extraParams - dodatkowe parametry, opisane w funkcji addList(java.lang.String, java.lang.Long, java.lang.Object[], java.lang.Object[])

innerCode - kod tworzący elementy listy

Throws:

palio.PalioException

DocumentException

addListItem

public void addListItem(java.lang.Long alignment,
                        java.lang.Object[] extraParams,
                        java.lang.String text)
                 throws palio.PalioException

Dodaje element do aktualnie tworzonej listy. Tablica extraParams, jeżeli nie jest null, zawiera następujące parametry (typu Long):

1. Leading
2. FirstLineIndent
3. SpacingBefore
4. SpacingAfter
5. IndentationLeft
6. IndentationRight

W miejsce każdego parametru można wstawić wartość null. Tablica nie musi zawierać wszystkich parametrów (może być krótsza).

Parameters:

alignment - wyrównanie {0 - do lewej, 1 - do środka, 2 - do prawej, 3 - wyjustowany, 4 - wyjustowany razem z ostatnią linią}

extraParams - dodatkowe parametry elementu listy (opisane powyżej)

text - treść elementu listy

Throws:

palio.PalioException

addListItem

public void addListItem(java.lang.Long alignment,
                        java.lang.Object[] extraParams,
                        palio.compiler.PalioCode innerCode)
                 throws palio.PalioException

Dodaje element do aktualnie tworzonej listy. Treść elementu jest tworzona w kodzie innerCode. Tablica extraParams, jeżeli nie jest null, zawiera następujące parametry (typu Long):

1. Leading
2. FirstLineIndent
3. SpacingBefore
4. SpacingAfter
5. IndentationLeft
6. IndentationRight

W miejsce każdego parametru można wstawić wartość null. Tablica nie musi zawierać wszystkich parametrów (może być krótsza).

Parameters:

alignment - wyrównanie {0 - do lewej, 1 - do środka, 2 - do prawej, 3 - wyjustowany, 4 - wyjustowany razem z ostatnią linią}

extraParams - dodatkowe parametry elementu listy (opisane powyżej)

innerCode - kod tworzcy treść elementu listy

Throws:

palio.PalioException

addListItem

public void addListItem(java.lang.Long alignment,
                        java.lang.String text)
                 throws palio.PalioException

Dodaje element do aktualnie tworzonej listy.

Parameters:

alignment - wyrównanie {0 - do lewej, 1 - do środka, 2 - do prawej, 3 - wyjustowany, 4 - wyjustowany razem z ostatnią linią}

text - treść elementu listy

Throws:

palio.PalioException

addListItem

public void addListItem(java.lang.Long alignment,
                        palio.compiler.PalioCode innerCode)
                 throws palio.PalioException

Dodaje element do aktualnie tworzonej listy. Treść elementu jest tworzona w kodzie innerCode.

Parameters:

alignment - wyrównanie {0 - do lewej, 1 - do środka, 2 - do prawej, 3 - wyjustowany, 4 - wyjustowany razem z ostatnią linią}

innerCode - kod tworzcy treść elementu listy

Throws:

palio.PalioException

addList

public void addList(java.lang.String type,
                    java.lang.Long symbolIndent,
                    java.lang.Object[] extraParams,
                    java.util.LinkedList elements,
                    java.lang.Long elementIndex)
             throws DocumentException,
                    palio.PalioException

Tworzy listę. Tablica extraParams, jeżeli nie jest null, zawiera następujące parametry:

1. Long/Long/Object First - numer litery w alfabecie od której ma zaczÂąc (np. 3 da "C") / pierwszy numer / symbol listy
2. Long IndentationLeft - wolne miejsce po lewel stronie listy
3. Long Indentation right - wolne miejsce po prawej stronie listy

W miejsce każdego parametru można wstawić wartość null. Tablica nie musi zawierać wszystkich parametrów (może być krótsza).

Parameters:

type - typ listy, możliwe wartości to: NUMBERS, LETTERS, LETTERS_SMALL, SYMBOLS

symbolIndent - miejsce na symbole listy (w punktach)

extraParams - dodatkowe parametry, opisane powyżej

elements - lista z kolejnymi elementami tworzonej w dokumencie listy

elementIndex - jeśli elements jest listą tablic (wynik zapytania SQL) to zostanie użyty element tablicy pod indeksem elementIndex

Throws:

DocumentException

palio.PalioException

addText

public void addText(java.lang.Long x,
                    java.lang.Long y,
                    java.lang.String text)

Wstawia podany tekst w dowolnym miejscu dokumentu. Punkt 0,0 leży w dolnym lewym rogu dokumentu.
W tym wywołaniu funkcja setTextBackground(Object[]) nie jest uwzględniana.

Parameters:

x - położenie w poziomie

y - położenie w pionie

text - tekst

addText

public void addText(java.lang.Long x,
                    java.lang.Long y,
                    java.lang.Object[] transformMatrix,
                    java.lang.String text)

Wstawia podany tekst w dowolnym miejscu dokumentu. Punkt 0,0 leży w dolnym lewym rogu dokumentu. Znaczenie kolejnych elementów (typu Number) macierzy przekształcenia:

1. 1 - normalny, -1 odbicie wzgl. osi pionowej
2. obrót tekstu (bez obracania liter)
3. obrót liter
4. 1 - normalny, -1 - odbicie wzgl. osi poziomej

.
Przykładowe wywołania: [1, 0, 0, 1] - tekst normalny, [1, 1, -1, 1] - tekst obrócony o 45 stopni w lewo.
W tym wywołaniu funkcja setTextBackground(Object[]) nie jest uwzględniana.

Parameters:

x - położenie w poziomie

y - położenie w pionie

transformMatrix - dodatkowa macierz przekształcenia tekstu, może być null

text - tekst

addTextAligned

public void addTextAligned(java.lang.Long x,
                           java.lang.Long y,
                           java.lang.String text,
                           java.lang.Long alignment,
                           java.lang.Long rotation,
                           java.lang.Boolean kerned)

Wstawia wyrównany tekst w dowolnym miejscu dokumentu. Punkt 0,0 leży w dolnym lewym rogu dokumentu.
W tym wywołaniu funkcja setTextBackground(Object[]) nie jest uwzględniana.

Parameters:

x - położenie w poziomie

y - położenie w pionie

text - tekst

alignment - wyrównanie tekstu: 0 - do lewej, 1 - do środka, 2 - do prawej

rotation - obrót tekstu podany w stopniach od 0 do 360

kerned - czy ma zostać użyty 'kerning' jako sposób regulacji świateł międzyliterowych

addText

public final void addText(java.lang.String text)
                   throws DocumentException,
                          palio.PalioException

Dodaje kawałek tekstu do elementu dokumentu, który jest aktualnym kontekstem (dokument, akapit, lista, komórka tabeli).

Parameters:

text - tekst do dodania

Throws:

DocumentException

palio.PalioException

addText

public final void addText(java.lang.Long count,
                          java.lang.String text)
                   throws DocumentException,
                          palio.PalioException

Dodaje count razy podany kawałek tekstu do elementu dokumentu, który jest aktualnym kontekstem (dokument, akapit, lista, komórka tabeli).

Parameters:

text - tekst do dodania

count - ile razy dodać podany tekst

Throws:

DocumentException

palio.PalioException

addText

public final void addText(java.lang.String text,
                          java.lang.Long textRise)
                   throws DocumentException,
                          palio.PalioException

Dodaje tekst do elementu dokumentu, który jest aktualnym kontekstem (dokument, akapit, lista, komórka tabeli).

Parameters:

text - tekst do dodania

textRise - przesunięcie pionowe tekstu podane w punktach

Throws:

DocumentException

palio.PalioException

addText

public final void addText(java.lang.Long count,
                          java.lang.String text,
                          java.lang.Long textRise)
                   throws DocumentException,
                          palio.PalioException

Dodaje count razy podany kawałek tekstu do elementu dokumentu, który jest aktualnym kontekstem (dokument, akapit, lista, komórka tabeli).

Parameters:

text - tekst do dodania

count - ile razy dodać podany tekst

textRise - przesunięcie pionowe tekstu podane w punktach

Throws:

DocumentException

palio.PalioException

addImage

public final void addImage(java.lang.String url,
                           java.lang.Object[] extraParams)
                    throws DocumentException,
                           java.io.IOException,
                           java.lang.NoSuchFieldException,
                           palio.PalioException

Dodaje obrazek do dokumentu. Tablica extraParams, jeżeli nie jest null, zawiera następujące parametry:

1. String/Long Alignment - wyrównanie obrazka: LEFT (0), MIDDLE (1), RIGHT (2), UNDERLYING (8), TEXTWRAP (4); jeżeli podajemy liczbowo to dwie ostatnie wartości można dosumować do jednej z pozostałych
2. [Long, Long] AbsolutePosition - bezwzgldne położenie obrazka na stronie podane w punktach (X, Y) liczone od lewego dolnego rogu
3. String ScalingMode - tryb skalowania: ABSOLUTE, PROPORTIONAL, PERCENT
4. [Long, Long] Size - wielkość obrazka w punktach lub procentach, zależnie od trybu skalowania (X, Y)
5. Long Rotation - obrót podany w stopniach

W miejsce każdego parametru można wstawić wartość null. Tablica nie musi zawierać wszystkich parametrów (może być krótsza).

Parameters:

url - URL do obrazka

extraParams - dodatkowe parametry

Throws:

DocumentException

java.io.IOException

java.lang.NoSuchFieldException

palio.PalioException

addImage

public final void addImage(byte[] image,
                           java.lang.Object[] extraParams)
                    throws DocumentException,
                           java.io.IOException,
                           java.lang.NoSuchFieldException,
                           palio.PalioException

Dodaje obrazek do dokumentu. Tablica extraParams, jeżeli nie jest null, zawiera następujące parametry:

1. String/Long Alignment - wyrównanie obrazka: LEFT (0), MIDDLE (1), RIGHT (2), UNDERLYING (8), TEXTWRAP (4); jeżeli podajemy liczbowo to dwie ostatnie wartości można dosumować do jednej z pozostałych
2. [Long, Long] AbsolutePosition - bezwzgldne położenie obrazka na stronie podane w punktach (X, Y) liczone od lewego dolnego rogu
3. String ScalingMode - tryb skalowania: ABSOLUTE, PROPORTIONAL, PERCENT
4. [Long, Long] Size - wielkość obrazka w punktach lub procentach, zależnie od trybu skalowania (X, Y)
5. Long Rotation - obrót podany w stopniach

W miejsce każdego parametru można wstawić wartość null. Tablica nie musi zawierać wszystkich parametrów (może być krótsza).

Parameters:

image - zawartość obrazka

extraParams - dodatkowe parametry

Throws:

DocumentException

java.io.IOException

java.lang.NoSuchFieldException

palio.PalioException

createBarcode

public java.lang.Object createBarcode(java.lang.String code,
                                      java.lang.String type)
                               throws palio.PalioException

Tworzy obiekt typu PdfTemplate z kodem kreskowym. Utworzony w ten sposób obiekt umieszczamy w dokumencie za pomocą funkcji addTemplate(Long, Long, Object[], Object). Możliwe typy kodów: CODABAR, CODE128, CODE128_UCC, CODE128_RAW, EAN8, EAN13, UPCA, UPCE, SUPP2, SUPP5, PLANET, POSTNET, INTER25, CODE39, CODE39_EXT. Jeżeli w kontekście dokumentu nie ma ustawionej czcionki to zostaną wygenerowane same kreski kodu.

Parameters:

code - kod do wygenerowania

type - typ kodu

Throws:

palio.PalioException

createBarcode

public java.lang.Object createBarcode(java.lang.String code,
                                      java.lang.String type,
                                      java.lang.Object[] barParams,
                                      java.lang.Object[] textParams)
                               throws palio.PalioException

Tworzy obiekt typu PdfTemplate z kodem kreskowym. Utworzony w ten sposób obiekt umieszczamy w dokumencie za pomocą funkcji addTemplate(Long, Long, Object[], Object). Możliwe typy kodów: CODABAR, CODE128, CODE128_UCC, CODE128_RAW, EAN8, EAN13, UPCA, UPCE, SUPP2, SUPP5, PLANET, POSTNET, INTER25, CODE39, CODE39_EXT.

Tablica barParams, jeśli nie jest null, zawiera następujące parametry kodu kreskowego:

1. (definicja koloru) BarColor - kolor kresek
2. Long/BigDecimal BarHeight - wysokość kresek w punktach
3. Long/BigDecimal X - minimalna szerokość kreski
4. Long/BigDecimal N - mnożnik szerokości szerszej kreski lub odstęp pomiędzy kreskami (PLANET i POSTNET)
5. Long/BigDecimal InkSpreading
6. Boolean GuardBars
7. Boolean GenerateChecksum - wygenerowanie sumy kontrolnej

W miejsce każdego parametru można wstawić wartość null. Tablica nie musi zawierać wszystkich parametrów (może być krótsza).

Tablica textParams, jeśli nie jest null, zawiera następujące parametry tekstu:

1. (definicja koloru) TextColor - kolor tekstu
2. Long TextAlignment - wyrównanie tekstu względem kodu {0 - po lewej, 1 - po środku, 2 - po prawej}
3. Long/BigDecimal Size - wielkość czcionki
4. Long/BigDecimal Baseline - odległość od kresek (pod lub nad, zależnie od znaku liczby)
5. Boolean StartStopText - początkowa i końcowa gwiazdka *
6. Boolean ChecksumText - wypisanie sumy kontrolnej

W miejsce każdego parametru można wstawić wartość null. Tablica nie musi zawierać wszystkich parametrów (może być krótsza). Jeżeli w kontekście dokumentu nie ma ustawionej czcionki to zostaną wygenerowane same kreski kodu.

Definicja koloru: tablica komponentów koloru (wartości od 0 do 255): [czerwony, zielony, niebieski], lub nazwa (dla kolorów podstawowych): RED, BLUE, YELLOW...

Parameters:

code - kod do wygenerowania

type - typ kodu

barParams - parametry kodu

textParams - parametry tekstu

Throws:

palio.PalioException

setStrictImageSequence

public void setStrictImageSequence(java.lang.Boolean strict)

Ustawia wewnętrzny parametr generatora, który decyduje o tym w którym momencie do danego dokumentu zostanie dodany obrazek niemieszczący się na aktualnej stronie. Przykładowo:
- jesteśmy przy końcu strony i dodajemy do dokumentu dwa obrazki
- pierw większy (nie zmieści się na tej stronie)
- potem mniejszy (zmieściłby się, gdyby nie ten większy)
- jeżeli strict=true generator przeskoczy do następnej strony i tam doda oba obrazki, w niezmienionej kolejności
- jeżeli strict=false generator doda większy obrazek jak tylko dojdzie do nowej strony, a tymczasem sprawdzi czy nastepne elementy treści się nie zmieszcza… jeszcze na tej stronie (i doda mniejszy obrazek).

Parameters:

strict - wartość parametru

newPage

public void newPage()
             throws palio.PalioException,
                    DocumentException

Wstawia znacznik nowej strony do dokumentu.

Throws:

palio.PalioException

DocumentException

closeDocument

public final byte[] closeDocument()

Zamyka tworzony dokument i zwraca jego zawartość.

Returns:

zawartość dokumentu

mergePDFs

public byte[] mergePDFs(java.util.LinkedList<byte[]> pdfs_byte)
                 throws palio.PalioException

Throws:

palio.PalioException