UniPRT SDK  v1.0.0.0
com.UniPRT.Sdk.LabelMaker.Abstract.ADataMatrix Class Referenceabstract
Inheritance diagram for com.UniPRT.Sdk.LabelMaker.Abstract.ADataMatrix:
com.UniPRT.Sdk.LabelMaker.Abstract.ABarcode2D com.UniPRT.Sdk.LabelMaker.Interface.ISquareCell com.UniPRT.Sdk.LabelMaker.Interface.IBarcode2D com.UniPRT.Sdk.LabelMaker.Interface.IBarcodeItem_2D com.UniPRT.Sdk.LabelMaker.Interface.IPositionRuler com.UniPRT.Sdk.LabelMaker.Interface.IRotation com.UniPRT.Sdk.LabelMaker.PGL.DataMatrixBarcode com.UniPRT.Sdk.LabelMaker.TSPL.DataMatrixBarcode

Public Member Functions

boolean IsRectangle ()
 Sets the shape for barcode to be rectangular shape, otherwise default square shape is used. More...
 
void SetRectangle (boolean rectangle)
 
Tuple< Integer, Integer > GetRowsCols ()
 Specify the number of cells in terms of rows and columns of the barcode if want to manually set the barcode matrix dimensions. More...
 
void SetRowsCols (Tuple< Integer, Integer > rowsCols)
 
String GetCtrlChar (int decimalCharValue)
 Gets a string that represents non-printable control character in 0-31 range. More...
 
String GetFNC1 ()
 Get a string that represents the FNC1 character in order to include it within the barcode data. More...
 
ICellSquare GetCellSize ()
 Barcode cell size. Larger cell size results in barcodes that take up a larger area. More...
 
void SetCellSize (ICellSquare cellSize)
 
abstract String toString ()
 
- Public Member Functions inherited from com.UniPRT.Sdk.LabelMaker.Abstract.ABarcode2D
IRuler GetRuler ()
 The print resolution can be set in either inch or MM scale. Setting/Updating either scale results in updates to both. More...
 
void SetRuler (IRuler ruler)
 
IPoint GetStart ()
 Position where barcode starts. More...
 
void SetStart (IPoint start)
 
String GetData ()
 The barcode content. More...
 
void SetData (String data)
 
RotateEnum GetRotation ()
 
void SetRotation (RotateEnum rotation)
 
abstract String ToString ()
 Returns the string that can be sent to printer. More...
 

Protected Member Functions

 ADataMatrix ()
 
 ADataMatrix (IPoint start, String data)
 

Protected Attributes

char ctrlCharDelimiter = CTRL_DELIM_PGL
 

Static Protected Attributes

static final char CTRL_DELIM_PGL = '\u000E'
 
static final char CTRL_DELIM_TSPL = '~'
 

Private Attributes

boolean rectangle
 
Tuple< Integer, Integer > rowsCols = new Tuple<>(0, 0)
 
ICellSquare cellSize = Defaults.GetCellSize()
 

Constructor & Destructor Documentation

◆ ADataMatrix() [1/2]

com.UniPRT.Sdk.LabelMaker.Abstract.ADataMatrix.ADataMatrix ( )
protected

◆ ADataMatrix() [2/2]

Member Function Documentation

◆ GetCellSize()

ICellSquare com.UniPRT.Sdk.LabelMaker.Abstract.ADataMatrix.GetCellSize ( )

◆ GetCtrlChar()

String com.UniPRT.Sdk.LabelMaker.Abstract.ADataMatrix.GetCtrlChar ( int  decimalCharValue)

Gets a string that represents non-printable control character in 0-31 range.

This is useful when need to include non-printable characters within the barcode data. e.g. End Of Line characters 0x0D (CR) or 0x0A (LF) with decimal values 13 or 10 respectively.

References com.UniPRT.Sdk.LabelMaker.Abstract.ADataMatrix.ctrlCharDelimiter.

◆ GetFNC1()

String com.UniPRT.Sdk.LabelMaker.Abstract.ADataMatrix.GetFNC1 ( )

Get a string that represents the FNC1 character in order to include it within the barcode data.

References com.UniPRT.Sdk.LabelMaker.Abstract.ADataMatrix.ctrlCharDelimiter.

◆ GetRowsCols()

Tuple<Integer, Integer> com.UniPRT.Sdk.LabelMaker.Abstract.ADataMatrix.GetRowsCols ( )

Specify the number of cells in terms of rows and columns of the barcode if want to manually set the barcode matrix dimensions.

Must specify valid values for rows and columns based on square or rectangular shape selected by Rectangle.
Valid Square dimensions (row & col): 10, 12, 14, 16, 18, 20, 22, 24, 26, 32, 36, 40, 44, 48, 52, 64, 72, 80, 88, 96, 104, 120, 132, 144
Valid Rectangle dimensions (row x col): 8x18, 8x32, 12x26, 12x36, 16x36, 16x48

Parameters
[in]Item1Rows. 0 to allow automatic dimensions.
[in]Item2Columns. 0 to allow automatic dimensions.

References com.UniPRT.Sdk.LabelMaker.Abstract.ADataMatrix.rowsCols.

Referenced by com.UniPRT.Sdk.LabelMaker.PGL.DataMatrixBarcode.toString(), and com.UniPRT.Sdk.LabelMaker.TSPL.DataMatrixBarcode.toString().

◆ IsRectangle()

boolean com.UniPRT.Sdk.LabelMaker.Abstract.ADataMatrix.IsRectangle ( )

Sets the shape for barcode to be rectangular shape, otherwise default square shape is used.

References com.UniPRT.Sdk.LabelMaker.Abstract.ADataMatrix.rectangle.

Referenced by com.UniPRT.Sdk.LabelMaker.PGL.DataMatrixBarcode.toString(), and com.UniPRT.Sdk.LabelMaker.TSPL.DataMatrixBarcode.toString().

◆ SetCellSize()

void com.UniPRT.Sdk.LabelMaker.Abstract.ADataMatrix.SetCellSize ( ICellSquare  cellSize)

◆ SetRectangle()

void com.UniPRT.Sdk.LabelMaker.Abstract.ADataMatrix.SetRectangle ( boolean  rectangle)

◆ SetRowsCols()

void com.UniPRT.Sdk.LabelMaker.Abstract.ADataMatrix.SetRowsCols ( Tuple< Integer, Integer >  rowsCols)

◆ toString()

abstract String com.UniPRT.Sdk.LabelMaker.Abstract.ADataMatrix.toString ( )
abstract

Member Data Documentation

◆ cellSize

◆ CTRL_DELIM_PGL

final char com.UniPRT.Sdk.LabelMaker.Abstract.ADataMatrix.CTRL_DELIM_PGL = '\u000E'
staticprotected

◆ CTRL_DELIM_TSPL

final char com.UniPRT.Sdk.LabelMaker.Abstract.ADataMatrix.CTRL_DELIM_TSPL = '~'
staticprotected

◆ ctrlCharDelimiter

◆ rectangle

boolean com.UniPRT.Sdk.LabelMaker.Abstract.ADataMatrix.rectangle
private

◆ rowsCols

Tuple<Integer, Integer> com.UniPRT.Sdk.LabelMaker.Abstract.ADataMatrix.rowsCols = new Tuple<>(0, 0)
private

The documentation for this class was generated from the following file: