com.zebra.sdk.common.card.graphics.barcode

Interface CodePDF417Util

All Superinterfaces:

BarcodeUtil

public interface CodePDF417Util
extends BarcodeUtil

Interface used to configure and draw a PDF417 barcode.

Method Summary

Methods

Modifier and Type	Method and Description
int	getColumns() Gets the number of data columns for the barcode.
boolean	getECIEnabled() Indicates whether the generation of ECI sequences is enabled.
String	getEncoding() Returns the message encoding.
int	getErrorCorrectionLevel() Gets the error correction level for the barcode.
int	getMaximumColumns() Gets the maximum number of columns.
int	getMaximumRows() Gets the maximum number of rows.
int	getMinimumColumns() Gets the minimum number of columns.
int	getMinimumRows() Gets the minimum number of rows.
double	getRowHeight() Returns the height of the rows.
double	getWidthToHeightRatio() Gets the ratio of the barcode width to the height.
void	setColumns(int columns) Sets the number of data columns for the barcode.
void	setECIEnabled(boolean enable) Controls whether ECI sequences are generated for the output encoding.
void	setEncoding(String encoding) Sets the message encoding.
void	setErrorCorrectionLevel(int level) Sets the error correction level for the barcode.
void	setMaximumColumns(int maxColumns) Sets the maximum number of columns.
void	setMaximumRows(int maxRows) Sets the maximum number of rows.
void	setMinimumColumns(int minColumns) Sets the minimum number of columns.
void	setMinimumRows(int minRows) Sets the minimum of rows.
void	setRowHeight(double rowHeight) Sets the height of the rows.
void	setWidthToHeightRatio(double ratio) Sets the ratio of the barcode width to the height.

Methods inherited from interface com.zebra.sdk.common.card.graphics.barcode.BarcodeUtil

doQuietZone, drawBarcode, getBarHeight, getBarWidth, getFont, getHeight, getModuleWidth, getPattern, getQuietZoneWidth, getVerticalQuietZone, hasQuietZone, setBarHeight, setFont, setHeight, setMessagePosition, setModuleWidth, setPattern, setQuietZoneWidth, setVerticalQuietZone

Method Detail

setColumns

void setColumns(int columns)

Sets the number of data columns for the barcode.

• The number of rows will automatically be determined based on the amount of data.

Parameters:

columns - The number of columns.

setECIEnabled

void setECIEnabled(boolean enable)

Controls whether ECI sequences are generated for the output encoding.

Parameters:

enable - True to enable the generation of ECI sequences.

setEncoding

void setEncoding(String encoding)

Sets the message encoding.

• The value must conform to one of Java's encodings and have a mapping in the ECI registry.

Parameters:

encoding - The message encoding.

setErrorCorrectionLevel

void setErrorCorrectionLevel(int level)

Sets the error correction level for the barcode.

Parameters:

level - The error correction level (a value between 0 and 8).

setMaximumColumns

void setMaximumColumns(int maxColumns)

Sets the maximum number of columns.

Parameters:

maxColumns - The maximum number of columns.

setMaximumRows

void setMaximumRows(int maxRows)

Sets the maximum number of rows.

Parameters:

maxRows - The maximum number of rows.

setMinimumColumns

void setMinimumColumns(int minColumns)

Sets the minimum number of columns.

Parameters:

minColumns - The minimum number of columns.

setMinimumRows

void setMinimumRows(int minRows)

Sets the minimum of rows.

Parameters:

minRows - The minimum of rows to set.

setRowHeight

void setRowHeight(double rowHeight)

Sets the height of the rows.

Parameters:

rowHeight - The height of the rows (in pixels).

setWidthToHeightRatio

void setWidthToHeightRatio(double ratio)

Sets the ratio of the barcode width to the height.

• A ratio of 5 means the width is 5 times the height.

Parameters:

ratio - The ratio of the barcode width to the height.

getColumns

int getColumns()

Gets the number of data columns for the barcode.

• The number of rows is automatically determined based on the amount of data.

Returns:

The number of data columns to produce.

getECIEnabled

boolean getECIEnabled()

Indicates whether the generation of ECI sequences is enabled.

Returns:

True if generation of ECI sequences is enabled.

getEncoding

String getEncoding()

Returns the message encoding.

Returns:

The message encoding (default is "ISO-8859-1").

getErrorCorrectionLevel

int getErrorCorrectionLevel()

Gets the error correction level for the barcode.

Returns:

The error correction level (0-8).

getMaximumColumns

int getMaximumColumns()

Gets the maximum number of columns.

Returns:

The maximum number of columns.

getMaximumRows

int getMaximumRows()

Gets the maximum number of rows.

Returns:

The maximum number of rows.

getMinimumColumns

int getMinimumColumns()

Gets the minimum number of columns.

Returns:

The minimum number of columns.

getMinimumRows

int getMinimumRows()

Gets the minimum number of rows.

Returns:

The minimum number of rows.

getRowHeight

double getRowHeight()

Returns the height of the rows.

Returns:

The row height (in mm).

getWidthToHeightRatio

double getWidthToHeightRatio()

Gets the ratio of the barcode width to the height.

• A ratio of 5 means the width is 5 times the height.

Returns:

The ratio of the barcode width to the height.