BarcodeParameters
Inheritance: java.lang.Object
public class BarcodeParameters
Barcode generation parameters.
Methods
| Method | Description |
|---|---|
| equals(Object arg0) | |
| getAspectRatio() | |
| getAustralianPost() | AustralianPost barcode parameters. |
| getAztec() | Aztec parameters. |
| getBackColor() | |
| getBarColor() | Bars color. |
| getBarHeight() | Height of 1D barcodes’ bars in Unit value. |
| getBarWidthReduction() | Get bars reduction value that is used to compensate ink spread while printing. |
| getBarcodeType() | |
| getCalculatedBarCodeWidth() | |
| getChecksumAlwaysShow() | Always display checksum digit in the human readable text for Code128 and GS1Code128 barcodes. |
| getClass() | |
| getCodabar() | Codabar parameters. |
| getCodablock() | Codablock parameters. |
| getCode128() | Code128 parameters. |
| getCode16K() | Code16K parameters. |
| getCodeText() | |
| getCodeTextParameters() | Codetext parameters. |
| getColumns() | |
| getComplexBarcode() | |
| getCoupon() | Coupon parameters. |
| getDataBar() | Databar parameters. |
| getDataMatrix() | DataMatrix parameters. |
| getDotCode() | DotCode parameters. |
| getEnableEscape() | Indicates whether explains the character “\” as an escape character in CodeText property. |
| getFilledBars() | Gets a value indicating whether bars filled. |
| getGS1CompositeBar() | GS1 Composite Bar parameters. |
| getHanXin() | HanXin parameters. |
| getITF() | ITF parameters. |
| getMaxiCode() | MaxiCode parameters. |
| getPadding() | Barcode paddings. |
| getPatchCode() | PatchCode parameters. |
| getPdf417() | PDF417 parameters. |
| getPostal() | Postal parameters. |
| getPostalShortBarHeight() | |
| getQR() | QR, MicroQR and RectMicroQR parameters. |
| getQuietZonesWidthInXDim() | |
| getResolution() | |
| getRows() | |
| getStateHash() | |
| getSupplement() | Supplement parameters. |
| getSupplementSpace() | |
| getThrowExceptionWhenCodeTextIncorrect() | Only for 1D barcodes. |
| getWideNarrowRatio() | Wide bars to Narrow bars ratio. |
| getXDimension() | x-dimension is the smallest width of the unit of BarCode bars or spaces. |
| hashCode() | |
| isChecksumEnabled() | |
| notify() | |
| notifyAll() | |
| setBarColor(int value) | Bars color. |
| setBarHeight(Unit value) | Height of 1D barcodes’ bars in Unit value. |
| setBarWidthReduction(Unit value) | Sets bars reduction value that is used to compensate ink spread while printing. |
| setBarcodeType(BaseEncodeType value) | |
| setCalculatedBarCodeWidth(int value) | |
| setChecksumAlwaysShow(boolean value) | Always display checksum digit in the human readable text for Code128 and GS1Code128 barcodes. |
| setChecksumEnabled(EnableChecksum value) | |
| setCodeText(String value) | |
| setEnableEscape(boolean value) | Indicates whether explains the character “\” as an escape character in CodeText property. |
| setFilledBars(boolean value) | Sets a value indicating whether bars filled. |
| setGS1CompositeBar(GS1CompositeBarParameters value) | GS1 Composite Bar parameters. |
| setThrowExceptionWhenCodeTextIncorrect(boolean value) | Only for 1D barcodes. |
| setWideNarrowRatio(float value) | Wide bars to Narrow bars ratio. |
| setXDimension(Unit value) | x-dimension is the smallest width of the unit of BarCode bars or spaces. |
| toString() | |
| wait() | |
| wait(long arg0) | |
| wait(long arg0, int arg1) |
equals(Object arg0)
public boolean equals(Object arg0)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | java.lang.Object |
Returns: boolean
getAspectRatio()
public float getAspectRatio()
Returns: float
getAustralianPost()
public AustralianPostParameters getAustralianPost()
AustralianPost barcode parameters.
Returns: AustralianPostParameters
getAztec()
public AztecParameters getAztec()
Aztec parameters.
Returns: AztecParameters
getBackColor()
public int getBackColor()
Returns: int
getBarColor()
public int getBarColor()
Bars color. Default value: Color.BLACK.
Returns: int
getBarHeight()
public Unit getBarHeight()
Height of 1D barcodes’ bars in Unit value. Ignored if AutoSizeMode property is set to AutoSizeMode.Nearest or AutoSizeMode.INTERPOLATION.
Returns: Unit
getBarWidthReduction()
public Unit getBarWidthReduction()
Get bars reduction value that is used to compensate ink spread while printing.
Returns: Unit -
getBarcodeType()
public BaseEncodeType getBarcodeType()
Returns: BaseEncodeType
getCalculatedBarCodeWidth()
public int getCalculatedBarCodeWidth()
Returns: int
getChecksumAlwaysShow()
public boolean getChecksumAlwaysShow()
Always display checksum digit in the human readable text for Code128 and GS1Code128 barcodes.
Returns: boolean
getClass()
public final native Class<?> getClass()
Returns: java.lang.Class
getCodabar()
public CodabarParameters getCodabar()
Codabar parameters.
Returns: CodabarParameters
getCodablock()
public CodablockParameters getCodablock()
Codablock parameters.
Returns: CodablockParameters
getCode128()
public Code128Parameters getCode128()
Code128 parameters.
Returns: Code128Parameters
getCode16K()
public Code16KParameters getCode16K()
Code16K parameters.
Returns: Code16KParameters
getCodeText()
public String getCodeText()
Returns: java.lang.String
getCodeTextParameters()
public CodetextParameters getCodeTextParameters()
Codetext parameters.
Returns: CodetextParameters
getColumns()
public int getColumns()
Returns: int
getComplexBarcode()
public ComplexBarcode getComplexBarcode()
Returns: ComplexBarcode
getCoupon()
public CouponParameters getCoupon()
Coupon parameters. Used for UpcaGs1DatabarCoupon, UpcaGs1Code128Coupon.
Returns: CouponParameters
getDataBar()
public DataBarParameters getDataBar()
Databar parameters.
Returns: DataBarParameters
getDataMatrix()
public DataMatrixParameters getDataMatrix()
DataMatrix parameters.
Returns: DataMatrixParameters
getDotCode()
public DotCodeParameters getDotCode()
DotCode parameters.
Returns: DotCodeParameters
getEnableEscape()
public boolean getEnableEscape()
Indicates whether explains the character “\” as an escape character in CodeText property. Used for Pdf417, DataMatrix, Code128 only If the EnableEscape is true, “\” will be explained as a special escape character. Otherwise, “\” acts as normal characters.
Aspose.BarCode supports inputing decimal ascii code and mnemonic for ASCII control-code characters. For example, \013 and \\CR stands for CR.
Returns: boolean
getFilledBars()
public boolean getFilledBars()
Gets a value indicating whether bars filled. Only for 1D barcodes. Default value: true.
Returns: boolean
getGS1CompositeBar()
public GS1CompositeBarParameters getGS1CompositeBar()
GS1 Composite Bar parameters. This sample shows how to create and save a GS1 Composite Bar image. Note that 1D codetext and 2D codetext are separated by symbol ‘|’ String codetext = “(01)03212345678906|(21)A1B2C3D4E5F6G7H8”; BarcodeGenerator generator = new BarcodeGenerator(EncodeTypes.GS_1_COMPOSITE_BAR, codetext); generator.getParameters().getBarcode().getGS1CompositeBar().setLinearComponentType(EncodeTypes.GS_1_CODE_128); generator.getParameters().getBarcode().getGS1CompositeBar().setTwoDComponentType(TwoDComponentType.CC_A); // Aspect ratio of 2D component generator.getParameters().getBarcode().getPdf417().setAspectRatio(3); // X-Dimension of 1D and 2D components generator.getParameters().getBarcode().getXDimension().setPixels(3); /// // Height of 1D component generator.getParameters().getBarcode().getBarHeight().setPixels(100); /// generator.save(“test.png”);
Returns: GS1CompositeBarParameters - GS1 Composite Bar parameters.
getHanXin()
public HanXinParameters getHanXin()
HanXin parameters.
Returns: HanXinParameters
getITF()
public ITFParameters getITF()
ITF parameters.
Returns: ITFParameters
getMaxiCode()
public MaxiCodeParameters getMaxiCode()
MaxiCode parameters.
Returns: MaxiCodeParameters
getPadding()
public Padding getPadding()
Barcode paddings. Default value: 5pt 5pt 5pt 5pt.
Returns: Padding
getPatchCode()
public PatchCodeParameters getPatchCode()
PatchCode parameters.
Returns: PatchCodeParameters
getPdf417()
public Pdf417Parameters getPdf417()
PDF417 parameters.
Returns: Pdf417Parameters
getPostal()
public PostalParameters getPostal()
Postal parameters. Used for Postnet, Planet.
Returns: PostalParameters
getPostalShortBarHeight()
public int getPostalShortBarHeight()
Returns: int
getQR()
public QrParameters getQR()
QR, MicroQR and RectMicroQR parameters.
Returns: QrParameters
getQuietZonesWidthInXDim()
public int getQuietZonesWidthInXDim()
Returns: int
getResolution()
public float getResolution()
Returns: float
getRows()
public int getRows()
Returns: int
getStateHash()
public int getStateHash()
Returns: int
getSupplement()
public SupplementParameters getSupplement()
Supplement parameters. Used for Interleaved2of5, Standard2of5, EAN13, EAN8, UPCA, UPCE, ISBN, ISSN, ISMN.
Returns: SupplementParameters
getSupplementSpace()
public int getSupplementSpace()
Returns: int
getThrowExceptionWhenCodeTextIncorrect()
public boolean getThrowExceptionWhenCodeTextIncorrect()
Only for 1D barcodes. If codetext is incorrect and value set to true - exception will be thrown. Otherwise codetext will be corrected to match barcode’s specification. Exception always will be thrown for: Databar symbology if codetext is incorrect. Exception always will not be thrown for: AustraliaPost, SingapurePost, Code39Extended, Code93Extended, Code16K, Code128 symbology if codetext is incorrect.
Returns: boolean
getWideNarrowRatio()
public float getWideNarrowRatio()
Wide bars to Narrow bars ratio. Default value: 3, that is, wide bars are 3 times as wide as narrow bars. Used for ITF, PZN, PharmaCode, Standard2of5, Interleaved2of5, Matrix2of5, ItalianPost25, IATA2of5, VIN, DeutschePost, OPC, Code32, DataLogic2of5, PatchCode, Code39Extended, Code39Standard
Returns: float
getXDimension()
public Unit getXDimension()
x-dimension is the smallest width of the unit of BarCode bars or spaces. Increase this will increase the whole barcode image width. Ignored if BaseGenerationParameters.AutoSizeMode property is set to AutoSizeMode.Nearest or AutoSizeMode.Interpolation.
Returns: Unit
hashCode()
public native int hashCode()
Returns: int
isChecksumEnabled()
public EnableChecksum isChecksumEnabled()
Enable checksum during generation 1D barcodes.
Default is treated as Yes for symbology which must contain checksum, as No where checksum only possible.
Checksum is possible: Code39 Standard/Extended, Standard2of5, Interleaved2of5, Matrix2of5, ItalianPost25, DeutschePostIdentcode, DeutschePostLeitcode, VIN, Codabar
Checksum always used: Rest symbology
Returns: EnableChecksum
notify()
public final native void notify()
notifyAll()
public final native void notifyAll()
setBarColor(int value)
public void setBarColor(int value)
Bars color. Default value: Color.BLACK.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setBarHeight(Unit value)
public void setBarHeight(Unit value)
Height of 1D barcodes’ bars in Unit value. Ignored if AutoSizeMode property is set to AutoSizeMode.Nearest or AutoSizeMode.INTERPOLATION.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | Unit |
setBarWidthReduction(Unit value)
public void setBarWidthReduction(Unit value)
Sets bars reduction value that is used to compensate ink spread while printing.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | Unit |
setBarcodeType(BaseEncodeType value)
public void setBarcodeType(BaseEncodeType value)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | BaseEncodeType |
setCalculatedBarCodeWidth(int value)
public void setCalculatedBarCodeWidth(int value)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setChecksumAlwaysShow(boolean value)
public void setChecksumAlwaysShow(boolean value)
Always display checksum digit in the human readable text for Code128 and GS1Code128 barcodes.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setChecksumEnabled(EnableChecksum value)
public void setChecksumEnabled(EnableChecksum value)
Enable checksum during generation 1D barcodes.
Default is treated as Yes for symbology which must contain checksum, as No where checksum only possible.
Checksum is possible: Code39 Standard/Extended, Standard2of5, Interleaved2of5, Matrix2of5, ItalianPost25, DeutschePostIdentcode, DeutschePostLeitcode, VIN, Codabar
Checksum always used: Rest symbology
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | EnableChecksum |
setCodeText(String value)
public void setCodeText(String value)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setEnableEscape(boolean value)
public void setEnableEscape(boolean value)
Indicates whether explains the character “\” as an escape character in CodeText property. Used for Pdf417, DataMatrix, Code128 only If the EnableEscape is true, “\” will be explained as a special escape character. Otherwise, “\” acts as normal characters.
Aspose.BarCode supports inputing decimal ascii code and mnemonic for ASCII control-code characters. For example, \013 and \\CR stands for CR.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setFilledBars(boolean value)
public void setFilledBars(boolean value)
Sets a value indicating whether bars filled. Only for 1D barcodes. Default value: true.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setGS1CompositeBar(GS1CompositeBarParameters value)
public void setGS1CompositeBar(GS1CompositeBarParameters value)
GS1 Composite Bar parameters. This sample shows how to create and save a GS1 Composite Bar image. Note that 1D codetext and 2D codetext are separated by symbol ‘/’ String codetext = “(01)03212345678906/(21)A1B2C3D4E5F6G7H8”; BarcodeGenerator generator = new BarcodeGenerator(EncodeTypes.GS_1_COMPOSITE_BAR, codetext); generator.getParameters().getBarcode().getGS1CompositeBar().setLinearComponentType(EncodeTypes.GS_1_CODE_128); generator.getParameters().getBarcode().getGS1CompositeBar().setTwoDComponentType(TwoDComponentType.CC_A); // Aspect ratio of 2D component generator.getParameters().getBarcode().getPdf417().setAspectRatio(3); // X-Dimension of 1D and 2D components generator.getParameters().getBarcode().getXDimension().setPixels(3); /// // Height of 1D component generator.getParameters().getBarcode().getBarHeight().setPixels(100); /// generator.save(“test.png”);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | GS1CompositeBarParameters |
setThrowExceptionWhenCodeTextIncorrect(boolean value)
public void setThrowExceptionWhenCodeTextIncorrect(boolean value)
Only for 1D barcodes. If codetext is incorrect and value set to true - exception will be thrown. Otherwise codetext will be corrected to match barcode’s specification. Exception always will be thrown for: Databar symbology if codetext is incorrect. Exception always will not be thrown for: AustraliaPost, SingapurePost, Code39Extended, Code93Extended, Code16K, Code128 symbology if codetext is incorrect.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setWideNarrowRatio(float value)
public void setWideNarrowRatio(float value)
Wide bars to Narrow bars ratio. Default value: 3, that is, wide bars are 3 times as wide as narrow bars. Used for ITF, PZN, PharmaCode, Standard2of5, Interleaved2of5, Matrix2of5, ItalianPost25, IATA2of5, VIN, DeutschePost, OPC, Code32, DataLogic2of5, PatchCode, Code39Extended, Code39Standard
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | float |
setXDimension(Unit value)
public void setXDimension(Unit value)
x-dimension is the smallest width of the unit of BarCode bars or spaces. Increase this will increase the whole barcode image width. Ignored if BaseGenerationParameters.AutoSizeMode property is set to AutoSizeMode.Nearest or AutoSizeMode.Interpolation.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | Unit |
toString()
public String toString()
Returns: java.lang.String
wait()
public final void wait()
wait(long arg0)
public final native void wait(long arg0)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | long |
wait(long arg0, int arg1)
public final void wait(long arg0, int arg1)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | long | |
| arg1 | int |