com.aspose.barcode.generation

Class BaseGenerationParameters

  • java.lang.Object
    • com.aspose.barcode.generation.BaseGenerationParameters


  • public class BaseGenerationParameters
    extends java.lang.Object

    Barcode image generation parameters.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      AutoSizeMode getAutoSizeMode()
      Specifies the different types of automatic sizing modes.
      java.awt.Color getBackColor()
      Background color of the barcode image.
      BarcodeParameters getBarcode()
      Gets the BarcodeParameters that contains all barcode properties.
      BorderParameters getBorder()
      Gets the BorderParameters that contains all configuration properties for barcode border.
      CaptionParameters getCaptionAbove()
      Caption Above the BarCode image.
      CaptionParameters getCaptionBelow()
      Caption Below the BarCode image.
      Unit getImageHeight()
      BarCode image height when AutoSizeMode property is set to AutoSizeMode.NEAREST or AutoSizeMode.INTERPOLATION.
      Unit getImageWidth()
      BarCode image width when AutoSizeMode property is set to AutoSizeMode.NEAREST or AutoSizeMode.INTERPOLATION.
      float getResolution()
      Gets the resolution of the BarCode image.
      float getRotationAngle()
      BarCode image rotation angle, measured in degree, e.g.
      void setAutoSizeMode(AutoSizeMode value)
      Specifies the different types of automatic sizing modes.
      void setBackColor(java.awt.Color value)
      Background color of the barcode image.
      void setImageHeight(Unit value)
      BarCode image height when AutoSizeMode property is set to AutoSizeMode.NEAREST or AutoSizeMode.INTERPOLATION.
      void setImageWidth(Unit value)
      BarCode image width when AutoSizeMode property is set to AutoSizeMode.NEAREST or AutoSizeMode.INTERPOLATION.
      void setResolution(float value)
      Sets the resolution of the BarCode image.
      void setRotationAngle(float value)
      BarCode image rotation angle, measured in degree, e.g.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • getBackColor

        public java.awt.Color getBackColor()

        Background color of the barcode image. Default value: Color.White. See Color.

      • setBackColor

        public void setBackColor(java.awt.Color value)

        Background color of the barcode image. Default value: Color.White. See Color.

      • getResolution

        public float getResolution()

        Gets the resolution of the BarCode image. One value for both dimensions. Default value: 96 dpi.

        Throws:
        java.lang.IllegalArgumentException - <p>The <b>Resolution</b> parameter value is less than or equal to 0.</p>
      • setResolution

        public void setResolution(float value)

        Sets the resolution of the BarCode image. One value for both dimensions. Default value: 96 dpi.

        Throws:
        java.lang.IllegalArgumentException - <p>The <b>Resolution</b> parameter value is less than or equal to 0.</p>
      • getRotationAngle

        public float getRotationAngle()

        BarCode image rotation angle, measured in degree, e.g. RotationAngle = 0 or RotationAngle = 360 means no rotation. If RotationAngle NOT equal to 90, 180, 270 or 0, it may increase the difficulty for the scanner to read the image. Default value: 0.


          This sample shows how to create and save a BarCode image.
          
                  BarcodeGenerator generator = new BarcodeGenerator(EncodeTypes.DATA_MATRIX);
                  generator.getParameters().setRotationAngle(7f);
            generator.save("test.png");
                
      • setRotationAngle

        public void setRotationAngle(float value)

        BarCode image rotation angle, measured in degree, e.g. RotationAngle = 0 or RotationAngle = 360 means no rotation. If RotationAngle NOT equal to 90, 180, 270 or 0, it may increase the difficulty for the scanner to read the image. Default value: 0.


          This sample shows how to create and save a BarCode image.
          
                  BarcodeGenerator generator = new BarcodeGenerator(EncodeTypes.DATA_MATRIX);
                  generator.getParameters().setRotationAngle(7f);
            generator.save("test.png");
                
      • getCaptionAbove

        public CaptionParameters getCaptionAbove()

        Caption Above the BarCode image. See CaptionParameters.

      • getCaptionBelow

        public CaptionParameters getCaptionBelow()

        Caption Below the BarCode image. See CaptionParameters.

      • getAutoSizeMode

        public AutoSizeMode getAutoSizeMode()

        Specifies the different types of automatic sizing modes. Default value: AutoSizeMode.NONE.

      • setAutoSizeMode

        public void setAutoSizeMode(AutoSizeMode value)

        Specifies the different types of automatic sizing modes. Default value: AutoSizeMode.NONE.

      • getImageHeight

        public Unit getImageHeight()

        BarCode image height when AutoSizeMode property is set to AutoSizeMode.NEAREST or AutoSizeMode.INTERPOLATION.

      • setImageHeight

        public void setImageHeight(Unit value)

        BarCode image height when AutoSizeMode property is set to AutoSizeMode.NEAREST or AutoSizeMode.INTERPOLATION.

      • getImageWidth

        public Unit getImageWidth()

        BarCode image width when AutoSizeMode property is set to AutoSizeMode.NEAREST or AutoSizeMode.INTERPOLATION.

      • setImageWidth

        public void setImageWidth(Unit value)

        BarCode image width when AutoSizeMode property is set to AutoSizeMode.NEAREST or AutoSizeMode.INTERPOLATION.

      • getBarcode

        public BarcodeParameters getBarcode()

        Gets the BarcodeParameters that contains all barcode properties.

      • getBorder

        public BorderParameters getBorder()

        Gets the BorderParameters that contains all configuration properties for barcode border.