Recursos

A continuación se dispone de los recursos necesarios para operar la impresora en los dispositivos POS PRO2.

Librería de impresión

Librería de impresión para dispositivos KOZEN.

Javadoc de librería

Javadoc de la librería (en inglés) para complementar el desarrollo.

Modo de uso

La librería de impresión para dispositivos POS PRO2 presenta una API de alto nivel que facilita la impresión de documentos. Para comenzar a imprimir, es necesario crear una instancia de la clase POIPrinterManager y conectar con la impresora del dispositivo. El constructor recibe como parámetro el contexto de la aplicación.


// Obtiene el contexto de la applicación
Context context = getApplicationConext();

// Instancia el administador de impresión con el contexto de la aplicación
POIPrinterManager printerManager = new POIPrinter(context);

// Conecta la impresora
try {
    printerManager.open();
} catch (NullPointerException e) {
    Log.e(MY_TAG, "La conexión con la impresora falló!", e);
}

Luego de iniciar la impresora, se debe definir el documento a imprimir. Para esto, la API dispone de métodos que permiten agregar líneas o bitmaps, con su respectivo estilo. Estos elementos son representados en la librería con las clases TextPrintLine y BitmapPrintLine.

/*
 * Esta clase presenta múltiples construtores que permiten detallar en distintos grados el estilo del texto.
 */
TextPrintLine myTextLine = new TextPrintLine(
    "Hola mundo!", // Texto a imprimir
    0,             // Alinear texto a la izquierda
    20,            // tamaño de letra
    false,         // negrita
    false,         // cursiva
);

// Obtiene los recursos desde el conexto.
Resources resources = context.getResources();

// Genera un bitmap de la imagen a dibujar
Bitmap myBitmap = BitmapFactory.decodeResource(resources, R.drawable.myBitmap);

// Define el BitmapPrintLine a imprimir.
BitmapPrintLine myBitmapLine = new BitmapPrintLine(
    myBitmap, // Bitmap a imprimir
    1         // Alinea imagen al centro
);

Una vez definidas las líneas del documento, estas se deben agregar a la impresión. También es posible añadir líneas en blanco o lineas de texto presentadas como columnas.

// Agrega línea de texto
printerManager.addPrintLine(myTextLine);

// El BitmapPrintLine es también un TextPrintLine.
printerManager.addPrintLine(myBitmapLine);

// Agrega líneas en blanco.
printerManager.addBlankView(2);

// También es posible agregar dos columnas de texto,
// alineando un texto a la izquierda y otro a la derecha.
printerManager.addPrintLine(Arrays.asList(
     new TextPrintLine("Izquierda", 0), new TextPrintLine("Derecha", 2)
));

// O incluso tres columnas
printerManager.addPrintLine(Arrays.asList(
     new TextPrintLine("Izquierda", 0),
     new TextPrintLine("Centro", 1),
     new TextPrintLine("Derecha", 2)
));

// Se agregan líneas en blanco al final del documento para facilitar el recorte.
printerManager.addBlankView(5);

Ya definido el documento a imprimir, se solicita la impresión. Esto imprimirá todas las líneas agregadas en el administrador de impresión. El cache debe limpiarse después de solicitar la impresión.

La solicitud de impresión recibe un listener que debe implementar métodos onStart(), onFinish() y onError().

// Define el listener a usar en la impresión.
POIPrinterManager.IPrinterListener myListener = new POIPrinterManager.IPrinterListener() {  
    @Override  
    public void onStart() {  
        Log.d(MY_TAG, "onStart");
    }
  
    @Override  
    public void onFinish() {  
         Log.d(MY_TAG, "onFinish");
    }
  
    @Override  
    public void onError(int errorCode, String msg) {  
         Log.d(MY_TAG, "onError:" + errorCode + " - msg:" + msg);
    }
});

// Solicita la impresión.
printerManager.beginPrint(myListener);

// Limpia el cache de impresión.
printerManager.cleanCache();

Se recomienda que se haga uso del listener para recibir eventos de errores y manejarlos según corresponda. Es posible que la impresión falle por sobrecalentamiento de la impresora. No se soporta la impresión con la pantalla bloqueada y la impresión fallará si se intenta.

