FormObject (org.jpedal:OpenViewerFX 7.12.28 API)

java.lang.Object
- org.jpedal.objects.raw.PdfObject
- - org.jpedal.objects.raw.FormObject

Direct Known Subclasses:: FSObject, MKObject

public class FormObject
extends PdfObject

Field Summary

Fields
Modifier and Type	Field and Description
`protected PdfObject`	`A`
`protected PdfObject`	`AA`
`protected PdfObject`	`AP`
`protected String`	`AS`
`protected Rectangle`	`BBox`
`protected PdfObject`	`Bl`
`protected PdfObject`	`BS`
`protected int[]`	`ByteRange`
`protected float[]`	`C`
`protected PdfObject`	`Cdict`
`protected String`	`Cert`
`protected Object[]`	`CO`
`static int`	`COMB_ID` 25 form flag indexes for the field flags
`static int`	`COMBO_ID` 18 form flag indexes for the field flags
`static int`	`COMMITONSELCHANGE_ID` 27 form flag indexes for the field flags
`protected String`	`ContactInfo`
`protected String`	`Contents`
`protected PdfObject`	`D`
`protected String`	`DA`
`static int`	`DONOTSCROLL_ID` 24 form flag indexes for the field flags
`static int`	`DONOTSPELLCHECK_ID` 23 form flag indexes for the field flags
`protected String`	`DSString`
`protected String`	`Dstring`
`protected String`	`DV`
`static int`	`EDIT_ID` 19 form flag indexes for the field flags
`protected int`	`F`
`protected int`	`Ff`
`static int`	`FILESELECT_ID` 21 form flag indexes for the field flags
`protected boolean[]`	`flags`
`protected int`	`Flags`
`protected String`	`Fstring`
`protected int`	`FT`
`protected String`	`H`
`protected float[]`	`IC`
`protected PdfObject`	`IF`
`protected Object[]`	`InkList`
`protected PdfObject`	`IRT`
`protected boolean`	`isXFAObject`
`protected String`	`IT`
`protected String`	`JSString`
`protected byte[][]`	`Kids`
`protected float[]`	`L`
`protected int`	`MaxLen`
`static int`	`MULTILINE_ID` 13 form flag indexes for the field flags
`static int`	`MULTISELECT_ID` 22 form flag indexes for the field flags
`protected String`	`N`
`protected String`	`NM`
`static int`	`NOEXPORT_ID` 3 form flag indexes for the field flags
`static int`	`NOTOGGLETOOFF_ID` 15 form flag indexes for the field flags
`protected PdfObject`	`OC`
`protected PdfObject`	`Off`
`protected PdfObject`	`On`
`protected Object[]`	`Opt`
`protected String[]`	`OptString`
`protected PdfObject`	`P`
`static int`	`PASSWORD_ID` 14 form flag indexes for the field flags
`static int`	`POPUP`
`protected String`	`Pstring`
`static int`	`PUSHBUTTON_ID` 17 form flag indexes for the field flags
`protected int`	`Q`
`protected float[]`	`QuadPoints`
`static int`	`RADIO_ID` 16 form flag indexes for the field flags
`static int`	`RADIOINUNISON_ID` 26 form flag indexes for the field flags
`protected byte[]`	`rawAS`
`protected byte[]`	`rawCert`
`protected byte[]`	`rawContactInfo`
`protected byte[]`	`rawContents`
`protected byte[]`	`rawDA`
`protected byte[]`	`rawDS`
`protected byte[]`	`rawDstring`
`protected byte[]`	`rawDV`
`protected byte[]`	`rawFstring`
`protected byte[]`	`rawH`
`protected byte[]`	`rawIT`
`protected byte[]`	`rawJS`
`protected byte[][]`	`rawKids`
`protected byte[]`	`rawN`
`protected byte[]`	`rawNM`
`protected byte[]`	`rawPstring`
`protected byte[]`	`rawRC`
`protected byte[]`	`rawRT`
`protected byte[]`	`rawS`
`protected byte[]`	`rawSubj`
`protected byte[]`	`rawT`
`protected byte[]`	`rawTM`
`protected byte[]`	`rawTU`
`protected byte[]`	`rawURI`
`protected byte[]`	`rawV`
`protected byte[]`	`rawX`
`protected String`	`RC`
`protected float[]`	`RD`
`static int`	`READONLY_ID` 1 form flag indexes for the field flags
`protected float[]`	`Rect`
`protected Object[]`	`Reference`
`static int`	`REQUIRED_ID` 2 form flag indexes for the field flags
`protected PdfObject`	`RichMediaContent`
`static int`	`RICHTEXT_ID` 26 form flag indexes for the field flags
`protected String`	`S`
`protected int[]`	`selectionIndices`
`static int`	`SORT_ID` 20 form flag indexes for the field flags
`protected String`	`Subj`
`protected String`	`T`
`protected int`	`TI`
`protected String`	`TM`
`protected String`	`TU`
`protected String`	`URI`
`protected float[]`	`Vertices`
`protected String`	`Vstring`
`protected int`	`W`

