QREncodeParams Class Documentation

class QREncodeParams

Namespace:com::datalogics::PDFL

Detailed Description

Used to control how the QR code is created.

Referenced by

Page

Uses types

QRColor

Constructor & Destructor Documentation

QREncodeParams

QREncodeParams(String text, double x, double y, double width, double height, QRErrorCorrectionLevel errorLevel, long quietZoneSize, QRColor codeColor, QRColor backgroundColor)

Parameters

text: String

The text string to encode in the QR code.

x: double

The X coordinate of the lower-left corner of the QR code on the page, in user space units.

y: double

The Y coordinate of the lower-left corner of the QR code on the page, in user space units.

width: double

The width of the QR code, in user space units.

height: double

The height of the QR code, in user space units.

errorLevel: QRErrorCorrectionLevel

The error correction level for the QR code.

quietZoneSize: long

The size of the quiet zone (margin) around the QR code, in modules.

codeColor: QRColor

The color of the QR code modules (the dark elements).

backgroundColor: QRColor

The color of the background behind the QR code modules.

Create a new QREncodeParams object using the specified values.

Member Function Documentation

delete

synchronized void delete(Boolean disposing)

Parameters

disposing: Boolean

Returns:

synchronized void

delete

synchronized void delete()

Returns:

synchronized void

finalize

void finalize()

Returns:

void

getBackgroundColor

QRColor getBackgroundColor()

Returns:

QRColor

Get the color of the background behind the QR code modules.

getCodeColor

QRColor getCodeColor()

Returns:

QRColor

Get the color of the QR code modules (the dark elements).

getErrorCorrectionLevel

QRErrorCorrectionLevel getErrorCorrectionLevel()

Returns:

QRErrorCorrectionLevel

Get the error correction level of the QR code.

getHeight

double getHeight()

Returns:

double

Get the height of the QR code, in user space units.

getQuietZoneSize

long getQuietZoneSize()

Returns:

long

Get the quiet zone size (margin around the QR code), in modules.

getTextToEncode

String getTextToEncode()

Returns:

String

Get the text string to be encoded in the QR code.

getWidth

double getWidth()

Returns:

double

Get the width of the QR code, in user space units.

getX

double getX()

Returns:

double

Get the X coordinate of the lower-left corner of the QR code on the page, in user space units.

getY

double getY()

Returns:

double

Get the Y coordinate of the lower-left corner of the QR code on the page, in user space units.

setBackgroundColor

void setBackgroundColor(QRColor backgroundColor)

Parameters

backgroundColor: QRColor

Returns:

void

Set the color of the background behind the QR code modules.

setCodeColor

void setCodeColor(QRColor codeColor)

Parameters

codeColor: QRColor

Returns:

void

Set the color of the QR code modules (the dark elements).

setErrorCorrectionLevel

void setErrorCorrectionLevel(QRErrorCorrectionLevel errorLevel)

Parameters

errorLevel: QRErrorCorrectionLevel

Returns:

void

Set the error correction level of the QR code.

setHeight

void setHeight(double height)

Parameters

height: double

Returns:

void

Set the height of the QR code, in user space units.

setQuietZoneSize

void setQuietZoneSize(long quiteSize)

Parameters

quiteSize: long

Returns:

void

Set the quiet zone size (margin around the QR code), in modules.

setTextToEncode

void setTextToEncode(String textToEncode)

Parameters

textToEncode: String

Returns:

void

Set the text string to be encoded in the QR code.

setWidth

void setWidth(double width)

Parameters

width: double

Returns:

void

Set the width of the QR code, in user space units.

setX

void setX(double x)

Parameters

x: double

Returns:

void

Set the X coordinate of the lower-left corner of the QR code on the page, in user space units.

setY

void setY(double y)

Parameters

y: double

Returns:

void

Set the Y coordinate of the lower-left corner of the QR code on the page, in user space units.