ru.crystals.pos.api.ext.loyal.dto

Class SlipParagraph

java.lang.Object

ru.crystals.pos.api.ext.loyal.dto.SlipParagraph

public class SlipParagraph
extends java.lang.Object

Сущность, представляющая "абзац" на чековом слипе.
NOTE: "абзац" - это минимальная атомарная единица, что может быть распечатана на слипе. Представляет из себя либо абзац текста, либо ШК (штрих-код). Каждый "абзац" печатается на чековой ленте с новой строки.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FORMATTED_TEXT_PREFIX Префикс, если с которого начинается текст payload, то ищём в нем маркеры с атрибутами текста Маркер в тексте - это число, указанное в квадратных скобках, которое указывает номера шрифта и его атрибуты для части текста, следующей за маркером, но до следующего маркера или конца абзаца.
private java.awt.image.BufferedImage	image Изображение, которое будет печататься данным параграфом.
private java.util.List<SlipText>	paragraphParts части абзаца с указанием номера шрифта и его атрибутов SlipText, SlipTextOptions
private java.lang.String	payload само сообщение "абзаца", что надо вывести на чековой ленте.
private SlipParagraphType	type Способ представления содержимого этого абзаца.

Constructor Summary

Constructors

Constructor and Description
SlipParagraph() Конструктор класса.
SlipParagraph(java.awt.image.BufferedImage image) Конструктор класса.
SlipParagraph(SlipParagraphType type, java.lang.String payload) Конструктор класса.

Method Summary

Modifier and Type	Method and Description
java.awt.image.BufferedImage	getImage() Возвращает изображение, которое представляет данный параграф.
java.util.List<SlipText>	getParagraphParts()
java.lang.String	getPayload() Возвращает текстовое содержимое параграфа.
SlipParagraphType	getType() Возвращает тип параграфа.
void	setPayload(java.lang.String payload) Устанавливает содержимое текстового параграфа.
void	setType(SlipParagraphType type) Устанавливает тип параграфа.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

FORMATTED_TEXT_PREFIX

public static final java.lang.String FORMATTED_TEXT_PREFIX

Префикс, если с которого начинается текст payload, то ищём в нем маркеры с атрибутами текста Маркер в тексте - это число, указанное в квадратных скобках, которое указывает номера шрифта и его атрибуты для части текста, следующей за маркером, но до следующего маркера или конца абзаца. Например, "\\f[18]Hello [2]world!" - напечатает строку, где "Hello " - жирный Шрифт 13х48, "world!" - жирный Шрифт 13х24; - для формирования этого числа можно пользоваться SlipTextOptions

Since:

0.0.41

See Also:

Constant Field Values

payload

private java.lang.String payload

само сообщение "абзаца", что надо вывести на чековой ленте.

image

private java.awt.image.BufferedImage image

Изображение, которое будет печататься данным параграфом.

Since:

0.0.41

paragraphParts

private java.util.List<SlipText> paragraphParts

части абзаца с указанием номера шрифта и его атрибутов SlipText, SlipTextOptions

Since:

0.0.41

type

private SlipParagraphType type

Способ представления содержимого этого абзаца.

Constructor Detail

SlipParagraph

public SlipParagraph()

Конструктор класса. Создаёт новый экземпляр класса SlipParagraph

SlipParagraph

public SlipParagraph(java.awt.image.BufferedImage image)

Конструктор класса. Создаёт новый экземпляр класса SlipParagraph с типом содержимого - изображение. При вызове этого конструктора параграфу автоматически выставляется тип SlipParagraphType.IMAGE.
Не все фискальные принтеры умеют распечатывать изображение, а те, что умеют, обладают рядом ограничений. Таким образом, доступные к печати изображения будут разниться в зависимости от модели фискального принтера касса использует. Если фискальный принтер не поддерживает печать изображений или параметры изображения выходят за рамки допустимых, оно распечатано не будет.
Ограничения:
для ПИРИТ 1Ф:
размер растра (считается как (длина х высота) / 8): до 11 Кб (11 264 байта);
ширина и высота должны быть кратны 8;
максимальный размер изображения 512х512 точек для чековой ленты шириной 80 мм и 336х400 точек для ленты шириной 57 мм;
для ПИРИТ 2Ф:
то же, но максимальный размер растра увеличен до 22 Кб (22 525 байта).
Изображение должно быть черно-белым.
В случае, если изображение не удовлетворяет заданным требованиям, касса может попытаться самостоятельно подогнать его под требования, что может существенно ухудшить качество изображения. Посему рекомендуется сразу передавать черно-белые изображения в формате bmp с глубиной цвета 1 бит и отвечающие остальным заданным требованиям.

Parameters:

image - изображение

SlipParagraph

public SlipParagraph(SlipParagraphType type,
                     java.lang.String payload)

Конструктор класса. Создаёт новый экземпляр класса SlipParagraph

Parameters:

type - тип параграфа

payload - текстовое содержимое параграфа

Method Detail

getPayload

public java.lang.String getPayload()

Возвращает текстовое содержимое параграфа.

Returns:

текстовое содержание параграфа или null, если параграф не текстовый или пустой.

setPayload

public void setPayload(java.lang.String payload)

Устанавливает содержимое текстового параграфа. Это имеет смысл только для параграфов типа SlipParagraphType.TEXT, SlipParagraphType.BARCODE, SlipParagraphType.QR - тех, которые действительно могут нести текстовое содержимое. Для нетекстовых параграфов, например SlipParagraphType.IMAGE установленный текст не будет иметь эффекта

Parameters:

payload - содержимое текстового параграфа

getType

public SlipParagraphType getType()

Возвращает тип параграфа. От типа параграфа зависит как касса будет интерпретировать его содержимое - распечатать как текст, баркод, изображение, etc.

Returns:

тип параграфа

setType

public void setType(SlipParagraphType type)

Устанавливает тип параграфа. От типа параграфа зависит как касса будет интерпретировать его содержимое - распечатать как текст, баркод, изображение, etc.

Parameters:

type - тип параграфа

getImage

public java.awt.image.BufferedImage getImage()

Возвращает изображение, которое представляет данный параграф. Имеет смысл только для параграфов типа SlipParagraphType.IMAGE, в остальных случаях содержимое этого поля игнорируется кассой.

Returns:

изображение, которое будет печататься в данном параграфе

Since:

0.0.41

See Also:

SlipParagraph(BufferedImage)

getParagraphParts

public java.util.List<SlipText> getParagraphParts()

Returns:

части абзаца с указанием номера шрифта и его атрибутов SlipText, SlipTextOptions

Since:

0.0.41

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object