IBarCodeControl - Aspose.BarCode for Java

Packages

All Known Implementing Classes:

BarCodeControl
```
public interface IBarCodeControl
```
IBarCodeControl

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`float`	`getAspectRatio()` AspectRatio
`boolean`	`getAutoSize()` Gets a value indicating whether the image size is to be adjusted automatically.
`java.awt.Color`	`getBackColor()` Background color of the barcode image.
`java.awt.image.BufferedImage`	`getBarCodeImage()` Get the BarCode image under current settings.
`float`	`getBarHeight()` height of 1D barcodes' bars.
`java.awt.Color`	`getBorderColor()` Gets BorderColor
`BorderDashStyle`	`getBorderDashStyle()` BorderDashStyle
`boolean`	`getBorderVisible()` BorderVisible
`float`	`getBorderWidth()` BorderWidth
`Caption`	`getCaptionAbove()` CaptionAbove
`Caption`	`getCaptionBelow()` CaptionBelow
`short`	`getCodabarStartSymbol()` CodabarStartSymbol
`short`	`getCodabarStopSymbol()` CodabarStopSymbol
`CodeLocation`	`getCodeLocation()` CodeLocation
`java.lang.String`	`getCodeText()` Data to be encoded, different types of BarCode may have different CodeText length restrictions.
`StringAlignment`	`getCodeTextAlignment()` CodeTextAlignment
`java.awt.Color`	`getCodeTextColor()` CodeTextColor
`java.awt.Font`	`getCodeTextFont()` Gets CodeTextFont
`float`	`getCodeTextSpace()` CodeTextSpace
`int`	`getColumns()` 2D BarCode's columns, if setting is illegal then columns will be calculated automatically applicable EncodeTypes: Pdf417
`CustomerInformationInterpretingType`	`getCustomerInformationInterpretingType()` CustomerInformationInterpretingType
`java.lang.String`	`getDisplay2DText()` Display2DText
`EnableChecksum`	`getEnableChecksum()` EnableChecksum
`boolean`	`getEnableEscape()` EnableEscape
`BaseEncodeType`	`getEncodeType()` BarCode's encode type (symbology).
`java.awt.Color`	`getForeColor()` Foreground color of the barcode image, that is, Bar's color of 1D barcode, Module's color of 2D barcode.
`GraphicsUnit`	`getGraphicsUnit()` Measurement of various properties such as width, height etc.
`float`	`getImageHeight()` BarCode image's height.
`ImageQualityMode`	`getImageQuality()` ImageQuality
`float`	`getImageWidth()` BarCode image's width.
`MarginsF`	`getMargins()` Margin area around the core BarCode image.
`Pdf417CompactionMode`	`getPdf417CompactionMode()` Pdf417CompactionMode
`Pdf417ErrorLevel`	`getPdf417ErrorLevel()` Pdf417ErrorLevel
`boolean`	`getPdf417Truncate()` Pdf417Truncate
`float`	`getPlanetShortBarHeight()` PLANET_SHORT_BAR_HEIGHT
`float`	`getPostnetShortBarHeight()` POSTNET_SHORT_BAR_HEIGHT
`Resolution`	`getResolution()` Resolution
`float`	`getRotationAngleF()` BarCode image's rotation angle, measured in degree, e.g.
`java.lang.String`	`getSupplementData()` SupplementData
`float`	`getSupplementSpace()` SUPPLEMENT_SPACE
`com.aspose.barcode.TextRenderingHint`	`getTextRenderingHint()` TextRenderingHint
`float`	`getWideNarrowRatio()` WideNarrowRatio
`float`	`getxDimension()` x-dimension, smallest width unit of BarCode's bars or spaces.
`float`	`getyDimension()` y-dimension
`void`	`rotate()` Rotate barcode image clockwise for 90 degrees
`void`	`rotate(float angle)` Rotate barcode image clockwise
`void`	`rotate(int direction, float angle)` Deprecated.
`void`	`rotate(RotationDirection direction, float angle)` Rotate the barcode image
`void`	`save(java.io.OutputStream stream, BarCodeImageFormat format)` Save BarCodeImage to specific file in specific format
`void`	`save(java.lang.String filename)` Save BarCodeImage to specific file in specific format
`void`	`save(java.lang.String filename, BarCodeImageFormat format)` Save BarCodeImage to specific file in specific format
`void`	`setAspectRatio(float value)` AspectRatio
`void`	`setAutoSize(boolean value)` Sets a value indicating whether the image size is to be adjusted automatically.
`void`	`setBackColor(java.awt.Color value)` Background color of the barcode image.
`void`	`setBarHeight(float value)` height of 1D barcodes' bars.
`void`	`setBorderColor(java.awt.Color value)` Sets BorderColor
`void`	`setBorderDashStyle(BorderDashStyle value)` BorderDashStyle
`void`	`setBorderDashStyle(int value)` Deprecated.
`void`	`setBorderVisible(boolean value)` BorderVisible
`void`	`setBorderWidth(float value)` BorderWidth
`void`	`setCaptionAbove(Caption value)` CaptionAbove
`void`	`setCaptionBelow(Caption value)` CaptionBelow
`void`	`setCodabarStartSymbol(short value)` CodabarStartSymbol
`void`	`setCodabarStopSymbol(short value)` CodabarStopSymbol
`void`	`setCodeLocation(CodeLocation value)` CodeLocation
`void`	`setCodeText(java.lang.String value)` Data to be encoded, different types of BarCode may have different CodeText length restrictions.
`void`	`setCodeTextAlignment(int value)` Deprecated.
`void`	`setCodeTextAlignment(StringAlignment value)` CodeTextAlignment
`void`	`setCodeTextColor(java.awt.Color value)` CodeTextColor
`void`	`setCodeTextFont(java.awt.Font value)` Sets CodeTextFont
`void`	`setCodeTextSpace(float value)` CodeTextSpace
`void`	`setColumns(int value)` 2D BarCode's columns, if setting is illegal then columns will be calculated automatically applicable EncodeTypes: Pdf417
`void`	`setCustomerInformationInterpretingType(CustomerInformationInterpretingType value)` CustomerInformationInterpretingType
`void`	`setCustomerInformationInterpretingType(int value)` Deprecated.
`void`	`setDisplay2DText(java.lang.String value)` Display2DText
`void`	`setEnableChecksum(EnableChecksum value)` EnableChecksum
`void`	`setEnableChecksum(int value)` Deprecated.
`void`	`setEnableEscape(boolean value)` EnableEscape
`void`	`setEncodeType(BaseEncodeType value)` BarCode's encode type (symbology).
`void`	`setForeColor(java.awt.Color value)` Foreground color of the barcode image, that is, Bar's color of 1D barcode, Module's color of 2D barcode.
`void`	`setGraphicsUnit(GraphicsUnit value)` Measurement of various properties such as width, height etc.
`void`	`setGraphicsUnit(int value)` Deprecated.
`void`	`setImageHeight(float value)` BarCode image's height.
`void`	`setImageQuality(ImageQualityMode value)`
`void`	`setImageQuality(int value)` Deprecated.
`void`	`setImageWidth(float value)` BarCode image's width.
`void`	`setPdf417CompactionMode(int value)` Deprecated.
`void`	`setPdf417CompactionMode(Pdf417CompactionMode value)` Pdf417CompactionMode
`void`	`setPdf417ErrorLevel(int value)` Deprecated.
`void`	`setPdf417ErrorLevel(Pdf417ErrorLevel value)` Pdf417ErrorLevel
`void`	`setPdf417Truncate(boolean value)` Pdf417Truncate
`void`	`setPlanetShortBarHeight(float value)` PLANET_SHORT_BAR_HEIGHT
`void`	`setPostnetShortBarHeight(float value)` POSTNET_SHORT_BAR_HEIGHT
`void`	`setResolution(Resolution value)` Resolution
`void`	`setRotationAngleF(float value)` BarCode image's rotation angle, measured in degree, e.g.
`void`	`setSupplementData(java.lang.String value)` SupplementData
`void`	`setSupplementSpace(float value)` SUPPLEMENT_SPACE
`void`	`setTextRenderingHint(com.aspose.barcode.TextRenderingHint value)` TextRenderingHint
`void`	`setWideNarrowRatio(float value)` WideNarrowRatio
`void`	`setxDimension(float value)` x-dimension, smallest width unit of BarCode's bars or spaces.
`void`	`setyDimension(float value)` y-dimension

