aboutsummaryrefslogtreecommitdiff
path: root/src/main/java/com/lowagie/text/pdf/BaseField.java
diff options
context:
space:
mode:
Diffstat (limited to 'src/main/java/com/lowagie/text/pdf/BaseField.java')
-rw-r--r--src/main/java/com/lowagie/text/pdf/BaseField.java665
1 files changed, 0 insertions, 665 deletions
diff --git a/src/main/java/com/lowagie/text/pdf/BaseField.java b/src/main/java/com/lowagie/text/pdf/BaseField.java
deleted file mode 100644
index 8817bbd..0000000
--- a/src/main/java/com/lowagie/text/pdf/BaseField.java
+++ /dev/null
@@ -1,665 +0,0 @@
-/*
- * Copyright 2005 by Paulo Soares.
- *
- * 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:
- * http://www.lowagie.com/iText/
- */
-
-package com.lowagie.text.pdf;
-
-import java.awt.Color;
-import com.lowagie.text.Element;
-import com.lowagie.text.DocumentException;
-import com.lowagie.text.Rectangle;
-import java.io.IOException;
-import java.util.ArrayList;
-import java.util.Iterator;
-import java.util.HashMap;
-
-/** Common field variables.
- * @author Paulo Soares (psoares@consiste.pt)
- */
-public abstract class BaseField {
-
- /** A thin border with 1 point width. */
- public static final float BORDER_WIDTH_THIN = 1;
- /** A medium border with 2 point width. */
- public static final float BORDER_WIDTH_MEDIUM = 2;
- /** A thick border with 3 point width. */
- public static final float BORDER_WIDTH_THICK = 3;
- /** The field is visible. */
- public static final int VISIBLE = 0;
- /** The field is hidden. */
- public static final int HIDDEN = 1;
- /** The field is visible but does not print. */
- public static final int VISIBLE_BUT_DOES_NOT_PRINT = 2;
- /** The field is hidden but is printable. */
- public static final int HIDDEN_BUT_PRINTABLE = 3;
- /** The user may not change the value of the field. */
- public static final int READ_ONLY = 1;
- /** The field must have a value at the time it is exported by a submit-form
- * action.
- */
- public static final int REQUIRED = 2;
- /** The field may contain multiple lines of text.
- * This flag is only meaningful with text fields.
- */
- public static final int MULTILINE = 4;
- /** The field will not scroll (horizontally for single-line
- * fields, vertically for multiple-line fields) to accommodate more text
- * than will fit within its annotation rectangle. Once the field is full, no
- * further text will be accepted.
- */
- public static final int DO_NOT_SCROLL = 8;
- /** The field is intended for entering a secure password that should
- * not be echoed visibly to the screen.
- */
- public static final int PASSWORD = 16;
- /** The text entered in the field represents the pathname of
- * a file whose contents are to be submitted as the value of the field.
- */
- public static final int FILE_SELECTION = 32;
- /** The text entered in the field will not be spell-checked.
- * This flag is meaningful only in text fields and in combo
- * fields with the <CODE>EDIT</CODE> flag set.
- */
- public static final int DO_NOT_SPELL_CHECK = 64;
- /** If set the combo box includes an editable text box as well as a drop list; if
- * clear, it includes only a drop list.
- * This flag is only meaningful with combo fields.
- */
- public static final int EDIT = 128;
-
- /**
- * combo box flag.
- */
- public static final int COMB = 256;
-
- protected float borderWidth = BORDER_WIDTH_THIN;
- protected int borderStyle = PdfBorderDictionary.STYLE_SOLID;
- protected Color borderColor;
- protected Color backgroundColor;
- protected Color textColor;
- protected BaseFont font;
- protected float fontSize = 0;
- protected int alignment = Element.ALIGN_LEFT;
- protected PdfWriter writer;
- protected String text;
- protected Rectangle box;
-
- /** Holds value of property rotation. */
- protected int rotation = 0;
-
- /** Holds value of property visibility. */
- protected int visibility;
-
- /** Holds value of property fieldName. */
- protected String fieldName;
-
- /** Holds value of property options. */
- protected int options;
-
- /** Holds value of property maxCharacterLength. */
- protected int maxCharacterLength;
-
- private final static HashMap fieldKeys = new HashMap();
-
- static {
- fieldKeys.putAll(PdfCopyFieldsImp.fieldKeys);
- fieldKeys.put(PdfName.T, new Integer(1));
- }
- /** Creates a new <CODE>TextField</CODE>.
- * @param writer the document <CODE>PdfWriter</CODE>
- * @param box the field location and dimensions
- * @param fieldName the field name. If <CODE>null</CODE> only the widget keys
- * will be included in the field allowing it to be used as a kid field.
- */
- public BaseField(PdfWriter writer, Rectangle box, String fieldName) {
- this.writer = writer;
- this.box = box;
- this.fieldName = fieldName;
- }
-
- protected BaseFont getRealFont() throws IOException, DocumentException {
- if (font == null)
- return BaseFont.createFont(BaseFont.HELVETICA, BaseFont.WINANSI, false);
- else
- return font;
- }
-
- protected PdfAppearance getBorderAppearance() throws IOException, DocumentException {
- PdfAppearance app = new PdfContentByte(writer).createAppearance(box.width(), box.height());
- switch (rotation) {
- case 90:
- app.setMatrix(0, 1, -1, 0, box.height(), 0);
- break;
- case 180:
- app.setMatrix(-1, 0, 0, -1, box.width(), box.height());
- break;
- case 270:
- app.setMatrix(0, -1, 1, 0, 0, box.width());
- break;
- }
- // background
- if (backgroundColor != null) {
- app.setColorFill(backgroundColor);
- app.rectangle(0, 0, box.width(), box.height());
- app.fill();
- }
- // border
- if (borderStyle == PdfBorderDictionary.STYLE_UNDERLINE) {
- if (borderWidth != 0 && borderColor != null) {
- app.setColorStroke(borderColor);
- app.setLineWidth(borderWidth);
- app.moveTo(0, borderWidth / 2);
- app.lineTo(box.width(), borderWidth / 2);
- app.stroke();
- }
- }
- else if (borderStyle == PdfBorderDictionary.STYLE_BEVELED) {
- if (borderWidth != 0 && borderColor != null) {
- app.setColorStroke(borderColor);
- app.setLineWidth(borderWidth);
- app.rectangle(borderWidth / 2, borderWidth / 2, box.width() - borderWidth, box.height() - borderWidth);
- app.stroke();
- }
- // beveled
- Color actual = backgroundColor;
- if (actual == null)
- actual = Color.white;
- app.setGrayFill(1);
- drawTopFrame(app);
- app.setColorFill(actual.darker());
- drawBottomFrame(app);
- }
- else if (borderStyle == PdfBorderDictionary.STYLE_INSET) {
- if (borderWidth != 0 && borderColor != null) {
- app.setColorStroke(borderColor);
- app.setLineWidth(borderWidth);
- app.rectangle(borderWidth / 2, borderWidth / 2, box.width() - borderWidth, box.height() - borderWidth);
- app.stroke();
- }
- // inset
- app.setGrayFill(0.5f);
- drawTopFrame(app);
- app.setGrayFill(0.75f);
- drawBottomFrame(app);
- }
- else {
- if (borderWidth != 0 && borderColor != null) {
- if (borderStyle == PdfBorderDictionary.STYLE_DASHED)
- app.setLineDash(3, 0);
- app.setColorStroke(borderColor);
- app.setLineWidth(borderWidth);
- app.rectangle(borderWidth / 2, borderWidth / 2, box.width() - borderWidth, box.height() - borderWidth);
- app.stroke();
- if ((options & COMB) != 0 && maxCharacterLength > 1) {
- float step = box.width() / maxCharacterLength;
- float yb = borderWidth / 2;
- float yt = box.height() - borderWidth / 2;
- for (int k = 1; k < maxCharacterLength; ++k) {
- float x = step * k;
- app.moveTo(x, yb);
- app.lineTo(x, yt);
- }
- app.stroke();
- }
- }
- }
- return app;
- }
-
- protected static ArrayList getHardBreaks(String text) {
- ArrayList arr = new ArrayList();
- char cs[] = text.toCharArray();
- int len = cs.length;
- StringBuffer buf = new StringBuffer();
- for (int k = 0; k < len; ++k) {
- char c = cs[k];
- if (c == '\r') {
- if (k + 1 < len && cs[k + 1] == '\n')
- ++k;
- arr.add(buf.toString());
- buf = new StringBuffer();
- }
- else if (c == '\n') {
- arr.add(buf.toString());
- buf = new StringBuffer();
- }
- else
- buf.append(c);
- }
- arr.add(buf.toString());
- return arr;
- }
-
- protected static void trimRight(StringBuffer buf) {
- int len = buf.length();
- while (true) {
- if (len == 0)
- return;
- if (buf.charAt(--len) != ' ')
- return;
- buf.setLength(len);
- }
- }
-
- protected static ArrayList breakLines(ArrayList breaks, BaseFont font, float fontSize, float width) {
- ArrayList lines = new ArrayList();
- StringBuffer buf = new StringBuffer();
- for (int ck = 0; ck < breaks.size(); ++ck) {
- buf.setLength(0);
- float w = 0;
- char cs[] = ((String)breaks.get(ck)).toCharArray();
- int len = cs.length;
- // 0 inline first, 1 inline, 2 spaces
- int state = 0;
- int lastspace = -1;
- char c = 0;
- int refk = 0;
- for (int k = 0; k < len; ++k) {
- c = cs[k];
- switch (state) {
- case 0:
- w += font.getWidthPoint(c, fontSize);
- buf.append(c);
- if (w > width) {
- w = 0;
- if (buf.length() > 1) {
- --k;
- buf.setLength(buf.length() - 1);
- }
- lines.add(buf.toString());
- buf.setLength(0);
- refk = k;
- if (c == ' ')
- state = 2;
- else
- state = 1;
- }
- else {
- if (c != ' ')
- state = 1;
- }
- break;
- case 1:
- w += font.getWidthPoint(c, fontSize);
- buf.append(c);
- if (c == ' ')
- lastspace = k;
- if (w > width) {
- w = 0;
- if (lastspace >= 0) {
- k = lastspace;
- buf.setLength(lastspace - refk);
- trimRight(buf);
- lines.add(buf.toString());
- buf.setLength(0);
- refk = k;
- lastspace = -1;
- state = 2;
- }
- else {
- if (buf.length() > 1) {
- --k;
- buf.setLength(buf.length() - 1);
- }
- lines.add(buf.toString());
- buf.setLength(0);
- refk = k;
- if (c == ' ')
- state = 2;
- }
- }
- break;
- case 2:
- if (c != ' ') {
- w = 0;
- --k;
- state = 1;
- }
- break;
- }
- }
- trimRight(buf);
- lines.add(buf.toString());
- }
- return lines;
- }
-
- private void drawTopFrame(PdfAppearance app) {
- app.moveTo(borderWidth, borderWidth);
- app.lineTo(borderWidth, box.height() - borderWidth);
- app.lineTo(box.width() - borderWidth, box.height() - borderWidth);
- app.lineTo(box.width() - 2 * borderWidth, box.height() - 2 * borderWidth);
- app.lineTo(2 * borderWidth, box.height() - 2 * borderWidth);
- app.lineTo(2 * borderWidth, 2 * borderWidth);
- app.lineTo(borderWidth, borderWidth);
- app.fill();
- }
-
- private void drawBottomFrame(PdfAppearance app) {
- app.moveTo(borderWidth, borderWidth);
- app.lineTo(box.width() - borderWidth, borderWidth);
- app.lineTo(box.width() - borderWidth, box.height() - borderWidth);
- app.lineTo(box.width() - 2 * borderWidth, box.height() - 2 * borderWidth);
- app.lineTo(box.width() - 2 * borderWidth, 2 * borderWidth);
- app.lineTo(2 * borderWidth, 2 * borderWidth);
- app.lineTo(borderWidth, borderWidth);
- app.fill();
- }
- /** Gets the border width in points.
- * @return the border width in points
- */
- public float getBorderWidth() {
- return this.borderWidth;
- }
-
- /** Sets the border width in points. To eliminate the border
- * set the border color to <CODE>null</CODE>.
- * @param borderWidth the border width in points
- */
- public void setBorderWidth(float borderWidth) {
- this.borderWidth = borderWidth;
- }
-
- /** Gets the border style.
- * @return the border style
- */
- public int getBorderStyle() {
- return this.borderStyle;
- }
-
- /** Sets the border style. The styles are found in <CODE>PdfBorderDictionary</CODE>
- * and can be <CODE>STYLE_SOLID</CODE>, <CODE>STYLE_DASHED</CODE>,
- * <CODE>STYLE_BEVELED</CODE>, <CODE>STYLE_INSET</CODE> and
- * <CODE>STYLE_UNDERLINE</CODE>.
- * @param borderStyle the border style
- */
- public void setBorderStyle(int borderStyle) {
- this.borderStyle = borderStyle;
- }
-
- /** Gets the border color.
- * @return the border color
- */
- public Color getBorderColor() {
- return this.borderColor;
- }
-
- /** Sets the border color. Set to <CODE>null</CODE> to remove
- * the border.
- * @param borderColor the border color
- */
- public void setBorderColor(Color borderColor) {
- this.borderColor = borderColor;
- }
-
- /** Gets the background color.
- * @return the background color
- */
- public Color getBackgroundColor() {
- return this.backgroundColor;
- }
-
- /** Sets the background color. Set to <CODE>null</CODE> for
- * transparent background.
- * @param backgroundColor the background color
- */
- public void setBackgroundColor(Color backgroundColor) {
- this.backgroundColor = backgroundColor;
- }
-
- /** Gets the text color.
- * @return the text color
- */
- public Color getTextColor() {
- return this.textColor;
- }
-
- /** Sets the text color. If <CODE>null</CODE> the color used
- * will be black.
- * @param textColor the text color
- */
- public void setTextColor(Color textColor) {
- this.textColor = textColor;
- }
-
- /** Gets the text font.
- * @return the text font
- */
- public BaseFont getFont() {
- return this.font;
- }
-
- /** Sets the text font. If <CODE>null</CODE> then Helvetica
- * will be used.
- * @param font the text font
- */
- public void setFont(BaseFont font) {
- this.font = font;
- }
-
- /** Gets the font size.
- * @return the font size
- */
- public float getFontSize() {
- return this.fontSize;
- }
-
- /** Sets the font size. If 0 then auto-sizing will be used but
- * only for text fields.
- * @param fontSize the font size
- */
- public void setFontSize(float fontSize) {
- this.fontSize = fontSize;
- }
-
- /** Gets the text horizontal alignment.
- * @return the text horizontal alignment
- */
- public int getAlignment() {
- return this.alignment;
- }
-
- /** Sets the text horizontal alignment. It can be <CODE>Element.ALIGN_LEFT</CODE>,
- * <CODE>Element.ALIGN_CENTER</CODE> and <CODE>Element.ALIGN_RIGHT</CODE>.
- * @param alignment the text horizontal alignment
- */
- public void setAlignment(int alignment) {
- this.alignment = alignment;
- }
-
- /** Gets the text.
- * @return the text
- */
- public String getText() {
- return this.text;
- }
-
- /** Sets the text for text fields.
- * @param text the text
- */
- public void setText(String text) {
- this.text = text;
- }
-
- /** Gets the field dimension and position.
- * @return the field dimension and position
- */
- public Rectangle getBox() {
- return this.box;
- }
-
- /** Sets the field dimension and position.
- * @param box the field dimension and position
- */
- public void setBox(Rectangle box) {
- this.box = box;
- }
-
- /** Gets the field rotation.
- * @return the field rotation
- */
- public int getRotation() {
- return this.rotation;
- }
-
- /** Sets the field rotation. This value should be the same as
- * the page rotation where the field will be shown.
- * @param rotation the field rotation
- */
- public void setRotation(int rotation) {
- if (rotation % 90 != 0)
- throw new IllegalArgumentException("Rotation must be a multiple of 90.");
- rotation %= 360;
- if (rotation < 0)
- rotation += 360;
- this.rotation = rotation;
- }
-
- /** Convenience method to set the field rotation the same as the
- * page rotation.
- * @param page the page
- */
- public void setRotationFromPage(Rectangle page) {
- setRotation(page.getRotation());
- }
-
- /** Gets the field visibility flag.
- * @return the field visibility flag
- */
- public int getVisibility() {
- return this.visibility;
- }
-
- /** Sets the field visibility flag. This flags can be one of
- * <CODE>VISIBLE</CODE>, <CODE>HIDDEN</CODE>, <CODE>VISIBLE_BUT_DOES_NOT_PRINT</CODE>
- * and <CODE>HIDDEN_BUT_PRINTABLE</CODE>.
- * @param visibility field visibility flag
- */
- public void setVisibility(int visibility) {
- this.visibility = visibility;
- }
-
- /** Gets the field name.
- * @return the field name
- */
- public String getFieldName() {
- return this.fieldName;
- }
-
- /** Sets the field name.
- * @param fieldName the field name. If <CODE>null</CODE> only the widget keys
- * will be included in the field allowing it to be used as a kid field.
- */
- public void setFieldName(String fieldName) {
- this.fieldName = fieldName;
- }
-
- /** Gets the option flags.
- * @return the option flags
- */
- public int getOptions() {
- return this.options;
- }
-
- /** Sets the option flags. The option flags can be a combination by oring of
- * <CODE>READ_ONLY</CODE>, <CODE>REQUIRED</CODE>,
- * <CODE>MULTILINE</CODE>, <CODE>DO_NOT_SCROLL</CODE>,
- * <CODE>PASSWORD</CODE>, <CODE>FILE_SELECTION</CODE>,
- * <CODE>DO_NOT_SPELL_CHECK</CODE> and <CODE>EDIT</CODE>.
- * @param options the option flags
- */
- public void setOptions(int options) {
- this.options = options;
- }
-
- /** Gets the maximum length of the field’s text, in characters.
- * @return the maximum length of the field’s text, in characters.
- */
- public int getMaxCharacterLength() {
- return this.maxCharacterLength;
- }
-
- /** Sets the maximum length of the field’s text, in characters.
- * It is only meaningful for text fields.
- * @param maxCharacterLength the maximum length of the field’s text, in characters
- */
- public void setMaxCharacterLength(int maxCharacterLength) {
- this.maxCharacterLength = maxCharacterLength;
- }
-
- /**
- * Getter for property writer.
- * @return Value of property writer.
- */
- public PdfWriter getWriter() {
- return writer;
- }
-
- /**
- * Setter for property writer.
- * @param writer New value of property writer.
- */
- public void setWriter(PdfWriter writer) {
- this.writer = writer;
- }
-
- /**
- * Moves the field keys from <CODE>from</CODE> to <CODE>to</CODE>. The moved keys
- * are removed from <CODE>from</CODE>.
- * @param from the source
- * @param to the destination. It may be <CODE>null</CODE>
- */
- public static void moveFields(PdfDictionary from, PdfDictionary to) {
- for (Iterator i = from.getKeys().iterator(); i.hasNext();) {
- PdfName key = (PdfName)i.next();
- if (fieldKeys.containsKey(key)) {
- if (to != null)
- to.put(key, from.get(key));
- i.remove();
- }
- }
- }
-} \ No newline at end of file