org.jpedal.objects.raw.FormObject Maven / Gradle / Ivy
/*
* ===========================================
* Java Pdf Extraction Decoding Access Library
* ===========================================
*
* Project Info: http://www.idrsolutions.com
* Help section for developers at http://www.idrsolutions.com/support/
*
* (C) Copyright 1997-2017 IDRsolutions and Contributors.
*
* This file is part of JPedal/JPDF2HTML5
*
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.*;
import java.awt.geom.Rectangle2D;
import java.awt.image.BufferedImage;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import java.util.StringTokenizer;
import javax.swing.*;
import javax.swing.text.JTextComponent;
import org.jpedal.color.DeviceCMYKColorSpace;
import org.jpedal.external.ExternalHandlers;
import org.jpedal.fonts.glyph.JavaFXSupport;
import org.jpedal.objects.acroforms.creation.FormFactory;
import org.jpedal.objects.acroforms.creation.GenericFormFactory;
import org.jpedal.objects.javascript.defaultactions.DisplayJavascriptActions;
import org.jpedal.utils.LogWriter;
import org.jpedal.utils.ObjectCloneFactory;
import org.jpedal.utils.StringUtils;
public class FormObject extends PdfObject {
private static Color FieldsHightlightColor;
static {
final String cs = System.getProperty("org.jpedal.FieldsHighlightColor");
if (cs != null) {
final float[] ff = generateFloatFromString(cs);
FieldsHightlightColor = new Color((int) ff[0], (int) ff[1], (int) ff[2]);
}
}
private static final JavaFXSupport fxSupport = ExternalHandlers.getFXHandler();
private int formType = -1;
private String fontName = "Arial";
Object guiComp;
private int guiType;
//rotation on page
private int rawRotation;
Point currentLocation;
float currentScaling = -1.0f;
//unknown CMAP as String
private String EOPROPtype, Filter, Location, 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;
private Map OptValues; // values from Opt
private String validValue;
private int[] matteDetails = {0, 0, 0, 0};
/**
* 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<
1=readonly - if set there is no interaction
*
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)
*/
public boolean[] getFieldFlags() { //otherwise known as Ff flags
if (flags == null) {
flags = new boolean[32];
}
return flags;
}
public void setFieldFlags(final int pos, final boolean value) {
if (flags == null) {
flags = new boolean[32];
}
flags[pos] = value;
}
/**
* 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(final String state) {
normalOnState = state;
}
/**
* @return whether or not appearances are used in this field
*/
public boolean isAppearanceUsed() {
return appearancesUsed;
}
public void setAppreancesUsed(final boolean used) {
appearancesUsed = used;
}
/**
* sets the border color
*/
public void setBorderColor(final String nextField) {
if (nextField != null) {
getDictionary(PdfDictionary.MK).setFloatArray(PdfDictionary.BC, generateFloatFromString(nextField));
}
}
/**
* sets the background color for this form
*/
public void setBackgroundColor(final 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(final String colorString) {
// 0=transparant
// 1=gray
// 3=rgb
// 4=cmyk
final StringTokenizer tokens = new StringTokenizer(colorString, "[()] ,");
final float[] toks = new float[tokens.countTokens()];
int i = 0;
while (tokens.hasMoreTokens()) {
toks[i] = Float.parseFloat(tokens.nextToken());
i++;
}
if (i == 0) {
return null;
} else {
return toks;
}
}
/**
* sets the normal caption for this form
*/
public void setNormalCaption(final 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() {
offsetDownIcon = true;
}
/**
* sets whether a down icon should be used
*/
protected void setNoDownIcon() {
noDownIcon = true;
}
/**
* sets whether to invert the normal icon for the down icon
*/
protected void setInvertForDownIcon() {
invertDownIcon = true;
}
/**
* returns true if has normal of image
*/
public boolean hasNormalOff() {
return normalOffImage != null;
}
/**
* returns true if has rollover off image
*/
public boolean hasRolloverOff() {
return rolloverOffImage != null;
}
/**
* returns true if has down off image
*/
public boolean hasDownOff() {
return downOffImage != null;
}
/**
* returns true if has one or more down images set
*/
public boolean hasDownImage() {
return (downOnImage != null || hasDownOff());
}
/**
* 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(final FormObject form) {
if (form == null) {
return;
}
if (form.parentRef != null) {
parentRef = form.parentRef;
}
if (form.flags != null) {
flags = form.flags.clone();
}
if (form.selectionIndices != null) {
selectionIndices = form.selectionIndices.clone();
}
if (form.selectedItem != null) {
selectedItem = form.selectedItem;
}
if (form.ref != null) {
ref = form.ref;
}
if (form.textColor != null) {
textColor = form.textColor.clone();
}
if (form.textFont != null) {
textFont = form.textFont;
}
if (form.textSize != -1) {
textSize = form.textSize;
}
if (form.textString != null) {
textString = form.textString;
}
if (form.appearancesUsed) {
appearancesUsed = form.appearancesUsed;
}
if (form.offsetDownIcon) {
offsetDownIcon = form.offsetDownIcon;
}
if (form.noDownIcon) {
noDownIcon = form.noDownIcon;
}
if (form.invertDownIcon) {
invertDownIcon = form.invertDownIcon;
}
if (form.normalOffImage != null) {
normalOffImage = form.normalOffImage;
}
if (form.normalOnImage != null) {
normalOnImage = form.normalOnImage;
}
if (form.rolloverOffImage != null) {
rolloverOffImage = form.rolloverOffImage;
}
if (form.rolloverOnImage != null) {
rolloverOnImage = form.rolloverOnImage;
}
if (form.downOffImage != null) {
downOffImage = form.downOffImage;
}
if (form.downOnImage != null) {
downOnImage = form.downOnImage;
}
if (form.pageNumber != -1) {
pageNumber = form.pageNumber;
}
//annotations
if (form.cColor != null) {
cColor = form.cColor;
}
if (form.contents != null) {
contents = form.contents;
}
if (form.show) {
show = form.show;
}
//?? cloning
AA = form.AA;
AP = form.AP;
BS = form.BS;
D = form.D;
OC = form.OC;
C = (form.C == null) ? null : form.C.clone();
QuadPoints = (form.QuadPoints == null) ? null : form.QuadPoints.clone();
InkList = (form.InkList == null) ? null : form.InkList.clone();
F = form.F;
Ff = form.Ff;
CO = (form.CO == null) ? null : form.CO.clone();
Opt = (form.Opt == null) ? null : form.Opt.clone();
Q = form.Q;
MaxLen = form.MaxLen;
FT = form.FT;
rawAS = (form.rawAS == null) ? null : form.rawAS.clone();
rawDA = (form.rawDA == null) ? null : form.rawDA.clone();
rawDS = (form.rawDS == null) ? null : form.rawDS.clone();
rawDV = (form.rawDV == null) ? null : form.rawDV.clone();
rawJS = (form.rawJS == null) ? null : form.rawJS.clone();
rawNM = (form.rawNM == null) ? null : form.rawNM.clone();
rawTM = (form.rawTM == null) ? null : form.rawTM.clone();
rawTU = (form.rawTU == null) ? null : form.rawTU.clone();
rawV = (form.rawV == null) ? null : form.rawV.clone();
//copy fieldname
T = form.T;
rawT = (form.rawT == null) ? null : form.rawT.clone();
Rect = (form.Rect == null) ? null : form.Rect.clone();
TI = form.TI;
MK = (form.MK == null) ? null : form.MK;
//align any set values
this.setSelected(form.isSelected);
}
/**
* @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 (Farray == null) {
if (F == -1) {
Farray = new boolean[10];
} else {
Farray = calcFarray(F);
}
}
return Farray;
}
public void setCharactersitics(final int pos, final boolean value) {
getCharacteristics();
Farray[pos] = value;
}
/**
* @return the default text size for this field
*/
public int getTextSize() {
return textSize;
}
/**
* @return the values map for this field,
* map that references the display value from the export values
*/
public Map getValuesMap(final boolean keyFirst) {
if (Opt != null && OptValues == null) {
final Object[] rawOpt = getObjectArray(PdfDictionary.Opt);
if (rawOpt != null) {
String key, value;
Object[] obj;
int ptr = 0;
for (final 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 (OptValues == null) {
OptValues = new HashMap();
}
OptValues.put(key, value);
} else if (rawKids != null && rawKids.length == rawOpt.length && aRawOpt instanceof byte[]) { //fixes case 25844
if (keyFirst) {
key = StringUtils.getTextString((byte[]) aRawOpt, false);
value = StringUtils.getTextString(rawKids[ptr], false);
} else {
//key = StringUtils.getTextString((byte[]) obj[1], false);
value = StringUtils.getTextString((byte[]) aRawOpt, false);
key = StringUtils.getTextString(rawKids[ptr], false);
}
if (OptValues == null) {
OptValues = new HashMap();
}
OptValues.put(key, value);
}
ptr++;
}
}
}
if (OptValues == null) {
return null;
} else {
return Collections.unmodifiableMap(OptValues);
}
}
/**
* @return the available items for this list or combo
*/
public String[] getItemsList() {
if (OptString == null) {
final Object[] rawOpt = getObjectArray(PdfDictionary.Opt);
if (rawOpt != null) {
final int count = rawOpt.length;
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)
final Object[] obj = (Object[]) rawOpt[ii];
OptString[ii] = StringUtils.getTextString((byte[]) obj[1], false);
} else if (rawOpt[ii] instanceof byte[]) {
OptString[ii] = StringUtils.getTextString((byte[]) rawOpt[ii], false);
}
}
}
}
return OptString;
}
/**
* @return the selected Item for this field
*/
public String getSelectedItem() {
if (selectedItem == null) {
selectedItem = getTextStreamValue(PdfDictionary.V);
}
//if no value yet set but selection, use that
if (selectedItem == null && selectionIndices != null) {
final String[] items = this.getItemsList();
final int itemSelected = selectionIndices[0];
if (items != null && itemSelected > -1 && itemSelected < items.length) {
selectedItem = items[itemSelected];
}
}
return selectedItem;
}
/**
* @return the top index, or item that is visible in the combobox or list first.
*/
public int[] getSelectionIndices() {
if (selectionIndices == null && TI != -1) {
selectionIndices = new int[1];
selectionIndices[0] = TI;
selectionIndex = TI;
}
return selectionIndices;
}
/**
* @return the text string for this field - if no value set but a default (DV value)
* set, return that.
*/
public String getTextString() {
if (textString == null) {
textString = getTextStreamValue(PdfDictionary.V);
}
if (textString == null && getTextStreamValue(PdfDictionary.DV) != null) {
return getTextStreamValue(PdfDictionary.DV);
} else {
if (textString != null) {
textString = textString.replaceAll("\r", "\n").trim();
} else {
textString = "";
}
return textString;
}
}
/**
* @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 normal on state for this field
*/
public String getNormalOnState() {
return normalOnState;
}
/**
* @return the normal off image for this field
*/
public BufferedImage getNormalOffImage() {
return normalOffImage;
}
/**
* @return the normal On image for this field
*/
public BufferedImage getNormalOnImage() {
return normalOnImage;
}
/**
* Get AP image
* Type should be PdfDictionary.On or PdfDictionary.Off
* key should be PdfDictionary.N, PdfDictionary.D, PdfDictionary.R
*
* @return the normal off image for this field
*/
public BufferedImage getAPImage(final int type, final int key) {
BufferedImage image = null;
switch (type) {
case PdfDictionary.On:
switch (key) {
case PdfDictionary.D:
image = downOnImage;
break;
case PdfDictionary.N:
image = normalOnImage;
break;
case PdfDictionary.R:
image = rolloverOnImage;
break;
}
break;
case PdfDictionary.Off:
switch (key) {
case PdfDictionary.D:
image = downOffImage;
break;
case PdfDictionary.N:
image = normalOffImage;
break;
case PdfDictionary.R:
image = rolloverOffImage;
break;
}
break;
}
return image;
}
/**
* @return if this field has not got a down icon
*/
public boolean hasNoDownIcon() {
return noDownIcon;
}
/**
* @return whether this field has a down icon as an offset of the normal icon
*/
public boolean hasOffsetDownIcon() {
return offsetDownIcon;
}
/**
* @return whether this field has a down icon as an inverted image of the normal icon
*/
public boolean hasInvertDownIcon() {
return invertDownIcon;
}
/**
* @return the down off image for this field
*/
public BufferedImage getDownOffImage() {
return downOffImage;
}
/**
* @return the down on image for this field
*/
public BufferedImage getDownOnImage() {
return downOnImage;
}
/**
* @return the rollover image for this field,
* the image displayed when the user moves the mouse over the field
*/
public BufferedImage getRolloverOffImage() {
return 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 rolloverOnImage;
}
/**
* @return the text font for this field
*/
public Font getTextFont() {
if (textFont == null) {
textFont = new Font("Arial", Font.PLAIN, 8);
}
return textFont;
}
public String getFontName() {
return fontName;
}
/**
* @return the text color for this field
*/
public Color getTextColor() {
return generateColor(textColor);
}
/**
* @return
*/
public String getLayerName() {
//lazy initialisation
if (this.layerName == null) {
final PdfObject OC = this.getDictionary(PdfDictionary.OC);
if (OC != null) {
this.layerName = OC.getName(PdfDictionary.Name);
}
}
return layerName;
}
/**
* oldJS
* returns the current value for this field,
* if text field the text string,
* if choice field the selected item
* if button field the normal caption
*
* @return
*/
public String getValue() {
final int formType = FT;
switch (formType) {
case PdfDictionary.Tx:
return getTextString();
case PdfDictionary.Ch:
if (selectedItem == null) {
selectedItem = getTextStreamValue(PdfDictionary.V);
}
return 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.
}
/**
* oldJS
* 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
final String CA;
final int formType = FT;
// if(isReadOnly()){
// return;
// }
switch (formType) {
case PdfDictionary.Tx:
final 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 (textString != null && textString.equals(inVal)) {
break;
}
//use empty string so that the raw pdf value does not get recalled.
if (inVal == null) {
inVal = "";
}
textString = inVal;
break;
case PdfDictionary.Ch:
if (selectedItem == null) {
selectedItem = getTextStreamValue(PdfDictionary.V);
}
if (selectedItem != null && selectedItem.equals(inVal)) {
break;
}
selectedItem = inVal;
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));
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));
}
}
/**
* oldJs
* defines the thickness of the border when stroking.
*/
public void setLineWidth(final int lineWidth) {
if (BS == null) {
BS = new FormObject();
}
BS.setIntNumber(PdfDictionary.W, lineWidth);
}
/**
* oldJs
* added for backward compatibility or old adobe files.
*/
public void setBorderWidth(final int width) {
setLineWidth(width);
}
/**
* Allows the user to set an offset for form components
* This is mainly used for movable form components such as text popups
*
* @param offset : The offset from the components location from the pdf
*/
public void setUserSetOffset(final Point offset) {
if (currentLocation == null) {
currentLocation = new Point();
}
currentLocation.x = (int) ((offset.x / currentScaling));
currentLocation.y = (int) ((offset.y / currentScaling));
}
/**
* Set the scaling for the formObject
* this is only used for the locations of forms that can move
* such as Text Popups
*
* @param scale : Current scaling to be used
*/
public void setCurrentScaling(final float scale) {
currentScaling = scale;
}
public float getCurrentScaling() {
return currentScaling;
}
/**
* oldJS
* JS returns the normal caption associated to this button
*/
public String buttonGetCaption() {
return buttonGetCaption(0);
}
/**
* oldJS
* returns the caption associated with this button,
*
* @param nFace -
* 0 normal caption (default)
* 1 down caption
* 2 rollover caption
*/
public String buttonGetCaption(final 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);
}
}
/**
* oldJS
* sets this buttons normal caption to cCaption
*/
public void buttonSetCaption(final String cCaption) {
buttonSetCaption(cCaption, 0);
}
/**
* oldJS
* 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(final String cCaption, final 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));
}
}
/**
* oldJS
* returns the background color for the annotation objects
*/
public Object getfillColor() {
return generateColor(getDictionary(PdfDictionary.MK).getFloatArray(PdfDictionary.BG));
}
/**
* oldJS
* sets our background color to the color specified
*/
public void setfillColor(float[] newColor) {
if (newColor != null) {
if (newColor.length > 0 && Float.isNaN(newColor[0])) { //not-a-number
final float[] tmp = new float[newColor.length - 1];
System.arraycopy(newColor, 1, tmp, 0, newColor.length - 1);
newColor = tmp;
}
getDictionary(PdfDictionary.MK).setFloatArray(PdfDictionary.BG, newColor);
}
}
/**
* oldJS
* sets the fillcolor, or background color using the string defined from javascript rhino parser
*/
public void setfillColor(final Object newColor) {
//added so that the fillColor NativeArray is called, this never seems to be called but
//without it the NativeArray one will not work.
//code below should work if ever called.
if (newColor != null) {
//convert javascript string to the appropriate color
final float[] color = DisplayJavascriptActions.convertToColorFloatArray((String) newColor);
//store color in our variable
getDictionary(PdfDictionary.MK).setFloatArray(PdfDictionary.BG, color);
}
}
public void setFormType(final int widgetType) {
formType = widgetType;
}
/**
* look at FormFactory.LIST etc for full list of types
*/
public int getFormType() {
return formType;
}
/**
* returns an Opaque BufferedImage for use when appearance Streams are null
*/
public static BufferedImage getOpaqueImage() {
return new BufferedImage(20, 20, BufferedImage.TYPE_INT_ARGB);
}
public void setGUIComponent(final Object guiComp, final int guiType) {
this.guiComp = guiComp;
this.guiType = guiType;
}
public Object getGUIComponent() {
return guiComp;
}
public boolean isReadOnly() {
boolean isReadOnly = false;
final boolean[] flags = getFieldFlags();
final 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(final Object value, final boolean isSelected, boolean sync) {
if (isReadOnly()) {
return;
}
if (GenericFormFactory.isTextForm(formType)) {
textString = (String) value;
//stop updating if value unchanged (and stops our legacy code failing in continuous loop
if (textString != null && textString.equals(lastTextString)) {
sync = false;
}
//track last value
lastTextString = textString;
} else {
textString = (String) value;
this.isSelected = isSelected;
//stop updating if value unchanged (and stops our legacy code failing in continuous loop
if (isSelected != lastIsSelected && lastTextString != null && textString != null && textString.equals(lastTextString)) {
sync = false;
}
//track last value
lastTextString = textString;
lastIsSelected = isSelected;
}
/*
* update our Swing/ULC component if needed on correct thread
*/
if ((sync && guiType != FormFactory.ULC) && //stop ULC for the moment!
guiComp != null) {
syncGUI(value);
}
}
private void syncGUI(final Object value) {
if (guiType == FormFactory.SWING) {
if (SwingUtilities.isEventDispatchThread()) {
setGUI(formType, value, guiComp, guiType);
} else {
final Runnable doPaintComponent = new Runnable() {
@Override
public void run() {
setGUI(formType, value, guiComp, guiType);
}
};
SwingUtilities.invokeLater(doPaintComponent);
}
} else if (guiType == FormFactory.JAVAFX) {
setGUI(formType, value, guiComp, guiType);
}
}
private static void setGUI(final int formType, final Object value, final Object guiComp, final int guiType) {
try {
if (guiType == FormFactory.JAVAFX) {
if (fxSupport != null) {
JavaFXSupport.renderGUIComponent(formType, value, guiComp);
}
} else if (guiType == FormFactory.SWING) {
if (GenericFormFactory.isTextForm(formType)) {
((JTextComponent) guiComp).setText((String) value);
} else if (formType == FormFactory.checkboxbutton) {
((AbstractButton) guiComp).setSelected(Boolean.valueOf((String) value));
} else if (GenericFormFactory.isButtonForm(formType)) {
((AbstractButton) guiComp).setText((String) value);
((AbstractButton) guiComp).setSelected(Boolean.valueOf((String) value));
} else if (formType == FormFactory.annotation &&
guiComp instanceof JButton) {
((AbstractButton) guiComp).setSelected(Boolean.valueOf((String) value));
}
}
} catch (final Exception ee) {
LogWriter.writeLog("Exception " + ee);
}
}
public boolean isSelected() {
return isSelected;
}
public void setSelected(final boolean setSelected) {
this.isSelected = setSelected;
if (guiComp != null) {
syncGUI(setSelected);
}
}
public int getSelectedIndex() {
return selectionIndex;
}
/**
* update value if ComboBox
*
* @param index
*/
public void setSelectedIndex(final int index) {
if (index != selectionIndex) {
selectionIndex = index;
selectionIndices = new int[1];
selectionIndices[0] = index;
if (guiComp != null) {
// Check if it's a JavaFX object, if not than use Swing
// Might need to be on FX Thread
if (guiType == FormFactory.JAVAFX) {
if (fxSupport != null) {
selectedItem = JavaFXSupport.getSelectedItem(guiComp, formType);
}
} else if (SwingUtilities.isEventDispatchThread()) {
if (formType == FormFactory.combobox) {
((JComboBox) guiComp).setSelectedIndex(selectionIndex);
selectedItem = (String) ((JComboBox) guiComp).getSelectedItem();
} else {
((JList) guiComp).setSelectedIndex(selectionIndex);
selectedItem = (String) ((JList) guiComp).getSelectedValue();
}
} else {
final Runnable doPaintComponent = new Runnable() {
@Override
public void run() {
if (formType == FormFactory.combobox) {
((JComboBox) guiComp).setSelectedIndex(selectionIndex);
selectedItem = (String) ((JComboBox) guiComp).getSelectedItem();
} else {
((JList) guiComp).setSelectedIndex(selectionIndex);
selectedItem = (String) ((JList) guiComp).getSelectedValue();
}
}
};
SwingUtilities.invokeLater(doPaintComponent);
}
}
}
}
/**
* update value if ComboBox
*
* @param value
*/
public void setSelectedItem(final String value) {
selectedItem = value;
if (guiComp != null) {
updateCombo();
}
}
private void updateCombo() {
if (formType == FormFactory.combobox || formType == FormFactory.list) {
if (guiType == FormFactory.JAVAFX) {
if (fxSupport != null) {
JavaFXSupport.select(guiComp, selectedItem, formType);
}
} else if (SwingUtilities.isEventDispatchThread()) {
if (formType == FormFactory.combobox) {
((JComboBox) guiComp).setSelectedItem(selectedItem);
} else {
((JList) guiComp).setSelectedValue(selectedItem, true);
}
} else {
final Runnable doPaintComponent = new Runnable() {
@Override
public void run() {
if (formType == FormFactory.combobox) {
((JComboBox) guiComp).setSelectedItem(selectedItem);
} else {
((JList) guiComp).setSelectedValue(selectedItem, true);
}
}
};
SwingUtilities.invokeLater(doPaintComponent);
}
} else {
throw new RuntimeException("Unexpected type must be FormFactory.combobox or FormFactory.list");
}
}
private static final float baseFontSize = 12;
/**
* Method to get the font size to be used in the form component
* This is currently only implemented for text pop-up forms
*
* @return The base size to be used in the form component
*/
@SuppressWarnings("MethodMayBeStatic")
public float getFontSize() {
return baseFontSize;
}
public Object getFormValue() {
final Object retValue;
switch (formType) {
case FormFactory.checkboxbutton:
retValue = isSelected;
break;
case FormFactory.combobox:
retValue = isSelected;
break;
case FormFactory.list:
retValue = selectedValues;
break;
case FormFactory.radiobutton:
retValue = isSelected;
break;
// case FormFactory.singlelinepassword:
// case FormFactory.multilinepassword:
// case FormFactory.multilinetext:
// case FormFactory.singlelinetext:
//
// retValue=getTextString();
//
// break;
default:
retValue = getTextString();
break;
}
return retValue;
}
/**
* used by JS to reset
*
* @return
*/
public String getLastValidValue() {
return validValue;
}
/**
* used by JS to reset
*/
public void setLastValidValue(final String value) {
validValue = value;
}
public void setPageRotation(final int rotation) {
rawRotation = rotation;
}
public void setVisible(final boolean isVisible) {
if (guiComp != null) {
if (guiType == FormFactory.JAVAFX) {
if (fxSupport != null) {
JavaFXSupport.setVisible(guiComp, isVisible);
}
} else {
((Component) guiComp).setVisible(isVisible);
}
}
}
/**
* @return the rotationOriginX
*/
public int getRotationOriginX() {
return rotationOriginX;
}
/**
* @param rotationOriginX the rotationOriginX to set
*/
public void setRotationOriginX(final int rotationOriginX) {
this.rotationOriginX = rotationOriginX;
}
/**
* @return the rotationOriginY
*/
public int getRotationOriginY() {
return rotationOriginY;
}
/**
* set the complete form rotation degree with reserve
* value
*
* @param rotationOriginY the rotationOriginY to set
*/
public void setRotationOriginY(final int rotationOriginY) {
this.rotationOriginY = rotationOriginY;
}
/**
* returns the complete form rotation degree with reserve
* value
*
* @return the elemRotationDegree
*/
public int getElemRotationDegree() {
return elemRotationDegree;
}
/**
* @param elemRotationDegree the elemRotationDegree to set
*/
public void setElemRotationDegree(final int elemRotationDegree) {
this.elemRotationDegree = elemRotationDegree;
}
/**
* set matte border details
* if it is specified in pdf or xfa
*
* @param matteDetails
*/
public void setMatteBorderDetails(final int[] matteDetails) {
this.matteDetails = matteDetails;
}
/**
* Method returns matte border details of
* Form (not all surrounding element)
*
* @return
*/
public int[] getMatteBorderDetails() {
return matteDetails;
}
public void setRawKids(final byte[][] kidsInParent) {
rawKids = kidsInParent;
}
public byte[][] getRawKids() {
return rawKids;
}
}