com.sap.ip.me.api.pios.symbology
Class PDF417

java.lang.Object
  extended bycom.sap.ip.me.api.pios.symbology.Symbology
      extended bycom.sap.ip.me.api.pios.symbology.Symbology2D
          extended bycom.sap.ip.me.api.pios.symbology.PDF417

public final class PDF417
extends Symbology2D

Represents the PDF417 Symbology.

PDF-417 (Portable Data Format) is a two-dimensional, multi-row symbology designed to be scanned by laser scanners and linear CCD scanners.

Aliases:
None
Code Type:
Stacked
Character Set:
Numbers, text or binary data
Barcode Example:
     PDF417 Sample

The following options can be set for this symbology:

Security level:
Required: yes
Used by: Printer
Default: n/a
Possible values:
SECURITY_LEVEL_1:
Security level 1.
SECURITY_LEVEL_2:
Security level 2.
SECURITY_LEVEL_3:
Security level 3.
SECURITY_LEVEL_4:
Security level 4.
SECURITY_LEVEL_5:
Security level 5.
SECURITY_LEVEL_6:
Security level 6.
SECURITY_LEVEL_7:
Security level 7.
SECURITY_LEVEL_8:
Security level 8.
SECURITY_LEVEL_AUTOMATIC:
The security level is selected automatically.
Truncate:
Required: optional
Used by: Printer
Default: No truncate
Possible values:
TRUNCATE:
Truncated PDF417.
Example: Create a PDF417 symbology for the printer with security level automatic.
 
 	...
 	PDF417 pdf417 = new PDF417(PDF417.SECURITY_LEVEL_AUTOMATIC);
	...
 
 

Since:
MI 2.5
Author:
Abaco

Field Summary
static long SECURITY_LEVEL_1
          Constant to indicate a security level of 1 option.
static long SECURITY_LEVEL_2
          Constant to indicate a security level of 2 option.
static long SECURITY_LEVEL_3
          Constant to indicate a security level of 3 option.
static long SECURITY_LEVEL_4
          Constant to indicate a security level of 4 option.
static long SECURITY_LEVEL_5
          Constant to indicate a security level of 5 option.
static long SECURITY_LEVEL_6
          Constant to indicate a security level of 6 option.
static long SECURITY_LEVEL_7
          Constant to indicate a security level of 7 option.
static long SECURITY_LEVEL_8
          Constant to indicate a security level of 8 option.
static long SECURITY_LEVEL_AUTOMATIC
          Constant to indicate security level selected automatically option.
static long TRUNCATE
          Constant to indicate truncate option.
 
Fields inherited from class com.sap.ip.me.api.pios.symbology.Symbology
options
 
Constructor Summary
PDF417()
          Constructs a new PDF417 object.
PDF417(long options)
          Constructs a new PDF417 object with the symbology options provided.
 
Method Summary
 int getColums()
          Returns the number of columns to encode.
 java.lang.String getName()
          Returns the symbology name.
 int getRows()
          Returns the number of rows to encode.
 int getType()
          Returns the symbology type.
 void setColumns(int columns)
          Sets the number of columns to encode.
 void setOptions(long options)
          Sets the configured options for the symbology.
 void setRows(int rows)
          Sets the number of rows to encode.
 
Methods inherited from class com.sap.ip.me.api.pios.symbology.Symbology
getOptions, validateOptions
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SECURITY_LEVEL_1

public static final long SECURITY_LEVEL_1
Constant to indicate a security level of 1 option.

See Also:
Constant Field Values

SECURITY_LEVEL_2

public static final long SECURITY_LEVEL_2
Constant to indicate a security level of 2 option.

See Also:
Constant Field Values

SECURITY_LEVEL_3

public static final long SECURITY_LEVEL_3
Constant to indicate a security level of 3 option.

See Also:
Constant Field Values

SECURITY_LEVEL_4

public static final long SECURITY_LEVEL_4
Constant to indicate a security level of 4 option.

See Also:
Constant Field Values

SECURITY_LEVEL_5

public static final long SECURITY_LEVEL_5
Constant to indicate a security level of 5 option.

See Also:
Constant Field Values

SECURITY_LEVEL_6

public static final long SECURITY_LEVEL_6
Constant to indicate a security level of 6 option.

See Also:
Constant Field Values

SECURITY_LEVEL_7

public static final long SECURITY_LEVEL_7
Constant to indicate a security level of 7 option.

See Also:
Constant Field Values

SECURITY_LEVEL_8

public static final long SECURITY_LEVEL_8
Constant to indicate a security level of 8 option.

See Also:
Constant Field Values

SECURITY_LEVEL_AUTOMATIC

public static final long SECURITY_LEVEL_AUTOMATIC
Constant to indicate security level selected automatically option.

See Also:
Constant Field Values

TRUNCATE

public static final long TRUNCATE
Constant to indicate truncate option.

See Also:
Constant Field Values
Constructor Detail

PDF417

public PDF417()
Constructs a new PDF417 object.


PDF417

public PDF417(long options)
       throws InvalidSymbologyException
Constructs a new PDF417 object with the symbology options provided.

The options value is either one of the option constants defined by this class, or must be built by bitwise OR'ing together (that is, using the long "|" operator) two or more of those option constants.

Parameters:
options - the symbology options mask
Throws:
InvalidSymbologyException - thrown if the received options are invalid for this symbology
Method Detail

getName

public java.lang.String getName()
Returns the symbology name.

Specified by:
getName in class Symbology
Returns:
The name of the symbology.

getType

public int getType()
Returns the symbology type.

Specified by:
getType in class Symbology
Returns:
The type of the symbology.
See Also:
SymbologyType

setOptions

public void setOptions(long options)
                throws InvalidSymbologyException
Sets the configured options for the symbology.

Specified by:
setOptions in class Symbology
Parameters:
options - the symbology options mask
Throws:
InvalidSymbologyException - thrown if the received options are invalid for this symbology

setColumns

public void setColumns(int columns)
Sets the number of columns to encode. Attribute needed to print a barcode.

Parameters:
columns - The number of columns to encode.

getColums

public int getColums()
Returns the number of columns to encode. Attribute needed to print a barcode.

Returns:
The number of columns to encode.

setRows

public void setRows(int rows)
Sets the number of rows to encode. Attribute needed to print a barcode.

Parameters:
rows - The number of rows to encode.

getRows

public int getRows()
Returns the number of rows to encode. Attibute needed to print a barcode.

Returns:
The number of rows to encode.


Copyright © 2005 SAP AG. All Rights Reserved.