palio.modules
Class Bar

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

All Implemented Interfaces:

palio.modules.core.CurrentModuleDataKeys

public class Bar
extends palio.modules.core.Module

Moduł generuje obrazki z kodami kreskowymi różnych typów.

Standardowe parametry obsługiwane przez wszystkie typy kodów:

• Long/BigDecimal BarHeight - wysokość kresek w mm
• String FontName - nazwa użytej czcionki {Arial, Helvetica ...}
• String MsgPosition - pozycja tekstu względem kresek {None, Top, Bottom}
• Long/BigDecimal FontSize - wielkość czcionki w mm
• Long/BigDecimal Height - całkowita wysokość kodu z tekstem
• Long/BigDecimal ModuleWidth - szerokość najwęższej kreski w mm
• Long/BigDecimal QuietZone - szerokość bocznych marginesów obrazka w mm
• Long/BigDecimal Resolution - rozdzielczość generowanego obrazka w punktach na cal (domyślnie 150)
• Long/BigDecimal Orientation - orientacja generowanego obrazka w stopniach: 0, 90, -90, 180, -180, 270 and -270 (domyślnie 0)
• Boolean AntiAlias - rozmycie krawędzi (domyślnie false)

Jeżeli chcemy podawać wymiary w pikselach zamiast milimetrach musimy użyć funkcji przeliczającej pix2mm(Long, Long).

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

Version:

1.2.0

Author:

Mateusz Gembarzewski

Field Summary

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

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

Method Summary

byte[]	codaBar(java.lang.String code, java.util.Map<java.lang.String,java.lang.Object> params) Generuje kod kreskowy typu CODABAR jako obrazek PNG.
java.lang.String	codaBarURL(java.lang.String code, java.util.Map<java.lang.String,java.lang.Object> params) Generuje obrazek z kodem kreskowym typu CODABAR i zwraca do niego link.
byte[]	code128Bar(java.lang.String code, java.util.Map<java.lang.String,java.lang.Object> params) Generuje kod kreskowy typu CODE128 jako obrazek PNG.
java.lang.String	code128BarURL(java.lang.String code, java.util.Map<java.lang.String,java.lang.Object> params) Generuje obrazek z kodem kreskowym typu CODE128 i zwraca do niego link.
byte[]	code39Bar(java.lang.String code, java.util.Map<java.lang.String,java.lang.Object> params) Generuje kod kreskowy typu CODE39 jako obrazek PNG.
java.lang.String	code39BarURL(java.lang.String code, java.util.Map<java.lang.String,java.lang.Object> params) Generuje obrazek z kodem kreskowym typu CODE39 i zwraca do niego link.
byte[]	dataMatrixBar(java.lang.String code, java.util.Map<java.lang.String,java.lang.Object> params) Generuje kod 2D typu DataMatrix jako obrazek PNG.
java.lang.String	dataMatrixBarURL(java.lang.String code, java.util.Map<java.lang.String,java.lang.Object> params) Generuje obrazek z kodem 2D typu DataMatrix i zwraca do niego odnośnik.
byte[]	ean13Bar(java.lang.String code, java.util.Map<java.lang.String,java.lang.Object> params) Generuje kod kreskowy typu EAN13 jako obrazek PNG.
java.lang.String	ean13BarURL(java.lang.String code, java.util.Map<java.lang.String,java.lang.Object> params) Generuje obrazek z kodem kreskowym typu EAN13 i zwraca do niego link.
byte[]	ean8Bar(java.lang.String code, java.util.Map<java.lang.String,java.lang.Object> params) Generuje kod kreskowy typu EAN8 jako obrazek PNG.
java.lang.String	ean8BarURL(java.lang.String code, java.util.Map<java.lang.String,java.lang.Object> params) Generuje obrazek z kodem kreskowym typu EAN8 i zwraca do niego link.
java.lang.String	getVersion() Returns the module version
byte[]	inter25Bar(java.lang.String code, java.util.Map<java.lang.String,java.lang.Object> params) Generuje kod kreskowy typu INTER25 (Interleaved 2 of 5) jako obrazek PNG.
java.lang.String	inter25BarURL(java.lang.String code, java.util.Map<java.lang.String,java.lang.Object> params) Generuje obrazek z kodem kreskowym typu INTER25 (Interleaved 2 of 5) i zwraca do niego link.
java.math.BigDecimal	pix2mm(java.lang.Long pixels, java.lang.Long resolution) Przelicza wielkość podaną w pikselach na milimetry przy założonej rozdzielczości.
byte[]	postnetBar(java.lang.String code, java.util.Map<java.lang.String,java.lang.Object> params) Generuje kod kreskowy typu POSTNET jako obrazek PNG.
java.lang.String	postnetBarURL(java.lang.String code, java.util.Map<java.lang.String,java.lang.Object> params) Generuje obrazek z kodem kreskowym typu POSTNET i zwraca do niego link.
byte[]	upcaBar(java.lang.String code, java.util.Map<java.lang.String,java.lang.Object> params) Generuje kod kreskowy typu UPCA jako obrazek PNG.
java.lang.String	upcaBarURL(java.lang.String code, java.util.Map<java.lang.String,java.lang.Object> params) Generuje obrazek z kodem kreskowym typu UPCA i zwraca do niego link.
byte[]	upceBar(java.lang.String code, java.util.Map<java.lang.String,java.lang.Object> params) Generuje kod kreskowy typu UPCE jako obrazek PNG.
java.lang.String	upceBarURL(java.lang.String code, java.util.Map<java.lang.String,java.lang.Object> params) Generuje obrazek z kodem kreskowym typu UPCE i zwraca do niego link.

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

