com.lowagie.text.pdf.PdfBorderDictionary Maven / Gradle / Ivy
/*
* $Id: PdfBorderDictionary.java 4065 2009-09-16 23:09:11Z psoares33 $
* $Name$
*
* Copyright 1999, 2000, 2001, 2002 Bruno Lowagie
*
* The contents of this file are subject to the Mozilla Public License Version 1.1
* (the "License"); you may not use this file except in compliance with the License.
* You may obtain a copy of the License at http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the License.
*
* The Original Code is 'iText, a free JAVA-PDF library'.
*
* The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
* the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
* All Rights Reserved.
* Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
* are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
*
* Contributor(s): all the names of the contributors are added in the source code
* where applicable.
*
* Alternatively, the contents of this file may be used under the terms of the
* LGPL license (the "GNU LIBRARY GENERAL PUBLIC LICENSE"), in which case the
* provisions of LGPL are applicable instead of those above. If you wish to
* allow use of your version of this file only under the terms of the LGPL
* License and not to allow others to use your version of this file under
* the MPL, indicate your decision by deleting the provisions above and
* replace them with the notice and other provisions required by the LGPL.
* If you do not delete the provisions above, a recipient may use your version
* of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
*
* This library is free software; you can redistribute it and/or modify it
* under the terms of the MPL as stated above or under the terms of the GNU
* Library General Public License as published by the Free Software Foundation;
* either version 2 of the License, or any later version.
*
* This library 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 Library general Public License for more
* details.
*
* If you didn't download this code from the following link, you should check if
* you aren't using an obsolete version:
* https://github.com/LibrePDF/OpenPDF
*/
package com.lowagie.text.pdf;
import com.lowagie.text.error_messages.MessageLocalization;
/**
* A PdfBorderDictionary define the appearance of a Border (Annotations).
*
* @see PdfDictionary
*/
public class PdfBorderDictionary extends PdfDictionary {
public static final int STYLE_SOLID = 0;
public static final int STYLE_DASHED = 1;
public static final int STYLE_BEVELED = 2;
public static final int STYLE_INSET = 3;
public static final int STYLE_UNDERLINE = 4;
// constructors
/**
* Constructs a PdfBorderDictionary.
* @param borderStyle the border style
* @param borderWidth the width of the border
* @param dashes the pattern of the border
*/
public PdfBorderDictionary(float borderWidth, int borderStyle, PdfDashPattern dashes) {
put(PdfName.W, new PdfNumber(borderWidth));
switch (borderStyle) {
case STYLE_SOLID:
put(PdfName.S, PdfName.S);
break;
case STYLE_DASHED:
if (dashes != null)
put(PdfName.D, dashes);
put(PdfName.S, PdfName.D);
break;
case STYLE_BEVELED:
put(PdfName.S, PdfName.B);
break;
case STYLE_INSET:
put(PdfName.S, PdfName.I);
break;
case STYLE_UNDERLINE:
put(PdfName.S, PdfName.U);
break;
default:
throw new IllegalArgumentException(MessageLocalization.getComposedMessage("invalid.border.style"));
}
}
public PdfBorderDictionary(float borderWidth, int borderStyle) {
this(borderWidth, borderStyle, null);
}
}