aspose.barcode 22.10.1 → 22.11.0

package/lib/Generation.js

@@ -738,7 +738,7 @@ class BaseGenerationParameters extends joint.BaseJavaClass
      *  //This sample shows how to create and save a BarCode image.
      *     let generator = new BarcodeGenerator( EncodeTypes.DATA_MATRIX);
      *     generator.getParameters().setRotationAngle(7);
-     *     generator.save("test.png");
+     *     generator.save("test.png", BarcodeImageFormat.PNG);
      */
     getRotationAngle()
     {
@@ -753,7 +753,7 @@ class BaseGenerationParameters extends joint.BaseJavaClass
      *  //This sample shows how to create and save a BarCode image.
      *     let generator = new BarcodeGenerator( EncodeTypes.DATA_MATRIX);
      *     generator.getParameters().setRotationAngle(7);
-     *     generator.save("test.png");
+     *     generator.save("test.png", BarcodeImageFormat.PNG);
      */
     setRotationAngle(value)
     {
@@ -994,7 +994,7 @@ class BorderParameters extends joint.BaseJavaClass
  * @example
  * //This sample shows influence of ChecksumValidation on recognition quality and results
  * let generator = new BarcodeGenerator(EncodeTypes.EAN_13, "1234567890128");
- * generator.save("test.png");
+ * generator.save("test.png", BarcodeImageFormat.PNG);
  * let reader = new BarCodeReader("test.png", DecodeType.EAN_13);
  * //checksum disabled
  * reader.setChecksumValidation(ChecksumValidation.OFF);
@@ -1188,7 +1188,7 @@ class CaptionParameters extends joint.BaseJavaClass
  *  //This sample shows how to create and save a BarCode image.
  *    let generator = new BarcodeGenerator(EncodeTypes.CODE_128);
  *    generator.getParameters().getBarcode().getBarHeight().setMillimeters(10);
- *    generator.save("test.png");
+ *    generator.save("test.png", BarcodeImageFormat.PNG);
  */
 class Unit extends joint.BaseJavaClass
 {
@@ -3023,6 +3023,22 @@ class MaxiCodeParameters extends joint.BaseJavaClass
     {
     }
 
+    /**
+     * Gets a MaxiCode encode mode.
+     */
+    getMaxiCodeMode()
+    {
+        return this.getJavaClass().getMaxiCodeModeSync();
+    }
+
+    /**
+     * Sets a MaxiCode encode mode.
+     */
+    setMaxiCodeMode(maxiCodeMode)
+    {
+        this.getJavaClass().setMaxiCodeModeSync(maxiCodeMode);
+    }
+
     /**
      * Gets a MaxiCode encode mode.
      */
@@ -3039,6 +3055,64 @@ class MaxiCodeParameters extends joint.BaseJavaClass
         this.getJavaClass().setMaxiCodeEncodeModeSync(value);
     }
 
+    /**
+     * Gets ECI encoding. Used when MaxiCodeEncodeMode is AUTO.
+     * Default value: ISO-8859-1
+     */
+    getECIEncoding()
+    {
+        return this.getJavaClass().getECIEncodingSync();
+    }
+
+    /**
+     * Sets ECI encoding. Used when MaxiCodeEncodeMode is AUTO.
+     * Default value: ISO-8859-1
+     */
+    setECIEncoding(ECIEncoding)
+    {
+        this.getJavaClass().setECIEncodingSync(ECIEncoding);
+    }
+
+    /**
+     * Gets a MaxiCode barcode id in structured append mode.
+     * ID must be a value between 1 and 8.
+     * Default value: 0
+     */
+    getMaxiCodeStructuredAppendModeBarcodeId()
+    {
+        return this.getJavaClass().getMaxiCodeStructuredAppendModeBarcodeIdSync();
+    }
+
+    /**
+     * Sets a MaxiCode barcode id in structured append mode.
+     * ID must be a value between 1 and 8.
+     * Default value: 0
+     */
+    setMaxiCodeStructuredAppendModeBarcodeId(maxiCodeStructuredAppendModeBarcodeId)
+    {
+        this.getJavaClass().setMaxiCodeStructuredAppendModeBarcodeIdSync(maxiCodeStructuredAppendModeBarcodeId);
+    }
+
+    /**
+     * Gets a MaxiCode barcodes count in structured append mode.
+     * Count number must be a value between 2 and 8 (maximum barcodes count).
+     * Default value: -1
+     */
+    getMaxiCodeStructuredAppendModeBarcodesCount()
+    {
+        return this.getJavaClass().getMaxiCodeStructuredAppendModeBarcodesCountSync();
+    }
+
+    /**
+     * Sets a MaxiCode barcodes count in structured append mode.
+     * Count number must be a value between 2 and 8 (maximum barcodes count).
+     * Default value: -1
+     */
+    setMaxiCodeStructuredAppendModeBarcodesCount(maxiCodeStructuredAppendModeBarcodesCount)
+    {
+        this.getJavaClass().setMaxiCodeStructuredAppendModeBarcodesCountSync(maxiCodeStructuredAppendModeBarcodesCount);
+    }
+
     /**
      * Height/Width ratio of 2D BarCode module.
      */
@@ -3384,7 +3458,6 @@ class FontUnit extends joint.BaseJavaClass
  */
 class ExtCodetextBuilder extends joint.BaseJavaClass
 {
-
     constructor(javaClass)
     {
         super(javaClass);
@@ -3485,7 +3558,8 @@ class QrExtCodetextBuilder extends ExtCodetextBuilder
 
     constructor()
     {
-        super(new java.import(QrExtCodetextBuilder.javaClassName)());
+        let java_class = java.import(QrExtCodetextBuilder.javaClassName);
+        super(new java_class());
         this.init();
     }
 
@@ -3605,6 +3679,60 @@ class QrStructuredAppendParameters extends joint.BaseJavaClass
     }
 }
 
+/**
+ * Extended codetext generator for MaxiCode barcodes for ExtendedCodetext Mode of MaxiCodeEncodeMode
+ * Use TwoDDisplayText property of BarcodeGenerator to set visible text to removing managing characters.
+ *
+ * This sample shows how to use MaxiCodeExtCodetextBuilder in Extended Mode.
+ *
+ * <pre>
+ * //create codetext
+ * let textBuilder = new MaxiCodeExtCodetextBuilder();
+ * textBuilder.addECICodetext(ECIEncodings.Win1251, "Will");
+ * textBuilder.addECICodetext(ECIEncodings.UTF8, "犬Right狗");
+ * textBuilder.addECICodetext(ECIEncodings.UTF16BE, "犬Power狗");
+ * textBuilder.addPlainCodetext("Plain text");
+ *
+ * //generate codetext
+ * let codetext = textBuilder.getExtendedCodetext();
+ *
+ * //generate
+ * let generator = new BarcodeGenerator(EncodeTypes.MAXI_CODE, codetext);
+ * generator.getParameters().getBarcode().getCodeTextParameters().setTwoDDisplayText("My Text");
+ * generator.save("test.bmp", BarcodeImageFormat.BMP);
+ * </pre>
+ */
+class MaxiCodeExtCodetextBuilder extends ExtCodetextBuilder
+{
+    static JAVA_CLASS_NAME = "com.aspose.mw.barcode.generation.MwMaxiCodeExtCodetextBuilder";
+
+    constructor()
+    {
+        try
+        {
+            let java_class = java.import(MaxiCodeExtCodetextBuilder.JAVA_CLASS_NAME);
+            super(new java_class());
+        }
+        catch (ex)
+        {
+            throw new BarcodeException(ex.getMessage(), __FILE__, __LINE__);
+        }
+    }
+
+    init()
+    {
+    }
+
+    /**
+     * Generates Extended codetext from the extended codetext list.
+     * @return Extended codetext as string
+     */
+    getExtendedCodetext()
+    {
+        return this.getJavaClass().getExtendedCodetextSync();
+    }
+}
+
 /**
  * BarcodeClassifications EncodeTypes classification
  * @enum
@@ -3738,7 +3866,7 @@ DataMatrixEncodeMode =
          * $generator->setCodeText("\\ansix12:ANSIX12TEXT\\ascii:backslash must be \\\\ doubled\\edifact:EdifactEncodedText");
          * $generator->getParameters()->getBarcode()->getDataMatrix().setDataMatrixEncodeMode(DataMatrixEncodeMode.EXTENDED_CODETEXT);
          * $generator->getParameters()->getBarcode()->getCodeTextParameters().setTwoDDisplayText("My Text");
-         * $generator->save("test.png");
+         * $generator->save("test.png", BarcodeImageFormat.PNG);
          */
         EXTENDED_CODETEXT: 12
     };
@@ -3804,12 +3932,12 @@ ITF14BorderType =
  * Encoding mode for QR barcodes. It is recommended to Use AUTO with CodeTextEncoding = Encoding.UTF8 for latin symbols or digits and UTF_8_BOM for unicode symbols.
  *  @example
  *     //Example how to use ECI encoding
- *     BarcodeGenerator generator = new BarcodeGenerator(EncodeTypes.QR);
+ *     let generator = new BarcodeGenerator(EncodeTypes.QR);
  *     generator.setCodeText("12345TEXT");
  *     generator.getParameters().getBarcode().getQR().setQrEncodeMode(QREncodeMode.ECI_ENCODING);
  *     generator.getParameters().getBarcode().getQR().setQrEncodeType(QREncodeType.FORCE_QR);
  *     generator.getParameters().getBarcode().getQR().setQrECIEncoding(ECIEncodings.UTF8);
- *     generator.save("test.png");
+ *     generator.save("test.png", BarcodeImageFormat.PNG);
  *
  * @example
  *      //Example how to use FNC1 first position in Extended Mode
@@ -3818,11 +3946,11 @@ ITF14BorderType =
  *      textBuilder.addFNC1GroupSeparator();
  *      textBuilder.addPlainCodetext("12345&lt;FNC1&gt;");
  *      //generate barcode
- *      BarcodeGenerator generator = new BarcodeGenerator(EncodeTypes.QR);
+ *      let generator = new BarcodeGenerator(EncodeTypes.QR);
  *      generator.setCodeText(textBuilder.getExtendedCodetext());
  *      generator.getParameters().getBarcode().getQR().setQrEncodeMode(QREncodeMode.EXTENDED_CODETEXT);
  *      generator.getParameters().getBarcode().getCodeTextParameters().setTwoDDisplayText("My Text");
- *      generator.save("d:/test.png");
+ *      generator.save("d:/test.png", BarcodeImageFormat.PNG);
  *
  * @example
  *   // This sample shows how to use FNC1 second position in Extended Mode.
@@ -3831,10 +3959,10 @@ ITF14BorderType =
  *    textBuilder.addFNC1SecondPosition("12");
  *    textBuilder.addPlainCodetext("TRUE3456");
  *    //generate barcode
- *    BarcodeGenerator generator = new BarcodeGenerator(EncodeTypes.QR);
+ *    let generator = new BarcodeGenerator(EncodeTypes.QR);
  *    generator.setCodeText(textBuilder.getExtendedCodetext());
  *    generator.getParameters().getBarcode().getCodeTextParameters().setTwoDDisplayText("My Text");
- *    generator.save("d:/test.png");
+ *    generator.save("d:/test.png", BarcodeImageFormat.PNG);
  *
  *    @example
  *    //This sample shows how to use multi ECI mode in Extended Mode.
@@ -3845,11 +3973,11 @@ ITF14BorderType =
  *   textBuilder.addECICodetext(ECIEncodings.UTF16BE, "Power");
  *   textBuilder.addPlainCodetext("t\e\\st");
  *   //generate barcode
- *   BarcodeGenerator generator = new BarcodeGenerator(EncodeTypes.QR);
+ *   let generator = new BarcodeGenerator(EncodeTypes.QR);
  *   generator.setCodeText(textBuilder.getExtendedCodetext());
  *   generator.getParameters().getBarcode().getQR().setQrEncodeMode(QREncodeMode.EXTENDED_CODETEXT);
  *   generator.getParameters().getBarcode().getCodeTextParameters().setTwoDDisplayText("My Text");
- *   generator.save("d:/test.png");
+ *   generator.save("d:/test.png", BarcodeImageFormat.PNG);
  * @enum
  */
 QREncodeMode =
@@ -4411,7 +4539,7 @@ TextAlignment =
  *  generator.setAutoSizeMode(AutoSizeMode.NEAREST);
  *  generator.getBarCodeWidth().setMillimeters(50);
  *  generator.getBarCodeHeight().setInches(1.3f);
- *  generator.save("test.png");
+ *  generator.save("test.png", BarcodeImageFormat.PNG);
  *
  *  @enum
  */
@@ -4439,7 +4567,7 @@ AutoSizeMode =
          *      generator.getParameters().getBarcode().setAutoSizeMode(AutoSizeMode.INTERPOLATION);
          *      generator.getParameters().getBarcode().getBarCodeWidth().setMillimeters(50);
          *      generator.getParameters().getBarcode().getBarCodeHeight().setInches(1.3);
-         *      generator.save("test.png");
+         *      generator.save("test.png", BarcodeImageFormat.PNG);
          */
         INTERPOLATION: 2,
     };
