Aspose.Barcode for Python via Java Generation and Recognition API docs
CaptionParameters Class Reference

Caption parameters. More...

Inherits BaseJavaClass.

Public Member Functions

None __init__ (self, javaClass)
 
str __str__ (self)
 String representation of the CaptionParameters object. More...
 
TextAlignment getAlignment (self)
 Caption test horizontal alignment. More...
 
Optional[FontUnitgetFont (self)
 Caption font. More...
 
bool getNoWrap (self)
 Specify word wraps (line breaks) within text. More...
 
Optional[PaddinggetPadding (self)
 Captions paddings. More...
 
str getText (self)
 Caption text. More...
 
Tuple[int, int, int] getTextColor (self)
 Caption text color, representation of an RGB tuple. More...
 
bool getVisible (self)
 Caption text visibility. More...
 
None init (self)
 
None setAlignment (self, TextAlignment value)
 Caption test horizontal alignment. More...
 
None setNoWrap (self, bool value)
 Specify word wraps (line breaks) within text. More...
 
None setPadding (self, Padding value)
 Captions paddings. More...
 
None setText (self, str value)
 Caption text. More...
 
None setTextColor (self, Tuple[int, int, int] value)
 Caption text color, representation of an RGB tuple. More...
 
None setVisible (self, bool value)
 Caption text visibility. 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

 padding
 
- Public Attributes inherited from BaseJavaClass
 javaClass
 
 javaClassName
 

Detailed Description

Caption parameters.

Constructor & Destructor Documentation

◆ __init__()

None __init__ (   self,
  javaClass 
)

Reimplemented from BaseJavaClass.

Member Function Documentation

◆ __str__()

str __str__ (   self)

String representation of the CaptionParameters object.

◆ getAlignment()

TextAlignment getAlignment (   self)

Caption test horizontal alignment.

Default valueAlignment.Center.

◆ getFont()

Optional[FontUnit] getFont (   self)

Caption font.

Default value: Arial 8pt regular.

◆ getNoWrap()

bool getNoWrap (   self)

Specify word wraps (line breaks) within text.

Returns
bool

◆ getPadding()

Optional[Padding] getPadding (   self)

Captions paddings.

Default value for CaptionAbove: 5pt 5pt 0 5pt. Default value for CaptionBelow: 0 5pt 5pt 5pt.

◆ getText()

str getText (   self)

Caption text.

Default value: empty string.

◆ getTextColor()

Tuple[int, int, int] getTextColor (   self)

Caption text color, representation of an RGB tuple.

Default value (0,0,0).

◆ getVisible()

bool getVisible (   self)

Caption text visibility.

Default value: false.

◆ init()

None init (   self)

Reimplemented from BaseJavaClass.

◆ setAlignment()

None setAlignment (   self,
TextAlignment  value 
)

Caption test horizontal alignment.

Default valueAlignment.Center.

◆ setNoWrap()

None setNoWrap (   self,
bool  value 
)

Specify word wraps (line breaks) within text.

◆ setPadding()

None setPadding (   self,
Padding  value 
)

Captions paddings.

Default value for CaptionAbove: 5pt 5pt 0 5pt. Default value for CaptionBelow: 0 5pt 5pt 5pt.

◆ setText()

None setText (   self,
str  value 
)

Caption text.

Default value: empty string.

◆ setTextColor()

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

Caption text color, representation of an RGB tuple.

Default value (0,0,0).

◆ setVisible()

None setVisible (   self,
bool  value 
)

Caption text visibility.

Default value: false.

Member Data Documentation

◆ padding

padding