Constructor Detail

Bar

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

Method Detail

getVersion

public java.lang.String getVersion()

Description copied from class: palio.modules.core.Module

Returns the module version

Specified by:

getVersion in class palio.modules.core.Module

code39Bar

public byte[] code39Bar(java.lang.String code,
                        java.util.Map<java.lang.String,java.lang.Object> params)
                 throws java.io.IOException

Generuje kod kreskowy typu CODE39 jako obrazek PNG.

Dodatkowe parametry obsługiwane przez ten typ kodów:

• String ChecksumMode - tryb cyfry kontrolnej {Auto (domyślny), Ignore, Add, Check}
• Boolean DisplayChecksum - czy pokazywać znak kontrolny (domyślnie false)
• Boolean DisplayStartStop - czy pokazywać znaki start/stop (domyślnie false)
• Long/BigDecimal WideFactor - stosunek szerokich kresek do wąskich (domyślnie 2.5)
• Long/BigDecimal IntercharGapWidth - odstęp pomiędzy znakami

Parameters:

code - kod do zakodowania

params - dodatkowe parametry

Returns:

zawartość obrazka

Throws:

java.io.IOException

code128Bar

public byte[] code128Bar(java.lang.String code,
                         java.util.Map<java.lang.String,java.lang.Object> params)
                  throws java.io.IOException

Generuje kod kreskowy typu CODE128 jako obrazek PNG.

Parameters:

code - kod do zakodowania

params - dodatkowe parametry

Returns:

zawartość obrazka

Throws:

java.io.IOException

inter25Bar

public byte[] inter25Bar(java.lang.String code,
                         java.util.Map<java.lang.String,java.lang.Object> params)
                  throws java.io.IOException

Generuje kod kreskowy typu INTER25 (Interleaved 2 of 5) jako obrazek PNG.

Dodatkowe parametry obsługiwane przez ten typ kodów:

• Boolean DisplayChecksum - czy pokazywać znak kontrolny (domyślnie false)
• Long/BigDecimal WideFactor - stosunek szerokich kresek do wąskich (domyślnie 3)
• String ChecksumMode - tryb cyfry kontrolnej {Auto (domyślny), Ignore, Add, Check}

Parameters:

code - kod do zakodowania

params - dodatkowe parametry

Returns:

zawartość obrazka

Throws:

java.io.IOException

codaBar

public byte[] codaBar(java.lang.String code,
                      java.util.Map<java.lang.String,java.lang.Object> params)
               throws java.io.IOException

Generuje kod kreskowy typu CODABAR jako obrazek PNG.

Dodatkowe parametry obsługiwane przez ten typ kodów:

• Long/BigDecimal WideFactor - stosunek szerokich kresek do wąskich (domyślnie 3)
• String ChecksumMode - tryb cyfry kontrolnej {Auto (domyślny), Ignore, Add, Check}

Parameters:

code - kod do zakodowania

params - dodatkowe parametry

Returns:

zawartość obrazka

Throws:

java.io.IOException

postnetBar

public byte[] postnetBar(java.lang.String code,
                         java.util.Map<java.lang.String,java.lang.Object> params)
                  throws java.io.IOException

Generuje kod kreskowy typu POSTNET jako obrazek PNG.

Dodatkowe parametry obsługiwane przez ten typ kodów:

