Pdf417Parameters Class Reference

Inherits BaseJavaClass.

Public Member Functions
	getPdf417CompactionMode ()
	setPdf417CompactionMode (int $value)
	getPdf417ErrorLevel ()
	setPdf417ErrorLevel (int $value)
	getPdf417Truncate ()
	setPdf417Truncate (bool $value)
	getColumns ()
	setColumns (int $value)
	getRows ()
	setRows (int $value)
	getAspectRatio ()
	setAspectRatio (float $value)
	getPdf417MacroFileID ()
	setPdf417MacroFileID (int $value)
	getPdf417MacroSegmentID ()
	setPdf417MacroSegmentID (int $value)
	getPdf417MacroSegmentsCount ()
	setPdf417MacroSegmentsCount (int $value)
	getPdf417MacroFileName ()
	setPdf417MacroFileName (string $value)
	getPdf417MacroTimeStamp ()
	setPdf417MacroTimeStamp (DateTime $value)
	getPdf417MacroSender ()
	setPdf417MacroSender (string $value)
	getPdf417MacroAddressee ()
	setPdf417MacroAddressee (string $value)
	getPdf417MacroFileSize ()
	setPdf417MacroFileSize (int $value)
	getPdf417MacroChecksum ()
	setPdf417MacroChecksum (int $value)
	getCodeTextEncoding ()
	setCodeTextEncoding (string $value)
	getPdf417ECIEncoding ()
	setPdf417ECIEncoding (int $value)
	getPdf417MacroECIEncoding ()
	setPdf417MacroECIEncoding (int $value)
	isReaderInitialization ()
	setReaderInitialization (bool $value)
	getCode128Emulation ()
	setCode128Emulation (int $value)
	toString ()
	getJavaClass ()
	getJavaClassName ()
	isNull ()
	printJavaClassName ()

Protected Member Functions
	init ()
	setJavaClass ($javaClass)

Detailed Description

PDF417 parameters.

Member Function Documentation

getAspectRatio()

Pdf417Parameters::getAspectRatio

(

)

Height/Width ratio of 2D BarCode module.

getCode128Emulation()

Pdf417Parameters::getCode128Emulation

(

)

Function codeword for Code 128 emulation. Applied for MicroPDF417 only. Ignored for PDF417 and MacroPDF417 barcodes.

getCodeTextEncoding()

Pdf417Parameters::getCodeTextEncoding

(

)

Gets the encoding of codetext.

getColumns()

Pdf417Parameters::getColumns

(

)

Columns count.

getJavaClass()

BaseJavaClass::getJavaClass ( )

inherited

getJavaClassName()

BaseJavaClass::getJavaClassName ( )

inherited

getPdf417CompactionMode()

Pdf417Parameters::getPdf417CompactionMode

(

)

Pdf417 symbology type of BarCode's compaction mode. Default value: Pdf417CompactionMode::AUTO.

getPdf417ECIEncoding()

Pdf417Parameters::getPdf417ECIEncoding

(

)

Extended Channel Interpretation Identifiers. It is used to tell the barcode reader details about the used references for encoding the data in the symbol. Not applied for Macro PDF417 text fields. Current implementation consists all well known charset encodings.

getPdf417ErrorLevel()

Pdf417Parameters::getPdf417ErrorLevel

(

)

Gets or sets Pdf417 symbology type of BarCode's error correction level ranging from level0 to level8, level0 means no error correction info, level8 means best error correction which means a larger picture.

getPdf417MacroAddressee()

Pdf417Parameters::getPdf417MacroAddressee

(

)

Gets macro Pdf417 barcode addressee name.

getPdf417MacroChecksum()

Pdf417Parameters::getPdf417MacroChecksum

(

)

Gets macro Pdf417 barcode checksum.

Returns

‪int checksum field contains the value of the 16-bit (2 bytes) CRC checksum using the CCITT-16 polynomial.

getPdf417MacroECIEncoding()

Pdf417Parameters::getPdf417MacroECIEncoding

(

)

Extended Channel Interpretation Identifiers. Applies for Macro PDF417 text fields.

getPdf417MacroFileID()

Pdf417Parameters::getPdf417MacroFileID

(

)

Getsmacro Pdf417 barcode's file ID. Used for MacroPdf417.

getPdf417MacroFileName()

Pdf417Parameters::getPdf417MacroFileName

(

)

Gets macro Pdf417 barcode file name.

Returns

getPdf417MacroFileSize()

Pdf417Parameters::getPdf417MacroFileSize

(

)

Gets or sets macro Pdf417 file size.

Returns

‪int file size field contains the size in bytes of the entire source file.

getPdf417MacroSegmentID()

Pdf417Parameters::getPdf417MacroSegmentID

(

)

Gets macro Pdf417 barcode's segment ID, which starts from 0, to MacroSegmentsCount - 1.

getPdf417MacroSegmentsCount()

Pdf417Parameters::getPdf417MacroSegmentsCount

(

)

Gets macro Pdf417 barcode segments count.

getPdf417MacroSender()

Pdf417Parameters::getPdf417MacroSender

