com.zebra.sdk.common.card.graphics

Interface ZebraGraphicsI

All Known Subinterfaces:

ZebraGraphics

All Known Implementing Classes:

ZebraCardGraphics

public interface ZebraGraphicsI

Interface for all Zebra card printer graphics related tasks.

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Clears user set parameters.
void	close() Releases all the resources.
byte[]	convertImageToRGB(byte[] imageData) Converts the image to RGB format.
ZebraCardImageI	createImage() Generates the final bitmap image.
byte[]	cropImage(byte[] imageData, int x, int y, int width, int height) Crops an image to supplied dimensions and returns the cropped image data.
void	drawImage(byte[] imageData, int x, int y, int width, int height, RotationType rotation) Draws the image into the specified rectangle
ExtractedImages	extractBlackImageData(byte[] imageData, int redThreshold, int greenThreshold, int blueThreshold) Separates the monochrome and color data from the specified image data using the specified threshold values.
byte[]	extractHalfPanelImageData(byte[] imageData) Attempts to identify and extract the color and non-color half panel regions of the source image.
void	initialize(int maxWidth, int maxHeight, OrientationType orientation, PrintType printType, Integer fillColor) Initializes the drawing surface if the specified maxWidth or maxHeight is 0 then the maximum values for the specified printer model will be used
void	monochromeConversionType(MonochromeConversion type) Sets the monochrome conversion type to be used during createImage().
byte[]	rotateImage(byte[] imageData, int width, int height, RotationType type) Rotates the image and then resizes the image.
byte[]	rotateImage(byte[] imageData, RotationType type) Rotates the image.
void	setBrightnessLevel(int level) Sets the brightness correction level to be applied during createImage()
void	setColorScale(int red, int green, int blue) Sets the color scale correction values for red, green, and blue pixel values during createImage()
void	setContrastLevel(int level) Sets the contrast correction level to be applied during createImage()
void	setGammaLevel(int level) Sets the gamma correction level to be applied during createImage()
void	setPrinterModel(PrinterModel model) Sets the printer model.
void	setSaturationLevel(int level) Sets the saturation correction level to be applied during createImage()

Method Detail

initialize

void initialize(int maxWidth,
              int maxHeight,
              OrientationType orientation,
              PrintType printType,
              Integer fillColor)

Initializes the drawing surface

• if the specified maxWidth or maxHeight is 0 then the maximum values for the specified printer model will be used

Parameters:

maxWidth - the maximum width of the image (limited based on printer model).

maxHeight - the maximum height of the image (limited based on printer model).

orientation - the orientation of the image.

printType - the type of print to be performed.

fillColor - the RGB background fill color.

drawImage

void drawImage(byte[] imageData,
             int x,
             int y,
             int width,
             int height,
             RotationType rotation)
               throws java.io.IOException,
                      IllegalArgumentException

Draws the image into the specified rectangle

Parameters:

imageData - the bitmap image data

x - the x coordinate.

y - the y coordinate.

width - the width of the rectangle.

• if 0 then the width of the specified image will be used

height - the height of the rectangle.

• if 0 then the height of the specified image will be used

rotation - the rotation of the image.

Throws:

java.io.IOException - if an error occurs during reading/writing.

IllegalArgumentException - if an argument passed in is not valid.

cropImage

byte[] cropImage(byte[] imageData,
               int x,
               int y,
               int width,
               int height)
                 throws java.io.IOException

Crops an image to supplied dimensions and returns the cropped image data.

Parameters:

imageData - byte[] containing the raw bitmap data.

x - the x-offset of new image.

y - the y-offset of new image.

width - the width of the cropped image.

height - the height of the cropped image.

Returns:

byte[] containing the cropped image data.

Throws:

java.io.IOException - if an error occurs reading the image data.

monochromeConversionType

void monochromeConversionType(MonochromeConversion type)

Sets the monochrome conversion type to be used during createImage().

• Valid for ribbon types of 1bpp and 8bpp only.

Parameters:

type - the type of monochrome conversion to perform.

setBrightnessLevel

void setBrightnessLevel(int level)

Sets the brightness correction level to be applied during createImage()

Parameters:

level - the brightness level.