• String ChecksumMode - tryb cyfry kontrolnej {Auto (domyślny), Ignore, Add, Check}
• String BaselinePosition - wyrównanie kresek {Bottom - do dołu (domyślny), Top - do góry}
• Boolean DisplayChecksum - czy pokazywać znak kontrolny (domyślnie false)
• Long/BigDecimal ShortBarHeight - wysokość krótkich kresek w mm
• Long/BigDecimal IntercharGapWidth - odstęp pomiędzy znakami

Parameters:

code - kod do zakodowania

params - dodatkowe parametry

Returns:

zawartość obrazka

Throws:

java.io.IOException

ean8Bar

public byte[] ean8Bar(java.lang.String code,
                      java.util.Map<java.lang.String,java.lang.Object> params)
               throws java.io.IOException

Generuje kod kreskowy typu EAN8 jako obrazek PNG.

Parameters:

code - kod do zakodowania

params - dodatkowe parametry

Returns:

zawartość obrazka

Throws:

java.io.IOException

ean13Bar

public byte[] ean13Bar(java.lang.String code,
                       java.util.Map<java.lang.String,java.lang.Object> params)
                throws java.io.IOException

Generuje kod kreskowy typu EAN13 jako obrazek PNG.

Parameters:

code - kod do zakodowania

params - dodatkowe parametry

Returns:

zawartość obrazka

Throws:

java.io.IOException

upcaBar

public byte[] upcaBar(java.lang.String code,
                      java.util.Map<java.lang.String,java.lang.Object> params)
               throws java.io.IOException

Generuje kod kreskowy typu UPCA jako obrazek PNG.

Parameters:

code - kod do zakodowania

params - dodatkowe parametry

Returns:

zawartość obrazka

Throws:

java.io.IOException

upceBar

public byte[] upceBar(java.lang.String code,
                      java.util.Map<java.lang.String,java.lang.Object> params)
               throws java.io.IOException

Generuje kod kreskowy typu UPCE jako obrazek PNG.

Parameters:

code - kod do zakodowania

params - dodatkowe parametry

Returns:

zawartość obrazka

Throws:

java.io.IOException

dataMatrixBar

public byte[] dataMatrixBar(java.lang.String code,
                            java.util.Map<java.lang.String,java.lang.Object> params)
                     throws java.io.IOException

Generuje kod 2D typu DataMatrix jako obrazek PNG.

Dodatkowe parametry obsługiwane przez ten typ kodów:

• String Shape - wymuszony kształt {None, Square, Rectangle}

Parameters:

code - Wartość do zakodowania

params - Dodatkowe parametry

Throws:

java.io.IOException

Since:

module 1.2.0, jPALIO 7.4.34

code39BarURL

public java.lang.String code39BarURL(java.lang.String code,
                                     java.util.Map<java.lang.String,java.lang.Object> params)
                              throws java.io.IOException

Generuje obrazek z kodem kreskowym typu CODE39 i zwraca do niego link.

Dodatkowe parametry obsługiwane przez ten typ kodów:

• String ChecksumMode - tryb cyfry kontrolnej {Auto (domyślny), Ignore, Add, Check}
• Boolean DisplayChecksum - czy pokazywać znak kontrolny (domyślnie false)
• Boolean DisplayStartStop - czy pokazywać znaki start/stop (domyślnie false)
• Long/BigDecimal WideFactor - stosunek szerokich kresek do wąskich (domyślnie 2.5)
• Long/BigDecimal IntercharGapWidth - odstęp pomiędzy znakami

Parameters:

code - kod do zakodowania

params - dodatkowe parametry

Returns:

link do obrazka z wygenerowanym kodem

Throws:

java.io.IOException

code128BarURL

public java.lang.String code128BarURL(java.lang.String code,
                                      java.util.Map<java.lang.String,java.lang.Object> params)
                               throws java.io.IOException

Generuje obrazek z kodem kreskowym typu CODE128 i zwraca do niego link.

Parameters:

code - kod do zakodowania

params - dodatkowe parametry

Returns:

link do obrazka z wygenerowanym kodem

Throws:

java.io.IOException

inter25BarURL

public java.lang.String inter25BarURL(java.lang.String code,
                                      java.util.Map<java.lang.String,java.lang.Object> params)
                               throws java.io.IOException

Generuje obrazek z kodem kreskowym typu INTER25 (Interleaved 2 of 5) i zwraca do niego link.

Dodatkowe parametry obsługiwane przez ten typ kodów:

• Boolean DisplayChecksum - czy pokazywać znak kontrolny (domyślnie false)
• Long/BigDecimal WideFactor - stosunek szerokich kresek do wąskich (domyślnie 3)
• String ChecksumMode - tryb cyfry kontrolnej {Auto (domyślny), Ignore, Add, Check}