Fields inherited from class org.jpedal.objects.raw.PdfObject
Collection, colorspace, ColorSpace, DECODED, DecodeParms, Encoding, Function, generalType, hasStream, includeParent, isDataExternal, isFullyResolved, isSymbol, isZapfDingbats, maybeIndirect, pageNumber, Params, parentType, ref, Resources, Shading, SMask, stream, subtype, type, UNDECODED_DIRECT, UNDECODED_REF

Constructor Summary

Constructors
Constructor and Description
`FormObject()`
`FormObject(int type)`
`FormObject(int ref, int gen)`
`FormObject(String ref)`
`FormObject(String ref, boolean flag)`
`FormObject(String ref, int parentType)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`buttonGetCaption()` oldJS JS returns the normal caption associated to this button
`String`	`buttonGetCaption(int nFace)` oldJS returns the caption associated with this button,
`void`	`buttonSetCaption(String cCaption)` oldJS sets this buttons normal caption to cCaption
`void`	`buttonSetCaption(String cCaption, int nFace)` oldJS sets this buttons caption to cCaption, it sets the caption defined by nFace.
`protected void`	`commandFf(int flagValue)` read and setup the form flags for the Ff entry field is the data to be used to setup the Ff flags
`void`	`copyInheritedValuesFromParent(FormObject parentObj)` overwrites all the values on this form with any values from the parent
`boolean`	`decompressStreamWhenRead()`
`PdfObject`	`duplicate()`
`static Color`	`generateColor(float[] toks)` takes a value, and turns it into the color it represents e.g.
`int`	`getActionFlag()` get status found during decode
`int`	`getAlignment()` returns the alignment (Q)
`BufferedImage`	`getAPImage(int type, int key)` Get AP image Type should be PdfDictionary.On or PdfDictionary.Off key should be PdfDictionary.N, PdfDictionary.D, PdfDictionary.R
`boolean`	`getBoolean(int id)`
`Rectangle2D`	`getBounding2DRectangleForTabbing()` This method should be called only in tabbing functionality
`Rectangle`	`getBoundingRectangle()` return the bounding rectangle for this object
`boolean[]`	`getCharacteristics()`
`float`	`getCurrentScaling()`
`PdfObject`	`getDictionary(int id)`
`BufferedImage`	`getDownOffImage()`
`BufferedImage`	`getDownOnImage()`
`int`	`getElemRotationDegree()` returns the complete form rotation degree with reserve value
`boolean[]`	`getFieldFlags()` returns the flags array (Ff in PDF) (indexs are the number listed) * all 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.
`Object`	`getfillColor()` oldJS returns the background color for the annotation objects
`float[]`	`getFloatArray(int id)`
`String`	`getFontName()`
`float`	`getFontSize()` Method to get the font size to be used in the form component This is currently only implemented for text pop-up forms
`int`	`getFormType()` look at FormFactory.LIST etc for full list of types
`Object`	`getFormValue()`
`Object`	`getGUIComponent()`
`String`	`getHTMLElementId()`
`int`	`getInt(int id)`
`int[]`	`getIntArray(int id)`
`String[]`	`getItemsList()`
`byte[][]`	`getKeyArray(int id)`
`String`	`getLastValidValue()` used by JS to reset
`String`	`getLayerName()`
`int[]`	`getMatteBorderDetails()` Method returns matte border details of Form (not all surrounding element)
`PdfArrayIterator`	`getMixedArray(int id)`
`String`	`getName(int id)`
`int`	`getNameAsConstant(int id)`
`BufferedImage`	`getNormalOffImage()`
`BufferedImage`	`getNormalOnImage()`
`String`	`getNormalOnState()`
`Object[]`	`getObjectArray(int id)`
`static BufferedImage`	`getOpaqueImage()` returns an Opaque BufferedImage for use when appearance Streams are null
`PdfObject`	`getParentPdfObj()`
`String`	`getParentRef()` gets the parent for this field
`byte[][]`	`getRawKids()`
`BufferedImage`	`getRolloverOffImage()`
`BufferedImage`	`getRolloverOnImage()`
`int`	`getRotationOriginX()`
`int`	`getRotationOriginY()`
`int`	`getSelectedIndex()`
`String`	`getSelectedItem()`
`int[]`	`getSelectionIndices()`
`Color`	`getTextColor()`
`Font`	`getTextFont()`
`int`	`getTextPosition()`
`int`	`getTextSize()`
`String`	`getTextStreamValue(int id)`
`byte[]`	`getTextStreamValueAsByte(int id)`
`String`	`getTextString()`
`String`	`getValue()` 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
`Map<String,String>`	`getValuesMap(boolean keyFirst)`
`boolean`	`hasDownImage()` returns true if has one or more down images set
`boolean`	`hasDownOff()` returns true if has down off image
`boolean`	`hasInvertDownIcon()`
`boolean`	`hasNoDownIcon()`
`boolean`	`hasNormalOff()` returns true if has normal of image
`boolean`	`hasOffsetDownIcon()`
`boolean`	`hasRolloverOff()` returns true if has rollover off image
`boolean`	`isAppearanceUsed()`
`boolean`	`isReadOnly()`
`boolean`	`isSelected()`
`boolean`	`isXFAObject()` returns true if this formObject represents an XFAObject
`void`	`overwriteWith(FormObject form)` copy all values from form to this FormObject WARNING overrites current data, so shoudl be called before the rest of the form is setup.
`void`	`setActionFlag(int popup)` used internally to set status while parsing - should not be called
`void`	`setAppreancesUsed(boolean used)`
`void`	`setBackgroundColor(String nextField)` sets the background color for this form
`void`	`setBoolean(int id, boolean value)`
`void`	`setBorderColor(String nextField)` sets the border color
`void`	`setBorderWidth(int width)` oldJs added for backward compatibility or old adobe files.
`void`	`setCharactersitics(int pos, boolean value)`
`void`	`setCurrentScaling(float scale)` Set the scaling for the formObject this is only used for the locations of forms that can move such as Text Popups
`void`	`setDictionary(int id, PdfObject value)`
`void`	`setElemRotationDegree(int elemRotationDegree)`
`void`	`setFieldFlags(int pos, boolean value)`
`void`	`setFieldName(String field)` sets the field name for this field (used by XFA)
`void`	`setfillColor(float[] newColor)` oldJS sets our background color to the color specified
`void`	`setfillColor(Object newColor)` oldJS sets the fillcolor, or background color using the string defined from javascript rhino parser
`void`	`setFlag(int pos, boolean flag)` sets the flag pos to value of flag
`void`	`setFloatArray(int id, float[] value)`
`void`	`setFontName(String font)` set the text font for this form
`void`	`setFormType(int widgetType)`
`void`	`setGUIComponent(Object guiComp, int guiType)`
`void`	`setHTMLElementId(String htmlElementId)`
`void`	`setIntArray(int id, int[] value)`
`void`	`setIntNumber(int id, int value)`
`protected void`	`setInvertForDownIcon()` sets whether to invert the normal icon for the down icon
`void`	`setKeyArray(int id, byte[][] value)`
`void`	`setLastValidValue(String value)` used by JS to reset
`void`	`setLineWidth(int lineWidth)` oldJs defines the thickness of the border when stroking.
`void`	`setMatteBorderDetails(int[] matteDetails)` set matte border details if it is specified in pdf or xfa
`void`	`setMixedArray(int id, byte[][] value)`
`void`	`setName(int id, byte[] value)`
`protected void`	`setNoDownIcon()` sets whether a down icon should be used
`void`	`setNormalCaption(String caption)` sets the normal caption for this form
`void`	`setNormalOnState(String state)` 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
`void`	`setObjectArray(int id, Object[] objectValues)`
`protected void`	`setOffsetDownApp()` sets whether there should be a down looking icon
`void`	`setPageRotation(int rotation)`
`void`	`setParent(String parent)` sets the parent for this field
`void`	`setParent(String parent, FormObject parentObj, boolean copyValuesFromParent)` sets the parent string for this field and stores the parent PDFObject passed in to be accessed locally and from getParent() BEWARE :- this method will copy all relevent values from the parent is copyValuesFromParent is true
`void`	`setParentPdfObj(PdfObject parent)`
`void`	`setRawKids(byte[][] kidsInParent)`
`void`	`setRotationOriginX(int rotationOriginX)`
`void`	`setRotationOriginY(int rotationOriginY)` set the complete form rotation degree with reserve value
`void`	`setSelected(boolean setSelected)`
`void`	`setSelectedIndex(int index)` update value if ComboBox
`void`	`setSelectedItem(String value)` update value if ComboBox
`void`	`setSelection(Object[] selectedValues, String curValue, int[] indices, int index)` sets the selected item only applicable to the choices fields
`void`	`setTextColor(float[] color)` sets the text color for this form
`void`	`setTextFont(Font font)` set the text font for this form
`void`	`setTextSize(int size)` sets the text size for this form
`void`	`setTextStreamValue(int id, byte[] value)`
`void`	`setTextStreamValue(int id, String value)`
`void`	`setTextValue(String text)` sets the text value
`void`	`setType(int type, boolean isXFA)` sets the type this form specifies
`void`	`setUserSetOffset(Point offset)` Allows the user to set an offset for form components This is mainly used for movable form components such as text popups
`void`	`setValue(String inVal)` oldJS sets the value of this field dependent on which type of field it is
`void`	`setVisible(boolean isVisible)`
`void`	`updateValue(Object value, boolean isSelected, boolean sync)` allow us to update value (and sync to GUI version if exists

Methods inherited from class org.jpedal.objects.raw.PdfObject
deepCopy, deepCopy, deepCopy, deepCopy, deepCopy, getBooleanArray, getByteArray, getCachedStreamFile, getCacheName, getClip, getConvertedData, getDecodedStream, getDoubleArray, getFloatNumber, getGeneralStringValue, getGeneralType, getID, getId, getKeyPairsIterator, getObjectRefAsString, getObjectRefGeneration, getObjectRefID, getObjectType, getPageNumber, getParameterConstant, getParentID, getPDFkeyInt, getRawName, getRawObjectType, getStatus, getStringArray, getStringKey, getStringValue, getStringValueAsByte, getUnresolvedData, hasStream, ignoreRecursion, ignoreRecursion, ignoreStream, ignoreStream, isCached, isCompressedStream, isDataExternal, isDataExternal, isFullyResolved, isInCompressedStream, maybeIndirect, maybeIndirect, moveCacheValues, setBooleanArray, setCache, setClip, setCompressedStream, setConstant, setConstant, setConvertedData, setDecodedStream, setDictionaryPairs, setDoubleArray, setFloatNumber, setFullyResolved, setGeneralStringValue, setID, setInCompressedStream, setInternalReference, setPageNumber, setRef, setRef, setStatus, setStream, setStreamMayBeCorrupt, setStringArray, setStringKey, setUnresolvedData, streamMayBeCorrupt, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - READONLY_ID
```
public static final int READONLY_ID
```
    1 form flag indexes for the field flags
    
    See Also:
    
    Constant Field Values
  - REQUIRED_ID
```
public static final int REQUIRED_ID
```
    2 form flag indexes for the field flags
    
    See Also:
    
    Constant Field Values
  - NOEXPORT_ID
```
public static final int NOEXPORT_ID
```
    3 form flag indexes for the field flags
    
    See Also:
    
    Constant Field Values
  - MULTILINE_ID
```
public static final int MULTILINE_ID
```
    13 form flag indexes for the field flags
    
    See Also:
    
    Constant Field Values
  - PASSWORD_ID
```
public static final int PASSWORD_ID
```
    14 form flag indexes for the field flags
    
    See Also:
    
    Constant Field Values
  - NOTOGGLETOOFF_ID
```
public static final int NOTOGGLETOOFF_ID
```
    15 form flag indexes for the field flags
    
    See Also:
    
    Constant Field Values
  - RADIO_ID
```
public static final int RADIO_ID
```
    16 form flag indexes for the field flags
    
    See Also:
    
    Constant Field Values
  - PUSHBUTTON_ID
```
public static final int PUSHBUTTON_ID
```
    17 form flag indexes for the field flags
    
    See Also:
    
    Constant Field Values
  - COMBO_ID
```
public static final int COMBO_ID
```
    18 form flag indexes for the field flags
    
    See Also:
    
    Constant Field Values
  - EDIT_ID
```
public static final int EDIT_ID
```
    19 form flag indexes for the field flags
    
    See Also:
    
    Constant Field Values
  - SORT_ID
```
public static final int SORT_ID
```
    20 form flag indexes for the field flags
    
    See Also:
    
    Constant Field Values
  - FILESELECT_ID
```
public static final int FILESELECT_ID
```
    21 form flag indexes for the field flags
    
    See Also:
    
    Constant Field Values
  - MULTISELECT_ID
```
public static final int MULTISELECT_ID
```
    22 form flag indexes for the field flags
    
    See Also:
    
    Constant Field Values
  - DONOTSPELLCHECK_ID
```
public static final int DONOTSPELLCHECK_ID
```
    23 form flag indexes for the field flags
    
    See Also:
    
    Constant Field Values
  - DONOTSCROLL_ID
```
public static final int DONOTSCROLL_ID
```
    24 form flag indexes for the field flags
    
    See Also:
    
    Constant Field Values
  - COMB_ID
```
public static final int COMB_ID
```
    25 form flag indexes for the field flags
    
    See Also:
    
    Constant Field Values
  - RICHTEXT_ID
```
public static final int RICHTEXT_ID
```
    26 form flag indexes for the field flags
    
    See Also:
    
    Constant Field Values
  - RADIOINUNISON_ID
```
public static final int RADIOINUNISON_ID
```
    26 form flag indexes for the field flags
    
    See Also:
    
    Constant Field Values
  - COMMITONSELCHANGE_ID
```
public static final int COMMITONSELCHANGE_ID
```
    27 form flag indexes for the field flags
    
    See Also:
    
    Constant Field Values
  - OptString
```
protected String[] OptString
```
  - isXFAObject
```
protected boolean isXFAObject
```
  - POPUP
```
public static final int POPUP
```
    See Also:
    
    Constant Field Values
  - BBox
```
protected Rectangle BBox
```
  - C
```
protected float[] C
```
  - IC
```
protected float[] IC
```
  - QuadPoints
```
protected float[] QuadPoints
```
  - RD
```
protected float[] RD
```
  - Rect
```
protected float[] Rect
```
  - L
```
protected float[] L
```
  - Vertices
```
protected float[] Vertices
```
  - flags
```
protected boolean[] flags
```
  - F
```
protected int F
```
  - Ff
```
protected int Ff
```
  - MaxLen
```
protected int MaxLen
```
  - W
```
protected int W
```
  - Q
```
protected int Q
```
  - TI
```
protected int TI
```
  - A
```
protected PdfObject A
```
  - AA
```
protected PdfObject AA
```
  - AP
```
protected PdfObject AP
```
  - Cdict
```
protected PdfObject Cdict
```
  - BS
```
protected PdfObject BS
```
  - D
```
protected PdfObject D
```
  - IF
```
protected PdfObject IF
```
  - IRT
```
protected PdfObject IRT
```
  - RichMediaContent
```
protected PdfObject RichMediaContent
```
  - Flags
```
protected int Flags
```
  - ByteRange
```
protected int[] ByteRange
```
  - selectionIndices
```
protected int[] selectionIndices
```
  - rawAS
```
protected byte[] rawAS
```
  - rawCert
```
protected byte[] rawCert
```
  - rawContactInfo
```
protected byte[] rawContactInfo
```
  - rawContents
```
protected byte[] rawContents
```
  - rawDstring
```
protected byte[] rawDstring
```
  - rawDA
```
protected byte[] rawDA
```
  - rawDS
```
protected byte[] rawDS
```
  - rawDV
```
protected byte[] rawDV
```
  - rawFstring
```
protected byte[] rawFstring
```
  - rawJS
```
protected byte[] rawJS
```
  - rawH
```
protected byte[] rawH
```
  - rawIT
```
protected byte[] rawIT
```
  - rawN
```
protected byte[] rawN
```
  - rawNM
```
protected byte[] rawNM
```
  - rawPstring
```
protected byte[] rawPstring
```
  - rawRC
```
protected byte[] rawRC
```
  - rawRT
```
protected byte[] rawRT
```
  - rawS
```
protected byte[] rawS
```
  - rawSubj
```
protected byte[] rawSubj
```
  - rawT
```
protected byte[] rawT
```
  - rawTM
```
protected byte[] rawTM
```
  - rawTU
```
protected byte[] rawTU
```
  - rawURI
```
protected byte[] rawURI
```
  - rawV
```
protected byte[] rawV
```
  - rawX
```
protected byte[] rawX
```
  - FT
```
protected int FT
```
  - AS
```
protected String AS
```
  - Cert
```
protected String Cert
```
  - ContactInfo
```
protected String ContactInfo
```
  - Contents
```
protected String Contents
```
  - Dstring
```
protected String Dstring
```
  - DA
```
protected String DA
```
  - DSString
```
protected String DSString
```
  - DV
```
protected String DV
```
  - Fstring
```
protected String Fstring
```
  - JSString
```
protected String JSString
```
  - H
```
protected String H
```
  - IT
```
protected String IT
```
  - N
```
protected String N
```
  - NM
```
protected String NM
```
  - Pstring
```
protected String Pstring
```
  - RC
```
protected String RC
```
  - S
```
protected String S
```
  - Subj
```
protected String Subj
```
  - T
```
protected String T
```
  - TM
```
protected String TM
```
  - TU
```
protected String TU
```
  - URI
```
protected String URI
```
  - Vstring
```
protected String Vstring
```
  - Bl
```
protected PdfObject Bl
```
  - OC
```
protected PdfObject OC
```
  - Off
```
protected PdfObject Off
```
  - On
```
protected PdfObject On
```
  - P
```
protected PdfObject P
```
  - CO
```
protected Object[] CO
```
  - InkList
```
protected Object[] InkList
```
  - Opt
```
protected Object[] Opt
```
  - Reference
```
protected Object[] Reference
```
  - Kids
```
protected byte[][] Kids
```
  - rawKids
```
protected byte[][] rawKids
```
- Constructor Detail
  - FormObject
```
public FormObject(String ref)
```
  - FormObject
```
public FormObject(String ref,
                  boolean flag)
