org.jpedal.objects.raw.FormObject Maven / Gradle / Ivy
The newest version!
/*
* ===========================================
* Java Pdf Extraction Decoding Access Library
* ===========================================
*
* Project Info: http://www.idrsolutions.com
* Help section for developers at http://www.idrsolutions.com/java-pdf-library-support/
*
* (C) Copyright 1997-2013, IDRsolutions and Contributors.
*
* This file is part of JPedal
*
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) 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
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* ---------------
* FormObject.java
* ---------------
*/
package org.jpedal.objects.raw;
import java.awt.Color;
import java.awt.Font;
import java.awt.Rectangle;
import java.awt.image.BufferedImage;
import java.util.HashMap;
import java.util.Map;
import java.util.StringTokenizer;
import javax.swing.SwingConstants;
import javax.swing.SwingUtilities;
import javax.swing.text.JTextComponent;
import org.jpedal.color.DeviceCMYKColorSpace;
import org.jpedal.objects.acroforms.actions.ActionHandler;
import org.jpedal.objects.acroforms.formData.ComponentData;
import org.jpedal.utils.LogWriter;
import org.jpedal.utils.ObjectCloneFactory;
import org.jpedal.utils.StringUtils;
//
//
public class FormObject extends PdfObject {
String nameUsed = "";
private boolean tested = false;
private int formType = -1;
Object guiComp = null;
int guiType = -1;
// rotation on page
private int rawRotation = 0;
// show if a kid (which is linked to other objects
private boolean isKid = false;
// unknown CMAP as String
private String EOPROPtype, Filter = null, Location = null, M, Reason, SubFilter;
private byte[] rawEOPROPtype, rawFilter, rawLocation, rawM, rawReason, rawSubFilter;
/**
* the C color for annotations
*/
private Color cColor;
/**
* the contents for any text display on the annotation
*/
private String contents;
/**
* whether the annotation is being displayed or not by default
*/
private boolean show = false;
private Map OptValues = null; // values from Opt
private boolean popupBuilt = false;
private Object popupObj;
/** 1 form flag indexes for the field flags */
public static final int READONLY_ID = 1;
/** 2 form flag indexes for the field flags */
public static final int REQUIRED_ID = 2;
/** 3 form flag indexes for the field flags */
public static final int NOEXPORT_ID = 3;
/** 13 form flag indexes for the field flags */
public static final int MULTILINE_ID = 13;
/** 14 form flag indexes for the field flags */
public static final int PASSWORD_ID = 14;
/** 15 form flag indexes for the field flags */
public static final int NOTOGGLETOOFF_ID = 15;
/** 16 form flag indexes for the field flags */
public static final int RADIO_ID = 16;
/** 17 form flag indexes for the field flags */
public static final int PUSHBUTTON_ID = 17;
/** 18 form flag indexes for the field flags */
public static final int COMBO_ID = 18;
/** 19 form flag indexes for the field flags */
public static final int EDIT_ID = 19;
/** 20 form flag indexes for the field flags */
public static final int SORT_ID = 20;
/** 21 form flag indexes for the field flags */
public static final int FILESELECT_ID = 21;
/** 22 form flag indexes for the field flags */
public static final int MULTISELECT_ID = 22;
/** 23 form flag indexes for the field flags */
public static final int DONOTSPELLCHECK_ID = 23;
/** 24 form flag indexes for the field flags */
public static final int DONOTSCROLL_ID = 24;
/** 25 form flag indexes for the field flags */
public static final int COMB_ID = 25;
/** 26 form flag indexes for the field flags */
public static final int RICHTEXT_ID = 26;// same as RADIOINUNISON_ID (radio buttons)
/** 26 form flag indexes for the field flags */
public static final int RADIOINUNISON_ID = 26;// same as RICHTEXT_ID (text fields)
/** 27 form flag indexes for the field flags */
public static final int COMMITONSELCHANGE_ID = 27;
/*
* variables for forms to check with the (Ff) flags field (1<
* 2=required - if set the field must have a value when submit-form-action occures
* 3=noexport - if set the field must not be exported by a submit-form-action
*
* Choice fields
* 18=combo - set its a combobox, else a list box
* 19=edit - defines a comboBox to be editable
* 20=sort - defines list to be sorted alphabetically
* 22=multiselect - if set more than one items can be selected, else only one
* 23=donotspellcheck - (only used on editable combobox) don't spell check
* 27=commitOnselchange - if set commit the action when selection changed, else commit when user exits field
*
* text fields
* 13=multiline - uses multipul lines else uses a single line
* 14=password - a password is intended
* 21=fileselect -text in field represents a file pathname to be submitted
* 23=donotspellcheck - don't spell check
* 24=donotscroll - once the field is full don't enter anymore text.
* 25=comb - (only if maxlen is present, (multiline, password and fileselect are CLEAR)), the text is justified across the field to MaxLen
* 26=richtext - use richtext format specified by RV entry in field dictionary
*
* button fields
* 15=notoggletooff - (use in radiobuttons only) if set one button must always be selected
* 16=radio - if set is a set of radio buttons
* 17=pushbutton - if set its a push button, if neither 16 nor 17 its a check box
* 26=radiosinunison - if set all radio buttons with the same on state are turned on and off in unison (same behaviour as html browsers)
*
* @return the flags array (Ff in PDF) (indexs are the number listed) * all
*/
public boolean[] getFieldFlags() {// otherwise known as Ff flags
if (this.flags == null) this.flags = new boolean[32];
return this.flags;
}
/**
* set the state which is defined as the On state for this form
* usually different for each child so that the selected child can be found by the state
*/
public void setNormalOnState(String state) {
this.normalOnState = state;
}
/**
* @return whether or not appearances are used in this field
*/
public boolean isAppearanceUsed() {
return this.appearancesUsed;
}
/**
* sets the image
* images are one of R rollover, N normal, D down and Off unselected, On selected
* for Normal selected the normal on state should also be set
*/
public void setAppearanceImage(BufferedImage image, int imageType, int status) {
if (image == null)
// if null use opaque image
image = getOpaqueImage();
switch (imageType) {
case PdfDictionary.D:
if (status == PdfDictionary.On) {
this.downOnImage = image;
}
else
if (status == PdfDictionary.Off) {
this.downOffImage = image;
}
else throw new RuntimeException("Unknown status use PdfDictionary.On or PdfDictionary.Off");
break;
case PdfDictionary.N:
if (status == PdfDictionary.On) {
this.normalOnImage = image;
}
else
if (status == PdfDictionary.Off) {
this.normalOffImage = image;
}
else throw new RuntimeException("Unknown status use PdfDictionary.On or PdfDictionary.Off");
break;
case PdfDictionary.R:
if (status == PdfDictionary.On) {
this.rolloverOnImage = image;
}
else
if (status == PdfDictionary.Off) {
this.rolloverOffImage = image;
}
else throw new RuntimeException("Unknown status use PdfDictionary.On or PdfDictionary.Off");
break;
default:
throw new RuntimeException("Unknown type use PdfDictionary.D, PdfDictionary.N or PdfDictionary.R");
}
this.appearancesUsed = true;
}
/**
* sets the border color
*/
public void setBorderColor(String nextField) {
if (nextField != null) getDictionary(PdfDictionary.MK).setFloatArray(PdfDictionary.BC, generateFloatFromString(nextField));
}
/**
* sets the background color for this form
*/
public void setBackgroundColor(String nextField) {
if (nextField != null) getDictionary(PdfDictionary.MK).setFloatArray(PdfDictionary.BG, generateFloatFromString(nextField));
}
/**
* takes a String colorString, and turns it into the color it represents e.g. (0.5) represents gray (127,127,127) cmyk = 4 tokens in the
* order c, m, y, k
*/
private static float[] generateFloatFromString(String colorString) {
// 0=transparant
// 1=gray
// 3=rgb
// 4=cmyk
if (debug) System.out.println("CHECK generateColorFromString=" + colorString);
StringTokenizer tokens = new StringTokenizer(colorString, "[()] ,");
float[] toks = new float[tokens.countTokens()];
int i = 0;
while (tokens.hasMoreTokens()) {
String tok = tokens.nextToken();
if (debug) System.out.println("token" + (i + 1) + '=' + tok + ' ' + colorString);
toks[i] = Float.parseFloat(tok);
i++;
}
if (i == 0) return null;
else return toks;
}
/**
* sets the normal caption for this form
*/
public void setNormalCaption(String caption) {
if (caption != null) {
getDictionary(PdfDictionary.MK).setTextStreamValue(PdfDictionary.CA, StringUtils.toBytes(caption));
}
}
/**
* sets whether there should be a down looking icon
*/
protected void setOffsetDownApp() {
this.offsetDownIcon = true;
}
/**
* sets whether a down icon should be used
*/
protected void setNoDownIcon() {
this.noDownIcon = true;
}
/**
* sets whether to invert the normal icon for the down icon
*/
protected void setInvertForDownIcon() {
this.invertDownIcon = true;
}
/*
* returns to rotation of this field object, currently in stamp annotations only
*
* deprecated use formObject.getDictionary(PdfDictionary.MK).getInt(PdfDictionary.R);
*
* public int getRotation(){
*
* return getDictionary(PdfDictionary.MK).getInt(PdfDictionary.R); }/
*/
/**
* @return true if has normal of image
*/
public boolean hasNormalOff() {
return this.normalOffImage != null;
}
/**
* @return true if has rollover off image
*/
public boolean hasRolloverOff() {
return this.rolloverOffImage != null;
}
/**
* @return true if has down off image
*/
public boolean hasDownOff() {
return this.downOffImage != null;
}
/**
* @return true if has one or more down images set
*/
public boolean hasDownImage() {
return (this.downOnImage != null || hasDownOff());
}
/**
* @return true if has a rollover on image
*/
public boolean hasRolloverOn() {
return this.rolloverOnImage != null;
}
/**
* @return true if has a normal on image
*/
public boolean hasNormalOn() {
return this.normalOnImage != null;
}
/**
* copy all values from form to this FormObject WARNING overrites current data, so shoudl be called before the rest of the form is
* setup.
*/
public void overwriteWith(FormObject form) {
if (form == null) return;
if (form.parentRef != null) this.parentRef = form.parentRef;
if (form.flags != null) this.flags = form.flags.clone();
if (form.I != null) this.I = form.I.clone();
if (form.selectedItem != null) this.selectedItem = form.selectedItem;
if (form.ref != null) this.ref = form.ref;
if (form.textColor != null) this.textColor = form.textColor.clone();
if (form.textFont != null) this.textFont = form.textFont;
if (form.textSize != -1) this.textSize = form.textSize;
if (form.textString != null) this.textString = form.textString;
if (form.appearancesUsed) this.appearancesUsed = form.appearancesUsed;
if (form.offsetDownIcon) this.offsetDownIcon = form.offsetDownIcon;
if (form.noDownIcon) this.noDownIcon = form.noDownIcon;
if (form.invertDownIcon) this.invertDownIcon = form.invertDownIcon;
if (form.onState != null) this.onState = form.onState;
if (form.currentState != null) this.currentState = form.currentState;
if (form.normalOffImage != null) this.normalOffImage = form.normalOffImage;
if (form.normalOnImage != null) this.normalOnImage = form.normalOnImage;
if (form.rolloverOffImage != null) this.rolloverOffImage = form.rolloverOffImage;
if (form.rolloverOnImage != null) this.rolloverOnImage = form.rolloverOnImage;
if (form.downOffImage != null) this.downOffImage = form.downOffImage;
if (form.downOnImage != null) this.downOnImage = form.downOnImage;
if (form.pageNumber != -1) this.pageNumber = form.pageNumber;
// annotations
if (form.cColor != null) this.cColor = form.cColor;
if (form.contents != null) this.contents = form.contents;
if (form.show) this.show = form.show;
// ?? cloning
this.AA = form.AA;
this.AP = form.AP;
this.BS = form.BS;
this.D = form.D;
this.OC = form.OC;
this.C = (form.C == null) ? null : form.C.clone();
this.QuadPoints = (form.QuadPoints == null) ? null : form.QuadPoints.clone();
this.F = form.F;
this.Ff = form.Ff;
this.CO = (form.CO == null) ? null : form.CO.clone();
this.Opt = (form.Opt == null) ? null : form.Opt.clone();
this.Q = form.Q;
this.MaxLen = form.MaxLen;
this.FT = form.FT;
this.rawAS = (form.rawAS == null) ? null : form.rawAS.clone();
this.rawDA = (form.rawDA == null) ? null : form.rawDA.clone();
this.rawDV = (form.rawDV == null) ? null : form.rawDV.clone();
this.rawJS = (form.rawJS == null) ? null : form.rawJS.clone();
this.rawNM = (form.rawNM == null) ? null : form.rawNM.clone();
this.rawTM = (form.rawTM == null) ? null : form.rawTM.clone();
this.rawTU = (form.rawTU == null) ? null : form.rawTU.clone();
this.rawV = (form.rawV == null) ? null : form.rawV.clone();
// copy fieldname
this.T = form.T;
this.rawT = (form.rawT == null) ? null : form.rawT.clone();
this.Rect = (form.Rect == null) ? null : form.Rect.clone();
this.TI = form.TI;
this.MK = (form.MK == null) ? null : (PdfObject) form.MK.clone();
}
public Object getPopupObj() {
return this.popupObj;
}
/**
* See also {@link FormObject#getUserName()}
*
* @return the full field name for this form
*
* @deprecated use formObject.getTextStreamValue(PdfDictionary.T); NO LONGER USED INTERNALLY
*/
// public String getFieldName() {
//
// //ensure resolved
// if(T==null)
// this.getTextStreamValue(PdfDictionary.T);
//
// return T;
// }
/**
* @return the currently selected State of this field at time of opening.
*/
public String getCurrentState() {
return this.currentState;
}
/**
* @return the on state for this field
*/
public String getOnState() {
return this.onState;
}
/**
* @return the characteristics for this field.
* bit 1 is index 0 in [] [0] 1 = invisible [1] 2 = hidden - dont display or print [2] 3 = print - print if set, dont if not [3] 4 =
* nozoom [4] 5= norotate [5] 6= noview [6] 7 = read only (ignored by wiget) [7] 8 = locked [8] 9 = togglenoview as on pdf 1.7 this became
* 10 bits long [9] 10 = LockedContents
*/
public boolean[] getCharacteristics() {
// lazy initialisation
if (this.Farray == null) {
if (this.F == -1) this.Farray = new boolean[10];
else this.Farray = calcFarray(this.F);
// System.out.println("F="+F+" "+this.getPDFRef()+" "+characteristic+" display="+display+" "+characteristic[2]);
}
return this.Farray;
}
/**
* @return userName for this field (TU value)
*
* use formObject.getTextStreamValue(PdfDictionary.TU);
*/
// public String getUserName() {
//
// //ensure resolved g
// if(TU==null)
// getTextStreamValue(PdfDictionary.TU);
//
// return TU;
// }
/**
* @return the default text size for this field
*/
public int getTextSize() {
return this.textSize;
}
/**
* @return the values map for this field, map that references the display value from the export values
*/
public Map getValuesMap(boolean keyFirst) {
if (this.Opt != null && this.OptValues == null) {
Object[] rawOpt = getObjectArray(PdfDictionary.Opt);
if (rawOpt != null) {
String key, value;
Object[] obj;
for (Object aRawOpt : rawOpt) {
if (aRawOpt instanceof Object[]) { // 2 items (see p678 in v1.6 PDF ref)
obj = (Object[]) aRawOpt;
if (keyFirst) {
key = StringUtils.getTextString((byte[]) obj[0], false);
value = StringUtils.getTextString((byte[]) obj[1], false);
}
else {
key = StringUtils.getTextString((byte[]) obj[1], false);
value = StringUtils.getTextString((byte[]) obj[0], false);
}
if (this.OptValues == null) this.OptValues = new HashMap();
this.OptValues.put(key, value);
}
}
}
}
return this.OptValues;
}
/**
* @return the default value for this field
*
* use formObject.getTextStreamValue(PdfDictionary.DV);
*/
// public String getDefaultValue() {
// return getTextStreamValue(PdfDictionary.DV);
// }
/**
* @return the items array list (Opt)
*/
public String[] getItemsList() {
if (this.OptString == null) {
Object[] rawOpt = getObjectArray(PdfDictionary.Opt);
if (rawOpt != null) {
int count = rawOpt.length;
this.OptString = new String[count];
for (int ii = 0; ii < count; ii++) {
if (rawOpt[ii] instanceof Object[]) { // 2 items (see p678 in v1.6 PDF ref)
Object[] obj = (Object[]) rawOpt[ii];
this.OptString[ii] = StringUtils.getTextString((byte[]) obj[1], false);
}
else
if (rawOpt[ii] instanceof byte[]) {
this.OptString[ii] = StringUtils.getTextString((byte[]) rawOpt[ii], false);
}
else
if (rawOpt[ii] != null) {}
}
}
}
return this.OptString;
}
/**
* @return the selected Item for this field
*/
public String getSelectedItem() {
if (this.selectedItem == null) this.selectedItem = getTextStreamValue(PdfDictionary.V);
// if no value set but selection, use that
if (this.selectedItem == null && this.I != null) {
String[] items = this.getItemsList();
int itemSelected = this.I[0];
if (items != null && itemSelected > -1 && itemSelected < items.length) return items[itemSelected];
else return null;
}
else return this.selectedItem;
}
/**
* @return the top index, or item that is visible in the combobox or list first.
*/
public int[] getTopIndex() {
if (this.I == null && this.TI != -1) {
this.I = new int[1];
this.I[0] = this.TI;
}
return this.I;
}
/**
* @return the text string for this field - if no value set but a default (DV value) set, return that.
*/
public String getTextString() {
if (this.textString == null) this.textString = getTextStreamValue(PdfDictionary.V);
if (this.textString == null && getTextStreamValue(PdfDictionary.DV) != null) return getTextStreamValue(PdfDictionary.DV);
else {
if (this.textString != null) this.textString = this.textString.replaceAll("\r", "\n").trim();
else this.textString = "";
return this.textString;
}
}
/**
* @return the maximum length of the text in the field
*
* use formObject.getInt(PdfDictionary.MaxLen)
*/
// public int getMaxTextLength() {
// return MaxLen;
// }
/**
* @return the normal caption for this button, the caption displayed when nothing is interacting with the icon, and at all other times unless a
* down and/or rollover caption is present
*
* use formObject.getDictionary(PdfDictionary.MK).getTextStreamValue(PdfDictionary.CA);
*/
// public String getNormalCaption() {
// return getDictionary(PdfDictionary.MK).getTextStreamValue(PdfDictionary.CA);
// }
/**
* @return the down caption, caption displayed when the button is down/pressed
*
* use formObject.getDictionary(PdfDictionary.MK).getTextStreamValue(PdfDictionary.AC);
*/
// public String getDownCaption() {
// return getDictionary(PdfDictionary.MK).getTextStreamValue(PdfDictionary.AC);
// }
/**
* @return the rollover caption, the caption displayed when the user rolls the mouse cursor over the button
*
* deprecated use formObject.getDictionary(PdfDictionary.MK).getTextStreamValue(PdfDictionary.RC);
*
* public String getRolloverCaption() {
*
* return getDictionary(PdfDictionary.MK).getTextStreamValue(PdfDictionary.RC); }/
**/
/**
* @return the position of the view of the text in this field
*
* positioning of text relative to icon - (integer) 0=caption only 1=icon only 2=caption below icon 3=caption above icon 4=caption on
* right of icon 5=caption on left of icon 6=caption overlaid ontop of icon
*/
public int getTextPosition() {
return getDictionary(PdfDictionary.MK).getInt(PdfDictionary.TP);
}
/**
* @return the default state of this field, the state to return to when the field is reset
*
* use formObject.getName(PdfDictionary.AS);
*/
// public String getDefaultState() {
//
// if(AS==null)
// this.getName(PdfDictionary.AS);
//
// return AS;
//
// }
/**
* @return the normal on state for this field
*/
public String getNormalOnState() {
return this.normalOnState;
}
/**
* @return the normal off image for this field
*/
public BufferedImage getNormalOffImage() {
return this.normalOffImage;
}
/**
* @return the normal On image for this field
*/
public BufferedImage getNormalOnImage() {
return this.normalOnImage;
}
/**
* @return if this field has not got a down icon
*/
public boolean hasNoDownIcon() {
return this.noDownIcon;
}
/**
* @return whether this field has a down icon as an offset of the normal icon
*/
public boolean hasOffsetDownIcon() {
return this.offsetDownIcon;
}
/**
* @return whether this field has a down icon as an inverted image of the normal icon
*/
public boolean hasInvertDownIcon() {
return this.invertDownIcon;
}
/**
* @return the down off image for this field
*/
public BufferedImage getDownOffImage() {
return this.downOffImage;
}
/**
* @return the down on image for this field
*/
public BufferedImage getDownOnImage() {
return this.downOnImage;
}
/**
* @return the rollover image for this field, the image displayed when the user moves the mouse over the field
*/
public BufferedImage getRolloverOffImage() {
return this.rolloverOffImage;
}
/**
* @return the rollover on image, the image displayed when the user moves the mouse over the field, when in the on state
*/
public BufferedImage getRolloverOnImage() {
return this.rolloverOnImage;
}
/**
* @return the text font for this field
*/
public Font getTextFont() {
if (this.textFont == null) {
this.textFont = new Font("Arial", Font.PLAIN, 8);
}
return this.textFont;
}
/**
* @return the text color for this field
*/
public Color getTextColor() {
return generateColor(this.textColor);
}
/**
* @return the border color for this field
*
* @deprecated use FormObject.generateColor(formObject.getDictionary(PdfDictionary.MK).getFloatArray(PdfDictionary.BC));
*/
@Deprecated
public Color getBorderColor() {
return generateColor(getDictionary(PdfDictionary.MK).getFloatArray(PdfDictionary.BC));
}
/**
* @return the border style for this field
*
* deprecated use formObject.getDictionary(pdfDictionary.BS);
*
* public PdfObject getBorder() { return BS; }/
**/
/**
* @return the background color for this field deprecated - use
* FormObject.generateColor(formObj.getDictionary(PdfDictionary.MK).getFloatArray(PdfDictionary.BG));
*
* public Color getBackgroundColor() {
*
* return generateColor(getDictionary(PdfDictionary.MK).getFloatArray(PdfDictionary.BG)); } /
**/
/**
* return true if the popup component has been built
*/
public boolean isPopupBuilt() {
return this.popupBuilt;
}
/**
* store the built popup component for use next time and set popupBuilt to true.
*/
public void setPopupBuilt(Object popup) {
if (popup == null) return;
this.popupObj = popup;
this.popupBuilt = true;
}
public String getLayerName() {
// lazy initialisation
if (this.layerName == null) {
PdfObject OC = this.getDictionary(PdfDictionary.OC);
if (OC != null) this.layerName = OC.getName(PdfDictionary.Name);
}
return this.layerName;
}
/** JS stores if any of the form values have changed acessed via hasFormChanged() */
private boolean formChanged = false;
/** JS has the form fields changed */
public boolean hasValueChanged() {
return this.formChanged;
}
/** flags up this forms value as being changed so that it will be updated to the view */
public void setFormChanged() {
this.formChanged = true;
}
/** JS resets the form changed flag to indicate the values have been updated */
public void resetFormChanged() {
this.formChanged = false;
}
/**
* @return the current value for this field, if text field the text string, if choice field the selected item if button field the normal
* caption
*/
public String getValue() {
int subtype = getParameterConstant(PdfDictionary.Subtype);
switch (subtype) {
case PdfDictionary.Tx:
return getTextString();
case PdfDictionary.Ch:
if (this.selectedItem == null) this.selectedItem = getTextStreamValue(PdfDictionary.V);
return this.selectedItem;
case PdfDictionary.Btn:
return getDictionary(PdfDictionary.MK).getTextStreamValue(PdfDictionary.CA);
case PdfDictionary.Sig:
return getDictionary(PdfDictionary.MK).getTextStreamValue(PdfDictionary.CA);
default:// to catch all the annots
return getDictionary(PdfDictionary.MK).getTextStreamValue(PdfDictionary.CA);
}
// NOTE - Do not return empty string if value is null, as affects 0.00 values.
}
/**
* sets the value of this field dependent on which type of field it is
*/
public void setValue(String inVal) {// need to kept as java strings
boolean preFormChanged = this.formChanged;
String CA;
int subtype = getParameterConstant(PdfDictionary.Subtype);
// if(isReadOnly()){
// return;
// }
switch (subtype) {
case PdfDictionary.Tx:
String curVal = getTextStreamValue(PdfDictionary.V);
// if the current value is the same as the new value, our job is done.
if (curVal != null && curVal.equals(inVal)) break;
if (this.textString != null && this.textString.equals(inVal)) {
break;
}
// use empty string so that the raw pdf value does not get recalled.
if (inVal == null) inVal = "";
this.textString = inVal;
this.formChanged = true;
break;
case PdfDictionary.Ch:
if (this.selectedItem == null) this.selectedItem = getTextStreamValue(PdfDictionary.V);
if (this.selectedItem != null && this.selectedItem.equals(inVal)) {
break;
}
this.selectedItem = inVal;
this.formChanged = true;
break;
case PdfDictionary.Btn:
CA = getDictionary(PdfDictionary.MK).getTextStreamValue(PdfDictionary.CA);
if (CA != null && CA.equals(inVal)) {
break;
}
getDictionary(PdfDictionary.MK).setTextStreamValue(PdfDictionary.CA, StringUtils.toBytes(inVal));
this.formChanged = true;
break;
default:
CA = getDictionary(PdfDictionary.MK).getTextStreamValue(PdfDictionary.CA);
if (CA != null && CA.equals(inVal)) {
break;
}
getDictionary(PdfDictionary.MK).setTextStreamValue(PdfDictionary.CA, StringUtils.toBytes(inVal));
this.formChanged = true;
}
if (this.formHandler != null && this.formChanged && !preFormChanged) this.formHandler.C(this);
}
/**
* defines the thickness of the border when stroking.
*/
public void setLineWidth(int lineWidth) {
if (this.BS == null) this.BS = new FormObject();
this.BS.setIntNumber(PdfDictionary.W, lineWidth);
}
/**
* JS Controls whether the field is hidden or visible on screen and in print. Values are: visible 0, hidden 1, noPrint 2, noView 3.
*
* GetCharacteristics will add this value into its array when called.
*/
public int display = -1;
/**
* added for backward compatibility or old adobe files.
*/
public void setBorderWidth(int width) {
setLineWidth(width);
}
/*
* change; p373 js_api Example; changeEx commitKey; fieldFull; keyDown; modifier; name; rc; richChange; richChangeEx; richValue; selEnd; selStart;
* shift; source; target; targetName; type; value;
*/
/**
* Verifies the current keystroke event before the data is committed. It can be used to check target form field values to verify, for
* example, whether character data was entered instead of numeric data. JavaScript sets this property to true after the last keystroke
* event and before the field is validated.
*/
public static boolean willCommit() {
// CHRIS javascript unimplemented willcommit
return true;
}
/**
* JS shows if the display value has changed, if it has we need to check what to and change
* call getCharacteristics() to get the new display values and that will reset the display flag
*/
public boolean hasDisplayChanged() {
boolean checkChange = (this.display != -1);
if (checkChange) return true;
else return false;
}
/**
* added to return this for event.target from javascript
*/
public Object getTarget() {
return this;
}
/**
* @return the normal caption associated to this button
*/
public String buttonGetCaption() {
return buttonGetCaption(0);
}
/**
* @return the caption associated with this button,
* @param nFace
* - 0 normal caption (default) 1 down caption 2 rollover caption
*/
public String buttonGetCaption(int nFace) {
switch (nFace) {
case 1:
return getDictionary(PdfDictionary.MK).getTextStreamValue(PdfDictionary.AC);
case 2:
return getDictionary(PdfDictionary.MK).getTextStreamValue(PdfDictionary.RC);
default:
return getDictionary(PdfDictionary.MK).getTextStreamValue(PdfDictionary.CA);
}
}
/**
* sets this buttons normal caption to cCaption
*/
public void buttonSetCaption(String cCaption) {
buttonSetCaption(cCaption, 0);
}
/**
* sets this buttons caption to cCaption, it sets the caption defined by nFace.
* @param nFace
* - 0 (default) normal caption 1 down caption 2 rollover caption
*/
public void buttonSetCaption(String cCaption, int nFace) {
switch (nFace) {
case 1:
getDictionary(PdfDictionary.MK).setTextStreamValue(PdfDictionary.AC, StringUtils.toBytes(cCaption));
break;
case 2:
getDictionary(PdfDictionary.MK).setTextStreamValue(PdfDictionary.RC, StringUtils.toBytes(cCaption));
break;
default:
getDictionary(PdfDictionary.MK).setTextStreamValue(PdfDictionary.CA, StringUtils.toBytes(cCaption));
}
}
/**
* @return the background color for the annotation objects
*/
public Object getfillColor() {
return generateColor(getDictionary(PdfDictionary.MK).getFloatArray(PdfDictionary.BG));
}
public boolean isKid() {
return this.isKid;
}
public void setKid(boolean kid) {
this.isKid = kid;
}
public void setFormType(int widgetType) {
this.formType = widgetType;
}
/**
* look at FormFactory.LIST etc for full list of types
*/
public int getFormType() {
return this.formType;
}
/** @return an Opaque BufferedImage for use when appearance Streams are null */
public static BufferedImage getOpaqueImage() {
return new BufferedImage(20, 20, BufferedImage.TYPE_INT_ARGB);
}
public String getNameUsed() {
return this.nameUsed;
}
public void setNameUsed(String name) {
this.nameUsed = name;
}
public boolean testedForDuplicates() {
return this.tested;
}
public void testedForDuplicates(boolean b) {
this.tested = b;
}
public void setGUIComponent(Object guiComp) {
this.guiComp = guiComp;
}
public Object getGUIComponent() {
return this.guiComp;
}
private boolean isReadOnly() {
boolean isReadOnly = false;
boolean[] flags = getFieldFlags();
boolean[] characteristics = getCharacteristics();
if (((flags != null) && (flags[FormObject.READONLY_ID])) || (characteristics != null && characteristics[9])// characteristics[9] =
// LockedContents
// p609 PDF ref ver 1-7, characteristics 'locked' flag does allow contents to be edited,
// but the 'LockedContents' flag stops content being changed.
) {
isReadOnly = true;
}
return isReadOnly;
}
/**
* allow us to update value (and sync to GUI version if exists
*/
public void updateValue(int key, final Object value, boolean sync) {
// if(isReadOnly())
// return;
switch (key) {
case ComponentData.TEXT_TYPE:
this.textString = (String) value;
// stop updating if value unchanged (and stops our legacy code failing in continuous loop
if (this.lastTextString != null && this.textString != null && this.textString.equals(this.lastTextString)) {
sync = false;
}
// track last value
this.lastTextString = this.textString;
break;
default:
throw new RuntimeException("Unknown type " + key);
}
/**
* update our Swing/ULC component if needed on correct thread
*/
if (sync) {
if (this.guiComp != null) {
if (this.guiComp instanceof JTextComponent) {
if (SwingUtilities.isEventDispatchThread()) {
((JTextComponent) this.guiComp).setText((String) value);
}
else {
final Runnable doPaintComponent = new Runnable() {
@Override
public void run() {
((JTextComponent) FormObject.this.guiComp).setText((String) value);
}
};
SwingUtilities.invokeLater(doPaintComponent);
}
}
else {}
}
}
else {
// we will cache updates here in JS and then write out at end.
}
}
/**
* Identify whether we use a Text component, JList,
*
* @param guiType
*/
public void setGUIType(int guiType) {
this.guiType = guiType;
}
public int getGUIType() {
return this.guiType;
}
}