• Range: -25 to 25
• Values passed in (-25 to 25) will be converted to a range of -127 to 127 before being applied to each pixel (e.g. a value of 25 will correspond to an actual offset of 127).

setContrastLevel

void setContrastLevel(int level)

Sets the contrast correction level to be applied during createImage()

Parameters:

level - the contrast level.

• Range: -25 to 25
• Values passed in (-25 to 25) will be converted to a range of -127 to 127 before being applied to each pixel (e.g. a value of 25 will correspond to an actual offset of 127).

setGammaLevel

void setGammaLevel(int level)

Sets the gamma correction level to be applied during createImage()

Parameters:

level - the gamma level.

• Range: -25 to 25

setSaturationLevel

void setSaturationLevel(int level)

Sets the saturation correction level to be applied during createImage()

Parameters:

level - the saturation correction level.

• Range: -25 to 25

setColorScale

void setColorScale(int red,
                 int green,
                 int blue)

Sets the color scale correction values for red, green, and blue pixel values during createImage()

Parameters:

red - the red pixel correction value.

green - the green pixel correction value.

blue - the blue pixel correction value.

• Range: -25 to 25
• Values passed in (-25 to 25) will be converted to a range of -127 to 127 before being applied to each pixel (e.g. a value of 25 will correspond to an actual offset of 127).

createImage

ZebraCardImageI createImage()
                            throws java.io.IOException

Generates the final bitmap image.

Returns:

ZebraCardImageI instance containing the bitmap image data.

Throws:

java.io.IOException - if an error occurs during reading/writing.

clear

void clear()

Clears user set parameters.

• Note: Will not reset parameters passed in during initialization

close

void close()

Releases all the resources.

rotateImage

byte[] rotateImage(byte[] imageData,
                 RotationType type)
                   throws java.io.IOException

Rotates the image.

Parameters:

imageData - the source image data.

type - the rotation type.

Returns:

byte[] the rotated image data.

Throws:

java.io.IOException - if an error occurs during reading/writing.

rotateImage

byte[] rotateImage(byte[] imageData,
                 int width,
                 int height,
                 RotationType type)
                   throws java.io.IOException

Rotates the image and then resizes the image.

Parameters:

imageData - the source image data.

width - the rotated image width.

height - the rotated image height.

type - the rotation type.

Returns:

byte[] the rotated image data.

Throws:

java.io.IOException - if an error occurs during reading/writing.

convertImageToRGB

byte[] convertImageToRGB(byte[] imageData)
                         throws java.io.IOException

Converts the image to RGB format.

Parameters:

imageData - the source image data.

Returns:

byte[] the RGB image data.

Throws:

java.io.IOException - if an error occurs during reading/writing.

setPrinterModel

void setPrinterModel(PrinterModel model)

Sets the printer model.

Parameters:

model - the printer model type.

extractBlackImageData

ExtractedImages extractBlackImageData(byte[] imageData,
                                    int redThreshold,
                                    int greenThreshold,
                                    int blueThreshold)
                                      throws IllegalArgumentException,
                                             java.io.IOException

Separates the monochrome and color data from the specified image data using the specified threshold values.

Parameters:

imageData - the 24bpp bitmap color image data.

redThreshold - the red pixel threshold value.

• Range: 0 to 255

greenThreshold - the green pixel threshold value.

• Range: 0 to 255

blueThreshold - the blue pixel threshold value.

• Range: 0 to 255

Returns:

Images images instance containing the extracted color and monochrome image data.

Throws:

IllegalArgumentException - if the redThreshold, greenThreshold, or blueThreshold level is outside of the valid range.

java.io.IOException - if an error occurs while reading the image data.

extractHalfPanelImageData

byte[] extractHalfPanelImageData(byte[] imageData)
                                 throws IllegalArgumentException,
                                        java.io.IOException

Attempts to identify and extract the color and non-color half panel regions of the source image.

• ZMotif Series 7 and ZC Series printers only.
• The printer model must be set prior to calling this method.

Parameters:

imageData - the 24bpp bitmap color image data.

Returns:

byte[] the extracted half panel color image data.

Throws:

IllegalArgumentException - If imageData is invalid or the printer model is not supported.

java.io.IOException - if an error occurs while reading the image data.