com.zebra.sdk.printer

Interface FormatUtil

All Known Subinterfaces:

ZebraPrinter, ZebraPrinterLinkOs

public interface FormatUtil

Defines functions used for interacting with printer formats. FormatUtilExample.java

Method Summary

Methods

Modifier and Type	Method and Description
FieldDescriptionData[]	getVariableFields(String formatString) Returns a list of descriptors of the variable fields in this format.
void	printStoredFormat(String formatPathOnPrinter, java.util.Map<Integer,String> vars) Prints a stored format on the printer, filling in the fields specified by the Map.
void	printStoredFormat(String formatPathOnPrinter, java.util.Map<Integer,String> vars, String encoding) Prints a stored format on the printer, filling in the fields specified by the Map.
void	printStoredFormat(String formatPathOnPrinter, String[] vars) Prints a stored format on the printer, filling in the fields specified by the array.
void	printStoredFormat(String formatPathOnPrinter, String[] vars, String encoding) Prints a stored format on the printer, filling in the fields specified by the array.
void	retrieveFormatFromPrinter(java.io.OutputStream formatData, String formatPathOnPrinter) Retrieves a format from the printer.
byte[]	retrieveFormatFromPrinter(String formatPathOnPrinter) Retrieves a format from the printer.

Method Detail

retrieveFormatFromPrinter

byte[] retrieveFormatFromPrinter(String formatPathOnPrinter)
                                 throws ConnectionException

Retrieves a format from the printer. On a LinkOS/ZPL printer, only .ZPL files are supported. On a CPCL printer, only .FMT and .LBL files are supported.

Parameters:

formatPathOnPrinter - the location of the file on the printer (e.g. "E:FORMAT.ZPL").

Returns:

the contents of the format file.

Throws:

ConnectionException - if there is an issue communicating with the printer (e.g. the connection is not open).

retrieveFormatFromPrinter

void retrieveFormatFromPrinter(java.io.OutputStream formatData,
                             String formatPathOnPrinter)
                               throws ConnectionException

Retrieves a format from the printer. On a LinkOS/ZPL printer, only .ZPL files are supported. On a CPCL printer, only .FMT and .LBL files are supported.

Parameters:

formatData - The format.

formatPathOnPrinter - the location of the file on the printer (e.g. "E:FORMAT.ZPL").

Throws:

ConnectionException - if there is an issue communicating with the printer (e.g. the connection is not open).

printStoredFormat

void printStoredFormat(String formatPathOnPrinter,
                     String[] vars)
                       throws ConnectionException

Prints a stored format on the printer, filling in the fields specified by the array. The values of any format variables will be encoded using the default encoding type. On a LinkOS/ZPL printer, only ZPL formats are supported. On a CPCL printer, only CPCL formats are supported.
See java.lang.String for more information about encoding types.

Parameters:

formatPathOnPrinter - the name of the format on the printer, including the extension (e.g. "E:FORMAT.ZPL").

vars - an array of strings representing the data to fill into the format. For LinkOS/ZPL printer formats, index 0 of the array corresponds to field number 2 (^FN2). For CPCL printer formats, the variables are passed in the order that they are found in the format.

Throws:

ConnectionException - if an I/O error occurs.

printStoredFormat

void printStoredFormat(String formatPathOnPrinter,
                     String[] vars,
                     String encoding)
                       throws ConnectionException,
                              java.io.UnsupportedEncodingException

Prints a stored format on the printer, filling in the fields specified by the array. The values of any format variables will be encoded using the provided encoding type. eg. UTF-8. On a LinkOS/ZPL printer, only ZPL formats are supported. On a CPCL printer, only CPCL formats are supported.
See java.lang.String for more information about encoding types.

Parameters:

formatPathOnPrinter - the location of the file on the printer (e.g. "E:FORMAT.ZPL").

vars - an array of strings representing the data to fill into the format. For LinkOS/ZPL printer formats, index 0 of the array corresponds to field number 2 (^FN2). For CPCL printer formats, the variables are passed in the order that they are found in the format.

encoding - a character-encoding name (eg. UTF-8).

Throws:

ConnectionException - if an I/O error occurs.

java.io.UnsupportedEncodingException - if the encoding is not supported.

printStoredFormat

void printStoredFormat(String formatPathOnPrinter,
                     java.util.Map<Integer,String> vars)
                       throws ConnectionException

Prints a stored format on the printer, filling in the fields specified by the Map. The values of any format variables will be encoded using the default encoding type. On a LinkOS/ZPL printer, only ZPL formats are supported. On a CPCL printer, only CPCL formats are supported.
See java.lang.String for more information about encoding types.

Parameters:

formatPathOnPrinter - the location of the file on the printer (e.g. "E:FORMAT.ZPL").

vars - a map which contains the key/value pairs for the stored format. For LinkOS/ZPL printer formats, the key number should correspond directly to the number of the field in the format. For CPCL printer formats, the values will be passed in ascending numerical order.

Throws:

ConnectionException - if an I/O error occurs.

printStoredFormat

void printStoredFormat(String formatPathOnPrinter,
                     java.util.Map<Integer,String> vars,
                     String encoding)
                       throws ConnectionException,
                              java.io.UnsupportedEncodingException

Prints a stored format on the printer, filling in the fields specified by the Map. The values of any format variables will be encoded using the provided encoding type. eg. UTF-8. On a LinkOS/ZPL printer, only ZPL formats are supported. On a CPCL printer, only CPCL formats are supported.
See java.lang.String for more information about encoding types.

Parameters:

formatPathOnPrinter - the location of the file on the printer (e.g. "E:FORMAT.ZPL").

vars - a map which contains the key/value pairs for the stored format. For LinkOS/ZPL printer formats, the key number should correspond directly to the number of the field in the format. For CPCL printer formats, the values will be passed in ascending numerical order.

encoding - a character-encoding name (e.g. UTF-8).

Throws:

ConnectionException - if an I/O error occurs.

java.io.UnsupportedEncodingException - if the encoding is not supported.

getVariableFields

FieldDescriptionData[] getVariableFields(String formatString)

Returns a list of descriptors of the variable fields in this format. On a LinkOS/ZPL printer, only ZPL formats are supported. On a CPCL printer, only CPCL formats are supported.

Parameters:

formatString - the contents of the recalled format.

Returns:

a list of field data descriptors. For a CPCL printer, the nth element of the list will contain the integer n and no name. For a LinkOS/ZPL printer, each element will contain an ^FN number and a variable name if present. If the format contains multiple ^FNs with the same number, only the last one will be in the result.
See FieldDescriptionData for an example of how variable fields look.

See Also:

FieldDescriptionData