Interface FormFactory
public interface FormFactory
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
static final Integer
static final int
static final Integer
static final int
static final Integer
static final int
static final int
static final Integer
static final int
static final Integer
static final int
static final Integer
static final int
static final Integer
static final int
static final Integer
static final int
static final Integer
static final int
static final Integer
static final int
static final Integer
static final int
static final int
static final int
static final int
match types for PDF objects in raw int formstatic final Integer
matches types of PDF form objects in Integer form -
Method Summary
Modifier and TypeMethodDescriptionvoid
addPageScript
(int pageNumber, int key, String script) annotationButton
(FormObject formObject) setup annotations display with pop-ups, etcvoid
appendAnnotOrder
(Map<String, String> annotOrder) Append a map of tab orders onto the form factories existing annotation order storecheckBoxBut
(FormObject formObject) setup and return a single checkBox button component, from the specified formObjectcomboBox
(FormObject formObject) setup and return a ComboBox component, from the specified formObjectboolean
flattenForm
(FormObject formObject) generateBorderfromForm
(FormObject form, float scaling) org.jpedal.objects.acroforms.GUIData
return new instance of GUIData implementation to support component setint
getType()
return Formfactory.
ULC, SWING or HTML
constantvoid
listField
(FormObject formObject) setup and return a List component, from the specified formObjectmultiLinePassword
(FormObject formObject) setup and return a multi line Password component, from the specified formObjectmultiLineText
(FormObject formObject) setup and return a multi line Text component, from the specified formObjectpushBut
(FormObject formObject) setup and return a push button component, from the specified formObjectradioBut
(FormObject formObject) setup and return a single radio button component, from the specified formObjectvoid
reset
(Object[] AcroRes, ActionHandler actionHandler, org.jpedal.objects.PdfPageData pageData, org.jpedal.io.PdfObjectReader currentPdfFile) user can instance own value so we need to pass in these objectsvoid
setAnnotOrder
(Map<String, String> annotOrder) Set the annotation order used for the tab indexvoid
setDVR
(org.jpedal.render.DynamicVectorRenderer htmLoutput, org.jpedal.objects.Javascript javaScript) void
setFormValues
(Map<String, Object> inputValues) void
setOptions
(EnumSet<org.jpedal.objects.acroforms.creation.FormOptions> formSettings) default void
signature
(FormObject formObject) setup the signature fieldsingleLinePassword
(FormObject formObject) setup and return a single line Password component, from the specified formObjectsingleLineText
(FormObject formObject) setup and return a single line Text component, from the specified formObject
-
Field Details
-
UNKNOWN
matches types of PDF form objects in Integer form -
LIST
-
COMBOBOX
-
SINGLELINETEXT
-
SINGLELINEPASSWORD
-
MULTILINETEXT
-
MULTILINEPASSWORD
-
PUSHBUTTON
-
RADIOBUTTON
-
CHECKBOXBUTTON
-
ANNOTATION
-
SIGNATURE
-
unknown
static final int unknownmatch types for PDF objects in raw int form- See Also:
-
list
static final int list- See Also:
-
combobox
static final int combobox- See Also:
-
singlelinetext
static final int singlelinetext- See Also:
-
singlelinepassword
static final int singlelinepassword- See Also:
-
multilinetext
static final int multilinetext- See Also:
-
multilinepassword
static final int multilinepassword- See Also:
-
pushbutton
static final int pushbutton- See Also:
-
radiobutton
static final int radiobutton- See Also:
-
checkboxbutton
static final int checkboxbutton- See Also:
-
annotation
static final int annotation- See Also:
-
signature
static final int signature- See Also:
-
SWING
static final int SWING- See Also:
-
ULC
static final int ULC- See Also:
-
HTML
static final int HTML- See Also:
-
SVG
static final int SVG- See Also:
-
-
Method Details
-
listField
setup and return a List component, from the specified formObject- Parameters:
formObject
- form object- Returns:
- Object
- See Also:
-
comboBox
setup and return a ComboBox component, from the specified formObject- Parameters:
formObject
- form object- Returns:
- Object
- See Also:
-
singleLineText
setup and return a single line Text component, from the specified formObject- Parameters:
formObject
- form object- Returns:
- Object
- See Also:
-
singleLinePassword
setup and return a single line Password component, from the specified formObject- Parameters:
formObject
- form object- Returns:
- Object
- See Also:
-
multiLineText
setup and return a multi line Text component, from the specified formObject- Parameters:
formObject
- form object- Returns:
- Object
- See Also:
-
multiLinePassword
setup and return a multi line Password component, from the specified formObject- Parameters:
formObject
- form object- Returns:
- Object
- See Also:
-
pushBut
setup and return a push button component, from the specified formObject- Parameters:
formObject
- form object- Returns:
- Object
- See Also:
-
radioBut
setup and return a single radio button component, from the specified formObject- Parameters:
formObject
- form object- Returns:
- Object
- See Also:
-
checkBoxBut
setup and return a single checkBox button component, from the specified formObject- Parameters:
formObject
- form object- Returns:
- Object
- See Also:
-
annotationButton
setup annotations display with pop-ups, etc- Parameters:
formObject
- form object- Returns:
- Object
-
signature
setup the signature field- Parameters:
formObject
- form object- Returns:
- Object
-
reset
void reset(Object[] AcroRes, ActionHandler actionHandler, org.jpedal.objects.PdfPageData pageData, org.jpedal.io.PdfObjectReader currentPdfFile) user can instance own value so we need to pass in these objects- Parameters:
AcroRes
- AcroResactionHandler
- Action HandlerpageData
- pdf page datacurrentPdfFile
- current pdf file
-
getCustomCompData
org.jpedal.objects.acroforms.GUIData getCustomCompData()return new instance of GUIData implementation to support component set- Returns:
- GUIData
-
getType
int getType()return Formfactory.
ULC, SWING or HTML
constant- Returns:
- int
-
indexAllKids
void indexAllKids() -
setAnnotOrder
Set the annotation order used for the tab indexTo append annotations instead of overriding the order, see
appendAnnotOrder(java.util.Map<java.lang.String, java.lang.String>)
- Parameters:
annotOrder
- The annotation order as a map, mapping the annotation ref to it's index- See Also:
-
appendAnnotOrder
Append a map of tab orders onto the form factories existing annotation order storeTo replace the existing annotation order, see
setAnnotOrder(java.util.Map<java.lang.String, java.lang.String>)
- Parameters:
annotOrder
- The annotations to append onto the existing map
-
setOptions
- Parameters:
formSettings
- settings
-
setDVR
void setDVR(org.jpedal.render.DynamicVectorRenderer htmLoutput, org.jpedal.objects.Javascript javaScript) - Parameters:
htmLoutput
- htmljavaScript
- javascript
-
generateBorderfromForm
- Parameters:
form
- Form objectscaling
- scaling- Returns:
- Object
-
flattenForm
- Parameters:
formObject
- a data object containing details of the form object- Returns:
- boolean
-
setFormValues
-
getReplacementValue
-
addPageScript
-
setupDRFonts
default void setupDRFonts()
-