com.dynamicpdf.api.elements.RectangleElement 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.Color;
import com.dynamicpdf.api.LineStyle;
import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.JsonIgnore;
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;

/**
 * Represents a rectangle page element.
 * 
 * This class can be used to place rectangles of any size or color on a page.
 */
@JsonInclude(Include.NON_DEFAULT)
@JsonAutoDetect(fieldVisibility = Visibility.NON_PRIVATE)
public class RectangleElement extends Element {

	private Color fillColor;
	private Color borderColor;
	private LineStyle borderStyle;
	private float width;
	private float height;
	private float borderWidth;
	private float cornerRadius;
	private String fillColorName;
	private String borderColorName;

	private String borderStyleName;

	/**
	 * Initializes a new instance of the RectangleElement class.
	 * 
	 * @param placement The placement of the rectangle on the page.
	 * @param width Width of the rectangle.
	 * @param height Height of the rectangle.
	 */
	public RectangleElement(ElementPlacement placement, float width, float height) {
		setPlacement(placement);
		this.width = width;
		this.height = height;
	}

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

	/**
	 * Gets the width of the rectangle.
	 * @return The width of the rectangle.
	 */
	public float getWidth() {
		return width;
	}

	/**
	 * Sets the width of the rectangle.
	 * @param value The width of the rectangle.
	 */
	public void setWidth(float value) {
		width = value;
	}

	/**
	 * Gets the height of the rectangle.
	 * @return The height of the rectangle.
	 */
	public float getHeight() {
		return height;
	}

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

	/**
	 * Gets the border width of the rectangle.
	 * To force the borders not to appear set the border width to any value 0 or less.
	 * @return The border width of the rectangle.
	 */
	public float getBorderWidth() {
		return borderWidth;
	}

	/**
	 * Sets the border width of the rectangle.
	 * To force the borders not to appear set the border width to any value 0 or less.
	 * @param value The border width of the rectangle.
	 */
	public void setBorderWidth(float value) {
		borderWidth = value;
	}

	/**
	 * Gets the corner radius of the rectangle.
	 * @return The corner radius of the rectangle.
	 */
	public float getCornerRadius() {
		return cornerRadius;
	}

	/**
	 * Sets the corner radius of the rectangle.
	 * @param value The corner radius of the rectangle.
	 */
	public void setCornerRadius(float value) {
		cornerRadius = value;
	}

	@JsonProperty("fillColor")
	String getFillColorName() {
		return fillColorName;
	}

	void setFillColorName(String value) {
		fillColorName = value;
	}

	@JsonProperty("borderColor")
	String getBorderColorName() {
		return borderColorName;
	}

	void setBorderColorName(String value) {
		borderColorName = value;
	}

	@JsonProperty("borderStyle")
	String getBorderStyleName() {
		return borderStyleName;
	}

	void setBorderStyleName(String value) {
		borderStyleName = value;
	}

	/**
	 * Gets the Colorobject to use for the fill of the rectangle.
	 *
	 * To force no color to appear in the rectangle (only borders) set the fill color to null (Nothing in Visual Basic).
	 * @return The Colorobject to use for the fill of the rectangle.
	 */
	@JsonIgnore
	public Color getFillColor() {
		return fillColor;
	}

	/**
	 * Sets the Colorobject to use for the fill of the rectangle.
	 *
	 * To force no color to appear in the rectangle (only borders) set the fill color to null (Nothing in Visual Basic).
	 * @param value The Colorobject to use for the fill of the rectangle.
	 */
	public void setFillColor(Color value) {
		fillColor = value;
		fillColorName = fillColor.getColorString();
	}

	/**
	 * Gets the Colorobject to use for the border of the rectangle.
	 * @return The Colorobject to use for the border of the rectangle.
	 */
	@JsonIgnore
	public Color getBorderColor() {
		return borderColor;
	}

	/**
	 * Sets the Colorobject to use for the border of the rectangle.
	 * @param value The Colorobject to use for the border of the rectangle.
	 */
	public void setBorderColor(Color value) {
		borderColor = value;
		borderColorName = borderColor.getColorString();
	}

	/**
	 * Gets the LineStyle object used to specify the border style of the rectangle.
	 * @return The LineStyle object used to specify the border style of the rectangle.
	 */
	@JsonIgnore
	public LineStyle getBorderStyle() {
		return borderStyle;
	}

	/**
	 * Sets the LineStyle object used to specify the border style of the rectangle.
	 * @param value The LineStyle object used to specify the border style of the rectangle.
	 */
	public void setBorderStyle(LineStyle value) {
		borderStyle = value;
		borderStyleName = borderStyle.getLineStyleString();
	}
}