org.jpedal.objects.javascript.ExpressionEngine Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of OpenViewerFX Show documentation

Open Source (LGPL) JavaFX PDF Viewer for NetBeans plugin

There is a newer version: 7.15.25

/*
 * ===========================================
 * 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
 *
 @LICENSE@
 *
 * ---------------
 * ExpressionEngine.java
 * ---------------
 */
package org.jpedal.objects.javascript;

import org.jpedal.objects.acroforms.AcroRenderer;
import org.jpedal.objects.raw.FormObject;

/**
 * allow user to handle expressions with own implementation
 */

public interface ExpressionEngine {

    /**
     * @param ref        ie 1 0 R
     * @param type       - defined in ActionHandler (ie K)
     * @param js         - Javascript string
     * @param eventType  - type of event (Keystroke, focus)
     * @param keyPressed - if key event, key value , otherwsie space
     * @return return code (ActionHandler.STOPPROCESSING to ignore JPedal handling)
     */
    //NOTE type is used externally so needs to be kept
    int execute(FormObject ref, int type, String js, int eventType, char keyPressed);

    /**
     * called on close to do any cleanup
     */
    void closeFile();

    /**
     * return true if JPedal should do nothing, false if JPedal should execute command as well
     * 
     * if code == ErrorCodes.JSInvalidRangeFormat
     * then args[1] is the forrmatted message to be displayed
     * @param code error code
     * @param args arguments
     * @return boolean
     */
    boolean reportError(int code, Object[] args);

//	String handleAFCommands(String js, int eventType, char keyPressed, String currentValue);

    /**
     * adding code for the javascript to  call as needed
     * @param value code to add
     * @return int
     */
    @SuppressWarnings("UnusedReturnValue")
    int addCode(String value);

    void executeFunctions(String jsCode, FormObject formObject);

    void dispose();

    void setAcroRenderer(AcroRenderer acro);
}