(

)

Gets macro Pdf417 barcode sender name.

getPdf417MacroTimeStamp()

Pdf417Parameters::getPdf417MacroTimeStamp

(

)

Gets macro Pdf417 barcode time stamp.

getPdf417Truncate()

Pdf417Parameters::getPdf417Truncate

(

)

Whether Pdf417 symbology type of BarCode is truncated (to reduce space).

getRows()

Pdf417Parameters::getRows

(

)

Rows count.

init()

Pdf417Parameters::init ( )

protected

Reimplemented from BaseJavaClass.

isNull()

BaseJavaClass::isNull ( )

inherited

isReaderInitialization()

Pdf417Parameters::isReaderInitialization

(

)

Used to instruct the reader to interpret the data contained within the symbol as programming for reader initialization

Returns

printJavaClassName()

BaseJavaClass::printJavaClassName ( )

inherited

setAspectRatio()

Pdf417Parameters::setAspectRatio

(

float

$value

)

Height/Width ratio of 2D BarCode module.

setCode128Emulation()

Pdf417Parameters::setCode128Emulation

(

int

$value

)

Function codeword for Code 128 emulation. Applied for MicroPDF417 only. Ignored for PDF417 and MacroPDF417 barcodes.

setCodeTextEncoding()

Pdf417Parameters::setCodeTextEncoding

(

string

$value

)

Sets the encoding of codetext.

setColumns()

Pdf417Parameters::setColumns

(

int

$value

)

Columns count.

setJavaClass()

BaseJavaClass::setJavaClass (   $javaClass )

protectedinherited

setPdf417CompactionMode()

Pdf417Parameters::setPdf417CompactionMode

(

int

$value

)

Pdf417 symbology type of BarCode's compaction mode. Default value: Pdf417CompactionMode::AUTO.

setPdf417ECIEncoding()

Pdf417Parameters::setPdf417ECIEncoding

(

int

$value

)

Extended Channel Interpretation Identifiers. It is used to tell the barcode reader details about the used references for encoding the data in the symbol. Not applied for Macro PDF417 text fields. Current implementation consists all well known charset encodings.

setPdf417ErrorLevel()

Pdf417Parameters::setPdf417ErrorLevel

(

int

$value

)

Gets or sets Pdf417 symbology type of BarCode's error correction level ranging from level0 to level8, level0 means no error correction info, level8 means best error correction which means a larger picture.

setPdf417MacroAddressee()

Pdf417Parameters::setPdf417MacroAddressee

(

string

$value

)

Sets macro Pdf417 barcode addressee name.

setPdf417MacroChecksum()

Pdf417Parameters::setPdf417MacroChecksum

(

int

$value

)

Sets macro Pdf417 barcode checksum.

Parameters

int

$value

‪The checksum field contains the value of the 16-bit (2 bytes) CRC checksum using the CCITT-16 polynomial.

setPdf417MacroECIEncoding()

Pdf417Parameters::setPdf417MacroECIEncoding

(

int

$value

)

Extended Channel Interpretation Identifiers. Applies for Macro PDF417 text fields.

setPdf417MacroFileID()

Pdf417Parameters::setPdf417MacroFileID

(

int

$value

)

Sets macro Pdf417 barcode's file ID. Used for MacroPdf417.

setPdf417MacroFileName()

Pdf417Parameters::setPdf417MacroFileName

(

string

$value

)

Sets macro Pdf417 barcode file name.

Parameters

string

$value

setPdf417MacroFileSize()

Pdf417Parameters::setPdf417MacroFileSize

(

int

$value

)

Gets or sets macro Pdf417 file size.

Parameters

int

$value

‪The file size field contains the size in bytes of the entire source file.

setPdf417MacroSegmentID()

Pdf417Parameters::setPdf417MacroSegmentID

(

int

$value

)

Sets macro Pdf417 barcode's segment ID, which starts from 0, to MacroSegmentsCount - 1.

setPdf417MacroSegmentsCount()

Pdf417Parameters::setPdf417MacroSegmentsCount

(

int

$value

)

Sets macro Pdf417 barcode segments count.

setPdf417MacroSender()

Pdf417Parameters::setPdf417MacroSender

(

string

$value

)

Sets macro Pdf417 barcode sender name.

setPdf417MacroTimeStamp()

Pdf417Parameters::setPdf417MacroTimeStamp

(

DateTime

$value

)

Sets macro Pdf417 barcode time stamp.

setPdf417Truncate()

Pdf417Parameters::setPdf417Truncate

(

bool

$value

)

Whether Pdf417 symbology type of BarCode is truncated (to reduce space).

setReaderInitialization()

Pdf417Parameters::setReaderInitialization

(

bool

$value

)

Used to instruct the reader to interpret the data contained within the symbol as programming for reader initialization

Parameters

bool

$value

setRows()

Pdf417Parameters::setRows

(

int

$value

)

Rows count.

toString()

Pdf417Parameters::toString

(

)

Returns a human-readable String representation of this Pdf417Parameters.

Returns

‪string that represents this Pdf417Parameters.