Los códigos de error recibidos por el listener se encuentran definidos en la clase POIPrinterManager.

 @Overrride
  public void onError(int errorCode, String msg)
  {
      String error;
      switch (errorCode) {
          case POIPrinterManager.ERROR_INIT: {
              error = "No se logró iniciar la impresora!";
              break;
          }
          case POIPrinterManager.ERROR_PRINT: {
              error = "Ocurrió un error al imprimir!: " + msg;
              break;
          }
          case POIPrinterManager.ERROR_OVERHEAT: {
              error = "La impresora se sobrecalentó!";
              break;
          }
          case POIPrinterManager.ERROR_NO_PAPER: {
              error = "La impresora no tienen papel!";
              break;
          }
        case POIPrinterManager.ERROR_OTHER: {
              error = "La impresora falló por un error no especificado!: " + msg;
              break;
          }
      }
      // ...

Referencia de API

A continuación se presenta una referencia de API para el SDK de impresión POS PRO2.

POIPrinterManager

Clase administradora de impresión. Esta es la clase que se encarga de conectar con la impresora, preparar los datos y comenzar a imprimir.

Campos de clase

Modificador y tipo	Campo	Descripción.
static final int	ERROR_INIT	Código de error de impresión. Fallo al iniciar impresora.
static final int	ERROR_NO_PAPER	Código de error de impresión. Fallo debido a falta de papel.
static final int	ERROR_OTHER	Código de error de impresión. Fallo no especificado.
static final int	ERROR_OVERHEAT	Código de error de impresión. Fallo debido a sobrecalentamiento.
static final int	ERROR_PRINT	Código de error de impresión. Fallo durante la impresión.
static final int	STATUS_IDLE	Código de estado de impresión. Impresora está lista para operar.
static final int	STATUS_NO_PAPER	Código de estado de impresión. Impresora sin papel.
static final int	STATUS_NO_PRINTER	Código de estado de impresión. No hay impresora disponible.
static final int	STATUS_OVERHEAT	Código de estado de impresión. La impresora está sobrecalentada.
static final int	STATUS_PRINTING	Código de estado de impresión. La impresora está trabajando.

Resumen de métodos

Modifier and Type	Method	Description
void	addBlankView(int line)	Añade líneas en blanco.
void	addLinearPrintLine(List<TextPrintLine> line)	Añade múltiples TextPrintLine a un layout lineal.
void	addPrintLine(PrintLine line)	Añade un solo TextPrintLine o BitmapPrintLine la impresión.
void	addPrintLine(List line)	Añade múltiples TextPrintLine to a layout relativo.
void	beginPrint(POIPrinterManager.IPrinterListener printerListener)	Comienza a imprimir los datos de impresión.
void	cleanCache()	Limpia los datos de impresión.
void	close()	Cierra y libera la impresora.
void	continuePrint(boolean restart)	Continúa el proceso de impresión si falló debido a sobrecalentamiento o falta de papel.
double	getBeforePrinterLength()	Obtiene el largo total de la impresión antes de imprimir.
String	getFont()	Obtiene el path de la actual fuente.
double	getPrinterLength()	Obtiene el largo total de la impresión.
int	getPrinterState()	Obtiene el estado de la impresora.
void	lineWrap(int value)	Imprime líneas blancas al comienzo de la impresión con tamaño predeterminado.
void	lineWrapPixels(int value)	Imprime líneas blancas al comienzo de la impresión con tamaño configurado.
void	open()	Inicia la impresora.
void	setBlankViewPixel(int pixel)	Fija pixeles para líneas en blanco.
void	setLineSpace(int line)	Fija separación de líneas.
void	setLineWrapPixels(int value)	Fija pixeles para líneas en blanco.
void	setPrintFont(String path)	Fija la fuente de impresión con un path a una fuente.
void	setPrintFontAssets(String path)	Fija la fuente de impresión con el nombre de una fuente.
void	setPrintGray(int gray)	Fija el valor de escala de gris en la impresión.
void	setPrintRed(int red)	Fija el valor de la escala de rojo en la impresión.
void	setPrintType(String type)	Fija el tipo de impresión.

Constructores

POIPrinterManager

public POIPrinterManager(android.content.Context context)

Construye una nueva instancia del administrador de impresión.

Parámetros:

context - Contexto de la aplicación.

Métodos

open

public void open()

Conecta con la impresora.

Lanza:

NullPointerException - cuando la conexión con la impresora falla.

continuePrint

public void continuePrint(boolean restart)

Continúa el proceso de impresión si falló debido a sobrecalentamiento o falta de papel.

Parámetros:

restart - true para empezar desde el comienzo, false para continuar donde quedó.

public void close()

Cierra y libera la impresora.

getPrinterState

public int getPrinterState()

Obtiene el estado actual de la immpresora.

Retorna:

Código de estado de impresora.

setPrintType

public void setPrintType(String type)

Fija el tipo de impresión.

Parámetros:

type - "00" para impresión normal, "01" para impresión de label.

setPrintGray

public void setPrintGray(int gray)

Fija el valor de la escala de grises. El valor predeterminado es 1200.

Mientras más grande el valor, más oscura es la letra.

Parámetros:

gray - Valor de escala de grises. Rango de valores: [300, 5000]

setPrintRed

public void setPrintRed(int red)

Fija el valor de la escala de rojo.

Parámetros:

red - Valor de la escala de rojo.

setPrintFont

public void setPrintFont(String path)

Fija la fuente del texto con un path a una fuente.

Parámetros:

path - Path de sistema a fuente. Ejemplo: /system/fonts/DroidSansMono.ttf

setPrintFontAssets

public void setPrintFont(String path)

Fija la fuente del texto con el nombre de un asset. Solo se tiene que pasar el nombre de la fuente como parámetro.

Ejemplo: setPrintFontAssets("Android-1.ttf")

Parámetros:

path - Path a recurso de assets. Ejemplo: assets/fonts/DroidSansMono.ttf

getFont

public String getFont()

Obtiene el path de la actual fuente aplicada.

Retorna:

Path a fuente.

setLineSpace

public void setLineSpace(int line)

Fija el valor de espaciado de líneas.

Parámetros:

line - Valor de espaciado de líneas.

cleanCache

public void cleanCache()

Limpia datos de impresión agregados.

addPrintLine

public void addPrintLine(PrintLine line)

Añade un solo TextPrintLine o BitmapPrintLine a la impresión.

Parámetros:

line - Objeto TextPrintLine o BitmapPrintLine a agregar.

addPrintLine

public void addPrintLine(List line)

Añade múltiples TextPrintLine a un layout relativo.

Parámetros:

line - Lista de TextPrintLine a agregar.

addLinearPrintLine

public void addLinearPrintLine(List line)

Añade múltiples TextPrintLine a un layout lineal.

Parámetros:

line - Lista de TextPrintLine a agregar.

addBlankView

public void addBlankView(int line)

Añade líneas en blanco.

Parámetros:

line - Cantidad de líneas en blanco.

setBlankViewPixel

public void setBlankViewPixel(int pixel)

Fija pixeles para líneas en blanco.

Parámetros:

pixel - Número de pixeles por cada línea en blanco.

beginPrint

public void beginPrint(POIPrinterManager.IPrinterListener printerListener)

Comienza a imprimir los datos de impresión.

Parámetros:

printerListener - Listener que escucha eventos de impresión (start, finish y error).

lineWrap

public void lineWrap(int value)

Imprime líneas blancas al comienzo de la impresión con tamaño predeterminado.

Parámetros:

value - Número de líneas blancas.

lineWrapPixels

public void lineWrap(int value)

Imprime líneas blancas al comienzo de la impresión con tamaño configurado.

La altura de cada línea se define con el método setLineWrapPixels()

Parámetros:

value - Número de líneas blancas.

setLineWrapPixels

public void setLineWrapPixels(int value)

Fija pixeles para líneas en blanco.

Parámetros:

pixel - Número de pixeles por cada línea en blanco.

getPrinterLength

public double getPrinterLength()

Obtiene el largo total de la impresión.

Retorna:

Largo total de los datos impresos.

getBeforePrinterLength

public double getBeforePrinterLength()

Obtiene el largo total de la impresión antes de imprimir.

Retorna:

Largo total antes de la impresión.

POIPrinterManager.IPrinterListener

Interfaz que define listener para eventos de impresión. Se deben definir los métodos, los que actuarán como callback cuando ocurra algún evento durante la impresión. Se recomienda capturar los eventos de error para manejarlos como corresponde.

Resumen de métodos

Modificador y Tipo	Método	Descripción
void	onError(int var1, String var2)	Escucha a eventos de error de impresión.
void	onFinish()	Escucha a evento de término de impresión.
void	onStart()	Escucha a evento de comienzo de impresión.

Métodos

onError

void onError(int var1, String var2)

Escucha a eventos de error de impresión.

Parámetros:

var1 - Código de error de impresión, los que se definen en la clase POIPrinterManager.
var2 - Mensaje de error de impresión.

onFinish

void onFinish()

Escucha a evento de término de impresión.

onStart

void onStart()

Escucha a evento de comienzo de impresión.

TextPrintLine

Abstracción para representar líneas de texto en la impresión. Hereda los métodos de la clase PrintLine.

Campos de clase

Modificador y tipo	Campo	Descripción
static final float	FONT_LARGE	Tamaño de fuente grande.
static final float	FONT_NORMAL	Tamaño de fuente normal (predeterminado).
static final float	FONT_SMALL	Tamaño de fuente pequeño.

Resumen de métodos

Modificador y tipo	Método	Descripción
String	getContent()	Obtiene el contenido de la línea de texto.
float	getLetterSpacing()	Obtiene el valor de espaciado de las letras.
String	getPrintFont()	Obtiene el path a la fuente del texto.
float	getSize()	Obtiene el tamaño de la letra del texto.
float	getTextScaleX()	Obtiene el valor de escalado del texto.
float	getWordSpacing()	Obtiene el valor de espaciado de palabras.
boolean	isBold()	Obtiene si el texto tiene estilo negrita aplicado.
boolean	isInvert()	Obtiene si el texto tiene estilo colores invertidos aplicado.
boolean	isItalic()	Obtiene si el texto tiene estilo cursiva aplicado.
boolean	isMirrorInvertY()	Obtiene si el texto tiene estilo reflejo aplicado.
boolean	isUnderLineText()	Obtiene si el texto tiene estilo subrayado aplicado.
void	setBold(boolean bold)	Fija el estilo de texto negrita.
void	setContent(String content)	Fija el contenido de la línea de texto.
void	setInvert(boolean invert)	Fija el estilo de texto colores invertidos.
void	setItalic(boolean italic)	Fija el estilo de texto cursiva.
void	setLetterSpacing(float letterSpacing)	Fija el valor de espaciado de las letras.
void	setMirrorInvertY(boolean mirrorInvertY)	Fija el estilo de texto reflejo.
void	setPrintFont(String printFont)	Fija el path a la fuente del texto.
void	setSize(float size)	Fija el tamaño de la letra del texto.
void	setSize(int size)	Fija el tamaño de la letra del texto.
void	setTextScaleX(float textScaleX)	Fija el valor de escalado del texto.
void	setUnderLineText(boolean underLineText)	Fija el estilo de texto subrayado.
void	setWordSpacing(float wordSpacing)	Fija el valor de espaciado de palabras.
String	toString()	Obtiene una representación de string de todos los parámetros.

Constructores

TextPrintLine

public TextPrintLine()

Constructor predeterminado. Genera una línea de texto de tamaño predeterminado, alineada a la izquierda, con texto vacío.

TextPrintLine

public TextPrintLine(String content)

Genera una línea de texto de tamaño predeterminado, alineada a la izquierda, con el texto dado.

Parámetros:

content - Texto de línea.

TextPrintLine

public TextPrintLine(String content, int position)

Genera una línea de texto de tamaño predeterminado con el texto y alineamiento dado.

Parámetros:

content - Texto de línea.
position - Alinemiento de línea. 0 para alinear a la izquierda, 1 para alinear al centro , 2 para alinear a la derecha.

TextPrintLine

public TextPrintLine(String content, int position, float size)