- Method Detail
  - getEncodeType
```
BaseEncodeType getEncodeType()
```
    BarCode's encode type (symbology).
    
    Returns:
    
    returns BarCode's encode type
  - setEncodeType
```
void setEncodeType(BaseEncodeType value)
```
    BarCode's encode type (symbology).
    
    Parameters:
    
    value -
  - getImageWidth
```
float getImageWidth()
```
    BarCode image's width.
  - setImageWidth
```
void setImageWidth(float value)
```
    BarCode image's width.
  - getImageHeight
```
float getImageHeight()
```
    BarCode image's height.
  - setImageHeight
```
void setImageHeight(float value)
```
    BarCode image's height.
  - getBarCodeImage
```
java.awt.image.BufferedImage getBarCodeImage()
```
    Get the BarCode image under current settings.
  - getxDimension
```
float getxDimension()
```
    x-dimension, smallest width unit of BarCode's bars or spaces.
  - setxDimension
```
void setxDimension(float value)
```
    x-dimension, smallest width unit of BarCode's bars or spaces.
  - getyDimension
```
float getyDimension()
```
    y-dimension
  - setyDimension
```
void setyDimension(float value)
```
    y-dimension
  - getBackColor
```
java.awt.Color getBackColor()
```
    Background color of the barcode image.
  - setBackColor
