com.itextpdf.forms.xfdf.BorderStyleAltObject Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of forms-android Show documentation
There is a newer version: 8.0.5
/*
    This file is part of the iText (R) project.
    Copyright (c) 1998-2024 Apryse Group NV
    Authors: Apryse Software.

    This program is offered under a commercial and under the AGPL license.
    For commercial licensing, contact us at https://itextpdf.com/sales.  For AGPL licensing, see below.

    AGPL licensing:
    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU Affero General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Affero General Public License for more details.

    You should have received a copy of the GNU Affero General Public License
    along with this program.  If not, see .
 */
package com.itextpdf.forms.xfdf;


/**
 * Represents the BorderStyleAlt element, a child of the link element.
 * Corresponds to the Border key in the common annotation dictionary.
 * Content model: border style encoded in the format specified in the border style attributes.
 * Required attributes: HCornerRadius, VCornerRadius, Width.
 * Optional attributes: DashPattern.
 * For more details see paragraph 6.5.3 in Xfdf document specification.
 * For more details about attributes see paragraph 6.6.19 in Xfdf document specification.
 */
public class BorderStyleAltObject {

    /**
     * Number specifying the horizontal corner radius of the rectangular border.
     * Corresponds to array index 0 in the Border key in the common annotation dictionary.
     */
    private float hCornerRadius;

    /**
     * Number specifying the vertical corner radius of the rectangular border.
     * Corresponds to array index 1 in the Border key in the common annotation dictionary.
     */
    private float vCornerRadius;

    /**
     * Number specifying the width of the rectangular border.
     * Corresponds to array index 2 in the Border key in the common annotation dictionary.
     */
    private float width;

    /**
     * An array of numbers specifying the pattern of dashes and gaps of the border.
     * Corresponds to array index 3 in the Border key in the common annotation dictionary.
     */
    private float[] dashPattern;

    /**
     * Encoded border style string.
     */
    private String content;

    /**
     * Creates an instance that encapsulates BorderStyleAlt XFDF element data.
     *
     * @param hCornerRadius a float value specifying the horizontal corner radius of the rectangular border.
     * @param vCornerRadius a float value specifying the vertical corner radius of the rectangular border.
     * @param width         a float value specifying the width of the rectangular border.
     */
    public BorderStyleAltObject(float hCornerRadius, float vCornerRadius, float width) {
        this.hCornerRadius = hCornerRadius;
        this.vCornerRadius = vCornerRadius;
        this.width = width;
    }

    /**
     * Gets the horizontal corner radius of the rectangular border.
     * Corresponds to array index 0 in the Border key in the common annotation dictionary.
     *
     * @return a float value specifying the horizontal corner radius.
     */
    public float getHCornerRadius() {
        return hCornerRadius;
    }

    /**
     * Gets the vertical corner radius of the rectangular border.
     * Corresponds to array index 1 in the Border key in the common annotation dictionary.
     *
     * @return a float value specifying the vertical corner radius.
     */
    public float getVCornerRadius() {
        return vCornerRadius;
    }

    /**
     * Gets the width of the rectangular border.
     * Corresponds to array index 2 in the Border key in the common annotation dictionary.
     *
     * @return a float value specifying the width of the border.
     */
    public float getWidth() {
        return width;
    }

    /**
     * Gets the dash pattern of the border.
     * Corresponds to array index 3 in the Border key in the common annotation dictionary.
     *
     * @return an array of numbers specifying the pattern of dashes and gaps of the border.
     */
    public float[] getDashPattern() {
        return dashPattern;
    }

    /**
     * Sets the dash pattern of the border.
     * Corresponds to array index 3 in the Border key in the common annotation dictionary.
     *
     * @param dashPattern an array of numbers specifying the pattern of dashes and gaps of the border.
     * @return this {@link BorderStyleAltObject} instance.
     */
    public BorderStyleAltObject setDashPattern(float[] dashPattern) {
        this.dashPattern = dashPattern;
        return this;
    }

    /**
     * Gets border style.
     *
     * @return an encoded border style as string.
     */
    public String getContent() {
        return content;
    }

    /**
     * Sets border style.
     *
     * @param content an encoded border style as string.
     * @return this {@link BorderStyleAltObject} instance.
     */
    public BorderStyleAltObject setContent(String content) {
        this.content = content;
        return this;
    }
}