@@ -4868,7 +4996,7 @@ MacroCharacter =
          * //to generate autoidentified GS1 message like this "(10)123ABC(10)123ABC" in ISO 15434 format you need:
          * let generator = new BarcodeGenerator(EncodeTypes.DATA_MATRIX, "10123ABC\u001D10123ABC");
          * generator.getParameters().getBarcode().getDataMatrix().setMacroCharacters(MacroCharacter.MACRO_05);
-         * let reader = new BarCodeReader(generator.generateBarCodeImage(), DecodeType.GS_1_DATA_MATRIX);
+         * let reader = new BarCodeReader(generator.generateBarCodeImage(BarcodeImageFormat.PNG), DecodeType.GS_1_DATA_MATRIX);
          * reader.readBarCodes().forEach(function(result, i, results)
          * {
          *     cosole.log("BarCode CodeText: " + result.getCodeText());
@@ -5205,6 +5333,182 @@ Pdf417MacroTerminator =
         SET: 2
     }
 
+
+/**
+ * Encoding mode for MaxiCode barcodes.
+ *
+ * @example
+ * //Auto mode
+ * let codetext = "犬Right狗";
+ * let generator = new BarcodeGenerator(EncodeTypes.MAXI_CODE, codetext));
+ * {
+ *     generator.getParameters().getBarcode().getMaxiCode().setECIEncoding(ECIEncodings.UTF8);
+ *     generator.save("test.bmp", BarcodeImageFormat.BMP);
+ * }
+ *
+ * //Bytes mode
+ * let encodedArr = [ 0xFF, 0xFE, 0xFD, 0xFC, 0xFB, 0xFA, 0xF9 ];
+ *
+ * //encode array to string
+ * let strBld = "";
+ * encodedArr.forEach(function(bval, i, bvals)
+ * {
+ *     strBld += bval;
+ * });
+ * let codetext = strBld;
+ *
+ * let generator1 = new BarcodeGenerator(EncodeTypes.MAXI_CODE, codetext))
+ * generator.getParameters().getBarcode().getMaxiCode().setMaxiCodeEncodeMode(MaxiCodeEncodeMode.BYTES);
+ * generator.save("test.bmp", BarcodeImageFormat.BMP);
+ *
+ * //Extended codetext mode
+ * //create codetext
+ * let textBuilder = new MaxiCodeExtCodetextBuilder();
+ * textBuilder.addECICodetext(ECIEncodings.Win1251, "Will");
+ * textBuilder.addECICodetext(ECIEncodings.UTF8, "犬Right狗");
+ * textBuilder.addECICodetext(ECIEncodings.UTF16BE, "犬Power狗");
+ * textBuilder.addPlainCodetext("Plain text");
+ *
+ * // generate codetext
+ * let codetext = textBuilder.getExtendedCodetext();
+ *
+ * //generate
+ * let generator = new BarcodeGenerator(EncodeTypes.MaxiCode, codetext);
+ * generator.getParameters().getBarcode().getMaxiCode().setMaxiCodeEncodeMode(MaxiCodeEncodeMode.EXTENDED_CODETEXT);
+ * generator.getParameters().getBarcode().getMaxiCode().setTwoDDisplayText("My Text");
+ * generator.save("test.bmp", BarcodeImageFormat.BMP);
+ */
+MaxiCodeEncodeMode =
+{
+    
+    /**
+     * Encode codetext with value set in the ECIEncoding property.
+     */
+    AUTO: 0,
+    
+    /**
+     * Encode codetext as plain bytes. If it detects any Unicode character, the character will be encoded as two bytes, lower byte first.
+     */
+    BYTES: 1,
+    
+    /**
+     * Extended mode which supports multi ECI modes.
+     * It is better to use MaxiCodeExtCodetextBuilder for extended codetext generation.
+     * Use Display2DText property to set visible text to removing managing characters.
+     * ECI identifiers are set as single slash and six digits identifier "\000026" - UTF8 ECI identifier
+     * All unicode characters after ECI identifier are automatically encoded into correct character codeset.
+     */
+    EXTENDED_CODETEXT: 2
+}
+
+/**
+ * Encoding mode for MaxiCode barcodes.
+ *
+ * This sample shows how to genereate MaxiCode barcodes using ComplexBarcodeGenerator
+ * @example
+ * //Mode 2 with standart second message
+ * let maxiCodeCodetext = new MaxiCodeCodetextMode2();
+ * maxiCodeCodetext.setPostalCode("524032140");
+ * maxiCodeCodetext.setCountryCode(056);
+ * maxiCodeCodetext.setServiceCategory(999);
+ * let maxiCodeStandartSecondMessage = new MaxiCodeStandartSecondMessage();
+ * maxiCodeStandartSecondMessage.setMessage("Test message");
+ * maxiCodeCodetext.setSecondMessage(maxiCodeStandartSecondMessage);
+ * let complexGenerator = new ComplexBarcodeGenerator(maxiCodeCodetext);
+ * complexGenerator.generateBarCodeImage(BarcodeImageFormat.PNG);
+ *
+ * //Mode 2 with structured second message
+ * let maxiCodeCodetext = new MaxiCodeCodetextMode2();
+ * maxiCodeCodetext.setPostalCode("524032140");
+ * maxiCodeCodetext.setCountryCode(056);
+ * maxiCodeCodetext.setServiceCategory(999);
+ * let maxiCodeStructuredSecondMessage = new MaxiCodeStructuredSecondMessage();
+ * maxiCodeStructuredSecondMessage.add("634 ALPHA DRIVE");
+ * maxiCodeStructuredSecondMessage.add("PITTSBURGH");
+ * maxiCodeStructuredSecondMessage.add("PA");
+ * maxiCodeStructuredSecondMessage.setYear(99);
+ * maxiCodeCodetext.setSecondMessage(maxiCodeStructuredSecondMessage);
+ * let complexGenerator = new ComplexBarcodeGenerator(maxiCodeCodetext);
+ * complexGenerator.generateBarCodeImage(BarcodeImageFormat.PNG);
+ *
+ * //Mode 3 with standart second message
+ * let maxiCodeCodetext = new MaxiCodeCodetextMode3();
+ * maxiCodeCodetext.setPostalCode("B1050");
+ * maxiCodeCodetext.setCountryCode(056);
+ * maxiCodeCodetext.setServiceCategory(999);
+ * let maxiCodeStandartSecondMessage = new MaxiCodeStandartSecondMessage();
+ * maxiCodeStandartSecondMessage.setMessage("Test message");
+ * maxiCodeCodetext.setSecondMessage(maxiCodeStandartSecondMessage);
+ * let complexGenerator = new ComplexBarcodeGenerator(maxiCodeCodetext);
+ * complexGenerator.generateBarCodeImage(BarcodeImageFormat.PNG);
+ *
+ * //Mode 3 with structured second message
+ * let maxiCodeCodetext = new MaxiCodeCodetextMode3();
+ * maxiCodeCodetext.setPostalCode("B1050");
+ * maxiCodeCodetext.setCountryCode(056);
+ * maxiCodeCodetext.setServiceCategory(999);
+ * let maxiCodeStructuredSecondMessage = new MaxiCodeStructuredSecondMessage();
+ * maxiCodeStructuredSecondMessage.add("634 ALPHA DRIVE");
+ * maxiCodeStructuredSecondMessage.add("PITTSBURGH");
+ * maxiCodeStructuredSecondMessage.add("PA");
+ * maxiCodeStructuredSecondMessage.setYear(99);
+ * maxiCodeCodetext.setSecondMessage(maxiCodeStructuredSecondMessage);
+ * let complexGenerator = new ComplexBarcodeGenerator(maxiCodeCodetext.getConstructedCodetext();
+ * complexGenerator.generateBarCodeImage(BarcodeImageFormat.PNG);
+ *
+ * //Mode 4
+ * let maxiCodeCodetext = new MaxiCodeStandardCodetext();
+ * maxiCodeCodetext.setMode(MaxiCodeMode.MODE_4);
+ * maxiCodeCodetext.setMessage("Test message");
+ * let complexGenerator = new ComplexBarcodeGenerator(maxiCodeCodetext.getConstructedCodetext();
+ * complexGenerator.generateBarCodeImage(BarcodeImageFormat.PNG);
+ *
+ * //Mode 5
+ * let maxiCodeCodetext = new MaxiCodeStandardCodetext();
+ * maxiCodeCodetext.setMode(MaxiCodeMode.MODE_5);
+ * maxiCodeCodetext.setMessage("Test message");
+ * let complexGenerator = new ComplexBarcodeGenerator(maxiCodeCodetext.getConstructedCodetext())
+ * complexGenerator.generateBarCodeImage(BarcodeImageFormat.PNG);
+ *
+ * //Mode 6
+ * let maxiCodeCodetext = new MaxiCodeStandardCodetext();
+ * maxiCodeCodetext.setMode(MaxiCodeMode.MODE_6);
+ * maxiCodeCodetext.setMessage("Test message");
+ * let complexGenerator = new ComplexBarcodeGenerator(maxiCodeCodetext.getConstructedCodetext();
+ * complexGenerator.generateBarCodeImage(BarcodeImageFormat.PNG);
+ */
+MaxiCodeMode =
+{
+    
+    /**
+     * Mode 2 encodes postal information in first message and data in second message.
+     * Has 9 digits postal code (used only in USA).
+     */
+    MODE_2: 2,
+    
+    /**
+     * Mode 3 encodes postal information in first message and data in second message.
+     * Has 6 alphanumeric postal code, used in the world.
+     */
+    MODE_3: 3,
+
+    /**
+     *  Mode 4 encodes data in first and second message, with short ECC correction.
+     */
+    MODE_4: 4,
+
+    /**
+     * Mode 5 encodes data in first and second message, with long ECC correction.
+     */
+    MODE_5: 5,
+
+    /**
+     * Mode 6 encodes data in first and second message, with short ECC correction.
+     * Used to encode device.
+     */
+    MODE_6: 6
+}
+
 module.exports = {
     BarcodeGenerator,
     EncodeTypes,
@@ -5263,5 +5567,6 @@ module.exports = {
     EnableChecksum,
     TwoDComponentType,
     GS1CompositeBarParameters,
-    Pdf417MacroTerminator
+    Pdf417MacroTerminator,
+    MaxiCodeExtCodetextBuilder
 };

package/lib/Joint.js

@@ -288,7 +288,7 @@ class Rectangle extends BaseJavaClass
 
     equals(obj)
     {
-        return this.getJavaClass().equals(obj.getJavaClass());
+        return this.getJavaClass().equalsSync(obj.getJavaClass());
     }
 
     /**
@@ -400,7 +400,7 @@ class Point extends BaseJavaClass
 
     equals(obj)
     {
-        return this.getJavaClass().equals(obj.getJavaClass());
+        return this.getJavaClass().equalsSync(obj.getJavaClass());
     }
 }