```
void setBackColor(java.awt.Color value)
```
    Background color of the barcode image.
  - getForeColor
```
java.awt.Color getForeColor()
```
    Foreground color of the barcode image, that is, Bar's color of 1D barcode, Module's color of 2D barcode.
  - setForeColor
```
void setForeColor(java.awt.Color value)
```
    Foreground color of the barcode image, that is, Bar's color of 1D barcode, Module's color of 2D barcode.
  - getAutoSize
```
boolean getAutoSize()
```
    Gets a value indicating whether the image size is to be adjusted automatically. Recommended value is true.
  - setAutoSize
```
void setAutoSize(boolean value)
```
    Sets a value indicating whether the image size is to be adjusted automatically. Recommended value is true.
  - getRotationAngleF
```
float getRotationAngleF()
```
    BarCode image's rotation angle, measured in degree, e.g. RotationAngleF = 0 or RotationAngleF = 360 means no rotation If RotationAngleF NOT equal to 90, 180, 270 or 0, it may increase the difficulty for the scanner to read the image, please set quality mode to anti-alias
  - setRotationAngleF
```
void setRotationAngleF(float value)
```
    BarCode image's rotation angle, measured in degree, e.g. RotationAngleF = 0 or RotationAngleF = 360 means no rotation If RotationAngleF NOT equal to 90, 180, 270 or 0, it may increase the difficulty for the scanner to read the image, please set quality mode to anti-alias
  - getGraphicsUnit
```
GraphicsUnit getGraphicsUnit()
```
    Measurement of various properties such as width, height etc. Default GraphicsUnit: MILLIMETER See .
  - setGraphicsUnit
```
void setGraphicsUnit(GraphicsUnit value)
```
    Measurement of various properties such as width, height etc. Default GraphicsUnit: MILLIMETER See .
  - setGraphicsUnit