```
  - FormObject
```
public FormObject(int ref,
                  int gen)
```
  - FormObject
```
public FormObject(int type)
```
  - FormObject
```
public FormObject()
```
  - FormObject
```
public FormObject(String ref,
                  int parentType)
```
- Method Detail
  - setHTMLElementId
```
public void setHTMLElementId(String htmlElementId)
```
  - getHTMLElementId
```
public String getHTMLElementId()
```
  - getBoolean
```
public boolean getBoolean(int id)
```
    Overrides:
    
    getBoolean in class PdfObject
  - setBoolean
```
public void setBoolean(int id,
                       boolean value)
```
    Overrides:
    
    setBoolean in class PdfObject
  - setActionFlag
```
public void setActionFlag(int popup)
```
    used internally to set status while parsing - should not be called
    
    Parameters:
    
    popup -
  - getActionFlag
```
public int getActionFlag()
```
    get status found during decode
  - getDictionary
```
public PdfObject getDictionary(int id)
```
    Overrides:
    
    getDictionary in class PdfObject
  - setIntNumber
```
public void setIntNumber(int id,
                         int value)
```
    Overrides:
    
    setIntNumber in class PdfObject
  - getInt
```
public int getInt(int id)
```
    Overrides:
    
    getInt in class PdfObject
  - setDictionary
```
public void setDictionary(int id,
                          PdfObject value)
