PAL

Overview

The SynqpayPrinter module integrates with the built-in thermal printer on Synqpay devices, allowing developers to create structured print jobs using the Printer Abstraction Layer (PAL).

---

Printing API

void print(in Bundle bundle);

The print method accepts a Bundle object representing the document to be printed. The Bundle is constructed using the SynqpayPAL package.

int getStatus();

The getStatus method retrieves the printer's current status.

---

Printer Status

The PrinterStatus class defines constants for various printer states:

• OK (0): Printer is ready.
• Error (1): Printer has encountered an error.
• PaperEnded (2): Printer is out of paper.
• PaperEnding (3): Printer paper is running low.
• PaperJam (4): Paper jam detected.
• CoverOpen (5): Printer cover is open.
• Unknown (6): Status is unknown.

---

Printer Abstraction Layer (PAL)

The SynqpayPAL package provides the necessary tools for building structured, customizable printable documents. It offers options for adjusting text direction, alignment, and line customization.

SynqpayPAL class

Direction Enum

• LTR: Left-to-right text direction (default).
• RTL: Right-to-left text direction.

Align Enum

• START: Aligns text to the left.
• END: Aligns text to the right.
• CENTER: Centers the text.

BarcodeType Enum

• CODE_128: Generates Code 128 barcode.
• QR_CODE: Generates QR codes.

Key Defaults

• Direction: Left-to-Right (LTR)
• Alignment: Start
• Text size: 14 (inherited from the line, but can be overridden for specific text)
• Fill last: false
• Vertical space: None

Key Methods

public static IDocument newDocument();

Creates a new document for printing.

---

IDocument Interface

The IDocument interface provides methods for constructing and finalizing a printable document.

Key Methods

IDocument direction(SynqpayPAL.Direction eDirection);

Sets the text flow direction.

ILine addLine();

Adds a new line to the document.

IDocument addSpace(int space);

Adds vertical space between elements (default: none).

IDocument addDivider(int height);

Adds a horizontal divider with specified thickness.

IBarcode addBarcode();

Adds a barcode element to the document.

IImage addImage();

Adds an image element to the document.

Bundle bundle();

Finalizes the document into a Bundle for printing.

---

ILine Interface

The ILine interface customizes the layout of text elements within a line.

Working Modes

1. Regular Mode: Text elements are added sequentially without spacing. Alignment applies only to the entire line, not individual text elements.
2. Fill Last Mode: The last text element stretches to fill the remaining space in the line. Alignment can only be adjusted for the last element.
3. Weight Mode: Space allocation is proportional to the weight of text elements. The fillLast property is ignored. Alignment can be applied to all text elements because they occupy distinct spaces.

Key Methods

IText addText();

Adds a text element to the line.

ILine align(SynqpayPAL.Align align);

Sets the alignment for the entire line (not individual text elements).

ILine textSize(int size);

Sets the text size for all elements in the line (default: 14). Inherited by text elements but can be overridden for specific text.

ILine fillLast(boolean fill);

Enables the Fill Last Mode.

ILine spaceTop(int spaceTop);

Adds space above the line (default: none).

ILine spaceBottom(int spaceBottom);

Adds space below the line (default: none).

---

IText Interface

The IText interface customizes the appearance and styling of text elements.

Key Methods

IText text(String text);

Sets the text content.

IText bold(boolean bold);

Applies bold styling to the text.

IText italic(boolean italic);

Applies italic styling to the text.

IText underline(boolean underline);

Underlines the text.

IText textSize(int size);

Sets the text size (default: inherited from the line, but can be overridden for specific text).

IText weight(int weight);

Defines the space allocation weight for Weight Mode.

IText align(SynqpayPAL.Align align);

Sets the alignment for the text element.

---

IBarcode Interface

The IBarcode interface defines barcode elements for printing.

Key Methods

IBarcode align(SynqpayPAL.Align align);