```
@Deprecated
void setGraphicsUnit(int value)
```
    Deprecated.
    
    Measurement of various properties such as width, height etc. Default GraphicsUnit: MILLIMETER See .
  - getBorderVisible
```
boolean getBorderVisible()
```
    BorderVisible
  - setBorderVisible
```
void setBorderVisible(boolean value)
```
    BorderVisible
  - getBorderDashStyle
```
BorderDashStyle getBorderDashStyle()
```
    BorderDashStyle
  - setBorderDashStyle
```
void setBorderDashStyle(BorderDashStyle value)
```
    BorderDashStyle
  - setBorderDashStyle
```
@Deprecated
void setBorderDashStyle(int value)
```
    Deprecated.
    
    BorderDashStyle
  - getBorderWidth
```
float getBorderWidth()
```
    BorderWidth
  - setBorderWidth
```
void setBorderWidth(float value)
```
    BorderWidth
  - getBorderColor
```
java.awt.Color getBorderColor()
```
    Gets BorderColor
    
    Returns:
    
    borderColor
  - setBorderColor
```
void setBorderColor(java.awt.Color value)
```
    Sets BorderColor
  - getCaptionAbove
```
Caption getCaptionAbove()
```
    CaptionAbove
  - setCaptionAbove
```
void setCaptionAbove(Caption value)
```
    CaptionAbove
  - getCaptionBelow
```
Caption getCaptionBelow()
```
    CaptionBelow
  - setCaptionBelow
```
void setCaptionBelow(Caption value)
```
    CaptionBelow
  - getMargins
```
MarginsF getMargins()
```
    Margin area around the core BarCode image.
  - getResolution
```
Resolution getResolution()
```
    Resolution
  - setResolution
```
void setResolution(Resolution value)
```
    Resolution
  - getCodeText
```
java.lang.String getCodeText()
```
    Data to be encoded, different types of BarCode may have different CodeText length restrictions.
  - setCodeText
```
void setCodeText(java.lang.String value)
```
    Data to be encoded, different types of BarCode may have different CodeText length restrictions.
  - getDisplay2DText
```
java.lang.String getDisplay2DText()
```
    Display2DText
  - setDisplay2DText
```
void setDisplay2DText(java.lang.String value)
```
    Display2DText
  - getPdf417Truncate
```
boolean getPdf417Truncate()
```
    Pdf417Truncate
  - setPdf417Truncate
```
void setPdf417Truncate(boolean value)
```
    Pdf417Truncate
  - getPdf417ErrorLevel
```
Pdf417ErrorLevel getPdf417ErrorLevel()
```
    Pdf417ErrorLevel
  - setPdf417ErrorLevel
```
void setPdf417ErrorLevel(Pdf417ErrorLevel value)
```
    Pdf417ErrorLevel
  - setPdf417ErrorLevel
```
@Deprecated
void setPdf417ErrorLevel(int value)
```
    Deprecated.
    
    Pdf417ErrorLevel
  - getPdf417CompactionMode
```
Pdf417CompactionMode getPdf417CompactionMode()
```
    Pdf417CompactionMode
  - setPdf417CompactionMode
```
@Deprecated
void setPdf417CompactionMode(int value)
```
    Deprecated.
    
    Pdf417CompactionMode
  - setPdf417CompactionMode
```
void setPdf417CompactionMode(Pdf417CompactionMode value)
```
    Pdf417CompactionMode
  - getAspectRatio
```
float getAspectRatio()
```
    AspectRatio
  - setAspectRatio
```
void setAspectRatio(float value)
```
    AspectRatio
  - getColumns
```
int getColumns()
```
    2D BarCode's columns, if setting is illegal then columns will be calculated automatically applicable EncodeTypes: Pdf417
  - setColumns
```
void setColumns(int value)
```
    2D BarCode's columns, if setting is illegal then columns will be calculated automatically applicable EncodeTypes: Pdf417
  - getEnableEscape
```
boolean getEnableEscape()
```
    EnableEscape
  - setEnableEscape