```
    Overrides:
    
    setDictionary in class PdfObject
  - getNameAsConstant
```
public int getNameAsConstant(int id)
```
    Overrides:
    
    getNameAsConstant in class PdfObject
  - getMixedArray
```
public PdfArrayIterator getMixedArray(int id)
```
    Overrides:
    
    getMixedArray in class PdfObject
  - getTextStreamValueAsByte
```
public byte[] getTextStreamValueAsByte(int id)
```
    Overrides:
    
    getTextStreamValueAsByte in class PdfObject
  - getIntArray
```
public int[] getIntArray(int id)
```
    Overrides:
    
    getIntArray in class PdfObject
  - setIntArray
```
public void setIntArray(int id,
                        int[] value)
```
    Overrides:
    
    setIntArray in class PdfObject
  - setMixedArray
```
public void setMixedArray(int id,
                          byte[][] value)
```
    Overrides:
    
    setMixedArray in class PdfObject
  - getFloatArray
```
public float[] getFloatArray(int id)
```
    Overrides:
    
    getFloatArray in class PdfObject
  - setFloatArray
```
public void setFloatArray(int id,
                          float[] value)
```
    Overrides:
    
    setFloatArray in class PdfObject
  - setName
```
public void setName(int id,
                    byte[] value)
```
    Overrides:
    
    setName in class PdfObject
  - setObjectArray
```
public void setObjectArray(int id,
                           Object[] objectValues)
