UniPRT SDK  v1.0.0.0
com.UniPRT.Sdk.LabelMaker.Abstract.APdf417 Class Referenceabstract

Base class for PDF417 barcode. More...

Inheritance diagram for com.UniPRT.Sdk.LabelMaker.Abstract.APdf417:
com.UniPRT.Sdk.LabelMaker.Abstract.ABarcode2D com.UniPRT.Sdk.LabelMaker.Interface.IRectangleCell 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.Pdf417Barcode com.UniPRT.Sdk.LabelMaker.TSPL.Pdf417Barcode

Public Member Functions

ICellRect GetCellSize ()
 The cell size can be thought of as the width and height of the narrowest bar element within a PDF417 row. More...
 
void SetCellSize (ICellRect cellSize)
 
Pdf417ErrCorrectionEnum GetErrorCorrection ()
 
void SetErrorCorrection (Pdf417ErrCorrectionEnum errorCorrection)
 
int GetRows ()
 The number of rows can be used to limit the height of the barcode. More...
 
void SetRows (int rows)
 
int GetColumns ()
 The number of columns can be used to limit the width of the barcode. More...
 
void SetColumns (int columns)
 
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

 APdf417 ()
 
 APdf417 (IPoint start, String data)
 
int LimitRange (int value, int min, int max)
 Utility method to limit values to a specified range. More...
 

Private Attributes

ICellRect cellSize
 
Pdf417ErrCorrectionEnum errorCorrection = Pdf417ErrCorrectionEnum.LEVEL_2
 
int rows = 0
 
int columns = 0
 

Detailed Description

Base class for PDF417 barcode.

Constructor & Destructor Documentation

◆ APdf417() [1/2]

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

◆ APdf417() [2/2]

Member Function Documentation

◆ GetCellSize()

ICellRect com.UniPRT.Sdk.LabelMaker.Abstract.APdf417.GetCellSize ( )

The cell size can be thought of as the width and height of the narrowest bar element within a PDF417 row.

Changing the dimensions of the smallest element affects the overall width and height of the barcode.

Implements com.UniPRT.Sdk.LabelMaker.Interface.IRectangleCell.

References com.UniPRT.Sdk.LabelMaker.Abstract.APdf417.cellSize.

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

◆ GetColumns()

int com.UniPRT.Sdk.LabelMaker.Abstract.APdf417.GetColumns ( )

The number of columns can be used to limit the width of the barcode.

A zero value indicates that columns are determined automatically. Barcode must be allowed to grow in width or height in order to fit data. For this reason, limiting the growth of the barcode can only be done in one direction either by limiting width or height via Rows or Columns. Note that additional non-data columns result from Start/Stop pattern and the Left/Right row indicators, creating additional 4 columns.

References com.UniPRT.Sdk.LabelMaker.Abstract.APdf417.columns.

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

◆ GetErrorCorrection()

◆ GetRows()

int com.UniPRT.Sdk.LabelMaker.Abstract.APdf417.GetRows ( )

The number of rows can be used to limit the height of the barcode.

A zero value indicates that rows are determined automatically. Barcode must be allowed to grow in width or height in order to fit data. For this reason, limiting the growth of the barcode can only be done in one direction either by limiting width or height via Rows or Columns.

References com.UniPRT.Sdk.LabelMaker.Abstract.APdf417.rows.

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

◆ LimitRange()

int com.UniPRT.Sdk.LabelMaker.Abstract.APdf417.LimitRange ( int  value,
int  min,
int  max 
)
protected

Utility method to limit values to a specified range.

Parameters
valueThe value to limit.
minThe minimum allowable value.
maxThe maximum allowable value.
Returns
The limited value.

Referenced by com.UniPRT.Sdk.LabelMaker.PGL.Pdf417Barcode.toString().

◆ SetCellSize()

void com.UniPRT.Sdk.LabelMaker.Abstract.APdf417.SetCellSize ( ICellRect  cellSize)

◆ SetColumns()

void com.UniPRT.Sdk.LabelMaker.Abstract.APdf417.SetColumns ( int  columns)

◆ SetErrorCorrection()

void com.UniPRT.Sdk.LabelMaker.Abstract.APdf417.SetErrorCorrection ( Pdf417ErrCorrectionEnum  errorCorrection)

◆ SetRows()

void com.UniPRT.Sdk.LabelMaker.Abstract.APdf417.SetRows ( int  rows)

◆ toString()

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

Member Data Documentation

◆ cellSize

ICellRect com.UniPRT.Sdk.LabelMaker.Abstract.APdf417.cellSize
private

◆ columns

int com.UniPRT.Sdk.LabelMaker.Abstract.APdf417.columns = 0
private

◆ errorCorrection

◆ rows

int com.UniPRT.Sdk.LabelMaker.Abstract.APdf417.rows = 0
private

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