```
void setEnableEscape(boolean value)
```
    EnableEscape
  - getEnableChecksum
```
EnableChecksum getEnableChecksum()
```
    EnableChecksum
  - setEnableChecksum
```
@Deprecated
void setEnableChecksum(int value)
```
    Deprecated.
    
    EnableChecksum
  - setEnableChecksum
```
void setEnableChecksum(EnableChecksum value)
```
    EnableChecksum
  - getCustomerInformationInterpretingType
```
CustomerInformationInterpretingType getCustomerInformationInterpretingType()
```
    CustomerInformationInterpretingType
  - setCustomerInformationInterpretingType
```
@Deprecated
void setCustomerInformationInterpretingType(int value)
```
    Deprecated.
    
    CustomerInformationInterpretingType
  - setCustomerInformationInterpretingType
```
void setCustomerInformationInterpretingType(CustomerInformationInterpretingType value)
```
    CustomerInformationInterpretingType
  - getBarHeight
```
float getBarHeight()
```
    height of 1D barcodes' bars.
  - setBarHeight
```
void setBarHeight(float value)
```
    height of 1D barcodes' bars.
  - getWideNarrowRatio
```
float getWideNarrowRatio()
```
    WideNarrowRatio
  - setWideNarrowRatio
```
void setWideNarrowRatio(float value)
```
    WideNarrowRatio
  - getCodeTextColor
```
java.awt.Color getCodeTextColor()
```
    CodeTextColor
  - setCodeTextColor
```
void setCodeTextColor(java.awt.Color value)
```
    CodeTextColor
  - getCodeLocation
```
CodeLocation getCodeLocation()
```
    CodeLocation
  - setCodeLocation
```
void setCodeLocation(CodeLocation value)
```
    CodeLocation
  - getCodeTextAlignment
```
StringAlignment getCodeTextAlignment()
```
    CodeTextAlignment
  - setCodeTextAlignment
```
@Deprecated
void setCodeTextAlignment(int value)
```
    Deprecated.
    
    CodeTextAlignment
  - setCodeTextAlignment
```
void setCodeTextAlignment(StringAlignment value)
```
    CodeTextAlignment
  - getCodeTextSpace
```
float getCodeTextSpace()
```
    CodeTextSpace
  - setCodeTextSpace
```
void setCodeTextSpace(float value)
```
    CodeTextSpace
  - getCodabarStartSymbol
```
short getCodabarStartSymbol()
```
    CodabarStartSymbol
  - setCodabarStartSymbol
```
void setCodabarStartSymbol(short value)
```
    CodabarStartSymbol
  - getCodabarStopSymbol
```
short getCodabarStopSymbol()
```
    CodabarStopSymbol
  - setCodabarStopSymbol
```
void setCodabarStopSymbol(short value)
```
    CodabarStopSymbol
  - getCodeTextFont
```
java.awt.Font getCodeTextFont()
```
    Gets CodeTextFont
    
    Returns:
    
    CodeTextFont
  - setCodeTextFont
```
void setCodeTextFont(java.awt.Font value)
```
    Sets CodeTextFont
    
    Parameters:
    
    value - CodeTextFont
  - getSupplementData
```
java.lang.String getSupplementData()
```
    SupplementData
  - setSupplementData
```
void setSupplementData(java.lang.String value)
```
    SupplementData
  - getSupplementSpace
```
float getSupplementSpace()
```
    SUPPLEMENT_SPACE
  - setSupplementSpace
```
void setSupplementSpace(float value)
```
    SUPPLEMENT_SPACE
  - getImageQuality
```
ImageQualityMode getImageQuality()
```
    ImageQuality
  - setImageQuality
```
@Deprecated
void setImageQuality(int value)
```
    Deprecated.
    
    ImageQuality
  - setImageQuality
```
void setImageQuality(ImageQualityMode value)
```
  - getTextRenderingHint