```
    Overrides:
    
    setObjectArray in class PdfObject
  - getObjectArray
```
public Object[] getObjectArray(int id)
```
    Overrides:
    
    getObjectArray in class PdfObject
  - setTextStreamValue
```
public void setTextStreamValue(int id,
                               byte[] value)
```
    Overrides:
    
    setTextStreamValue in class PdfObject
  - setTextStreamValue
```
public void setTextStreamValue(int id,
                               String value)
```
    Overrides:
    
    setTextStreamValue in class PdfObject
  - getName
```
public String getName(int id)
```
    Overrides:
    
    getName in class PdfObject
  - getTextStreamValue
```
public String getTextStreamValue(int id)
```
    Overrides:
    
    getTextStreamValue in class PdfObject
  - getKeyArray
```
public byte[][] getKeyArray(int id)
```
    Overrides:
    
    getKeyArray in class PdfObject
  - setKeyArray
```
public void setKeyArray(int id,
                        byte[][] value)
```
    Overrides:
    
    setKeyArray in class PdfObject
  - decompressStreamWhenRead
```
public boolean decompressStreamWhenRead()
```
    Overrides:
    
    decompressStreamWhenRead in class PdfObject
  - commandFf
```
protected void commandFf(int flagValue)
```
    read and setup the form flags for the Ff entry field is the data to be used to setup the Ff flags
  - generateColor
```
public static Color generateColor(float[] toks)
```
    takes a value, and turns it into the color it represents e.g. (0.5) represents gray (127,127,127) grey = array length 1, with one value rgb = array length 3, in the order of red,green,blue cmyk = array length 4, in the reverse order, (ie. k, y, m, c)
  - isXFAObject
```
public boolean isXFAObject()
```
    returns true if this formObject represents an XFAObject
  - duplicate
```
public PdfObject duplicate()
```
    Overrides:
    
    duplicate in class PdfObject
  - copyInheritedValuesFromParent
```
public void copyInheritedValuesFromParent(FormObject parentObj)
```
    overwrites all the values on this form with any values from the parent
  - getAlignment
```
public int getAlignment()
```
    returns the alignment (Q)
  - setTextColor
```
public void setTextColor(float[] color)
```
    sets the text color for this form
  - setFontName
```
public void setFontName(String font)
```
    set the text font for this form
  - setTextFont
```
public void setTextFont(Font font)
```
    set the text font for this form
  - setTextSize
```
public void setTextSize(int size)
```
    sets the text size for this form
  - setTextValue
```
public void setTextValue(String text)
```
    sets the text value
  - setSelection
```
public void setSelection(Object[] selectedValues,
                         String curValue,
                         int[] indices,
                         int index)
