Modifier and Type | Method and Description |
---|---|
void |
PDFLibrary.addFontFile(FileHandler fontFile)
Add an additional font (typically a TrueType, Type1 or CFF font) to Foxit
PDF SDK library.
|
int |
PDFLibrary.getLicenseType()
Get the current license type.
|
void |
PDFLibrary.initialize(int memorySize,
boolean scaleable)
Initialize the Foxit PDF SDK library.
|
abstract void |
IInvalidate.invalidateRect(java.lang.Object clientData,
int objectType,
RectF rectF)
Invalidate a rectangle area.
|
void |
PDFLibrary.unlock(java.lang.String licenseKey,
java.lang.String unlockCode)
Unlock Foxit PDF SDK library with license key and code.
|
Modifier and Type | Method and Description |
---|---|
static Archive |
Archive.create()
Create an
Archive object for serializing and de-serializing. |
byte[] |
Archive.getData()
Get archived data from the
Archive object. |
void |
Archive.loadData(byte[] buffer)
Load data to the
Archive object. |
void |
Archive.release()
Release the
Archive handle. |
Modifier and Type | Method and Description |
---|---|
void |
ImageFile.addFrame(Bitmap bitmap)
Add a frame to current
ImageFile object. |
Bitmap |
Bitmap.cloneBitmap()
Clone current bitmap and generate a cloned bitmap.
|
void |
Bitmap.convertFormat(int format)
Convert current bitmap to another specific format.
|
java.awt.image.BufferedImage |
Bitmap.convertToBufferedImage()
Convert current bitmap to a
BufferedImage object. |
int |
Image.countFrames()
Count image frames.
|
static ImageFile |
ImageFile.create(FileHandler file,
int imageType,
int frameCount)
Create an
ImageFile object. |
static Bitmap |
Bitmap.create(Size size,
int format,
java.awt.image.DataBuffer buffer,
int stride)
Create a bitmap.
|
void |
Bitmap.fillRect(long color,
Rect rect)
Fill current bitmap with a specific color.
|
java.awt.image.DataBuffer |
Bitmap.getBuffer()
Get the whole data buffer of current bitmap.
|
Bitmap |
Image.getCurrentFrameBitmap()
Retrieve the bitmap of the current frame.
|
Size |
Image.getCurrentFrameSize()
Get width and height of the current frame.
|
int[] |
Image.getDPI()
Get DPI(DPI, that is Dot-Per-Inch.) properties of an
Image
object.This function doesn't support JPX and GIF. |
Bitmap |
Bitmap.getFlipped(boolean flipX,
boolean flipY)
Swap X/Y dimensions of current bitmap and generate a flipped bitmap as the result.
|
int |
Bitmap.getFormat()
Get format of current bitmap.
|
java.awt.image.DataBuffer |
Bitmap.getLineBuffer(int lineIndex)
Get a data buffer of a specific scan-line of current bitmap.
|
int |
Bitmap.getLineStride()
Get a row stride of current bitmap.
|
Size |
Image.getSize()
Get the image width and height.
|
Size |
Bitmap.getSize()
Get the size of current bitmap.
|
int |
Image.getType()
Get the image type.
|
static Image |
Image.load(FileHandler imageFile)
Load an
Image object from an image file. |
boolean |
Image.loadFrame(int frameIndex)
Load an image frame by index.
|
void |
ImageFile.release()
Release current
ImageFile object. |
void |
Image.release()
Release an
Image object. |
void |
Bitmap.release()
Release current bitmap.
|
void |
ImageFile.setDPI(int[] axis)
Set DPI(Dot-Per-Inch.) properties of current
ImageFile object. |
void |
Bitmap.stretchTo(Bitmap dstBitmap,
int dstLeft,
int dstTop,
int dstWidth,
int dstHeight,
Rect dstClipRect,
int interpolation)
Stretch current bitmap into a new bitmap with different size.
|
void |
Bitmap.transformTo(Bitmap dstBitmap,
Matrix matrix,
Rect dstClipRect,
int interpolation)
Transform current bitmap into a new bitmap.
|
Modifier and Type | Method and Description |
---|---|
Annot |
PDFPage.addAnnot(RectF rectf,
java.lang.String annotType,
java.lang.String filter,
int index)
Add an annotation with a specific index, by specific filter.
|
Layer |
PDFDocument.addLayer(java.lang.String layerName)
Add a layer to current PDF document.
|
void |
PDFPath.addPointsCount(int count)
Add a number of points to the given
PDFPath object. |
Signature |
PDFPage.addSignature(RectF rect)
Add an unsigned signature field without appearance to a specific
position in current PDF page.
|
void |
PDFPath.appendEllipse(RectF rect)
Add an ellipse figure to path data.
|
void |
PDFPath.appendRect(RectF rect)
Add a rectangle figure to path data.
|
RectF |
PDFPage.calcContentBBox(int mode)
Calculate content box rectangle in PDF page.
|
void |
PDFPath.clear()
Clear all points of the given
PDFPath object. |
PDFBookmarkIterator |
PDFBookmarkIterator.cloneBookmark()
Clone an iterator to access bookmark in a document.
|
void |
PDFDocument.close()
Close the current document.
|
boolean |
PDFPath.closeFigure()
Close the last figure of path data.
|
void |
PDFDocument.closePage(PDFPage page)
Release all contents of page and relative resources.
|
int |
Progress.continueProgress(int millisecond)
Continue a progressive process.
|
int |
PDFBookmarkIterator.countActions()
Count the actions of current bookmark item.
|
int |
PDFPage.countActions(int trigger)
Count trigger actions of a page.
|
int |
PDFDocument.countActions(int trigger)
Get document trigger action counts.
|
int |
PDFPage.countAnnots(java.lang.String filter)
Get count of annotations, by specific filter.
|
int |
PDFAttachments.countAttachment()
Get the count of
PDFAttachment object. |
int |
PDFTextPage.countChars()
Get the count of characters in a page.
|
int |
PDFTextLink.countLinks()
Get the count of URL formatted texts inside a page.
|
int |
PDFDocument.countPages()
Get the page count of current document.
|
int |
PDFTextSelection.countPieces()
Count the number of all rectangular segments in a PDF text selected area.
|
int |
PDFPath.countPoints()
Get number of points of the given
PDFPath object. |
int |
PDFDocument.countSignatures()
Count signatures of current PDF document .
|
int |
PDFPage.countWatermarks()
Get count of watermarks in current page, not including the SDK trial watermark.
|
static RenderContext |
RenderContext.create()
Create a PDF rendering context object.
|
static PDFPath |
PDFPath.create()
Create a new
PDFPath object. |
static PDFDocument |
PDFDocument.create()
Create a new
PDFDocument object. |
static Renderer |
Renderer.create(Bitmap bitmap)
Create a
Renderer object, from a specific Bitmap object. |
static PDFAttachment |
PDFAttachment.create(PDFDocument document)
Create a
PDFAttachment object. |
static PDFWatermark |
PDFWatermark.create(PDFDocument document,
Bitmap bitmap,
PDFWatermark.WatermarkSetting settings)
Create a
PDFWatermark object from a specific Bitmap object. |
static PDFWatermark |
PDFWatermark.create(PDFDocument document,
Image image,
PDFWatermark.WatermarkSetting settings)
Create a
PDFWatermark object from a specific Image object. |
static PDFWatermark |
PDFWatermark.create(PDFDocument document,
PDFPage page,
PDFWatermark.WatermarkSetting settings)
Create a
PDFWatermark object from a specific PDFPage object. |
static PDFWatermark |
PDFWatermark.create(PDFDocument document,
java.lang.String text,
PDFWatermark.WatermarkTextProperty properties,
PDFWatermark.WatermarkSetting settings)
Create a
PDFWatermark object from a specific text string. |
static PDFTextPage |
PDFTextPage.create(PDFPage page)
Create a new
PDFTextPage object with a specified
PDFPage object |
static PDFReflowPage |
PDFReflowPage.create(PDFPage page)
Create a
PDFReflowPage object from specified
PDFPage object. |
static PDFTextPage |
PDFTextPage.create(PDFPage page,
int option)
Create a new
PDFTextPage object with option from a specified
PDFPage object |
static Font |
Font.create(java.lang.String fontName,
int fontStyles,
int weight,
int charset)
Create a
Font object with specified attributes. |
PDFBookmarkIterator |
PDFDocument.createBookmarkIterator()
Create a new
PDFBookmarkIterator object in the current document. |
static Font |
Font.createFromFile(FileHandler fontFile,
int faceIndex,
int charset)
Create a
Font object from a FileHandler object. |
LayerContext |
PDFDocument.createLayerContext(int usageType)
Create a PDF layer context with a given type.
|
PDFPage |
PDFDocument.createPage(int pageIndex)
Create a new page.
|
static Font |
Font.createStandard(int fontID)
Create a standard
Font object by the standard font ID. |
void |
PDFPath.cubicBezierTo(java.awt.geom.Point2D.Float point1,
java.awt.geom.Point2D.Float point2,
java.awt.geom.Point2D.Float point3)
Add Bezier points to a given path data.
|
void |
PDFDocument.deletePage(PDFPage page)
Delete a page from document.
|
Annot |
PDFPage.deserializeAnnot(Archive archive)
Deserialize the annotation.
|
boolean |
PDFPage.doJavaScriptAction(int trigger)
Perform the page javascript which is specified by the trigger.
|
boolean |
PDFDocument.doJavaScriptAction(int trigger)
Perform the document javascript which is specified by the trigger.
|
void |
Renderer.drawBitmap(java.awt.Point dstPt,
Bitmap srcBitmap,
Rect srcRect)
Render a bitmap object.
|
static Font.FontFace[] |
Font.enumFaces(FileHandler fontFile)
Enumerate faces from a font file.
|
LayerNode |
PDFDocument.enumLayers()
Enum all PDF Layers.
|
void |
PDFDocument.exportAnnotsToFDF(java.lang.String pdfPath,
FileHandler fdfFile)
Export all the annotations of the document into a FDF file.
|
void |
PDFTextPage.exportToFile(FileHandler file)
Export text content in a page to a specific file.
|
PDFTextLink |
PDFTextPage.extractLinks()
Process a PDF page text object to get URL formatted texts (as
hyperlinks).
|
boolean |
PDFTextSearch.findNext()
Search in the direction from page start to end.
|
boolean |
PDFTextSearch.findPrev()
Search in the direction from page end to start.
|
void |
PDFPage.flatten(int flags)
Flatten a PDF page, and annotations or form fields will be made to be a
part of the page contents.
|
PDFAction |
PDFBookmarkIterator.getAction(int index)
Get the specified bookmark action.
|
PDFAction |
PDFPage.getAction(int trigger,
int index)
Get a trigger action of a page.
|
PDFAction |
PDFDocument.getAction(int trigger,
int index)
Get document trigger action.
|
Annot |
PDFPage.getAnnot(java.lang.String filter,
int index)
Get annotation with a specified index, by specific filter.
|
Annot |
PDFPage.getAnnotAtDevicePos(java.lang.String filter,
Matrix matrix,
java.awt.Point pt,
float tolerance)
Get annotation at a specific position in device (in pixel), by specific
filter.
|
Annot |
PDFPage.getAnnotAtPos(java.lang.String filter,
java.awt.geom.Point2D.Float pt,
float tolerance)
Get annotation at a specific position in PDF page, by specific filter.
|
int |
PDFDocument.getAreaType(java.lang.String areaItem)
Get the type of area item.
|
int |
Font.getAscent()
Get the ascent value of the font.
|
PDFAttachment |
PDFAttachments.getAttachment(int index)
Get a specific
PDFAttachment object. |
RectF |
PDFTextSelection.getBBox()
Get bounding box(a rectangular area) of a PDF selected text area.
|
PDFBookmarkIterator.BookmarkData |
PDFBookmarkIterator.getBookmarkData()
Get the current bookmark item's data.
|
RectF |
PDFPage.getBox(int boxType)
Get page box which is a value of rectangle type.
|
Rect |
Font.getCharBBox(char unicode)
Get the specific character bounding box of the font.
|
int |
PDFTextPage.getCharIndexAtPos(float x,
float y,
float tolerance)
Get index of a character at or nearby position on the page.
|
PDFTextPage.CharInfo |
PDFTextPage.getCharInfo(int charIndex)
Get character information of a specific character.
|
java.lang.String |
PDFTextSelection.getChars()
Extract the whole text from a PDF selected text area.
|
java.lang.String |
PDFTextPage.getChars(int start,
int count)
Get text content in a page, within a specific character range.
|
float |
Font.getCharWidth(char unicode)
Get the specific character width of the font.
|
int[] |
PDFAttachment.getCheckSum()
Get checksum of the
PDFAttachment object. |
SizeF |
PDFReflowPage.getContentSize()
Get width and height of a reflow page after calling function
. |
DateTime |
PDFAttachment.getCreationDateTime()
Get the created
DateTime object of an attachment. |
DateTime |
PDFMetadata.getDateTime(java.lang.String key)
Get a date and time value from meta-data.
|
int |
Font.getDescent()
Get the descent value of the font.
|
java.lang.String |
PDFAttachment.getDescription()
Get description of the
PDFAttachment object. |
Matrix |
PDFPage.getDisplayMatrix(int x,
int y,
int width,
int height,
int rotation)
Get page transformation matrix.
|
int |
PDFDocument.getDisplayMode()
Get display mode.
|
java.lang.String |
PDFDocument.getEncryptionFilter()
Deprecated.
Current function will be deprecated in future. So, not recommend to use current function any more.
Instead, please use
and . |
java.lang.String |
PDFDocument.getEncryptionParam(java.lang.String key)
Deprecated.
Current function will be deprecated in future. So, not recommend to use current function any more.
Instead, please use
and . |
EncryptionParams |
PDFDocument.getEncryptionParams()
Get encryption parameter object.
|
java.lang.String |
PDFDocument.getEncryptionSubFilter()
Deprecated.
Current function will be deprecated in future. So, not recommend to use current function any more.
Instead, please use
and . |
int |
PDFDocument.getEncryptionType()
Deprecated.
Current function will be deprecated in future. So, not recommend to use current function any more.
Instead, please use
and . |
java.lang.String |
Font.getFaceName()
Retrieve face name of a font.
|
java.lang.String |
PDFAttachment.getFileName()
Get file name of the
PDFAttachment object. |
int |
PDFDocument.getFileVersion()
Get file version.
|
java.lang.String |
PDFReflowPage.getFocusData(Matrix matrix,
java.awt.Point point)
Get focus data corresponding to a given position in device coordinate
system.
|
java.awt.Point |
PDFReflowPage.getFocusPos(Matrix matrix,
java.lang.String focusData)
Get a point position in device coordinate system which corresponds to a
given focus data.
|
java.lang.String |
PDFTextLink.getLink(int linkIndex)
Get the linked URL associated with a specific hyperlink.
|
Matrix |
PDFReflowPage.getMatrix(int x,
int y,
int width,
int height,
int rotation)
Get matrix of a
PDFReflowPage object. |
PDFMetadata |
PDFDocument.getMetadata()
Get a
PDFMetadata object. |
DateTime |
PDFAttachment.getModifiedDateTime()
Get the last modified
DateTime object of the PDFAttachment . |
int |
PDFTextPage.getNextCharIndexByDirection(int curIndex,
int direction)
Deprecated.
Current function will be deprecated in future. So, not recommend to use current function any more.
Get index of the next character of a specific character in a specific
direction.
|
int |
PDFDocument.getNonFullScreenPageMode()
Get display mode for non full-screen mode from viewer preferences.
|
PDFPage |
PDFDocument.getPage(int pageIndex)
Get a
PDFPage object with the specified page index. |
PageObjects |
PDFPage.getPageObjects()
Get page objects in a PDF page.
|
int |
PDFDocument.getPasswordType()
Get the password type of current document.
|
int |
Progress.getPercent()
Get the percent of progressive process.
|
int |
PDFTextSelection.getPieceCharRange(int pieceIndex,
java.lang.Integer start)
Get the index of start character and the count of characters of a
specific segment.
|
RectF |
PDFTextSelection.getPieceRect(int index)
Get rectangular area of a specific segment, based on the result returned
by function
. |
int |
PDFTextSelection.getPieceRotation(int pieceIndex)
Get rotation of the specific segment, based on the result returned by
function
. |
PDFPath.PDFPoint |
PDFPath.getPoint(int index)
Get a specific point of the given path data.
|
BookmarkPos |
PDFBookmarkIterator.getPos()
Get the bookmark position handle from
PDFBookmarkIterator . |
int |
PDFDocument.getPrintCopies()
Get the number of copies to be printed.
|
int[] |
PDFDocument.getPrintRanges()
Get page ranges which are allowed to print.
|
java.lang.String |
PDFDocument.getPrintScale()
Get page scale.
|
int |
PDFDocument.getReadingDirection()
Get reading direction.
|
int |
PDFPage.getRotation()
Get page rotation.
|
PDFTextSelection |
PDFTextSearch.getSelection()
Get a
PDFTextSelection from a text search when a match is
found. |
PDFTextSelection |
PDFTextLink.getSelection(int linkIndex)
Get a
PDFTextSelection handle from a specific hyperlink. |
Signature |
PDFDocument.getSignature(int index)
Get the signature by specified index.
|
SizeF |
PDFWatermark.getSize()
Retrieve the size (width and height) of current watermark.
|
SizeF |
PDFPage.getSize()
Get page size.
|
long |
PDFAttachment.getSize()
Get the size of the
PDFAttachment object. |
java.lang.String |
PDFMetadata.getString(java.lang.String key)
Get a string value from meta-data.
|
boolean |
PDFDocument.getUIVisibility(java.lang.String uiItem)
Get UI visibility status.
|
int |
PDFDocument.getUserPermissions()
Get user permissions.
|
PDFDocument.PDFWrapperData |
PDFDocument.getWrapperData()
Get the
PDFWrapperData object of current document. |
long |
PDFDocument.getWrapperOffset()
Get wrapper offset.
|
boolean |
PDFBookmarkIterator.hasChild()
Check whether the current bookmark item has child node or not.
|
boolean |
PDFDocument.hasForm()
Check if the current document has form.
|
void |
PDFDocument.importAnnotsFromFDF(FileHandler fdfFile)
Import all the annotations of the document in a FDF file into the
document.
|
void |
PDFDocument.initiateJavaScript()
Perform the document javascript when document is opened, defining
JavaScript functions for use by other scripts in the document.
|
void |
PDFBookmarkIterator.insert(int position,
PDFBookmarkIterator.BookmarkData data)
Insert a new bookmark item at the position specified by index.
|
void |
PDFPage.insertAction(int trigger,
int index,
PDFAction action)
Insert a page trigger action.
|
void |
PDFDocument.insertAction(int trigger,
int index,
PDFAction action)
Insert document trigger action.
|
void |
PDFBookmarkIterator.insertAction(int index,
PDFAction action)
Insert bookmark action.
|
boolean |
PDFBookmarkIterator.insertAtPos(BookmarkPos newParentPos,
int childIndex)
Insert a bookmark to be the child (specified by index) of another
bookmark with specific position and original bookmark will be the next sibling.
|
void |
PDFAttachments.insertAttachment(int index,
PDFAttachment attachment)
Insert an attachment.
|
void |
PDFWatermark.insertToPage(PDFPage page)
Insert current watermark to a specific page.
|
boolean |
Font.isBold()
Judge whether a font object is bold or not.
|
boolean |
PDFAttachment.isEmbedded()
Check whether the
PDFAttachment object is an embedded file
or not. |
boolean |
PDFBookmarkIterator.isFirstChild()
Check whether the current bookmark item is the first child of its
parent or not.
|
boolean |
Font.isItalic()
Judge whether a
Font object is italic or not. |
boolean |
PDFBookmarkIterator.isLastChild()
Check whether the current bookmark item is the last child of its
parent or not.
|
boolean |
PDFDocument.isModified()
Get PDF document modify mark.
|
boolean |
PDFPage.isParsed()
Check whether the page has been parsed or not.
|
boolean |
PDFBookmarkIterator.isRoot()
Check whether the current bookmark item is root or not.
|
boolean |
PDFDocument.isWrapper()
Check whether the current document is a wrapper document or not.
|
void |
PDFPath.lineTo(java.awt.geom.Point2D.Float point)
Add a point to a given figure, and a line is to be drawn from the current
position to this point, which then becomes a new current position.
|
void |
PDFPage.loadAnnots()
Load annotations from a PDF page.
|
PDFAttachments |
PDFDocument.loadAttachments()
Retrieve a
PDFAttachments object. |
PDFForm |
PDFDocument.loadForm()
Retrieve a
PDFForm object. |
void |
PDFPath.moveTo(java.awt.geom.Point2D.Float point)
Add a point to start a figure.
|
boolean |
PDFBookmarkIterator.moveToFirstChild()
Move the cursor to its first child if exists.
|
boolean |
PDFBookmarkIterator.moveToNextSibling()
Move the cursor to its next sibling if exists.
|
boolean |
PDFBookmarkIterator.moveToParent()
Move the cursor to its parent if exists.
|
boolean |
PDFBookmarkIterator.moveToPos(BookmarkPos position)
Move the cursor to a position specified by a
BookmarkPos object. |
boolean |
PDFBookmarkIterator.moveToPrevSibling()
Move the cursor to its previous sibling if exists.
|
void |
PDFBookmarkIterator.moveToRoot()
Move the cursor to the root of PDF bookmark.
|
static PDFDocument |
PDFDocument.open(FileHandler file,
byte[] password)
Open an existing PDF document.
|
static PDFDocument |
PDFDocument.open(FileHandler file,
byte[] password,
int flag)
Open an existing PDF document, with specific loading flags.
|
java.lang.String |
PDFDocument.pageIndexToPageLabel(int index)
Convert a page index to page label.
|
int |
PDFDocument.pageLabelToPageIndex(boolean isCase,
java.lang.String label)
Convert a page label to page index.
|
static void |
PDFDocument.registerSecurityHandler(java.lang.String filter,
SecurityHandler securityHandler)
Register a custom security handler to Foxit PDF SDK, enabling access to a PDF document which is protected by customized security handler.
|
void |
Renderer.release()
Release the
Renderer object. |
void |
RenderContext.release()
Release a PDF rendering context object.
|
void |
PDFWatermark.release()
Release current watermark object.
|
void |
PDFTextSelection.release()
Release all resources allocated for a
PDFTextSelection
handle. |
void |
PDFTextSearch.release()
Clear all resources allocated for a
PDFTextSearch object. |
void |
PDFTextPage.release()
Release all resources allocated for a
PDFTextPage object. |
void |
PDFTextLink.release()
Release all resources allocated for a
PDFTextLink . |
void |
PDFReflowPage.release()
Release all resources allocated for a
PDFReflowPage handle. |
void |
PDFPath.release()
Release all related resources of the given
PDFPath object. |
void |
PDFBookmarkIterator.release()
Release a
PDFBookmarkIterator object. |
void |
PDFAttachments.release()
Release a
PDFAttachments object. |
void |
PDFAttachment.release()
Release a
PDFAttachment object. |
void |
BookmarkPos.release()
Release a
BookmarkPos object. |
static void |
Font.release(Font font)
Release a
Font object. |
void |
PDFDocument.releaseForm()
Release a PDF interactive form object.
|
void |
PDFBookmarkIterator.remove()
Remove the current bookmark item.
|
boolean |
PDFBookmarkIterator.removeAction(int index)
Remove a specific bookmark action.
|
boolean |
PDFPage.removeAction(int trigger,
int index)
Remove a page trigger action.
|
boolean |
PDFDocument.removeAction(int trigger,
int index)
Remove document trigger action.
|
boolean |
PDFBookmarkIterator.removeAllActions()
Remove all bookmark actions.
|
boolean |
PDFPage.removeAllActions(int trigger)
Remove all trigger actions of a page.
|
boolean |
PDFDocument.removeAllActions(int trigger)
Remove all document trigger actions.
|
void |
PDFPage.removeAnnot(Annot annot)
Remove an annotation from page.
|
boolean |
PDFAttachments.removeAttachment(PDFAttachment attachment)
Remove an attachment.
|
void |
PDFDocument.removeLayer(Layer layer,
int options)
Remove a layer from current PDF document.
|
boolean |
PDFPath.removePoint(int index)
Remove the specific point of the given path data.
|
boolean |
PDFPage.removeWatermark(int index)
Remove a watermark by index from current page,
not including the SDK trial watermark.
|
void |
PDFPage.removeWatermarks()
Remove all watermarks in the current page.
|
void |
PDFDocument.reopen(FileHandler file,
byte[] password)
Re-open PDF file.
|
void |
PDFDocument.saveAsWrapper(FileHandler file,
PDFDocument.PDFWrapperData data,
int userPermissions,
byte[] ownerPassword)
Save a PDF document as a wrapper file.
|
void |
PDFDocument.saveAsWrapperFile(FileHandler file,
PDFDocument.PDFWrapperData data,
int userPermissions,
java.lang.String ownerPassword)
Deprecated.
Current function will be deprecated in future. So, not recommend to use current function any more.
Instead, please use
PDFDocument.saveAsWrapper(FileHandler, PDFWrapperData, int, byte[]) . |
PDFTextSelection |
PDFTextPage.selectByRange(int start,
int count)
Get a text selection handle by specific character range.
|
PDFTextSelection |
PDFTextPage.selectByRectangle(RectF rect)
Get a text selection handle by specific rectangle.
|
void |
PDFPage.serializeAnnot(Archive archive,
Annot annot)
Serialize a annotation.
|
boolean |
PDFPage.setAction(int trigger,
int index,
PDFAction action)
Set a page trigger action.
|
boolean |
PDFDocument.setAction(int trigger,
int index,
PDFAction action)
Set document trigger action.
|
boolean |
PDFBookmarkIterator.setAction(int index,
PDFAction action)
Set bookmark action.
|
void |
PDFDocument.setAreaType(java.lang.String uiItem,
int types)
Set the area type in viewer preferences.
|
void |
PDFBookmarkIterator.setBookmarkData(PDFBookmarkIterator.BookmarkData data)
Set data to the current bookmark.
|
void |
PDFPage.setBox(int boxType,
RectF pageBox)
Set page area which is a rectangle type of value.
|
static void |
PDFDocument.setCertificateHandler(CertificateHandler certificateHandler)
Set certificate security handler to Foxit PDF SDK.
|
void |
PDFAttachment.setCheckSum(int[] checkSum)
Set the checksum of the
PDFAttachment object. |
void |
Renderer.setClipRect(Rect clipRect)
Set current clipping rectangle into a
Renderer object. |
void |
PDFAttachment.setCreationDateTime(DateTime date)
Set the creation date of the
PDFAttachment
object. |
void |
PDFMetadata.setDateTime(java.lang.String key,
DateTime date)
Set a date value to a field indicated by the parameter key in meta-data.
|
void |
PDFAttachment.setDescription(java.lang.String description)
Set the description of the
PDFAttachment object. |
void |
PDFAttachment.setFile(FileHandler file)
Set the file of an attachment.
|
void |
PDFAttachment.setFileName(java.lang.String fileName,
boolean bURL)
Set the file name of the
PDFAttachment object. |
void |
Renderer.setFlags(int flags)
Set flags of a
Renderer object. |
void |
RenderContext.setFlags(int flags)
Set flags of a PDF rendering context.
|
static void |
PDFDocument.setFoxitDRMHandler(FoxitDRMHandler foxitDRMHandler)
Set Foxit DRM security handler to Foxit PDF SDK.
|
static void |
Renderer.setGamma(float gamma)
Set gamma value for rendering text.
|
void |
RenderContext.setHalftoneLimit(int halftoneLimit)
Set the halftone limit of a PDF rendering context.
|
void |
PDFPage.setIndex(int index)
Change page index of a page.
|
void |
RenderContext.setLayerContext(LayerContext layerContext)
Set layer context to render context object.
|
void |
PDFDocument.setLayersBaseState(int state)
Set the base state for all layers in the default configuration.
|
void |
PDFReflowPage.setLineSpace(float lineSpace)
Set line space before calling function
. |
void |
RenderContext.setMatrix(Matrix matrix)
Set a transformation matrix of a PDF rendering context.
|
void |
PDFAttachment.setModifiedDateTime(DateTime date)
Set the modification date of the
PDFAttachment . |
void |
PDFDocument.setNonFullScreenPageMode(int mode)
Set display mode for non full-screen mode in viewer preferences.
|
void |
RenderContext.setOption(int option,
RenderOption renderOption)
Set option parameter of a PDF rendering context.
|
boolean |
PDFPath.setPoint(int index,
PDFPath.PDFPoint point)
Set the specific point of the path data.
|
void |
PDFDocument.setPrintCopies(int copies)
Set the number of copies to be printed.
|
void |
PDFDocument.setPrintRanges(int[] pageRanges)
Set the page ranges to be printed.
|
void |
PDFDocument.setPrintScale(java.lang.String printScale)
Set page scaling in viewer preferences.
|
void |
PDFDocument.setReadingDirection(int direction)
Set reading direction in viewer preferences.
|
void |
PDFPage.setRotation(int rotation)
Set page rotation.
|
void |
PDFReflowPage.setSize(float width,
float height)
Set screen size before calling function
. |
void |
PDFPage.setSize(float width,
float height)
Set page size.
|
void |
PDFMetadata.setString(java.lang.String key,
java.lang.String value)
Set a string value to a field indicated by the parameter key in
meta-data.
|
void |
PDFDocument.setUIVisibility(java.lang.String uiItem,
boolean uiVisible)
Set UI visibility in viewer preferences.
|
Progress |
PDFDocument.startEncryption(EncryptionParams params,
FileHandler encryptedFile,
int flag)
Start encryption on a PDF document.
|
static Progress |
PDFDocument.startImportPages(PDFDocument dstDoc,
int startIndex,
PDFDocument srcDoc,
int[] pageRanges,
java.lang.String layerName)
To start a progressive process of inserting a range of pages from an
extra source document (or with its layer information) into a target
document.
|
Progress |
PDFReflowPage.startParse(int flags)
Start parsing process for a
PDFReflowPage object. |
Progress |
PDFPage.startParse(int flag)
Start parsing a PDF page.
|
Progress |
PDFReflowPage.startRender(RenderContext context,
Renderer render)
Start rendering a reflowed page.
|
Progress |
PDFPage.startRender(RenderContext context,
Renderer render,
int flag)
Start rendering a PDF page in a renderer with a PDF rendering context.
|
Progress |
PDFPage.startRenderAnnots(RenderContext context,
Renderer render,
Annot[] annots)
Render annotations on render context.
|
Progress |
PDFPage.startRenderFormControls(RenderContext context,
Renderer render,
PDFFormControl[] formControls)
Start rendering a PDF form control in a renderer with a PDF rendering
context.
|
Progress |
PDFPage.startRenderPageAnnots(RenderContext context,
Renderer render)
Render all annotations of a page on render context.
|
Progress |
PDFPage.startRenderPageFormControls(RenderContext context,
Renderer render)
Start rendering a page's form controls in a renderer with a PDF rendering
context.
|
Progress |
PDFPage.startRenderPageSignatures(RenderContext context,
Renderer renderer)
Start to render all signatures of current PDF page with the specified render context and renderer.
|
Progress |
PDFDocument.startSaveToFile(FileHandler file,
int flag)
Start saving a PDF document to a file in a progressive manner.
|
boolean |
PDFTextSearch.startSearch(java.lang.String text,
int flags,
int startPostion)
Deprecated.
Current function will be deprecated in future. So, not recommend to use current function any more.
Instead, please use
. |
PDFTextSearch |
PDFTextPage.startSearch(java.lang.String text,
int flags,
int startPostion)
Start a PDF text search process.
|
void |
PDFPath.transform(Matrix matrix)
Transform all path points into path data with a given matrix.
|
Matrix |
PDFPage.transformDeviceToPage(Rect srcRect,
RectF dstRect,
int rotation)
Calculate transformation matrix from device coordinate to PDF page
coordinate.
|
Matrix |
PDFPage.transformPageToDevice(RectF srcRect,
Rect dstRect,
int rotation)
Calculate transformation matrix from PDF page coordinate to device
coordinate.
|
void |
PDFPage.unloadAnnots()
Unload annotations of a PDF page.
|
static void |
PDFDocument.unregisterSecurityHandler(java.lang.String filter)
Unregister a custom security handler from Foxit PDF SDK.
|
boolean |
PDFBookmarkIterator.update()
Update specific bookmark iterator object after object of bookmark tree
has been changed.
|
void |
PDFAttachment.writeToFile(FileHandler file)
Write the attachment to a file.
|
Modifier and Type | Method and Description |
---|---|
static PDFDestination |
PDFDestination.create(int pageIndex,
int zoomMode,
float[] params)
create a new
PDFDestination object with the specified page index,
zoom mode and params. |
static PDFEmbeddedGotoActionTarget |
PDFEmbeddedGotoActionTarget.create(java.lang.String relationship,
java.lang.String fileName,
java.lang.String destName,
java.lang.String annotName,
int pageIndex,
int annotIndex)
Create a new target object.
|
static PDFAction |
PDFAction.createEmbeddedGotoAction(PDFEmbeddedGotoActionTarget target,
PDFAttachment attachment,
PDFDestination dest,
boolean isNewWindow)
Create a new embedded go-to action.
|
static PDFAction |
PDFAction.createEmbeddedGotoAction(PDFEmbeddedGotoActionTarget target,
PDFAttachment attachment,
java.lang.String destName,
boolean isNewWindow)
Create a new embedded go-to action.
|
static PDFAction |
PDFAction.createGotoAction(PDFDestination destination)
Create a new go-to action.
|
static PDFAction |
PDFAction.createHideAction(java.lang.String[] fieldsList,
boolean isHide)
Create a new hide action.
|
static PDFAction |
PDFAction.createImportDataAction(PDFAttachment attachment)
Create a new import-data action.
|
static PDFAction |
PDFAction.createJavascriptAction(java.lang.String script)
Create a new JavaScript action.
|
static PDFAction |
PDFAction.createLaunchAction(java.lang.String fileName,
java.lang.String defaultPath,
java.lang.String operations,
java.lang.String parameters,
boolean isNewWindow)
Create a new launch action.
|
static PDFAction |
PDFAction.createNamedAction(java.lang.String name)
Create a new named action.
|
static PDFAction |
PDFAction.createRemoteGotoAction(java.lang.String fileName,
PDFDestination destination)
Create a new remote go-to action.
|
static PDFAction |
PDFAction.createRemoteGotoAction(java.lang.String fileName,
java.lang.String destName)
Create a new embedded go-to action.
|
static PDFAction |
PDFAction.createResetFormAction(int flags,
java.lang.String[] fields)
Create a new reset-form action.
|
static PDFAction |
PDFAction.createSubmitFormAction(int flags,
java.lang.String[] fields,
PDFAttachment attachment)
Create a new submit-form action.
|
static PDFAction |
PDFAction.createURIAction(java.lang.String url,
boolean isMapMousePos)
Create a new URI action.
|
int |
PDFEmbeddedGotoActionTarget.getAnnotIndex()
Get annotation index of current target.
|
java.lang.String |
PDFEmbeddedGotoActionTarget.getAnnotName()
Get annotation name of current target.
|
PDFAttachment |
PDFSubmitFormAction.getAttachment()
Get attachment which the form data is submitted.
|
PDFAttachment |
PDFLaunchAction.getAttachment()
Get attachment of launch action.
|
PDFAttachment |
PDFImportDataAction.getAttachment()
Get attachment of import action.
|
PDFAttachment |
PDFEmbeddedGotoAction.getAttachment()
Get attachment of embedded go-to action.
|
java.lang.String |
PDFLaunchAction.getDefaultPath()
Get default path of launch action.
|
PDFDestination |
PDFRemoteGotoAction.getDestination()
Get destination of current action.
|
PDFDestination |
PDFGotoAction.getDestination()
Get destination of go-to action.
|
PDFDestination |
PDFEmbeddedGotoAction.getDestination()
Get destination of embedded go-to action.
|
java.lang.String |
PDFRemoteGotoAction.getDestName()
Get destination name.
|
java.lang.String |
PDFEmbeddedGotoActionTarget.getDestName()
Get destination name of current target.
|
java.lang.String |
PDFEmbeddedGotoAction.getDestName()
Get destination name of embedded go-to action.
|
java.lang.String[] |
PDFSubmitFormAction.getFields()
Get an array which are names of fields.
|
java.lang.String[] |
PDFResetFormAction.getFields()
Get fields to be included or excluded.
|
java.lang.String[] |
PDFHideAction.getFields()
Get an array which are names of fields to be included or excluded.
|
java.lang.String |
PDFRemoteGotoAction.getFileName()
Get file name.
|
java.lang.String |
PDFLaunchAction.getFileName()
Get file name of launch action.
|
java.lang.String |
PDFEmbeddedGotoActionTarget.getFileName()
Get file name of current target.
|
long |
PDFSubmitFormAction.getFlags()
Get flags specifying various characteristics of the action.
|
int |
PDFResetFormAction.getFlags()
Get flags specify including or excluding fields.
|
java.lang.String |
PDFJavascriptAction.getJavascript()
Get JavaScript contents.
|
java.lang.String |
PDFNamedAction.getName()
Get action name of current action.
|
PDFEmbeddedGotoActionTarget |
PDFEmbeddedGotoActionTarget.getNextTarget()
Get next target.
|
java.lang.String |
PDFLaunchAction.getOperation()
Get operation.
|
int |
PDFEmbeddedGotoActionTarget.getPageIndex()
Get page index of current target.
|
java.lang.String |
PDFLaunchAction.getParameters()
Get parameters.
|
java.lang.String |
PDFEmbeddedGotoActionTarget.getRelationship()
Get relationship of current target.
|
PDFEmbeddedGotoActionTarget |
PDFEmbeddedGotoAction.getTarget()
Get target of embedded go-to action.
|
java.lang.String |
PDFURIAction.getURL()
Get URL address.
|
boolean |
PDFHideAction.isHide()
Check whether hide annotations or not.
|
boolean |
PDFURIAction.isMapMousePos()
Check whether to track the mouse position when the URI is resolved.
|
boolean |
PDFLaunchAction.isNewWindow()
Check whether a new window should be opened.
|
boolean |
PDFEmbeddedGotoAction.isNewWindow()
Check whether a new window should be opened or not.
|
void |
PDFEmbeddedGotoActionTarget.release()
Release all resources of current
PDFEmbeddedGotoActionTarget object. |
void |
PDFAction.release()
Release all resources of the action.
|
void |
PDFEmbeddedGotoActionTarget.setAnnotIndex(int annotIndex)
Set annotation index of current target.
|
void |
PDFEmbeddedGotoActionTarget.setAnnotName(java.lang.String annotName)
Set annotation name of current target.
|
void |
PDFSubmitFormAction.setAttachment(PDFAttachment attachment)
Set the attachment which the form data is submitted.
|
void |
PDFLaunchAction.setAttachment(PDFAttachment attachment)
Set the attachment which is the application or document to be launched.
|
void |
PDFImportDataAction.setAttachment(PDFAttachment attachment)
Set the attachment from which form data is imported.
|
void |
PDFEmbeddedGotoAction.setAttachment(PDFAttachment attachment)
Set attachment of embedded go-to action.
|
void |
PDFLaunchAction.setDefaultPath(java.lang.String defaultPath)
Set default path of launch action.
|
void |
PDFRemoteGotoAction.setDestination(PDFDestination destination)
Set destination.
|
void |
PDFGotoAction.setDestination(PDFDestination destination)
Set destination of go-to action.
|
void |
PDFEmbeddedGotoAction.setDestination(PDFDestination destination)
Set destination of embedded go-to action.
|
void |
PDFRemoteGotoAction.setDestName(java.lang.String destName)
Set destination name.
|
void |
PDFEmbeddedGotoActionTarget.setDestName(java.lang.String destName)
Set destination name of current target.
|
void |
PDFEmbeddedGotoAction.setDestName(java.lang.String destName)
Set destination name of embedded go-to action.
|
void |
PDFSubmitFormAction.setFields(java.lang.String[] fields)
Set action's fields.
|
void |
PDFResetFormAction.setFields(java.lang.String[] fields)
Set fields to be included or excluded.
|
void |
PDFHideAction.setFields(java.lang.String[] fields)
Set fields to be included or excluded.
|
void |
PDFRemoteGotoAction.setFileName(java.lang.String fileName)
Set file name.
|
void |
PDFLaunchAction.setFileName(java.lang.String fileName)
Set file name of launch action.
|
void |
PDFEmbeddedGotoActionTarget.setFileName(java.lang.String fileName)
Set filename of current target.
|
void |
PDFSubmitFormAction.setFlags(int flags)
Set flags to specify various characteristics of the action.
|
void |
PDFResetFormAction.setFlags(int flags)
Set flags specify including or excluding fields.
|
void |
PDFHideAction.setHide(boolean isHide)
Set hide annotations or not.
|
void |
PDFJavascriptAction.setJavascript(java.lang.String javaScript)
Set JavaScript contents.
|
void |
PDFURIAction.setMapMousePos(boolean isMapMousePos)
Set whether to track the mouse position when the URI is resolved.
|
void |
PDFNamedAction.setName(java.lang.String name)
Set action name of named action.
|
void |
PDFLaunchAction.setNewWindow(boolean isNewWindow)
Set a new window which should be opened or not.
|
void |
PDFEmbeddedGotoAction.setNewWindow(boolean isNewWindow)
Set whether a new window should be opened or not.
|
void |
PDFEmbeddedGotoActionTarget.setNextTarget(PDFEmbeddedGotoActionTarget target)
Set next target of current target.
|
void |
PDFLaunchAction.setOperation(java.lang.String operation)
Set operation.
|
void |
PDFEmbeddedGotoActionTarget.setPageIndex(int pageIndex)
Set page index of current target.
|
void |
PDFLaunchAction.setParameters(java.lang.String parameters)
Set parameters.
|
void |
PDFDestination.setParams(float[] params)
Set parameters of destination.
|
void |
PDFEmbeddedGotoActionTarget.setRelationship(java.lang.String relationship)
Set relationship between current document and the target document.
|
void |
PDFEmbeddedGotoAction.setTarget(PDFEmbeddedGotoActionTarget target)
Set target of embedded go-to action.
|
void |
PDFURIAction.setURL(java.lang.String url)
Set URL address.
|
void |
PDFDestination.setZoomMode(int zoomMode)
Set zoom mode of destination.
|
Modifier and Type | Method and Description |
---|---|
Markup |
Markup.addState(int stateModel,
int state)
Add a specific state to current markup annotation.
|
abstract boolean |
AnnotIconProvider.canChangeColor(java.lang.Object clientData,
java.lang.String iconType,
java.lang.String iconID)
Callback function to determine whether supports to change the icon color
of specific annotation type.
|
int |
Widget.countActions(int trigger)
Count actions associated with current widget annotation.
|
int |
Link.countActions(int trigger)
Count actions associated with current link annotation.
|
int |
Markup.countReplies()
Count replies of current markup annotation.
|
int |
Markup.countStateAnnots(int stateModel)
Count specific state annotations associated with current markup annotation.
|
PDFAction |
Widget.getAction(int trigger,
int index)
Get action data of specific index associated with current annotation.
|
PDFAction |
Link.getAction(int trigger,
int index)
Get action data of specific index associated with current link annotation.
|
int |
FreeText.getAlignment()
Get alignment of current free text annotation.
|
PDFAttachment |
FileAttachment.getAttachment()
Get attachment of current file attachment annotation.
|
Annot.Border |
Annot.getBorder()
Get border of current PDF annotation.
|
long |
Annot.getBorderColor()
Get border color of current PDF annotation.
|
java.awt.geom.Point2D.Float[] |
FreeText.getCalloutLinePoints()
Get callout line points of current free text annotation.
|
float[] |
Line.getCaptionOffset()
Get caption offset of current line annotation.
|
java.lang.String |
Line.getCaptionPosition()
Get caption position of current line annotation.
|
java.lang.String |
Annot.getContents()
Get contents of current PDF annotation.
|
DateTime |
Markup.getCreationDateTime()
Get creation time of current markup annotation.
|
DefaultAppearance |
FreeText.getDefaultAppearance()
Get default appearance of current free text annotation, which can be used in
formatting text.
|
Rect |
Annot.getDeviceRect(boolean bTransformIcon,
Matrix matrix)
Get the rectangle of current PDF annotation in device coordinations.
|
abstract SizeF |
AnnotIconProvider.getDisplaySize(java.lang.Object clientData,
java.lang.String iconType,
java.lang.String iconID)
Callback function to retrieve icon size when display, in device
size(pixel normally).
|
long |
Square.getFillColor()
Get fill color of current square annotation.
|
long |
Polyline.getFillColor()
Get fill color of current polyline annotation.
|
long |
Polygon.getFillColor()
Get fill color of current polygon annotation.
|
long |
FreeText.getFillColor()
Get fill color of current free text annotation.
|
long |
Circle.getFillColor()
Get fill color of current circle annotation.
|
int |
Annot.getFlags()
Get current PDF annotation flags.
|
Markup[] |
Markup.getGroupElements()
Get group elements if annotation is in a group, including itself.
|
Markup |
Markup.getGroupHeader()
Get header annotation of a group which current annotation belongs to.
|
int |
Widget.getHighlightingMode()
Get highlighting mode of current PDF widget annotation.
|
int |
Link.getHighlightingMode()
Get highlighting mode of current link annotation.
|
abstract PDFPage |
AnnotIconProvider.getIcon(java.lang.Object clientData,
java.lang.String iconType,
java.lang.String iconID,
long color)
Callback function to retrieve icon, which is as PDF page contents.
|
Widget.AnnotIconFit |
Widget.getIconFit()
Get icon fit of current widget annotation.
|
java.lang.String |
Text.getIconName()
Get icon name of current text annotation.
|
java.lang.String |
Sound.getIconName()
Get icon name of current sound annotation.
|
java.lang.String |
RubberStamp.getIconName()
Get icon name of current stamp annotation.
|
java.lang.String |
FileAttachment.getIconName()
Get icon name of current file attachment annotation.
|
int |
Annot.getIndex(java.lang.String filter)
Get the index of current PDF annotation, by specific filter.
|
PDFPath |
Ink.getInkList()
Get ink list data of current ink annotation.
|
float[] |
Square.getInnerRectMargin()
Get the margin between inner rectangle and rectangle of current square
annotation.
|
float[] |
FreeText.getInnerRectMargin()
Get the margin between inner rectangle and rectangle of current free text
annotation.
|
float[] |
Circle.getInnerRectMargin()
Get the margin between inner rectangle and rectangle of current circle
annotation.
|
float[] |
Caret.getInnerRectMargin()
Get the margin between inner rectangle and rectangle of current caret
annotation.
|
java.lang.String |
Markup.getIntent()
Get intent of current markup annotation.
|
float |
Line.getLeaderLineExtension()
Get leader line extension of current line annotation.
|
float |
Line.getLeaderLineLength()
Get leader line length of current line annotation.
|
float |
Line.getLeaderLineOffset()
Get leader line offset of current line annotation.
|
java.lang.String[] |
Polyline.getLineEndingStyles()
Get line ending styles of current polyline annotation.
|
java.lang.String[] |
Line.getLineEndingStyles()
Get line ending styles of current line annotation.
|
java.lang.String[] |
FreeText.getLineEndingStyles()
Get line ending styles of current free text annotation.
|
java.awt.geom.Point2D.Float[] |
Line.getLinePosition()
Get line position of current line annotation.
|
java.lang.String |
Widget.getMKCaption(int mkEntry)
Get caption of a specific type in MK dictionary.
|
long |
Widget.getMKColor(int mkEntry)
Get color of a specific type in MK dictionary.
|
long |
Screen.getMKColor(int mkEntry)
Get color of a specific type in MK dictionary.
|
Bitmap |
Widget.getMKIconBitmap(int mkEntry)
Get icon bitmap of specific icon type in MK dictionary.
|
int |
Widget.getMKRotation()
Get rotation (the number of degrees) in MK dictionary.
|
int |
Screen.getMKRotation()
Get rotation (the number of degrees) in MK dictionary.
|
DateTime |
Annot.getModifiedDateTime()
Get modification time of current PDF annotation.
|
java.lang.String |
Annot.getName()
Get name property of current PDF annotation.
|
float |
Markup.getOpacity()
Get opacity of current markup annotation.
|
boolean |
Text.getOpenStatus()
Get open status of current text annotation.
|
boolean |
Popup.getOpenStatus()
Get open status of current popup annotation.
|
Popup |
TextMarkup.getPopup()
Get the associated popup annotation of current text markup annotation.
|
Popup |
Text.getPopup()
Get the associated popup annotation of current text annotation.
|
Popup |
Square.getPopup()
Get the associated popup annotation of current square annotation.
|
Popup |
RubberStamp.getPopup()
Get the associated popup annotation of current stamp annotation.
|
Popup |
Polyline.getPopup()
Get the associated popup annotation of current polyline annotation.
|
Popup |
Polygon.getPopup()
Get the associated popup annotation of current polygon annotation.
|
Popup |
Line.getPopup()
Get the associated popup annotation of current line annotation.
|
Popup |
Ink.getPopup()
Get the associated popup annotation of current ink annotation.
|
Popup |
FileAttachment.getPopup()
Get the associated popup annotation of current file attachment annotation.
|
Popup |
Circle.getPopup()
Get the associated popup annotation of current circle annotation.
|
Popup |
Caret.getPopup()
Get the associated popup annotation of current caret annotation.
|
abstract java.lang.String |
AnnotIconProvider.getProviderIDName(java.lang.Object clientData)
Callback function to retrieve identity information of icon provider.
|
abstract int |
AnnotIconProvider.getProviderVersion(java.lang.Object clientData)
Callback function to retrieve the version number of icon provider.
|
Annot.QuadpointsF[] |
TextMarkup.getQuadPoints()
Get quadrilateral points of current text markup annotation.
|
Annot.QuadpointsF[] |
Link.getQuadPoints()
Get quadrilaterals points of current link annotation.
|
RectF |
Annot.getRect()
Get the rectangle of current PDF annotation in PDF page coordinations.
|
Markup |
Markup.getReply(int index)
Get reply of current markup annotation, with specific index.
|
int[] |
Markup.getState()
Get state out of current state text annotation.
|
Markup |
Markup.getStateAnnot(int stateModel,
int index)
Get specified state annotation associated with current markup annotation.
|
java.lang.String |
Markup.getSubject()
Get subject of current markup annotation.
|
java.lang.String |
Caret.getSymbol()
Get symbol of current caret annotation.
|
java.lang.String |
Markup.getTitle()
Get title of current markup annotation.
|
java.lang.String |
Annot.getType()
Get the type of current PDF annotation.
|
java.awt.geom.Point2D.Float[] |
Polyline.getVertices()
Get vertices of current polyline annotation.
|
java.awt.geom.Point2D.Float[] |
Polygon.getVertices()
Get vertices of current polygon annotation.
|
boolean |
Line.hasCaptionContents()
Checks if there's a caption to current line annotation.
|
abstract boolean |
AnnotIconProvider.hasIcon(java.lang.Object clientData,
java.lang.String iconType,
java.lang.String iconID)
Callback function to determine whether icon provider supports icon for
specific annotation type.
|
boolean |
Widget.hasMKEntry(int mkEntry)
Checks if specific entry is in MK dictionary.
|
boolean |
Screen.hasMKEntry(int mkEntry)
Checks if specific entry is in MK dictionary.
|
void |
Widget.insertAction(int trigger,
int index,
PDFAction action)
Insert action data of specified index associated with current widget
annotation.
|
void |
Link.insertAction(int trigger,
int index,
PDFAction action)
Insert action data of specified index associated with current link annotation.
|
Markup |
Markup.insertReply(int index)
Insert a new empty reply with a specified index to current markup annotation.
|
boolean |
Markup.isGrouped()
Checks whether current annotation is in a group or not.
|
boolean |
Annot.isMarkup()
Checks whether current PDF annotation is a
Markup
annotation. |
boolean |
Markup.isTextMarkup()
Checks whether current annotation is a
TextMarkup
annotation. |
void |
Annot.move(RectF newRect)
Move current pdf annotation to a new position specified by a rectangle.
|
abstract void |
AnnotIconProvider.release(java.lang.Object clientData)
Callback function to release current
AnnotIconProvider
object. |
boolean |
Widget.removeAction(int trigger,
int index)
Remove an action of specified index associated with current widget annotation.
|
boolean |
Link.removeAction(int trigger,
int index)
Remove an action of specified index associated with current link annotation.
|
boolean |
Widget.removeAllActions(int trigger)
Remove all the actions associated with current widget annotation.
|
boolean |
Link.removeAllActions(int trigger)
Remove all the actions associated with current link annotation.
|
void |
Markup.removeAllReplies()
Remove all the replies of current markup annotation.
|
void |
Markup.removeAllStates()
Remove all the state annotations associated with current markup annotation.
|
boolean |
Widget.removeMKEntry(int mkEntry)
Remove a specified entry in MK dictionary.
|
boolean |
Screen.removeMKEntry(int mkEntry)
Remove a specified entry in MK dictionary.
|
boolean |
Markup.removeReply(int index)
Remove a reply with specified index from current markup annotation.
|
void |
Widget.resetAppearance()
Reset(regenerate) appearance of current widget annotation.
|
void |
TextMarkup.resetAppearance()
Reset(regenerate) appearance of current text markup annotation.
|
void |
Text.resetAppearance()
Reset(regenerate) appearance of current text annotation.
|
void |
Square.resetAppearance()
Reset(regenerate) appearance of current square annotation.
|
void |
RubberStamp.resetAppearance()
Reset(regenerate) appearance of current stamp annotation.
|
void |
Polyline.resetAppearance()
Reset(regenerate) appearance of current polyline annotation.
|
void |
Polygon.resetAppearance()
Reset(regenerate) appearance of current polygon annotation.
|
void |
Link.resetAppearance()
Reset(regenerate) appearance of current link annotation.
|
void |
Line.resetAppearance()
Reset(regenerate) appearance of current line annotation.
|
void |
Ink.resetAppearance()
Reset(regenerate) appearance of current ink annotation.
|
void |
FreeText.resetAppearance()
Reset(regenerate) appearance of current free text annotation.
|
void |
FileAttachment.resetAppearance()
Reset(regenerate) appearance of current file attachment annotation.
|
void |
Circle.resetAppearance()
Reset(regenerate) appearance of current circle annotation.
|
void |
Caret.resetAppearance()
Reset(regenerate) appearance of current caret annotation.
|
boolean |
Widget.setAction(int trigger,
int index,
PDFAction action)
Set action data of specified index associated with current widget annotation.
|
boolean |
Link.setAction(int trigger,
int index,
PDFAction action)
Set action data of specified index associated with current link annotation.
|
void |
FreeText.setAlignment(int alignment)
Set alignment of current free text annotation.
|
void |
FileAttachment.setAttachment(PDFAttachment attachment)
Set attachment of current file attachment annotation.
|
void |
Annot.setBorder(Annot.Border border)
Set border of current PDF annotation.
|
void |
Annot.setBorderColor(long color)
Set border color of current PDF annotation.
|
void |
FreeText.setCalloutLinePoints(java.awt.geom.Point2D.Float pt1,
java.awt.geom.Point2D.Float pt2,
java.awt.geom.Point2D.Float pt3)
Set callout line points of a free text annotation.
|
void |
Line.setCaptionOffset(float offsetX,
float offsetY)
Set caption offset of current line annotation.
|
void |
Line.setCaptionPosition(java.lang.String captionPos)
Set caption position of current line annotation.
|
void |
Line.setCaptionVisibility(boolean isVisible)
Set flag which decides whether to set a caption to the annotation or not.
|
void |
Annot.setContents(java.lang.String contents)
Set contents of current PDF annotation.
|
void |
Markup.setCreationDateTime(DateTime dateTime)
Set creation time of current markup annotation.
|
void |
FreeText.setDefaultAppearance(DefaultAppearance defaultAppearance)
Set default appearance of current free text annotation, which can be used in
formatting the text.
|
void |
Square.setFillColor(long color)
Set fill color of current square annotation.
|
void |
Polyline.setFillColor(long color)
Set fill color of current polyline annotation.
|
void |
Polygon.setFillColor(long color)
Set fill color of current polygon annotation.
|
void |
FreeText.setFillColor(long color)
Set fill color of current free text annotation.
|
void |
Circle.setFillColor(long color)
Set fill color of current circle annotation.
|
void |
Annot.setFlags(int flags)
Set current PDF annotation flags.
|
static void |
Markup.setGroup(Markup[] annots,
int headerIndex)
Group all the input annotations.
|
void |
Widget.setHighLightingMode(int hlMode)
Set highlighting mode of current PDF widget annotation.
|
void |
Link.setHighLightingMode(int hlMode)
Set highlighting mode of current link annotation.
|
void |
Widget.setIconFit(Widget.AnnotIconFit iconfit)
Set icon fit of current widget annotation.
|
void |
Text.setIconName(java.lang.String iconName)
Set icon name of current text annotation.
|
void |
RubberStamp.setIconName(java.lang.String iconName)
Set icon name of current stamp annotation.
|
void |
FileAttachment.setIconName(java.lang.String iconName)
Set icon name of current file attachment annotation.
|
static void |
Annot.setIconProvider(AnnotIconProvider iconProvider)
Set handler of PDF annotation icon provider to SDK management.
|
void |
RubberStamp.setImage(Image image,
int compress)
Set image to current stamp annotation.
|
void |
Ink.setInkList(PDFPath path)
Set ink list data of current ink annotation.
|
void |
Square.setInnerRectMargin(float[] values)
Set the inner rectangle of current square annotation.
|
void |
FreeText.setInnerRectMargin(float[] values)
Set the inner rectangle of current free text annotation.
|
void |
Circle.setInnerRectMargin(float[] values)
Set the inner rectangle of current circle annotation.
|
void |
Caret.setInnerRectMargin(float[] values)
Set the margin between inner rectangle and rectangle of current caret
annotation.
|
void |
Markup.setIntent(java.lang.String intent)
Set intent of current markup annotation.
|
void |
Line.setLeaderLineExtension(float extLength)
Set leader line extension of current line annotation.
|
void |
Line.setLeaderLineLength(float length)
Set leader line length of current line annotation.
|
void |
Line.setLeaderLineOffset(float offset)
Set leader line offset of current line annotation.
|
void |
Polyline.setLineEndingStyle(java.lang.String startingStyle,
java.lang.String endingStyle)
Set line ending styles of current polyline annotation.
|
void |
Line.setLineEndingStyle(java.lang.String startingStyle,
java.lang.String endingStyle)
Set line ending styles of current line annotation.
|
void |
FreeText.setLineEndingStyle(java.lang.String startingStyle,
java.lang.String endingStyle)
Set line ending styles of current free text annotation.
|
void |
Line.setLinePosition(java.awt.geom.Point2D.Float start,
java.awt.geom.Point2D.Float end)
Set line position of current line annotation.
|
void |
Widget.setMKCaption(int mkEntry,
java.lang.String caption)
Set caption of a specific type in MK dictionary.
|
void |
Widget.setMKColor(int mkEntry,
long color)
Set color of specific type in MK dictionary.
|
void |
Screen.setMKColor(int mkEntry,
long color)
Set color of specific type in MK dictionary.
|
void |
Widget.setMKIconImage(int mkEntry,
Image image)
Set an image to a specific icon type in MK dictionary.
|
void |
Widget.setMKRotation(int degree)
Set rotation in MK dictionary.
|
void |
Screen.setMKRotation(int degree)
Set rotation in MK dictionary.
|
void |
Annot.setModifiedDateTime(DateTime dateTime)
Set modification time of current PDF annotation.
|
void |
Annot.setName(java.lang.String name)
Set name value of current PDF annotation.
|
void |
Markup.setOpacity(float opacity)
Set opacity of current markup annotation.
|
void |
Text.setOpenStatus(boolean status)
Set open status of current text annotation.
|
void |
Popup.setOpenStatus(boolean status)
Set open status of current popup annotation.
|
void |
TextMarkup.setQuadPoints(Annot.QuadpointsF[] quadPoints)
Set quadrilaterals points of current text markup annotation.
|
void |
Link.setQuadPoints(Annot.QuadpointsF[] quadPoints)
Set quadrilaterals points of current link annotation.
|
abstract AnnotIconProvider.ShadingColor |
AnnotIconProvider.setShadingColor(java.lang.Object clientData,
java.lang.String iconType,
java.lang.String iconID,
long refColor,
int shadingIndex)
Callback function to set shading colors if an icon supports shading.
|
void |
Markup.setState(int stateModel,
int state)
Set state model and state of current state annotation.
|
void |
Markup.setSubject(java.lang.String subject)
Set subject of current markup annotation.
|
void |
Caret.setSymbol(java.lang.String symbol)
Set symbol of current caret annotation.
|
void |
Markup.setTitle(java.lang.String title)
Set title of current markup annotation.
|
void |
Polyline.setVertices(java.awt.geom.Point2D.Float[] vertices)
Set vertices of current polyline annotation.
|
void |
Polygon.setVertices(java.awt.geom.Point2D.Float[] vertices)
Set vertices of current polygon annotation.
|
void |
Markup.unGroup()
Ungroup current markup annotation from the group.
|
Modifier and Type | Method and Description |
---|---|
void |
PDFFormField.calculate()
Perform the form field javascript to calculate the values of form fields.
|
int |
PDFFormField.countActions(int trigger)
Retrieve count of actions associated with a field and a trigger type in a form.
|
int |
PDFFormField.countControls(PDFPage page)
Get count of controls which belongs to specified fields.
|
int |
PDFForm.countFields(java.lang.String filter)
Get count of fields satisfying a name filter in the form.
|
boolean |
PDFFormControl.doJavaScriptAction(int trigger)
Perform the form control javascript which is specified by the trigger.
|
void |
PDFForm.exportToFDF(FileHandler fdfFile)
Export data in the form to a FDF document.
|
void |
PDFForm.exportToXML(FileHandler xmlFile)
Export the form data to a XML file.
|
boolean |
PDFFormField.format()
Perform the form field javascript to format the values of form fields.
|
PDFAction |
PDFFormField.getAction(int trigger,
int index)
Retrieve action associated with a field and a trigger type at a specified
index in a form.
|
int |
PDFFormField.getAlignment()
Get alignment type of a field's text.
|
int |
PDFForm.getAlignment()
Retrieve alignment property of the form.
|
java.lang.String |
PDFFormField.getAlternateName()
Get alternate name to be used in place of actual field name.
|
PDFFormControl |
PDFFormField.getControl(PDFPage page,
int index)
Get a form control which belongs to the specified fields in the specified page.
|
PDFFormControl |
PDFForm.getControlAtDevicePos(PDFPage page,
Matrix matrix,
java.awt.Point point,
float tolerance,
int typeFilter)
Retrieve a form control which locates at a specific device position in the
form.
|
PDFFormControl |
PDFForm.getControlAtPos(PDFPage page,
java.awt.geom.Point2D.Float point,
float tolerance,
int typeFilter)
Retrieve a form control at a specific position in the form.
|
DefaultAppearance |
PDFFormField.getDefaultAppearance()
Get default appearance of specified fields.
|
DefaultAppearance |
PDFForm.getDefaultAppearance()
Retrieve a default appearance of the form.
|
java.lang.String |
PDFFormField.getDefaultValue()
Get default value of a field, not suitable for PushButton fields.
|
java.lang.String |
PDFFormControl.getExportValue()
Get option's export value.
|
PDFFormField |
PDFForm.getField(java.lang.String filter,
int index)
Get the fields with specified filter and index.
|
java.lang.String |
PDFFormControl.getFieldName()
Get field name from
PDFFormControl handle. |
java.lang.String[] |
PDFForm.getFieldsInCalculationOrder()
Get fields in the form in calculation order.
|
int |
PDFFormField.getFlags()
Get flags specifying various characteristics of the field.
|
int |
PDFFormControl.getIndex()
Get index of the form control which belongs to the specified fields.
|
java.lang.String |
PDFFormField.getMappingName()
Get mapping name to be used when exporting interactive form field data
from the document.
|
int |
PDFFormField.getMaxLen()
Get maximum length of the field's text, by characters.
|
PDFFormField.ChoiceOption[] |
PDFFormField.getOptions()
Get list box or combo box's options.
|
int |
PDFFormField.getTopVisibleIndex()
Get top index for scrollable list boxes.
|
int |
PDFFormField.getType()
Get type of a field.
|
java.lang.String |
PDFFormField.getValue()
Get value of a field, not suitable for PushButton fields.
|
void |
PDFForm.importFromFDF(FileHandler fdfFile)
Import data in FDF document to fill the form.
|
void |
PDFForm.importFromXML(FileHandler xmlFile)
Import the form data from a XML file.
|
boolean |
PDFFormField.insertAction(int trigger,
int index,
PDFAction action)
Insert an action associated with current field and a trigger type at a
specified index in a form.
|
boolean |
PDFFormControl.isChecked()
Get check box or radio button's state.
|
boolean |
PDFFormControl.isDefaultChecked()
Get check box or radio button's default state.
|
boolean |
PDFForm.needConstructAppearances()
Check whether need to construct appearance property of the form or not.
|
boolean |
PDFFormField.removeAction(int trigger,
int index)
Remove an action associated with current field and a trigger type by index in a form.
|
boolean |
PDFFormField.removeAllActions(int trigger)
Remove all actions associated with current field and a trigger type in a form.
|
boolean |
PDFForm.renameField(java.lang.String fieldName,
java.lang.String newFieldName)
Rename a field to a new name.
|
void |
PDFForm.reset(java.lang.String[] fieldNames,
boolean bInclude)
Reset data in fields to their default value.
|
boolean |
PDFFormField.setAction(int trigger,
int index,
PDFAction action)
Update an action associated with current field and a trigger type at a
specified index in a form.
|
boolean |
PDFFormField.setAlignment(int alignment)
Set alignment property of current field's text, only useful for text field and list box.
|
void |
PDFForm.setAlignment(int alignment)
Set alignment property of current form, as a document-wide default value.
|
boolean |
PDFFormField.setAlternateName(java.lang.String alternateName)
Set alternate name to be used in place of actual field name.
|
void |
PDFFormControl.setChecked(boolean checked)
Set check box or radio button's state.
|
void |
PDFForm.setConstructAppearancesFlag(boolean needConstruct)
Set a flag that specifies whether to construct appearances when loading
form controls.
|
boolean |
PDFFormField.setDefaultAppearance(DefaultAppearance appearance)
Set default appearance of current field.
|
void |
PDFForm.setDefaultAppearance(DefaultAppearance appearance)
Set default appearance of the form.
|
void |
PDFFormControl.setDefaultChecked(boolean defaultChecked)
Set check box or radio button's default state.
|
boolean |
PDFFormField.setDefaultValue(java.lang.String value)
Set default value of a field, except PushButton fields.
|
void |
PDFFormControl.setExportValue(java.lang.String exportValue)
Set option's export value.
|
boolean |
PDFForm.setFieldsInCalculationOrder(java.lang.String[] fieldNames)
Set fields in calculation order in the form.
|
boolean |
PDFFormField.setFlags(int flags)
Set flags specifying various characteristics of the field.
|
boolean |
PDFFormField.setMappingName(java.lang.String mappingName)
Set mapping name to be used when exporting interactive form field data
from the document.
|
boolean |
PDFFormField.setMaxLen(int maxlen)
Set maximum length of the field's text, in characters.
|
boolean |
PDFFormField.setOption(PDFFormField.ChoiceOption[] options)
Set list box or combo box's options.
|
boolean |
PDFFormField.setTopVisibleIndex(int index)
Set top index for scrollable list boxes.
|
boolean |
PDFFormField.setValue(java.lang.String value)
Set value of a field.
|
boolean |
PDFForm.validateFieldName(java.lang.String fieldName,
int fieldType)
Check whether a name is valid for specified type of field in the form.
|
boolean |
PDFFormField.validateKeyStrokeEvent(PDFFormField.KeyStrokeEvent event)
Perform the form field javascript to validate whether the part of a
field's current value can be replaced by a new value.
|
boolean |
PDFFormField.validateValue(java.lang.String value)
Perform the form field javascript to validate whether the user input
value is valid.
|
Modifier and Type | Method and Description |
---|---|
void |
Layer.addPageObject(PDFPage page,
PageObject pageObject)
Add a specified page object to current layer.
|
void |
LayerNode.clear()
Clear current PDF layer node.
|
void |
LayerContext.copyStates(LayerContext srcLayerContext)
Copy state from source PDF layer context to current layer context.
|
int |
LayerNode.countChildren()
Get the count of children.
|
LayerNode |
LayerNode.getChildren(int index)
Get the children of the layer or layer group with the specified index.
|
PDFDocument |
LayerContext.getDocument()
Retrieve a PDF document which owns current PDF layer context.
|
int |
Layer.getExportUsage()
Get layer usage state for exporting.
|
Layer |
LayerNode.getLayer()
Get the current layer of layer group.
|
java.lang.String |
LayerNode.getName()
Get the current layer name or layer group name.
|
java.lang.String |
Layer.getName()
Get the name of current PDF layer.
|
java.util.ArrayList<PageObject> |
Layer.getPageObjects(PDFPage page)
get page objects which is related with current layer.
|
PrintData |
Layer.getPrintData()
Get layer usage data for printing.
|
int |
LayerContext.getUsageType()
Get the usage type of current PDF layer context.
|
int |
Layer.getViewUsage()
Get layer usage state for viewing.
|
ZoomData |
Layer.getZoomData()
Get layer usage data for zooming.
|
boolean |
Layer.hasIntent(java.lang.String intent)
Check whether current PDF layer has a specific intent.
|
boolean |
Layer.isInPage(PDFPage page)
Check whether current PDF layer is in a given page or not.
|
boolean |
LayerContext.isVisible(Layer layer)
Check whether a PDF layer is visible or not.
|
void |
LayerContext.mergeStates(LayerContext srcLayerContext)
Merge state from source PDF layer context to current layer context.
|
void |
LayerContext.release()
Release current PDF layer context.
|
void |
Layer.removePageObject(PageObject pageObject)
Remove a specified page object to current layer.
|
void |
Layer.removeUsage(int usage)
Remove a kind of usage property.
|
void |
LayerContext.reset()
Reset current PDF layer context.
|
void |
Layer.setDefaultVisibleState(boolean visible)
Set default visible state to current layer
|
void |
Layer.setExportUsage(int exportUsage)
Set layer usage state for exporting.
|
void |
Layer.setName(java.lang.String name)
Set the name of current PDF layer.
|
void |
Layer.setPrintData(PrintData printData)
Set layer usage data for printing.
|
void |
Layer.setViewUsage(int viewUsage)
Set layer usage state for viewing.
|
void |
LayerContext.setVisible(Layer layer,
boolean visible)
Change the visibility state of a PDF layer.
|
void |
Layer.setZoomData(ZoomData zoomData)
Set layer usage data for zooming.
|
Modifier and Type | Method and Description |
---|---|
int |
PageObjects.countObjects(int typeFilter)
Get the count of page objects with specific type.
|
static TextObject |
TextObject.create(PDFPage page)
Create a new text object.
|
static ImageObject |
ImageObject.create(PDFPage page)
Create an image object.
|
void |
PageObjects.generateContents()
Generate PDF Page content.
|
long |
PageObject.getFillColor()
Get fill color of a page object.
|
PageObject |
PageObjects.getObject(int typeFilter,
int index)
Get a specified page object from page objects.
|
java.lang.String |
TextObject.getString()
Get string of current text object.
|
long |
PageObject.getStrokeColor()
Get stroke color of a page object.
|
TextState |
TextObject.getTextState()
Get text states of current text object.
|
void |
PageObjects.insertObject(int typeFilter,
int index,
PageObject pageObject)
Insert a page object and it will be automatically freed.
|
void |
PageObject.release()
Release a page object which is created or which is cloned but not
inserted into any PDF page.
|
void |
ImageObject.setBitmap(Bitmap bitmap,
Bitmap mask)
Set a bitmap to an image object.
|
void |
PageObject.setFillColor(long color)
Set fill color of a page object.
|
void |
ImageObject.setImage(Image image)
Set an image to an image object.
|
void |
PageObject.setMatrix(Matrix matrix)
Set matrix of a page object.
|
void |
TextObject.setString(java.lang.String str)
Set string to current text object.
|
void |
PageObject.setStrokeColor(long color)
Set stroke color of a page object.
|
void |
TextObject.setTextState(TextState textState,
boolean italic,
int weight)
Set text states to current text object.
|
Modifier and Type | Method and Description |
---|---|
int |
PasswordEncryptionParams.checkPassword(byte[] password)
Detect type of password.
|
abstract java.lang.Object |
SecurityHandler.createContext(java.lang.Object clientData,
FileHandler file,
java.lang.String filter,
java.lang.String subFilter,
java.lang.String encryptInfo)
Callback function to initialize context handle.
|
abstract byte[] |
SecurityHandler.decryptData(java.lang.Object clientData,
java.lang.Object decryptor,
byte[] encDataBuf)
Callback function to decrypted data to the decryptor.
|
abstract byte[] |
SecurityHandler.encryptData(java.lang.Object clientData,
java.lang.Object context,
int objNum,
int genNum,
byte[] srcBuf)
Callback function to encrypt data.
|
abstract byte[] |
SecurityHandler.finishDecryptor(java.lang.Object clientData,
java.lang.Object decryptor)
Callback function to release internal structure of the started decryptor context.
|
abstract CertificateHandler.CertificateInfo |
CertificateHandler.getCertificateInfo(java.lang.Object clientData)
Callback function to get the certificate information for decryption.
|
abstract SecurityHandler.CipherInfo |
SecurityHandler.getCipherInfo(java.lang.Object clientData,
java.lang.Object context)
Callback function to get cipher information including encryption algorithm and key.
|
abstract long |
SecurityHandler.getDecryptedSize(java.lang.Object clientData,
java.lang.Object context,
long dataSize)
Callback function to get the estimation size of decrypted data for a source data block.
|
abstract FoxitDRMHandler.CryptionParams |
FoxitDRMHandler.getDecryptionParams(java.lang.Object clientData,
FileHandler file,
java.lang.String subFilter)
Callback function to get decryption parameters.
|
java.lang.String |
FoxitDRMEncryptionParams.getDRMParam(java.lang.String key)
Get string value of a key from encryption parameter used for Foxit DRM security.
|
abstract long |
SecurityHandler.getEncryptedSize(java.lang.Object clientData,
java.lang.Object context,
int objNum,
int genNum,
byte[] srcBuf)
Callback function to get encrypted data size for a source data block.
|
java.lang.String |
EncryptionParams.getFilter()
Get encryption filter value.
|
java.lang.String |
EncryptionParams.getParam(java.lang.String key)
Get encryption parameter value.
|
java.lang.String |
EncryptionParams.getSubFilter()
Get encryption sub-filter value.
|
abstract long |
SecurityHandler.getUserPermissions(java.lang.Object clientData,
java.lang.Object context,
long userPermission)
Callback function to get permissions of user for context.
|
abstract boolean |
SecurityHandler.isOwner(java.lang.Object clientData,
java.lang.Object context)
Callback function to get identity type: owner or user.
|
abstract void |
SecurityHandler.releaseContext(java.lang.Object clientData,
java.lang.Object context)
Callback function to release context handle of a custom handler.
|
void |
CertificateEncryptionParams.setCipher(int cipherType)
Set the type of encryption algorithm.
|
void |
PasswordEncryptionParams.setCipher(int cipherType,
int keyLength)
Set the type of encryption algorithm and the key length of it.
|
void |
FoxitDRMEncryptionParams.setCryptionParams(FoxitDRMHandler.CryptionParams params)
Set the encryption parameters.
|
void |
FoxitDRMEncryptionParams.setDRMParam(java.lang.String key,
java.lang.String value)
Set string value of a key as encryption parameters for Foxit DRM encryption.
|
void |
CertificateEncryptionParams.setFilePath(java.lang.String path)
Set the specified certificate file path.
|
void |
CustomEncryptionParams.setFilter(java.lang.String filter)
Set the filter of the custom security handler.
|
void |
FoxitDRMEncryptionParams.setSubFilter(java.lang.String subFilter)
Set the subfilter of the custom security handler.
|
abstract java.lang.Object |
SecurityHandler.startDecryptor(java.lang.Object clientData,
java.lang.Object context,
int objNum,
int genNum)
Callback function to start a decryptor context, for decrypting a data stream.
|
boolean |
FoxitDRMEncryptionParams.verifyDRMParams()
Verify DRM encryption parameters in a PDF document.
|
Modifier and Type | Method and Description |
---|---|
void |
Signature.clearData()
Clear the signed data and appearance of current signature.
|
abstract void |
SignatureHandler.continueCalcDigest(java.lang.Object clientData,
java.lang.Object context,
int millisecond)
Foxit PDF SDK calls this interface to continue a custom digest calculation.
|
void |
Signature.draw(RenderContext context,
Renderer renderer)
Render current signature on a render context.
|
abstract java.lang.String |
SignatureHandler.finishCalcDigest(java.lang.Object clientData,
java.lang.Object context)
Foxit PDF SDK calls this interface to finish the custom digest calculation and get the digest.
|
long |
Signature.getAnnotFlags()
Get annotation flags of current signature.
|
long |
Signature.getAppearanceFlags()
Get the appearance flags of current signature.
|
Bitmap |
Signature.getBitmap()
Get the icon bitmap in current signature visual display.
|
java.lang.String |
Signature.getContactInfo()
Get contact information of current signature object.
|
DateTime |
Signature.getCreationDateTime()
Get creation date and time of current signature.
|
java.lang.String |
Signature.getDistinguishedName()
Get distinguished name of the signature owner.
|
java.lang.String |
Signature.getFilter()
Get the name of the preferred signature handler used for current signature.
|
java.lang.String |
Signature.getLocation()
Get location information of signature owner.
|
int |
Signature.getPageIndex()
Get the index of a PDF page containing current signature.
|
java.lang.String |
Signature.getReason()
Get signing reason of current signature.
|
java.lang.String |
Signature.getSigner()
Get signer name of current signature.
|
int |
Signature.getState()
Get current state of current signature.
|
java.lang.String |
Signature.getSubFilter()
Get sub-filter of current signature.
|
java.lang.String |
Signature.getText()
Get the text content of current signature appearance.
|
void |
Signature.initValue()
Initialize the value of current signature field.
|
boolean |
Signature.isSigned()
Determine whether current signature is signed or not.
|
static void |
Signature.registerDefaultHandler()
Register a default signature handler to Foxit PDF SDK.
|
static void |
Signature.registerSignatureHandler(java.lang.String filter,
java.lang.String subFilter,
SignatureHandler handler)
A third-party handler registers their handler to Foxit PDF SDK, along
with its filter and sub filter.
|
void |
Signature.remove()
Remove current signature.
|
void |
Signature.resetAppearance()
Reset the appearance of an unsigned signature field.
|
void |
Signature.setAnnotFlags(long flags)
Set annotation flags of current signature.
|
void |
Signature.setAppearanceFlags(long apFlags)
Set signature appearance flags required for resetting appearance.
|
void |
Signature.setBitmap(Bitmap bitmap)
Set a bitmap to icon in current signature display.
|
void |
Signature.setContactInfo(java.lang.String contactInfo)
Set contact information of current signature.
|
void |
Signature.setCreationDateTime(DateTime tm)
Set the creation date and time of a signature.
|
void |
Signature.setDefaultContentsLength(long contentsLen)
Set the default length of current signature value.
|
void |
Signature.setDistinguishedName(java.lang.String dn)
Set distinguished name of the signature owner in current signature dictionary.
|
void |
Signature.setFilter(java.lang.String filter)
Set the name of filter, which is used to choose a registered signature handler for current signature.
|
void |
Signature.setImage(Image img)
Set an
Image object to icon in current signature display. |
void |
Signature.setKeyStoreInfo(Signature.KeyStoreInfo ksInfo)
Set the
KeyStoreInfo object to current signature. |
void |
Signature.setLocation(java.lang.String location)
Set the CPU host name or physical location of the signature owner.
|
void |
Signature.setReason(java.lang.String reason)
Set signing reason of current signature.
|
void |
Signature.setSigner(java.lang.String signer)
Set signer name of current signature.
|
void |
Signature.setSubFilter(java.lang.String subFilter)
Set the name of sub-filter, which is used to choose a registered signature handler for current signature.
|
void |
Signature.setText(java.lang.String text)
Set the text content of current signature appearance.
|
abstract java.lang.String |
SignatureHandler.sign(java.lang.Object clientData,
java.lang.Object context,
Signature sigField,
java.lang.String digest)
Foxit PDF SDK calls this interface to sign a document.
|
abstract java.lang.Object |
SignatureHandler.startCalcDigest(java.lang.Object clientData,
Signature sigField,
FileHandler file,
int[] byteRange)
Foxit PDF SDK calls this interface to start a custom digest calculation.
|
Progress |
Signature.startSign(FileHandler signedFile)
Sign a PDF document progressively, by using a default signature handler
or a third-party signature handler.
|
Progress |
Signature.startVerify()
Verify current signature progressively , by using a default signature handler
or a third-party signature handler.
|
abstract void |
SignatureHandler.verify(java.lang.Object clientData,
java.lang.Object context,
Signature sigField,
java.lang.String digest,
java.lang.String signedData)
Foxit PDF SDK calls this interface to verify a specified signature.
|
Modifier and Type | Method and Description |
---|---|
void |
PSI.addPoint(java.awt.geom.Point2D.Float point,
float pressure,
int pointType)
Add a point to the pressure sensitive ink object.
|
Annot |
PSI.convertToPDFAnnot(RectF renderRect,
PDFPage page,
RectF annotRect)
Convert the pressure sensitive ink object to a PDF annotation.
|
static PSI |
PSI.create(boolean simulate)
Create a pressure sensitive ink object.
|
RectF |
PSI.getContentsRect()
Get contents rectangle of current pressure sensitive ink object.
|
void |
PSI.initCanvas(float width,
float height)
Initialize canvas for current pressure sensitive ink.
|
void |
PSI.invalidateRect(IInvalidate invalidate)
Invalidating the pressure sensitive ink area
|
void |
PSI.release()
Destroy current pressure sensitive ink object.
|
void |
PSI.render(Renderer render,
java.awt.Point dest,
int width,
int height,
java.awt.geom.Point2D.Float src)
Render the pressure sensitive ink object.
|
void |
PSI.setInkColor(long color)
Set ink color of current pressure sensitive ink object.
|
void |
PSI.setInkDiameter(int diameter)
Set ink diameter of current pressure sensitive ink object.
|
void |
PSI.setOpacity(float opacity)
Set ink opacity of current pressure sensitive ink object.
|
Modifier and Type | Method and Description |
---|---|
static FileHandler |
FileHandler.create(byte[] buffer,
int fileModes)
Create a memory-based
FileHandler object. |
static FileHandler |
FileHandler.create(java.lang.String fileName,
int fileModes)
Create a
FileHandler object from the specific file path. |
int |
FileHandler.getSize()
Get the actual size of current
FileHandler object. |
byte[] |
FileHandler.read(int offset,
int size)
Read buffer(represented as byte array) from the specific file which is related with current
FileHandler object. |
void |
FileHandler.release()
Release current
FileHandler object. |