CodetextParameters Class Reference

Codetext parameters. More...

Inherits BaseJavaClass.

Public Member Functions
None	__init__ (self, javaClass)
str	__str__ (self)
	Returns a string representation of the CodetextParameters instance. More...
TextAlignment	getAlignment (self)
	Gets the alignment of the code text. More...
Tuple[int, int, int]	getColor (self)
	Specify the displaying CodeText's Color, representation of an RGB tuple. More...
Optional[FontUnit]	getFont (self)
	Specify the displaying CodeText's font. More...
FontMode	getFontMode (self)
	Specify FontMode. More...
CodeLocation	getLocation (self)
	Specify the displaying CodeText Location, set to CodeLocation.NONE to hide CodeText. More...
bool	getNoWrap (self)
	Specify word wraps (line breaks) within text. More...
Optional[Unit]	getSpace (self)
	Space between the CodeText and the BarCode in Unit value. More...
str	getTwoDDisplayText (self)
	Text that will be displayed instead of codetext in 2D barcodes. More...
None	init (self)
None	setAlignment (self, TextAlignment value)
	Sets the alignment of the code text. More...
None	setColor (self, Tuple[int, int, int] value)
	Specify the displaying CodeText's Color, representation of an RGB tuple. More...
None	setFont (self, FontUnit value)
	Specify the displaying CodeText's font. More...
None	setFontMode (self, FontMode value)
	Specify FontMode. More...
None	setLocation (self, CodeLocation value)
	Specify the displaying CodeText Location, set to CodeLocation.NONE to hide CodeText. More...
None	setNoWrap (self, bool value)
	Specify word wraps (line breaks) within text. More...
None	setSpace (self, Unit value)
	Space between the CodeText and the BarCode in Unit value. More...
None	setTwoDDisplayText (self, str value)
	Text that will be displayed instead of codetext in 2D barcodes. More...
Public Member Functions inherited from BaseJavaClass
def	getJavaClass (self)
str	getJavaClassName (self)
bool	isNull (self)
None	printJavaClassName (self)
None	setJavaClass (self, javaClass)

Public Attributes
	font
	space
Public Attributes inherited from BaseJavaClass
	javaClass
	javaClassName

Detailed Description

Codetext parameters.

Constructor & Destructor Documentation

__init__()

None __init__	(		self,
			javaClass
	)

Reimplemented from BaseJavaClass.

Member Function Documentation

__str__()

str __str__

(

self

)

Returns a string representation of the CodetextParameters instance.

Returns

A string that represents this CodetextParameters.

getAlignment()

TextAlignment getAlignment

(

self

)

Gets the alignment of the code text.

Default value: TextAlignment.CENTER.

getColor()

Tuple[int, int, int] getColor

(

self

)

Specify the displaying CodeText's Color, representation of an RGB tuple.

Default value (0,0,0).

getFont()

Optional[FontUnit] getFont

(

self

)

Specify the displaying CodeText's font.

Default value: Arial 5pt regular. Ignored if FontMode is set to FontMode.AUTO.

getFontMode()

FontMode getFontMode

(

self

)

Specify FontMode.

If FontMode is set to Auto, font size will be calculated automatically based on xDimension value. It is recommended to use FontMode.AUTO especially in AutoSizeMode.NEAREST or AutoSizeMode.INTERPOLATION. Default value: FontMode.AUTO.

getLocation()

CodeLocation getLocation

(

self

)

Specify the displaying CodeText Location, set to CodeLocation.NONE to hide CodeText.

Default value: CodeLocation.NONE.

getNoWrap()

bool getNoWrap

(

self

)

Specify word wraps (line breaks) within text.

Returns

bool

getSpace()

Optional[Unit] getSpace

(

self

)

Space between the CodeText and the BarCode in Unit value.

Default value: 2pt. Ignored for EAN8, EAN13, UPCE, UPCA, ISBN, ISMN, ISSN, UpcaGs1DatabarCoupon.

getTwoDDisplayText()

str getTwoDDisplayText

(

self

)

Text that will be displayed instead of codetext in 2D barcodes.

Used for: Aztec, Pdf417, DataMatrix, QR, MaxiCode, DotCode

init()

None init

(

self

)

Reimplemented from BaseJavaClass.

setAlignment()

None setAlignment	(		self,
		TextAlignment	value
	)

Sets the alignment of the code text.

Default value: TextAlignment.CENTER.

setColor()

None setColor	(		self,
		Tuple[int, int, int]	value
	)

Specify the displaying CodeText's Color, representation of an RGB tuple.

Default value (0,0,0).

setFont()

None setFont	(		self,
		FontUnit	value
	)

Specify the displaying CodeText's font.

Default value: Arial 5pt regular. Ignored if FontMode is set to FontMode.AUTO.

setFontMode()

None setFontMode	(		self,
		FontMode	value
	)

Specify FontMode.

If FontMode is set to Auto, font size will be calculated automatically based on xDimension value. It is recommended to use FontMode.AUTO especially in AutoSizeMode.NEAREST or AutoSizeMode.INTERPOLATION. Default value: FontMode.AUTO.

setLocation()

None setLocation	(		self,
		CodeLocation	value
	)

Specify the displaying CodeText Location, set to CodeLocation.NONE to hide CodeText.

Default value: CodeLocation.NONE.

setNoWrap()

None setNoWrap	(		self,
		bool	value
	)

Specify word wraps (line breaks) within text.

setSpace()

None setSpace	(		self,
		Unit	value
	)

Space between the CodeText and the BarCode in Unit value.

Default value: 2pt. Ignored for EAN8, EAN13, UPCE, UPCA, ISBN, ISMN, ISSN, UpcaGs1DatabarCoupon.

setTwoDDisplayText()

None setTwoDDisplayText	(		self,
		str	value
	)

Text that will be displayed instead of codetext in 2D barcodes.

Used for: Aztec, Pdf417, DataMatrix, QR, MaxiCode, DotCode

Member Data Documentation

font

font

space

space