Aspose.Barcode for PHP via Java Generation and Recognition API docs

Inherits BaseJavaClass.

Public Member Functions

 getTwoDDisplayText ()
 
 setTwoDDisplayText (string $value)
 
 getFontMode ()
 
 setFontMode (int $value)
 
 getFont ()
 
 setFont (FontUnit $value)
 
 getSpace ()
 
 setSpace (Unit $value)
 
 getAlignment ()
 
 setAlignment (int $value)
 
 getColor ()
 
 setColor (string $value)
 
 getLocation ()
 
 setLocation (int $value)
 
 getNoWrap ()
 
 setNoWrap (bool $value)
 
 toString ()
 
- Public Member Functions inherited from BaseJavaClass
 __construct ($javaClass)
 
 getJavaClass ()
 
 getJavaClassName ()
 
 isNull ()
 
 printJavaClassName ()
 

Protected Member Functions

 init ()
 
- Protected Member Functions inherited from BaseJavaClass
 setJavaClass ($javaClass)
 

Private Attributes

 $font
 
 $space
 

Detailed Description

Codetext parameters.

Member Function Documentation

◆ getAlignment()

CodetextParameters::getAlignment ( )

Gets or sets the alignment of the code text. Default value: TextAlignment::CENTER.

◆ getColor()

CodetextParameters::getColor ( )

Specify the displaying CodeText's Color. Default value BLACK.

◆ getFont()

CodetextParameters::getFont ( )

Specify the displaying CodeText's font. Default value: Arial 5pt regular. Ignored if FontMode is set to FontMode::AUTO.

◆ getFontMode()

CodetextParameters::getFontMode ( )

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()

CodetextParameters::getLocation ( )

Specify the displaying CodeText Location, set to CodeLocation::NONE to hide CodeText. Default value: CodeLocation::BELOW.

◆ getNoWrap()

CodetextParameters::getNoWrap ( )

Specify word wraps (line breaks) within text.

Returns
bool

◆ getSpace()

CodetextParameters::getSpace ( )

Space between the CodeText and the BarCode in Unit value. Default value: 2pt. Ignored for EAN8, EAN13, UPCE, UPCA, ISBN, ISMN, ISSN, UpcaGs1DatabarCoupon.

◆ getTwoDDisplayText()

CodetextParameters::getTwoDDisplayText ( )

Text that will be displayed instead of codetext in 2D barcodes. Used for: Aztec, Pdf417, DataMatrix, QR, MaxiCode, DotCode

◆ init()

CodetextParameters::init ( )
protected

Reimplemented from BaseJavaClass.

◆ setAlignment()

CodetextParameters::setAlignment ( int  $value)

Gets or sets the alignment of the code text. Default value: TextAlignment::CENTER.

◆ setColor()

CodetextParameters::setColor ( string  $value)

Specify the displaying CodeText's Color. Default value BLACK.

◆ setFont()

CodetextParameters::setFont ( FontUnit  $value)

Specify the displaying CodeText's font. Default value: Arial 5pt regular. Ignored if FontMode is set to FontMode::AUTO.

◆ setFontMode()

CodetextParameters::setFontMode ( int  $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()

CodetextParameters::setLocation ( int  $value)

Specify the displaying CodeText Location, set to CodeLocation::NONE to hide CodeText. Default value: CodeLocation::BELOW.

◆ setNoWrap()

CodetextParameters::setNoWrap ( bool  $value)

Specify word wraps (line breaks) within text.

◆ setSpace()

CodetextParameters::setSpace ( 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()

CodetextParameters::setTwoDDisplayText ( string  $value)

Text that will be displayed instead of codetext in 2D barcodes. Used for: Aztec, Pdf417, DataMatrix, QR, MaxiCode, DotCode

◆ toString()

CodetextParameters::toString ( )

Returns a human-readable string representation of this CodetextParameters.

Returns
string A string that represents this CodetextParameters.

Member Data Documentation

◆ $font

CodetextParameters::$font
private

◆ $space

CodetextParameters::$space
private