```
com.aspose.barcode.TextRenderingHint getTextRenderingHint()
```
    TextRenderingHint
  - setTextRenderingHint
```
void setTextRenderingHint(com.aspose.barcode.TextRenderingHint value)
```
    TextRenderingHint
  - getPostnetShortBarHeight
```
float getPostnetShortBarHeight()
```
    POSTNET_SHORT_BAR_HEIGHT
  - setPostnetShortBarHeight
```
void setPostnetShortBarHeight(float value)
```
    POSTNET_SHORT_BAR_HEIGHT
  - getPlanetShortBarHeight
```
float getPlanetShortBarHeight()
```
    PLANET_SHORT_BAR_HEIGHT
  - setPlanetShortBarHeight
```
void setPlanetShortBarHeight(float value)
```
    PLANET_SHORT_BAR_HEIGHT
  - rotate
```
void rotate()
```
    Rotate barcode image clockwise for 90 degrees
  - rotate
```
void rotate(float angle)
```
    Rotate barcode image clockwise
    
    Parameters:
    
    angle - Rotation Angle
  - rotate
```
void rotate(RotationDirection direction,
            float angle)
```
    Rotate the barcode image
    
    Parameters:
    
    direction - rotation direction
    
    angle - rotation angle
  - rotate
```
@Deprecated
void rotate(int direction,
                         float angle)
```
    Deprecated.
    
    Rotate the barcode image
    
    Parameters:
    
    direction - rotation direction
    
    angle - rotation angle
  - save
```
void save(java.lang.String filename)
   throws java.io.IOException
```
    Save BarCodeImage to specific file in specific format
    
    Parameters:
    
    filename - save to this file path
    
    Throws:
    
    java.io.IOException
  - save
```
void save(java.io.OutputStream stream,
          BarCodeImageFormat format)
   throws java.io.IOException
```
    Save BarCodeImage to specific file in specific format
    
    Parameters:
    
    filename - Save to this file path
    
    format - The specific format
    
    Throws:
    
    java.io.IOException
  - save
```
void save(java.lang.String filename,
          BarCodeImageFormat format)
   throws java.io.IOException
```
    Save BarCodeImage to specific file in specific format
    
    Parameters:
    
    filename - save to this file path
    
    format - The specific format
    
    Throws:
    
    java.io.IOException

Packages

com.aspose.barcode

Interfaces

Classes

Enums

Exceptions

Interface IBarCodeControl

Method Summary

Method Detail

getEncodeType

setEncodeType

getImageWidth

setImageWidth

getImageHeight

setImageHeight

getBarCodeImage

getxDimension

setxDimension

getyDimension

setyDimension

getBackColor

setBackColor

getForeColor

setForeColor

getAutoSize

setAutoSize

getRotationAngleF

setRotationAngleF

getGraphicsUnit

setGraphicsUnit

setGraphicsUnit

getBorderVisible

setBorderVisible

getBorderDashStyle

setBorderDashStyle

setBorderDashStyle

getBorderWidth

setBorderWidth

getBorderColor

setBorderColor

getCaptionAbove

setCaptionAbove

getCaptionBelow

setCaptionBelow

getMargins

getResolution

setResolution

getCodeText

setCodeText

getDisplay2DText

setDisplay2DText

getPdf417Truncate

setPdf417Truncate

getPdf417ErrorLevel

setPdf417ErrorLevel

setPdf417ErrorLevel

getPdf417CompactionMode

setPdf417CompactionMode

setPdf417CompactionMode

getAspectRatio

setAspectRatio

getColumns

setColumns

getEnableEscape

setEnableEscape

getEnableChecksum

setEnableChecksum

setEnableChecksum

getCustomerInformationInterpretingType

setCustomerInformationInterpretingType

setCustomerInformationInterpretingType

getBarHeight

setBarHeight

getWideNarrowRatio

setWideNarrowRatio

getCodeTextColor

setCodeTextColor

getCodeLocation

setCodeLocation

getCodeTextAlignment