```
    sets the selected item only applicable to the choices fields
  - setFieldName
```
public void setFieldName(String field)
```
    sets the field name for this field (used by XFA)
  - setParent
```
public void setParent(String parent)
```
    sets the parent for this field
  - setParent
```
public void setParent(String parent,
                      FormObject parentObj,
                      boolean copyValuesFromParent)
```
    sets the parent string for this field and stores the parent PDFObject passed in to be accessed locally and from getParent() BEWARE :- this method will copy all relevent values from the parent is copyValuesFromParent is true
  - getParentPdfObj
```
public PdfObject getParentPdfObj()
```
  - setParentPdfObj
```
public void setParentPdfObj(PdfObject parent)
```
  - getParentRef
```
public String getParentRef()
```
    gets the parent for this field
  - getBounding2DRectangleForTabbing
```
public Rectangle2D getBounding2DRectangleForTabbing()
```
    This method should be called only in tabbing functionality
    
    Returns:
  - getBoundingRectangle
```
public Rectangle getBoundingRectangle()
```
    return the bounding rectangle for this object
  - setType
```
public void setType(int type,
                    boolean isXFA)
```
    sets the type this form specifies
  - setFlag
```
public void setFlag(int pos,
                    boolean flag)
```
    sets the flag pos to value of flag
  - getFieldFlags
```
public boolean[] getFieldFlags()
```
    returns the flags array (Ff in PDF) (indexs are the number listed) * all
    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)
  - setFieldFlags
```
public void setFieldFlags(int pos,
                          boolean value)