Sets the alignment for the barcode.

IBarcode content(String content);

Sets the content for the barcode.

IBarcode type(SynqpayPAL.BarcodeType type);

Specifies the barcode type (e.g., QR_CODE or CODE_128).

IBarcode size(int height, int width);

Sets the size of the barcode using specific height and width.

IBarcode size(int width);

Sets the width of the barcode, with the height determined automatically.

IBarcode spaceTop(int spaceTop);

Adds space above the barcode (default: none).

IBarcode spaceBottom(int spaceBottom);

Adds space below the barcode (default: none).

---

IImage Interface

The IImage interface defines image elements for printing.

The ImageFrame class is the marshalling wrapper for sending Android Bitmap objects to the Synqpay printer. This is the type that must be used to send Bitmap images to the printer.

Key Methods

IImage image(ImageFrame image);

Sets the image content using an ImageFrame.

IImage align(SynqpayPAL.Align align);

Sets the alignment for the image.

IImage spaceTop(int spaceTop);

Adds space above the image (default: none).

IImage spaceBottom(int spaceBottom);

Adds space below the image (default: none).

---

Example Usage

import android.os.Bundle;
import SynqpayPAL.*;

// Create a new document
IDocument document = SynqpayPAL.newDocument();
document.addImage()
        .align(SynqpayPAL.Align.CENTER)
        .image(new ImageFrame(
                Bitmap.createScaledBitmap(BitmapFactory.decodeResource(getResources(),R.drawable.mcdonalds), 200,200,false)))
        .spaceBottom(20);

ILine line1 = document.addLine();
line1.addText()
        .text("Hello");
line1.addText().text("World!");

document.addSpace(30);

document.addLine().addText().text("Fill Last Mode").bold(true);
document.addDivider(4);
ILine line2 = document.addLine();
line2.fillLast(true);
line2.addText().text("Hello");
line2.addText().text("World").align(SynqpayPAL.Align.END);

document.addSpace(30);

document.addLine().addText().text("Weight Mode").bold(true);
document.addDivider(4);
ILine line3 = document.addLine();
line3.addText().text("Hello").weight(1);
line3.addText().text("World").weight(1);
ILine line4 = document.addLine();
line4.addText().text("Another").weight(1);
line4.addText().text("Text of line").weight(1);

document.addSpace(10);

ILine line5 = document.addLine();
line5.addText().text("ITEM").weight(6);
line5.addText().text("QTY").weight(2);
line5.addText().text("PRICE").weight(3).align(SynqpayPAL.Align.END);

ILine line6 = document.addLine();
line6.addText().text("Apples").weight(6);
line6.addText().text("1kg").weight(2);
line6.addText().text("$1.00").weight(3).align(SynqpayPAL.Align.END);

ILine line7 = document.addLine();
line7.addText().text("Coca Cola 1,5l").weight(6);
line7.addText().text("3 pcs").weight(2);
line7.addText().text("$10.00").weight(3).align(SynqpayPAL.Align.END);

ILine line8 = document.addLine();
line8.addText().text("Bread 1,5l").weight(6);
line8.addText().text("3 pcs").weight(2);
line8.addText().text("$10.00").weight(3).align(SynqpayPAL.Align.END);

document.addBarcode()
        .size(250)
        .type(SynqpayPAL.BarcodeType.QR_CODE)
        .content("https://google.com")
        .spaceBottom(10)
        .spaceTop(10)
        .align(SynqpayPAL.Align.CENTER);

document.addBarcode()
        .size(40,400)
        .type(SynqpayPAL.BarcodeType.CODE_128)
        .content("12345678901234567890")
        .spaceBottom(10)
        .spaceTop(10)
        .align(SynqpayPAL.Align.CENTER);



// Finalize and print
Bundle bundle = document.bundle();
try {
    printer.print(bundle);
} catch (RemoteException e) {
    throw new RuntimeException(e);
}

Example