Package | org.purepdf.pdf.forms |
Class | public class PdfFormField |
Inheritance | PdfFormField PdfAnnotation PdfDictionary PdfObject it.sephiroth.utils.ObjectHash |
Property | Defined By | ||
---|---|---|---|
action : PdfAction [write-only] | PdfAnnotation | ||
_annotation : Boolean = true | PdfAnnotation | ||
annotation : Boolean | PdfAnnotation | ||
appearanceState : String [write-only] | PdfAnnotation | ||
borderStyle : PdfBorderDictionary [write-only] | PdfAnnotation | ||
color : RGBColor [write-only] | PdfAnnotation | ||
defaultAppearanceString : PdfContentByte [write-only] | PdfAnnotation | ||
defaultValueAsName : String [write-only] | PdfFormField | ||
defaultValueAsString : String [write-only] | PdfFormField | ||
fieldFlags : int [write-only] | PdfFormField | ||
fieldName : String [write-only] | PdfFormField | ||
flags : int [write-only] | PdfAnnotation | ||
form : Boolean | PdfAnnotation | ||
indirectReference : PdfIndirectReference [read-only]
Returns an indirect reference to the annotation
| PdfAnnotation | ||
isAnnotation : Boolean [read-only] | PdfAnnotation | ||
isForm : Boolean [read-only] | PdfAnnotation | ||
kids : Vector.<PdfFormField> [read-only] | PdfFormField | ||
mappingName : String [write-only] | PdfFormField | ||
mkAlternateCaption : String [write-only] | PdfFormField | ||
mkAlternateIcon : PdfTemplate [write-only] | PdfFormField | ||
mkBackgroundColor : RGBColor [write-only] | PdfAnnotation | ||
mkBorderColor : RGBColor [write-only] | PdfAnnotation | ||
mkNormalCaption : String [write-only] | PdfFormField | ||
mkNormalIcon : PdfTemplate [write-only] | PdfFormField | ||
mkRolloverCaption : String [write-only] | PdfFormField | ||
mkRolloverIcon : PdfTemplate [write-only] | PdfFormField | ||
mkRotation : int [write-only] | PdfAnnotation | ||
mkTextPosition : int [write-only] | PdfFormField | ||
parent : PdfFormField | PdfFormField | ||
placeInPage : int [read-only] | PdfAnnotation | ||
popup : PdfAnnotation [write-only] | PdfAnnotation | ||
quadding : int [write-only] | PdfFormField | ||
size : int [read-only] | PdfDictionary | ||
_templates : HashMap | PdfAnnotation | ||
templates : HashMap | PdfAnnotation | ||
userName : String [write-only] | PdfFormField | ||
valueAsName : String [write-only] | PdfFormField | ||
valueAsString : String [write-only] | PdfFormField | ||
writer : PdfWriter | PdfAnnotation |
Property | Defined By | ||
---|---|---|---|
bytes : Bytes | PdfObject | ||
dictionaryType : PdfName | PdfDictionary | ||
_form : Boolean = false | PdfAnnotation | ||
hashMap : HashMap | PdfDictionary | ||
indRef : PRIndirectReference | PdfObject | ||
_kids : Vector.<PdfFormField> | PdfFormField | ||
mk : PdfDictionary [read-only] | PdfAnnotation | ||
_parent : PdfFormField | PdfFormField | ||
_placeInPage : int = -1 | PdfAnnotation | ||
reference : PdfIndirectReference | PdfAnnotation | ||
type : int | PdfObject | ||
used : Boolean = false | PdfAnnotation | ||
_writer : PdfWriter | PdfAnnotation |
Method | Defined By | ||
---|---|---|---|
PdfFormField | |||
addKid(field:PdfFormField):void | PdfFormField | ||
canBeInObjStm():Boolean
Whether this object can be contained in an object stream. | PdfObject | ||
PdfDictionary | |||
[static]
| PdfAnnotation | ||
[static] | PdfFormField | ||
[static] | PdfFormField | ||
createCombos(writer:PdfWriter, edit:Boolean, options:Vector.<Vector.<String>>, topIndex:int):PdfFormField [static] | PdfFormField | ||
[static] | PdfFormField | ||
createFileAttachment(writer:PdfWriter, rect:RectangleElement, contents:String, fileStore:ByteArray, fileDisplay:String):PdfAnnotation [static]
Creates a file attachment annotation. | PdfAnnotation | ||
createFreeText(writer:PdfWriter, rect:RectangleElement, contents:String, defaultAppearance:PdfContentByte):PdfAnnotation [static]
Add some free text to the document. | PdfAnnotation | ||
createLine(writer:PdfWriter, rect:RectangleElement, contents:String, x1:Number, y1:Number, x2:Number, y2:Number):PdfAnnotation [static]
Adds a line to the document. | PdfAnnotation | ||
createLink(writer:PdfWriter, rect:RectangleElement, highlight:PdfName, action:PdfAction):PdfAnnotation [static]
Creates an Annotation with an Action. | PdfAnnotation | ||
createLink2(writer:PdfWriter, rect:RectangleElement, highlight:PdfName, namedDestination:String):PdfAnnotation [static]
Creates an Annotation with an local destination. | PdfAnnotation | ||
createLink3(writer:PdfWriter, rect:RectangleElement, highlight:PdfName, page:int, dest:PdfDestination):PdfAnnotation [static]
Creates an Annotation with a PdfDestination. | PdfAnnotation | ||
[static] | PdfFormField | ||
[static] | PdfFormField | ||
[static]
Adds a popup to your document. | PdfAnnotation | ||
[static] | PdfFormField | ||
[static] | PdfFormField | ||
createScreen(writer:PdfWriter, rect:RectangleElement, clipTitle:String, fs:PdfFileSpecification, mimeType:String, playOnDisplay:Boolean):PdfAnnotation [static]
Creates a screen PdfAnnotation
| PdfAnnotation | ||
[static] | PdfFormField | ||
createSquareCircle(writer:PdfWriter, rect:RectangleElement, contents:String, square:Boolean):PdfAnnotation [static]
Adds a circle or a square that shows a tooltip when you pass over it. | PdfAnnotation | ||
createText(writer:PdfWriter, rect:RectangleElement, title:String, contents:String, opened:Boolean, icon:String):PdfAnnotation [static] | PdfAnnotation | ||
[static] | PdfFormField | ||
dispose():void | PdfObject | ||
Returns a PdfObject as a PdfArray,
resolving indirect references. | PdfDictionary | ||
PdfDictionary | |||
Returns a PdfObject as a PdfNumber,
resolving indirect references. | PdfDictionary | ||
PdfObject | |||
Returns the PdfObject associated to the specified
key, resolving a possible indirect reference to a direct
object. | PdfDictionary | ||
PdfObject | |||
getKeys():KeySet | PdfDictionary | ||
[static] | PdfAnnotation | ||
getType():int | PdfObject | ||
getUsed():Boolean | PdfAnnotation | ||
PdfDictionary | |||
isArray():Boolean | PdfObject | ||
isBoolean():Boolean | PdfObject | ||
isDictionary():Boolean | PdfObject | ||
isIndirect():Boolean | PdfObject | ||
isName():Boolean | PdfObject | ||
isNull():Boolean | PdfObject | ||
isNumber():Boolean | PdfObject | ||
isStream():Boolean
Checks if this PdfObject is of the type PdfStream
| PdfObject | ||
isString():Boolean | PdfObject | ||
merge(other:PdfDictionary):void | PdfDictionary | ||
mergeDifferent(other:PdfDictionary):void | PdfDictionary | ||
PdfDictionary | |||
putAll(other:PdfDictionary):void | PdfDictionary | ||
Associates the specified PdfObject as value to the
specified PdfName as key in this map. | PdfDictionary | ||
PdfDictionary | |||
PdfAnnotation | |||
PdfAnnotation | |||
PdfAnnotation | |||
setButton(flags:int):void | PdfFormField | ||
setFieldFlags(value:int):int | PdfFormField | ||
setIndRef(indRef:PRIndirectReference):void
Set the indirect reference
| PdfObject | ||
setMKIconFit(scale:PdfName, scalingType:PdfName, leftoverLeft:Number, leftoverBottom:Number, fitInBounds:Boolean):void | PdfFormField | ||
setPage():void | PdfAnnotation | ||
setUsed():void [override] | PdfFormField | ||
PdfFormField | |||
[static] | PdfFormField | ||
[override] | PdfDictionary | ||
toString():String [override] | PdfDictionary |
Method | Defined By | ||
---|---|---|---|
[static]
Creates a link. | PdfAnnotation | ||
[static] | PdfFormField | ||
[static] | PdfFormField | ||
processOptions(options:Vector.<String>):PdfArray [static] | PdfFormField | ||
processOptions2(options:Vector.<Vector.<String>>):PdfArray [static] | PdfFormField | ||
setContent(content:String):void | PdfObject |
Constant | Defined By | ||
---|---|---|---|
AA_BLUR : PdfName [static] | PdfAnnotation | ||
AA_DOWN : PdfName [static] | PdfAnnotation | ||
AA_ENTER : PdfName [static] | PdfAnnotation | ||
AA_EXIT : PdfName [static] | PdfAnnotation | ||
AA_FOCUS : PdfName [static] | PdfAnnotation | ||
AA_JS_CHANGE : PdfName [static] | PdfAnnotation | ||
AA_JS_FORMAT : PdfName [static] | PdfAnnotation | ||
AA_JS_KEY : PdfName [static] | PdfAnnotation | ||
AA_JS_OTHER_CHANGE : PdfName [static] | PdfAnnotation | ||
AA_UP : PdfName [static] | PdfAnnotation | ||
APPEARANCE_DOWN : PdfName [static] | PdfAnnotation | ||
APPEARANCE_NORMAL : PdfName [static] | PdfAnnotation | ||
APPEARANCE_ROLLOVER : PdfName [static] | PdfAnnotation | ||
ARRAY : int = 5 [static] | PdfObject | ||
BOOLEAN : int = 1 [static] | PdfObject | ||
CATALOG : PdfName [static] | PdfDictionary | ||
DICTIONARY : int = 6 [static] | PdfObject | ||
FF_COMB : int = 16777216 [static] | PdfFormField | ||
FF_COMBO : int = 131072 [static] | PdfFormField | ||
FF_DONOTSCROLL : int = 8388608 [static] | PdfFormField | ||
FF_DONOTSPELLCHECK : int = 4194304 [static] | PdfFormField | ||
FF_EDIT : int = 262144 [static] | PdfFormField | ||
FF_FILESELECT : int = 1048576 [static] | PdfFormField | ||
FF_MULTILINE : int = 4096 [static] | PdfFormField | ||
FF_MULTISELECT : int = 2097152 [static] | PdfFormField | ||
FF_NO_EXPORT : int = 4 [static] | PdfFormField | ||
FF_NO_TOGGLE_TO_OFF : int = 16384 [static] | PdfFormField | ||
FF_PASSWORD : int = 8192 [static] | PdfFormField | ||
FF_PUSHBUTTON : int = 65536 [static] | PdfFormField | ||
FF_RADIO : int = 32768 [static] | PdfFormField | ||
FF_RADIOSINUNISON : int [static] | PdfFormField | ||
FF_READ_ONLY : int = 1 [static] | PdfFormField | ||
FF_REQUIRED : int = 2 [static] | PdfFormField | ||
FLAGS_HIDDEN : int = 2 [static] | PdfAnnotation | ||
FLAGS_INVISIBLE : int = 1 [static] | PdfAnnotation | ||
FLAGS_LOCKED : int = 128 [static] | PdfAnnotation | ||
FLAGS_NOROTATE : int = 16 [static] | PdfAnnotation | ||
FLAGS_NOVIEW : int = 32 [static] | PdfAnnotation | ||
FLAGS_NOZOOM : int = 8 [static] | PdfAnnotation | ||
FLAGS_PRINT : int = 4 [static] | PdfAnnotation | ||
FLAGS_READONLY : int = 64 [static] | PdfAnnotation | ||
FLAGS_TOGGLENOVIEW : int = 256 [static] | PdfAnnotation | ||
HIGHLIGHT_INVERT : PdfName [static] | PdfAnnotation | ||
HIGHLIGHT_NONE : PdfName [static] | PdfAnnotation | ||
HIGHLIGHT_OUTLINE : PdfName [static] | PdfAnnotation | ||
HIGHLIGHT_PUSH : PdfName [static] | PdfAnnotation | ||
HIGHLIGHT_TOGGLE : PdfName [static] | PdfAnnotation | ||
IF_SCALE_ALWAYS : PdfName [static] | PdfFormField | ||
IF_SCALE_ANAMORPHIC : PdfName [static] | PdfFormField | ||
IF_SCALE_BIGGER : PdfName [static] | PdfFormField | ||
IF_SCALE_NEVER : PdfName [static] | PdfFormField | ||
IF_SCALE_PROPORTIONAL : PdfName [static] | PdfFormField | ||
IF_SCALE_SMALLER : PdfName [static] | PdfFormField | ||
INDIRECT : int = 10 [static] | PdfObject | ||
MARKUP_HIGHLIGHT : int = 0 [static] | PdfAnnotation | ||
MARKUP_SQUIGGLY : int = 3 [static] | PdfAnnotation | ||
MARKUP_STRIKEOUT : int = 2 [static] | PdfAnnotation | ||
MARKUP_UNDERLINE : int = 1 [static] | PdfAnnotation | ||
MK_CAPTION_ABOVE : int = 3 [static] | PdfFormField | ||
MK_CAPTION_BELOW : int = 2 [static] | PdfFormField | ||
MK_CAPTION_LEFT : int = 5 [static] | PdfFormField | ||
MK_CAPTION_OVERLAID : int = 6 [static] | PdfFormField | ||
MK_CAPTION_RIGHT : int = 4 [static] | PdfFormField | ||
MK_NO_CAPTION : int = 1 [static] | PdfFormField | ||
MK_NO_ICON : int = 0 [static] | PdfFormField | ||
MULTILINE : Boolean = true [static] | PdfFormField | ||
NAME : int = 4 [static] | PdfObject | ||
NOTHING : String [static] | PdfObject | ||
NULL : int = 8 [static] | PdfObject | ||
NUMBER : int = 2 [static] | PdfObject | ||
OUTLINES : PdfName [static] | PdfDictionary | ||
PAGE : PdfName [static] | PdfDictionary | ||
PASSWORD : Boolean = true [static] | PdfFormField | ||
PLAINTEXT : Boolean = false [static] | PdfFormField | ||
Q_CENTER : int = 1 [static] | PdfFormField | ||
Q_LEFT : int = 0 [static] | PdfFormField | ||
Q_RIGHT : int = 2 [static] | PdfFormField | ||
SINGLELINE : Boolean = false [static] | PdfFormField | ||
STREAM : int = 7 [static] | PdfObject | ||
STRING : int = 3 [static] | PdfObject | ||
TEXT_PDFDOCENCODING : String = PDF [static] | PdfObject | ||
TEXT_UNICODE : String = UnicodeBig [static] | PdfObject |
_kids | property |
protected var _kids:Vector.<PdfFormField>
_parent | property |
protected var _parent:PdfFormField
defaultValueAsName | property |
defaultValueAsName:String
[write-only] public function set defaultValueAsName(value:String):void
defaultValueAsString | property |
defaultValueAsString:String
[write-only] public function set defaultValueAsString(value:String):void
fieldFlags | property |
fieldFlags:int
[write-only] public function set fieldFlags(value:int):void
fieldName | property |
fieldName:String
[write-only] public function set fieldName(value:String):void
kids | property |
kids:Vector.<PdfFormField>
[read-only] public function get kids():Vector.<PdfFormField>
mappingName | property |
mappingName:String
[write-only] public function set mappingName(value:String):void
mkAlternateCaption | property |
mkAlternateCaption:String
[write-only] public function set mkAlternateCaption(value:String):void
mkAlternateIcon | property |
mkAlternateIcon:PdfTemplate
[write-only] public function set mkAlternateIcon(value:PdfTemplate):void
mkNormalCaption | property |
mkNormalCaption:String
[write-only] public function set mkNormalCaption(value:String):void
mkNormalIcon | property |
mkNormalIcon:PdfTemplate
[write-only] public function set mkNormalIcon(value:PdfTemplate):void
mkRolloverCaption | property |
mkRolloverCaption:String
[write-only] public function set mkRolloverCaption(value:String):void
mkRolloverIcon | property |
mkRolloverIcon:PdfTemplate
[write-only] public function set mkRolloverIcon(value:PdfTemplate):void
mkTextPosition | property |
mkTextPosition:int
[write-only] public function set mkTextPosition(value:int):void
parent | property |
parent:PdfFormField
public function get parent():PdfFormField
public function set parent(value:PdfFormField):void
quadding | property |
quadding:int
[write-only] public function set quadding(value:int):void
userName | property |
userName:String
[write-only] public function set userName(value:String):void
valueAsName | property |
valueAsName:String
[write-only] public function set valueAsName(value:String):void
valueAsString | property |
valueAsString:String
[write-only] public function set valueAsString(value:String):void
PdfFormField | () | Constructor |
public function PdfFormField($writer:PdfWriter, rect:RectangleElement = null)
$writer:PdfWriter | |
rect:RectangleElement (default = null )
|
addKid | () | method |
createButton | () | method |
protected static function createButton(writer:PdfWriter, flags:int):PdfFormField
Parameters
writer:PdfWriter | |
flags:int |
PdfFormField |
createCheckBox | () | method |
public static function createCheckBox(writer:PdfWriter):PdfFormField
Parameters
writer:PdfWriter |
PdfFormField |
createChoice | () | method |
protected static function createChoice(writer:PdfWriter, flags:int, options:PdfArray, topIndex:int):PdfFormField
Parameters
writer:PdfWriter | |
flags:int | |
options:PdfArray | |
topIndex:int |
PdfFormField |
createCombo | () | method |
public static function createCombo(writer:PdfWriter, edit:Boolean, options:Vector.<String>, topIndex:int):PdfFormField
Parameters
writer:PdfWriter | |
edit:Boolean | |
options:Vector.<String> | |
topIndex:int |
PdfFormField |
createCombos | () | method |
public static function createCombos(writer:PdfWriter, edit:Boolean, options:Vector.<Vector.<String>>, topIndex:int):PdfFormField
Parameters
writer:PdfWriter | |
edit:Boolean | |
options:Vector.<Vector.<String>> | |
topIndex:int |
PdfFormField |
createEmpty | () | method |
public static function createEmpty(writer:PdfWriter):PdfFormField
Parameters
writer:PdfWriter |
PdfFormField |
createList | () | method |
public static function createList(writer:PdfWriter, options:Vector.<String>, topIndex:int):PdfFormField
Parameters
writer:PdfWriter | |
options:Vector.<String> | |
topIndex:int |
PdfFormField |
createLists | () | method |
public static function createLists(writer:PdfWriter, options:Vector.<Vector.<String>>, topIndex:int):PdfFormField
Parameters
writer:PdfWriter | |
options:Vector.<Vector.<String>> | |
topIndex:int |
PdfFormField |
createPushButton | () | method |
public static function createPushButton(writer:PdfWriter):PdfFormField
Parameters
writer:PdfWriter |
PdfFormField |
createRadioButton | () | method |
public static function createRadioButton(writer:PdfWriter, noToggleToOff:Boolean):PdfFormField
Parameters
writer:PdfWriter | |
noToggleToOff:Boolean |
PdfFormField |
createSignature | () | method |
public static function createSignature(writer:PdfWriter):PdfFormField
Parameters
writer:PdfWriter |
PdfFormField |
createTextField | () | method |
public static function createTextField(writer:PdfWriter, multiline:Boolean, password:Boolean, maxLen:int):PdfFormField
Parameters
writer:PdfWriter | |
multiline:Boolean | |
password:Boolean | |
maxLen:int |
PdfFormField |
mergeResources | () | method |
pdf_core static function mergeResources(result:PdfDictionary, source:PdfDictionary):void
Parameters
result:PdfDictionary | |
source:PdfDictionary |
mergeResources2 | () | method |
pdf_core static function mergeResources2(result:PdfDictionary, source:PdfDictionary, writer:Object):void
Parameters
result:PdfDictionary | |
source:PdfDictionary | |
writer:Object |
processOptions | () | method |
protected static function processOptions(options:Vector.<String>):PdfArray
Parameters
options:Vector.<String> |
PdfArray |
processOptions2 | () | method |
protected static function processOptions2(options:Vector.<Vector.<String>>):PdfArray
Parameters
options:Vector.<Vector.<String>> |
PdfArray |
setButton | () | method |
public function setButton(flags:int):void
Parameters
flags:int |
setFieldFlags | () | method |
public function setFieldFlags(value:int):int
Parameters
value:int |
int |
setMKIconFit | () | method |
public function setMKIconFit(scale:PdfName, scalingType:PdfName, leftoverLeft:Number, leftoverBottom:Number, fitInBounds:Boolean):void
Parameters
scale:PdfName | |
scalingType:PdfName | |
leftoverLeft:Number | |
leftoverBottom:Number | |
fitInBounds:Boolean |
setUsed | () | method |
override public function setUsed():void
setWidget | () | method |
public function setWidget(rect:RectangleElement, highlight:PdfName):void
Parameters
rect:RectangleElement | |
highlight:PdfName |
shallowDuplicate | () | method |
public static function shallowDuplicate(annot:PdfAnnotation):PdfAnnotation
Parameters
annot:PdfAnnotation |
PdfAnnotation |
FF_COMB | Constant |
public static const FF_COMB:int = 16777216
FF_COMBO | Constant |
public static const FF_COMBO:int = 131072
FF_DONOTSCROLL | Constant |
public static const FF_DONOTSCROLL:int = 8388608
FF_DONOTSPELLCHECK | Constant |
public static const FF_DONOTSPELLCHECK:int = 4194304
FF_EDIT | Constant |
public static const FF_EDIT:int = 262144
FF_FILESELECT | Constant |
public static const FF_FILESELECT:int = 1048576
FF_MULTILINE | Constant |
public static const FF_MULTILINE:int = 4096
FF_MULTISELECT | Constant |
public static const FF_MULTISELECT:int = 2097152
FF_NO_EXPORT | Constant |
public static const FF_NO_EXPORT:int = 4
FF_NO_TOGGLE_TO_OFF | Constant |
public static const FF_NO_TOGGLE_TO_OFF:int = 16384
FF_PASSWORD | Constant |
public static const FF_PASSWORD:int = 8192
FF_PUSHBUTTON | Constant |
public static const FF_PUSHBUTTON:int = 65536
FF_RADIO | Constant |
public static const FF_RADIO:int = 32768
FF_RADIOSINUNISON | Constant |
public static const FF_RADIOSINUNISON:int
FF_READ_ONLY | Constant |
public static const FF_READ_ONLY:int = 1
FF_REQUIRED | Constant |
public static const FF_REQUIRED:int = 2
IF_SCALE_ALWAYS | Constant |
public static const IF_SCALE_ALWAYS:PdfName
IF_SCALE_ANAMORPHIC | Constant |
public static const IF_SCALE_ANAMORPHIC:PdfName
IF_SCALE_BIGGER | Constant |
public static const IF_SCALE_BIGGER:PdfName
IF_SCALE_NEVER | Constant |
public static const IF_SCALE_NEVER:PdfName
IF_SCALE_PROPORTIONAL | Constant |
public static const IF_SCALE_PROPORTIONAL:PdfName
IF_SCALE_SMALLER | Constant |
public static const IF_SCALE_SMALLER:PdfName
MK_CAPTION_ABOVE | Constant |
public static const MK_CAPTION_ABOVE:int = 3
MK_CAPTION_BELOW | Constant |
public static const MK_CAPTION_BELOW:int = 2
MK_CAPTION_LEFT | Constant |
public static const MK_CAPTION_LEFT:int = 5
MK_CAPTION_OVERLAID | Constant |
public static const MK_CAPTION_OVERLAID:int = 6
MK_CAPTION_RIGHT | Constant |
public static const MK_CAPTION_RIGHT:int = 4
MK_NO_CAPTION | Constant |
public static const MK_NO_CAPTION:int = 1
MK_NO_ICON | Constant |
public static const MK_NO_ICON:int = 0
MULTILINE | Constant |
public static const MULTILINE:Boolean = true
PASSWORD | Constant |
public static const PASSWORD:Boolean = true
PLAINTEXT | Constant |
public static const PLAINTEXT:Boolean = false
Q_CENTER | Constant |
public static const Q_CENTER:int = 1
Q_LEFT | Constant |
public static const Q_LEFT:int = 0
Q_RIGHT | Constant |
public static const Q_RIGHT:int = 2
SINGLELINE | Constant |
public static const SINGLELINE:Boolean = false