```
  - setNormalOnState
```
public void setNormalOnState(String state)
```
    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
  - isAppearanceUsed
```
public boolean isAppearanceUsed()
```
    Returns:
    
    whether or not appearances are used in this field
  - setAppreancesUsed
```
public void setAppreancesUsed(boolean used)
```
  - setBorderColor
```
public void setBorderColor(String nextField)
```
    sets the border color
  - setBackgroundColor
```
public void setBackgroundColor(String nextField)
```
    sets the background color for this form
  - setNormalCaption
```
public void setNormalCaption(String caption)
```
    sets the normal caption for this form
  - setOffsetDownApp
```
protected void setOffsetDownApp()
```
    sets whether there should be a down looking icon
  - setNoDownIcon
```
protected void setNoDownIcon()
```
    sets whether a down icon should be used
  - setInvertForDownIcon
```
protected void setInvertForDownIcon()
```
    sets whether to invert the normal icon for the down icon
  - hasNormalOff
```
public boolean hasNormalOff()
```
    returns true if has normal of image
  - hasRolloverOff
```
public boolean hasRolloverOff()
```
    returns true if has rollover off image
  - hasDownOff
```
public boolean hasDownOff()
```
    returns true if has down off image
  - hasDownImage
```
public boolean hasDownImage()
```
    returns true if has one or more down images set
  - overwriteWith
```
public void overwriteWith(FormObject form)
```
    copy all values from form to this FormObject WARNING overrites current data, so shoudl be called before the rest of the form is setup.
  - getCharacteristics
```
public boolean[] getCharacteristics()
```
    Returns:
    
    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
  - setCharactersitics
```
public void setCharactersitics(int pos,
                               boolean value)
```
  - getTextSize
```
public int getTextSize()
```
    Returns:
    
    the default text size for this field
  - getValuesMap
```
public Map<String,String> getValuesMap(boolean keyFirst)
```
    Returns:
    
    the values map for this field, map that references the display value from the export values
  - getItemsList
```
public String[] getItemsList()
```
    Returns:
    
    the available items for this list or combo
  - getSelectedItem
```
public String getSelectedItem()
```
    Returns:
    
    the selected Item for this field
  - getSelectionIndices
```
public int[] getSelectionIndices()
```
    Returns:
    
    the top index, or item that is visible in the combobox or list first.
  - getTextString
```
public String getTextString()
```
    Returns:
    
    the text string for this field - if no value set but a default (DV value) set, return that.
  - getTextPosition
```
public int getTextPosition()
```
    Returns:
    
    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
  - getNormalOnState
```
public String getNormalOnState()
```
    Returns:
    
    the normal on state for this field
  - getNormalOffImage
```
public BufferedImage getNormalOffImage()
```
    Returns:
    
    the normal off image for this field
  - getNormalOnImage
```
public BufferedImage getNormalOnImage()
```
    Returns:
    
    the normal On image for this field
  - getAPImage
```
public BufferedImage getAPImage(int type,
                                int key)
```
    Get AP image Type should be PdfDictionary.On or PdfDictionary.Off key should be PdfDictionary.N, PdfDictionary.D, PdfDictionary.R
    
    Returns:
    
    the normal off image for this field
  - hasNoDownIcon
```
public boolean hasNoDownIcon()
```
    Returns:
    
    if this field has not got a down icon
  - hasOffsetDownIcon
```
public boolean hasOffsetDownIcon()
```
    Returns:
    
    whether this field has a down icon as an offset of the normal icon
  - hasInvertDownIcon
```
public boolean hasInvertDownIcon()
```
    Returns:
    
    whether this field has a down icon as an inverted image of the normal icon
  - getDownOffImage
```
public BufferedImage getDownOffImage()
```
    Returns:
    
    the down off image for this field
  - getDownOnImage
```
public BufferedImage getDownOnImage()
```
    Returns:
    
    the down on image for this field
  - getRolloverOffImage
```
public BufferedImage getRolloverOffImage()
```
    Returns:
    
    the rollover image for this field, the image displayed when the user moves the mouse over the field
  - getRolloverOnImage
```
public BufferedImage getRolloverOnImage()
```
    Returns:
    
    the rollover on image, the image displayed when the user moves the mouse over the field, when in the on state
  - getTextFont
```
public Font getTextFont()
```
    Returns:
    
    the text font for this field
  - getFontName
```
public String getFontName()
```
  - getTextColor
```
public Color getTextColor()
```
    Returns:
    
    the text color for this field
  - getLayerName
```
public String getLayerName()
```
    Returns:
  - getValue
```
public String getValue()
```
    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
    
    Returns:
  - setValue
```
public void setValue(String inVal)
```
    oldJS sets the value of this field dependent on which type of field it is
  - setLineWidth
```
public void setLineWidth(int lineWidth)
```
    oldJs defines the thickness of the border when stroking.
  - setBorderWidth
```
public void setBorderWidth(int width)
```
    oldJs added for backward compatibility or old adobe files.
  - setUserSetOffset
```
public void setUserSetOffset(Point offset)
```
    Allows the user to set an offset for form components This is mainly used for movable form components such as text popups
    
    Parameters:
    
    offset - : The offset from the components location from the pdf
  - setCurrentScaling
```
public void setCurrentScaling(float scale)
```
    Set the scaling for the formObject this is only used for the locations of forms that can move such as Text Popups
    
    Parameters:
    
    scale - : Current scaling to be used
  - getCurrentScaling
```
public float getCurrentScaling()
```
  - buttonGetCaption
```
public String buttonGetCaption()
```
    oldJS JS returns the normal caption associated to this button
  - buttonGetCaption
```
public String buttonGetCaption(int nFace)
```
    oldJS returns the caption associated with this button,
    
    Parameters:
    
    nFace - - 0 normal caption (default) 1 down caption 2 rollover caption
  - buttonSetCaption
```
public void buttonSetCaption(String cCaption)
```
    oldJS sets this buttons normal caption to cCaption
  - buttonSetCaption
```
public void buttonSetCaption(String cCaption,
                             int nFace)
