com.heirloomcomputing.ecs.api

Interface IGenericBarcode

public interface IGenericBarcode

Generic Barcode Functions

This class must be implemented by any Barcode implementation to be usable from C$BARCODE.

The method of usage from C$BARCODE is:

• Construct the implementation..
• Set the properties.
• Call getComponent(), returning the barcode component.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROPERTY_ANGLE_DEGREES_DOUBLE The angle of the barcode printing in degrees.
static java.lang.String	PROPERTY_BACKGROUND_COLOR The background color of the barcode.
static java.lang.String	PROPERTY_BARCODE_BACKGROUND_COLOR The background color within the barcode.
static java.lang.String	PROPERTY_BARCODE_HEIGHT_INT The height of the barcode.
static java.lang.String	PROPERTY_CHECK_DIGIT_BOOL Whether or not a check digit should be included.
static java.lang.String	PROPERTY_DRIVER The DRIVER property is never passed in setProperty; rather, it is the property that specifies the implementation of the IGenericBarcode interface.
static java.lang.String	PROPERTY_NARROWEST_BAR_WIDTH_INT The narrowest bar width.
static java.lang.String	PROPERTY_SHOW_TEXT_BOOL Whether or not the text of the barcode value should be included.
static java.lang.String	PROPERTY_TYPE Wherever there is a match to one of the listed types, recognize the listed type in addition to any other propertietary type names supported.
static java.lang.String	PROPERTY_VALUE The value or code of the barcode.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getObject() Return the final barcode object, reflecting properties as set by setProperty.
void	setProperty(java.lang.String property, java.lang.Object value) Set a property on the barcode.

Field Detail

PROPERTY_DRIVER

static final java.lang.String PROPERTY_DRIVER

The DRIVER property is never passed in setProperty; rather, it is the property that specifies the implementation of the IGenericBarcode interface.

See Also:

Constant Field Values

PROPERTY_TYPE

static final java.lang.String PROPERTY_TYPE

Wherever there is a match to one of the listed types, recognize the listed type in addition to any other propertietary type names supported.

• Code128
• Code39
• Code39_2to1
• ExtendedCode39
• ExtendedCode39_2to1
• Interleaved25
• Interleaved25_2to1
• Codebar
• Codebar_2to1
• MSI

See Also:

Constant Field Values

PROPERTY_VALUE

static final java.lang.String PROPERTY_VALUE

The value or code of the barcode.

See Also:

Constant Field Values

PROPERTY_CHECK_DIGIT_BOOL

static final java.lang.String PROPERTY_CHECK_DIGIT_BOOL

Whether or not a check digit should be included.

See Also:

Constant Field Values

PROPERTY_SHOW_TEXT_BOOL

static final java.lang.String PROPERTY_SHOW_TEXT_BOOL

Whether or not the text of the barcode value should be included.

See Also:

Constant Field Values

PROPERTY_NARROWEST_BAR_WIDTH_INT

static final java.lang.String PROPERTY_NARROWEST_BAR_WIDTH_INT

The narrowest bar width.

See Also:

Constant Field Values

PROPERTY_ANGLE_DEGREES_DOUBLE

static final java.lang.String PROPERTY_ANGLE_DEGREES_DOUBLE

The angle of the barcode printing in degrees.

See Also:

Constant Field Values

PROPERTY_BARCODE_HEIGHT_INT

static final java.lang.String PROPERTY_BARCODE_HEIGHT_INT

The height of the barcode.

See Also:

Constant Field Values

PROPERTY_BACKGROUND_COLOR

static final java.lang.String PROPERTY_BACKGROUND_COLOR

The background color of the barcode.

See Also:

Constant Field Values

PROPERTY_BARCODE_BACKGROUND_COLOR

static final java.lang.String PROPERTY_BARCODE_BACKGROUND_COLOR

The background color within the barcode.

See Also:

Constant Field Values

Method Detail

setProperty

void setProperty(java.lang.String property,
                 java.lang.Object value)

Set a property on the barcode.

Parameters:

property - - the String property name

value - - the Object to be associated with the property

getObject

java.lang.Object getObject()

Return the final barcode object, reflecting properties as set by setProperty. This will generally be either a Component or an Image.

Returns:

the Object associated with this barcode