You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pdfbox.apache.org by ms...@apache.org on 2014/10/19 23:54:34 UTC
svn commit: r1633010 - in
/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox:
pdmodel/interactive/form/PDField.java
pdmodel/interactive/form/PDTextField.java util/appearance/
util/appearance/AppearanceGenerator.java
Author: msahyoun
Date: Sun Oct 19 21:54:33 2014
New Revision: 1633010
URL: http://svn.apache.org/r1633010
Log:
PDFBOX-2333 enable appearance generation
Added:
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/util/appearance/
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/util/appearance/AppearanceGenerator.java (with props)
Modified:
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDField.java
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDTextField.java
Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDField.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDField.java?rev=1633010&r1=1633009&r2=1633010&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDField.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDField.java Sun Oct 19 21:54:33 2014
@@ -20,6 +20,7 @@ import org.apache.pdfbox.cos.COSDictiona
import org.apache.pdfbox.cos.COSInteger;
import org.apache.pdfbox.cos.COSName;
import org.apache.pdfbox.pdmodel.interactive.action.PDFormFieldAdditionalActions;
+import org.apache.pdfbox.util.appearance.AppearanceGenerator;
/**
* A field in an interactive form.
@@ -121,6 +122,12 @@ public abstract class PDField extends PD
}
return fieldType;
}
+
+ protected void updateFieldAppearances() {
+ if (!getAcroForm().isNeedAppearances()) {
+ AppearanceGenerator.generateFieldAppearances(this);
+ }
+ }
}
Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDTextField.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDTextField.java?rev=1633010&r1=1633009&r2=1633010&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDTextField.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/form/PDTextField.java Sun Oct 19 21:54:33 2014
@@ -93,7 +93,8 @@ public final class PDTextField extends P
{
getDictionary().removeItem(COSName.V);
}
- // TODO create/update appearance
+
+ updateFieldAppearances();
}
/**
Added: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/util/appearance/AppearanceGenerator.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/util/appearance/AppearanceGenerator.java?rev=1633010&view=auto
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/util/appearance/AppearanceGenerator.java (added)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/util/appearance/AppearanceGenerator.java Sun Oct 19 21:54:33 2014
@@ -0,0 +1,74 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (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.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.pdfbox.util.appearance;
+
+import java.io.IOException;
+
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
+import org.apache.pdfbox.pdmodel.interactive.form.PDAppearanceString;
+import org.apache.pdfbox.pdmodel.interactive.form.PDField;
+import org.apache.pdfbox.pdmodel.interactive.form.PDVariableText;
+
+/**
+ * (Re-) Generate the appearance for a field.
+ *
+ * The fields appearance defines the 'look' the field has when it's rendered
+ * for display or printing.
+ *
+ */
+
+public class AppearanceGenerator {
+
+ private static final Log LOG = LogFactory.getLog(AppearanceGenerator.class);
+
+ private AppearanceGenerator() {
+ }
+
+
+ /**
+ * Generate the appearances for a single field.
+ *
+ * @param field The field which appearances need to be generated.
+ */
+ public static void generateFieldAppearances(PDField field) {
+ // TODO: handle appearance generation for other field types
+ if (field instanceof PDVariableText) {
+
+ PDAppearanceString pdAppearance = new PDAppearanceString(field.getAcroForm(), (PDVariableText) field);
+
+ Object fieldValue = field.getValue();
+
+ // in case there is no value being set generate the visual
+ // appearance with an empty String
+ if (fieldValue == null) {
+ fieldValue = "";
+ }
+
+ // TODO: implement the handling for additional values.
+ if (fieldValue instanceof String) {
+ try {
+ pdAppearance.setAppearanceValue((String) fieldValue);
+ } catch (IOException e) {
+ LOG.error("Unable to generate the field appearance.", e);
+ }
+ } else {
+ LOG.warn("Can't generate the appearance for values typed " + fieldValue.getClass().getName() + ".");
+ }
+ }
+ }
+}
Propchange: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/util/appearance/AppearanceGenerator.java
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/util/appearance/AppearanceGenerator.java
------------------------------------------------------------------------------
svn:mime-type = text/plain