Parameters:

code - kod do zakodowania

params - dodatkowe parametry

Returns:

link do obrazka z wygenerowanym kodem

Throws:

java.io.IOException

codaBarURL

public java.lang.String codaBarURL(java.lang.String code,
                                   java.util.Map<java.lang.String,java.lang.Object> params)
                            throws java.io.IOException

Generuje obrazek z kodem kreskowym typu CODABAR i zwraca do niego link.

Dodatkowe parametry obsługiwane przez ten typ kodów:

• Long/BigDecimal WideFactor - stosunek szerokich kresek do wąskich (domyślnie 3)
• String ChecksumMode - tryb cyfry kontrolnej {Auto (domyślny), Ignore, Add, Check}

Parameters:

code - kod do zakodowania

params - dodatkowe parametry

Returns:

link do obrazka z wygenerowanym kodem

Throws:

java.io.IOException

postnetBarURL

public java.lang.String postnetBarURL(java.lang.String code,
                                      java.util.Map<java.lang.String,java.lang.Object> params)
                               throws java.io.IOException

Generuje obrazek z kodem kreskowym typu POSTNET i zwraca do niego link.

Dodatkowe parametry obsługiwane przez ten typ kodów:

• String ChecksumMode - tryb cyfry kontrolnej {Auto (domyślny), Ignore, Add, Check}
• String BaselinePosition - wyrównanie kresek {Bottom - do dołu (domyślny), Top - do góry}
• Boolean DisplayChecksum - czy pokazywać znak kontrolny (domyślnie false)
• Long/BigDecimal ShortBarHeight - wysokość krótkich kresek
• Long/BigDecimal IntercharGapWidth - odstęp pomiędzy znakami

Parameters:

code - kod do zakodowania

params - dodatkowe parametry

Returns:

link do obrazka z wygenerowanym kodem

Throws:

java.io.IOException

ean8BarURL

public java.lang.String ean8BarURL(java.lang.String code,
                                   java.util.Map<java.lang.String,java.lang.Object> params)
                            throws java.io.IOException

Generuje obrazek z kodem kreskowym typu EAN8 i zwraca do niego link.

Parameters:

code - kod do zakodowania

params - dodatkowe parametry

Returns:

link do obrazka z wygenerowanym kodem

Throws:

java.io.IOException

ean13BarURL

public java.lang.String ean13BarURL(java.lang.String code,
                                    java.util.Map<java.lang.String,java.lang.Object> params)
                             throws java.io.IOException

Generuje obrazek z kodem kreskowym typu EAN13 i zwraca do niego link.

Parameters:

code - kod do zakodowania

params - dodatkowe parametry

Returns:

link do obrazka z wygenerowanym kodem

Throws:

java.io.IOException

upcaBarURL

public java.lang.String upcaBarURL(java.lang.String code,
                                   java.util.Map<java.lang.String,java.lang.Object> params)
                            throws java.io.IOException

Generuje obrazek z kodem kreskowym typu UPCA i zwraca do niego link.

Parameters:

code - kod do zakodowania

params - dodatkowe parametry

Returns:

link do obrazka z wygenerowanym kodem

Throws:

java.io.IOException

upceBarURL

public java.lang.String upceBarURL(java.lang.String code,
                                   java.util.Map<java.lang.String,java.lang.Object> params)
                            throws java.io.IOException

Generuje obrazek z kodem kreskowym typu UPCE i zwraca do niego link.

Parameters:

code - kod do zakodowania

params - dodatkowe parametry

Returns:

link do obrazka z wygenerowanym kodem

Throws:

java.io.IOException

dataMatrixBarURL

public java.lang.String dataMatrixBarURL(java.lang.String code,
                                         java.util.Map<java.lang.String,java.lang.Object> params)
                                  throws java.io.IOException

Generuje obrazek z kodem 2D typu DataMatrix i zwraca do niego odnośnik.

Parameters:

code - Wartość do zakodowania

params - Dodatkowe parametry

Returns:

Odnośnik do obrazka z wygenerowanym kodem

Throws:

java.io.IOException

pix2mm

public java.math.BigDecimal pix2mm(java.lang.Long pixels,
                                   java.lang.Long resolution)

Przelicza wielkość podaną w pikselach na milimetry przy założonej rozdzielczości. Rozdzielczość podawana w punktach na cal (DPI).

Parameters:

pixels - ilość pikseli

resolution - rozdzielczość