com.dynamicpdf.api.elements.MsiBarcodeElement Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dynamicpdf-api Show documentation

A Java Client API that uses the DynamicPDF API to create, merge, split, form fill, stamp, secure/encrypt PDF documents.

There is a newer version: 1.10.1

package com.dynamicpdf.api.elements;

import com.dynamicpdf.api.FloatJsonSerializer;
import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility;
import com.fasterxml.jackson.annotation.JsonInclude.Include;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;

/**
 *  Represents a MSI Barcode element (also known as Modified Plessey).
 */
@JsonInclude(Include.NON_DEFAULT)
@JsonAutoDetect(fieldVisibility = Visibility.NON_PRIVATE)
public class MsiBarcodeElement extends TextBarcodeElement {

	private MsiBarcodeCheckDigitMode appendCheckDigit = null;
	private float height;

	/**
	 * Initializes a new instance of the MsiBarcodeElement class
	 * 
	 * @param value The value of the barcode.
	 * @param placement The placement of the barcode on the page.
	 * @param height The height of the barcode.
	 * @param xOffset The X coordinate of the barcode.
	 * @param yOffset The Y coordinate of the barcode.
	 */
	public MsiBarcodeElement(String value, ElementPlacement placement, float height, float xOffset, float yOffset) {
		super(value, placement, xOffset, yOffset);
		this.height = height;
	}
	
	/**
	 * Initializes a new instance of the MsiBarcodeElement class
	 * 
	 * @param value The value of the barcode.
	 * @param height The height of the barcode.
	 * @param xOffset The X coordinate of the barcode.
	 * @param yOffset The Y coordinate of the barcode.
	 */
	public MsiBarcodeElement(String value, float height, float xOffset, float yOffset) {
		super(value, ElementPlacement.TOPLEFT, xOffset, yOffset);
		this.height = height;
	}

	/**
	 * Initializes a new instance of the MsiBarcodeElement class
	 * 
	 * @param value The value of the barcode.
	 * @param placement The placement of the barcode on the page.
	 * @param height The height of the barcode.
	 */
	public MsiBarcodeElement(String value, ElementPlacement placement, float height) {
		this(value, placement, height, 0, 0);
	}
	
	/**
	 * Initializes a new instance of the MsiBarcodeElement class
	 * 
	 * @param value The value of the barcode.
	 * @param height The height of the barcode.
	 */
	public MsiBarcodeElement(String value, float height) {
		this(value, ElementPlacement.TOPLEFT, height, 0, 0);
	}

	@JsonProperty("type")
	ElementType getType() {
		return ElementType.MSIBARCODE;
	}

	/**
	 * Gets a value specifying if the check digit should calculated.
	 * @return A value specifying if the check digit should calculated.
	 */
	public MsiBarcodeCheckDigitMode getAppendCheckDigit() {
		return appendCheckDigit;
	}

	/**
	 * Sets a value specifying if the check digit should calculated.
	 * @param value A value specifying if the check digit should calculated.
	 */
	public void setAppendCheckDigit(MsiBarcodeCheckDigitMode value) {
		appendCheckDigit = value;
	}

	/**
	 * Gets the height of the barcode.
	 * @return The height of the barcode.
	 */
	@JsonSerialize(using = FloatJsonSerializer.class)
	public float getHeight() {
		return height;
	}

	/**
	 * Sets the height of the barcode.
	 * @param value The height of the barcode.
	 */
	public void setHeight(float value) {
		height = value;
	}

}