```
    oldJS sets this buttons caption to cCaption, it sets the caption defined by nFace.
    
    Parameters:
    
    nFace - - 0 (default) normal caption 1 down caption 2 rollover caption
  - getfillColor
```
public Object getfillColor()
```
    oldJS returns the background color for the annotation objects
  - setfillColor
```
public void setfillColor(float[] newColor)
```
    oldJS sets our background color to the color specified
  - setfillColor
```
public void setfillColor(Object newColor)
```
    oldJS sets the fillcolor, or background color using the string defined from javascript rhino parser
  - setFormType
```
public void setFormType(int widgetType)
```
  - getFormType
```
public int getFormType()
```
    look at FormFactory.LIST etc for full list of types
  - getOpaqueImage
```
public static BufferedImage getOpaqueImage()
```
    returns an Opaque BufferedImage for use when appearance Streams are null
  - setGUIComponent
```
public void setGUIComponent(Object guiComp,
                            int guiType)
```
  - getGUIComponent
```
public Object getGUIComponent()
```
  - isReadOnly
```
public boolean isReadOnly()
```
  - updateValue
```
public void updateValue(Object value,
                        boolean isSelected,
                        boolean sync)
```
    allow us to update value (and sync to GUI version if exists
  - isSelected
```
public boolean isSelected()
```
  - setSelected
```
public void setSelected(boolean setSelected)
```
  - getSelectedIndex
```
public int getSelectedIndex()
```
  - setSelectedIndex
```
public void setSelectedIndex(int index)
```
    update value if ComboBox
    
    Parameters:
    
    index -
  - setSelectedItem
```
public void setSelectedItem(String value)
```
    update value if ComboBox
    
    Parameters:
    
    value -
  - getFontSize
```
public float getFontSize()
```
    Method to get the font size to be used in the form component This is currently only implemented for text pop-up forms
    
    Returns:
    
    The base size to be used in the form component
  - getFormValue
```
public Object getFormValue()
```
  - getLastValidValue
```
public String getLastValidValue()
```
    used by JS to reset
    
    Returns:
  - setLastValidValue
```
public void setLastValidValue(String value)
```
    used by JS to reset
  - setPageRotation
```
public void setPageRotation(int rotation)
```
  - setVisible
```
public void setVisible(boolean isVisible)
```
  - getRotationOriginX
```
public int getRotationOriginX()
```
    Returns:
    
    the rotationOriginX
  - setRotationOriginX
```
public void setRotationOriginX(int rotationOriginX)
```
    Parameters:
    
    rotationOriginX - the rotationOriginX to set
  - getRotationOriginY
```
public int getRotationOriginY()
```
    Returns:
    
    the rotationOriginY
  - setRotationOriginY
```
public void setRotationOriginY(int rotationOriginY)
```
    set the complete form rotation degree with reserve value
    
    Parameters:
    
    rotationOriginY - the rotationOriginY to set
  - getElemRotationDegree
```
public int getElemRotationDegree()
```
    returns the complete form rotation degree with reserve value
    
    Returns:
    
    the elemRotationDegree
  - setElemRotationDegree
```
public void setElemRotationDegree(int elemRotationDegree)
```
    Parameters:
    
    elemRotationDegree - the elemRotationDegree to set
  - setMatteBorderDetails
```
public void setMatteBorderDetails(int[] matteDetails)
```
    set matte border details if it is specified in pdf or xfa
    
    Parameters:
    
    matteDetails -
  - getMatteBorderDetails
```
public int[] getMatteBorderDetails()
```
    Method returns matte border details of Form (not all surrounding element)
    
    Returns:
  - setRawKids
```
public void setRawKids(byte[][] kidsInParent)
```
  - getRawKids
```
public byte[][] getRawKids()
```

Class FormObject

Field Summary

Fields inherited from class org.jpedal.objects.raw.PdfObject

Constructor Summary

Method Summary

Methods inherited from class org.jpedal.objects.raw.PdfObject

Methods inherited from class java.lang.Object

Field Detail

READONLY_ID

REQUIRED_ID

NOEXPORT_ID

MULTILINE_ID

PASSWORD_ID

NOTOGGLETOOFF_ID

RADIO_ID

PUSHBUTTON_ID

COMBO_ID

EDIT_ID

SORT_ID

FILESELECT_ID

MULTISELECT_ID

DONOTSPELLCHECK_ID

DONOTSCROLL_ID

COMB_ID

RICHTEXT_ID

RADIOINUNISON_ID

COMMITONSELCHANGE_ID

OptString

isXFAObject

POPUP

BBox

C

IC

QuadPoints

RD

Rect

L

Vertices

flags

F

Ff

MaxLen

W

Q

TI

A

AA

AP

Cdict

BS

D

IF

IRT

RichMediaContent

Flags

ByteRange

selectionIndices

rawAS

rawCert

rawContactInfo

rawContents

rawDstring

rawDA

rawDS

rawDV

rawFstring

rawJS

rawH

rawIT

rawN

rawNM

rawPstring

rawRC

rawRT

rawS

rawSubj

rawT

rawTM

rawTU

rawURI