org.jpedal.objects.acroforms.creation.FormFactory 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-2016 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


 *
 * ---------------
 * FormFactory.java
 * ---------------
 */
package org.jpedal.objects.acroforms.creation;

import java.util.EnumSet;
import java.util.Map;
import org.jpedal.io.PdfObjectReader;
import org.jpedal.objects.Javascript;
import org.jpedal.objects.PdfPageData;
import org.jpedal.objects.acroforms.GUIData;
import org.jpedal.objects.acroforms.actions.ActionHandler;
import org.jpedal.objects.raw.FormObject;
import org.jpedal.render.DynamicVectorRenderer;

@SuppressWarnings("UnusedDeclaration")
public interface FormFactory {
    
    /**
     * matches types of PDF form objects in Integer form
     */
    Integer UNKNOWN = -1;
    Integer LIST = 1;
    Integer COMBOBOX = 2;
    Integer SINGLELINETEXT = 3;
    Integer SINGLELINEPASSWORD = 4;
    Integer MULTILINETEXT = 5;
    Integer MULTILINEPASSWORD = 6;
    Integer PUSHBUTTON = 7;
    Integer RADIOBUTTON = 8;
    Integer CHECKBOXBUTTON = 9;
    Integer ANNOTATION = 10;
    Integer SIGNATURE = 11;
    
    /** match types for PDF objects in raw int form */
    int unknown = -1;
    //LIST
    int list = 1;
    int combobox = 2;
    //TEXT
    int singlelinetext = 3;
    int singlelinepassword = 4;
    int multilinetext = 5;
    int multilinepassword = 6;
    //BUTTON
    int pushbutton = 7;
    int radiobutton = 8;
    int checkboxbutton = 9;
    int annotation = 10;
    int signature = 11;
    
    int SWING = 1;
    
    int ULC = 2;
    
    int HTML = 3;
    
    int SVG = 4;
    
    int JAVAFX = 5;
    
    /**
     * setup and return a List component, from the specified formObject
     * @see FormObject
     */
    Object listField(FormObject formObject);
    
    /**
     * setup and return a ComboBox component, from the specified formObject
     * @see FormObject
     */
    Object comboBox(FormObject formObject);
    
    /**
     * setup and return a single line Text component, from the specified formObject
     * @see FormObject
     */
    Object singleLineText(FormObject formObject);
    
    /**
     * setup and return a single line Password component, from the specified formObject
     * @see FormObject
     */
    Object singleLinePassword(FormObject formObject);
    
    /**
     * setup and return a multi line Text component, from the specified formObject
     * @see FormObject
     */
    Object multiLineText(FormObject formObject);
    
    /**
     * setup and return a multi line Password component, from the specified formObject
     * @see FormObject
     */
    Object multiLinePassword(FormObject formObject);
    
    /**
     * setup and return a push button component, from the specified formObject
     * @see FormObject
     */
    Object pushBut(FormObject formObject);
    
    /**
     * setup and return a single radio button component, from the specified formObject
     * @see FormObject
     */
    Object radioBut(FormObject formObject);
    
    /**
     * setup and return a single checkBox button component, from the specified formObject
     * @see FormObject
     */
    Object checkBoxBut(FormObject formObject);
    
    /**
     * setup annotations display with pop-ups, etc
     */
    Object annotationButton(FormObject formObject);
    
    /**
     * setup the signature field
     */
    Object signature(FormObject formObject);
    
    /**
     * user can instance own value so we need to pass in these objects
     * @param AcroRes
     * @param actionHandler
     * @param pageData
     * @param currentPdfFile
     */
    void reset(Object[] AcroRes, ActionHandler actionHandler, PdfPageData pageData, PdfObjectReader currentPdfFile);
    
    /**
     * return new instance of GUIData implementation to support component set
     */
    GUIData getCustomCompData();
    
    /** return Formfactory.
ULC, SWING or HTML
constant */
    int getType();
    
    //public void setDecoder(PdfDecoder decode_pdf);
    
    void indexAllKids();
    
    /**pass in Map contains annot field list in order to set tabindex*/
    void setAnnotOrder(Map annotOrder);
    
    @SuppressWarnings("UnusedDeclaration")
    void setOptions(EnumSet formSettings);
    
    void setDVR(DynamicVectorRenderer htmLoutput, Javascript javaScript);

    Object generateBorderfromForm(final FormObject form, final float scaling);

    boolean flattenForms();
    
}