org.faceless.pdf2

Class JSCoreMethods

java.lang.Object

org.faceless.pdf2.JSCoreMethods

public class JSCoreMethods
extends java.lang.Object

This class contains various methods which are called from JavaScript. An instance of this class is bound to the "__bfo" global object in the JavaScript environment and it serves as the interface between the two environments. This implementation has no-ops for many methods (eg appAlert), but a subclass can override them to provide useful implementations, say by bringing up an AWT Dialog.

Since:

2.9

Constructor Summary

Constructors

Constructor and Description
JSCoreMethods()

Method Summary

Modifier and Type	Method and Description
void	AFDate_Format(JSEvent event, int pdf)
void	AFDate_FormatEx(JSEvent event, java.lang.String format) An implementation of the AFDate_Format JavaScript method
void	AFDate_KeystrokeEx(JSEvent event, java.lang.String format) Implementation of the AFDate_KeystrokeEx JavaScript method
java.lang.String	AFMergeChange(JSEvent event) merges the last change with the uncommitted change
void	AFNumber_Format(JSEvent event, int dec, int sep, int neg, int dummy, java.lang.String cursym, boolean curfirst) An implementation of the AFNumber_Format JavaScript method
java.util.Date	AFParseDateEx(java.lang.String value, java.lang.String format) Attempts to parse a string containing some form of date; returns null on failure or a Date object on success.
void	AFPercent_Format(JSEvent event, int dec, int sep) An implementation of the AFPercent_Format JavaScript method
void	AFSpecial_Format(JSEvent event, int psf) An implementation of the AFSpecial_Format JavaScript method
void	AFSpecial_Keystroke(JSEvent event, int psf)
int	appAlert(java.lang.String message, int nIcon, int nType, java.lang.String cTitle, java.lang.Object oDoc, java.lang.Object oCheckbox) An implementation of the App.alert() JavaScript method
void	appBeep() An implementation of the App.beep() JavaScript method
java.lang.String	appResponse(java.lang.String message, java.lang.String cTitle, java.lang.String cDefault, boolean bPassword, java.lang.String cLabel) An implementation of the App.response() JavaScript method
java.lang.String	appViewerType() An implementation of the App.viewerType JavaScript property
java.lang.String	appViewerVariation() An implementation of the App.viewerVariation JavaScript property
int	appViewerVersion() An implementation of the App.viewerVersion JavaScript property
java.lang.Object[]	colorFromAWT(java.awt.Paint paint) Convert an AWT Color to a PDF color
java.awt.Color	colorToAWT(java.lang.Object[] pdfcolor) Convert a PDF Color to an AWT color
void	consoleClear() An implementation of the Console.clear() JavaScript method.
void	consoleHide() An implementation of the Console.hide() JavaScript method.
void	consolePrintln(java.lang.String s) An implementation of the Console.println() JavaScript method.
void	consoleShow() /** An implementation of the Console.show() JavaScript method.
boolean	getAppFocusRect() An implementation of the App.focusRect JavaScript property (getter)
boolean	getAppRuntimeHighlight() An implementation of the App.runtimeHighlight JavaScript property (getter)
java.awt.Color	getAppRuntimeHighlightColor() An implementation of the App.runtimeHighlightColor JavaScript property (getter)
java.lang.String	getCustomJavaScript(java.lang.String type, java.lang.String name) Return an additional Script to be run on the App/Init event.
java.lang.String	getImplementation()
void	notifyForRedraw(java.lang.Object o) Called when a PDF object has had it's state changed and needs to be rebuilt
void	reportThrowable(java.lang.Throwable e, java.lang.String filename, int linenumber) Print a Throwable to the Console
void	setAppFocusRect(boolean value) An implementation of the App.focusRect JavaScript property (setter)
void	setAppRuntimeHighlight(boolean value) An implementation of the App.runtimeHighlight JavaScript property (setter)
void	setAppRuntimeHighlightColor(java.awt.Color value) An implementation of the App.runtimeHighlightColor JavaScript property (setter)
void	throwCustomException(java.lang.String type, java.lang.String message)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JSCoreMethods

public JSCoreMethods()

Method Detail

getImplementation

public java.lang.String getImplementation()

getCustomJavaScript

public java.lang.String getCustomJavaScript(java.lang.String type,
                                            java.lang.String name)

Return an additional Script to be run on the App/Init event. The default implementation returns null, which means no extra JavaScript is run.

reportThrowable

public void reportThrowable(java.lang.Throwable e,
                            java.lang.String filename,
                            int linenumber)

Print a Throwable to the Console

throwCustomException

public void throwCustomException(java.lang.String type,
                                 java.lang.String message)
                          throws org.faceless.pdf2.JSCoreMethods.CustomException

Throws:

org.faceless.pdf2.JSCoreMethods.CustomException

AFNumber_Format

public final void AFNumber_Format(JSEvent event,
                                  int dec,
                                  int sep,
                                  int neg,
                                  int dummy,
                                  java.lang.String cursym,
                                  boolean curfirst)

An implementation of the AFNumber_Format JavaScript method

AFPercent_Format

public final void AFPercent_Format(JSEvent event,
                                   int dec,
                                   int sep)

An implementation of the AFPercent_Format JavaScript method

AFSpecial_Format

public final void AFSpecial_Format(JSEvent event,
                                   int psf)

An implementation of the AFSpecial_Format JavaScript method

AFDate_FormatEx

public final void AFDate_FormatEx(JSEvent event,
                                  java.lang.String format)

An implementation of the AFDate_Format JavaScript method

AFDate_Format

public final void AFDate_Format(JSEvent event,
                                int pdf)

AFDate_KeystrokeEx

public final void AFDate_KeystrokeEx(JSEvent event,
                                     java.lang.String format)

Implementation of the AFDate_KeystrokeEx JavaScript method

AFSpecial_Keystroke

public final void AFSpecial_Keystroke(JSEvent event,
                                      int psf)

AFMergeChange

public final java.lang.String AFMergeChange(JSEvent event)

merges the last change with the uncommitted change

AFParseDateEx

public final java.util.Date AFParseDateEx(java.lang.String value,
                                          java.lang.String format)

Attempts to parse a string containing some form of date; returns null on failure or a Date object on success. cFormat should be the format in which the date is entered. ( eg y/m/d, ddmmyy, etc ).

notifyForRedraw

public void notifyForRedraw(java.lang.Object o)

Called when a PDF object has had it's state changed and needs to be rebuilt

colorFromAWT

public final java.lang.Object[] colorFromAWT(java.awt.Paint paint)

Convert an AWT Color to a PDF color

colorToAWT

public final java.awt.Color colorToAWT(java.lang.Object[] pdfcolor)

Convert a PDF Color to an AWT color

appBeep

public void appBeep()

An implementation of the App.beep() JavaScript method

appAlert

public int appAlert(java.lang.String message,
                    int nIcon,
                    int nType,
                    java.lang.String cTitle,
                    java.lang.Object oDoc,
                    java.lang.Object oCheckbox)

An implementation of the App.alert() JavaScript method

appResponse

public java.lang.String appResponse(java.lang.String message,
                                    java.lang.String cTitle,
                                    java.lang.String cDefault,
                                    boolean bPassword,
                                    java.lang.String cLabel)

An implementation of the App.response() JavaScript method

appViewerType

public java.lang.String appViewerType()

An implementation of the App.viewerType JavaScript property

appViewerVariation

public java.lang.String appViewerVariation()

An implementation of the App.viewerVariation JavaScript property

appViewerVersion

public int appViewerVersion()

An implementation of the App.viewerVersion JavaScript property

getAppRuntimeHighlight

public boolean getAppRuntimeHighlight()

An implementation of the App.runtimeHighlight JavaScript property (getter)

setAppRuntimeHighlight

public void setAppRuntimeHighlight(boolean value)

An implementation of the App.runtimeHighlight JavaScript property (setter)

setAppRuntimeHighlightColor

public void setAppRuntimeHighlightColor(java.awt.Color value)

An implementation of the App.runtimeHighlightColor JavaScript property (setter)

getAppRuntimeHighlightColor

public java.awt.Color getAppRuntimeHighlightColor()

An implementation of the App.runtimeHighlightColor JavaScript property (getter)

getAppFocusRect

public boolean getAppFocusRect()

An implementation of the App.focusRect JavaScript property (getter)

setAppFocusRect

public void setAppFocusRect(boolean value)

An implementation of the App.focusRect JavaScript property (setter)

consoleShow

public void consoleShow()

/** An implementation of the Console.show() JavaScript method. The default implementation of this method turns on console.println(), so output goes to System.out

consoleHide

public void consoleHide()

An implementation of the Console.hide() JavaScript method. The default implementation of this method turns off console.println();

consoleClear

public void consoleClear()

An implementation of the Console.clear() JavaScript method.

consolePrintln

public void consolePrintln(java.lang.String s)

An implementation of the Console.println() JavaScript method. The default implementation does nothiing unless console.show() has been called.