A B C D E F G H I L M N O P R S T V W X

A

addAsset(String, PdfFileSpecification) - Method in class com.itextpdf.text.pdf.richmedia.RichMediaAnnotation

Adds an embedded file.

addAsset(String, PdfIndirectReference) - Method in class com.itextpdf.text.pdf.richmedia.RichMediaAnnotation

Adds a reference to an embedded file.

addConfiguration(RichMediaConfiguration) - Method in class com.itextpdf.text.pdf.richmedia.RichMediaAnnotation

Adds a RichMediaConfiguration.

addConfiguration(PdfIndirectReference) - Method in class com.itextpdf.text.pdf.richmedia.RichMediaAnnotation

Adds a reference to a RichMediaConfiguration.

addInstance(RichMediaInstance) - Method in class com.itextpdf.text.pdf.richmedia.RichMediaConfiguration

Adds a RichMediaInstance to the instances array of this configuration.

addView(PdfDictionary) - Method in class com.itextpdf.text.pdf.richmedia.RichMediaAnnotation

Adds a view dictionary.

addView(PdfIndirectReference) - Method in class com.itextpdf.text.pdf.richmedia.RichMediaAnnotation

Adds a reference to a view dictionary.

addXPTSValue(PdfNumber, PtIdentifier) - Method in class com.itextpdf.text.pdf.spatial.PointData

Adds a point to the Point Data dictionary.

Angular - Enum in com.itextpdf.text.pdf.spatial.units

Angular display units for use in a Preferred Display Units (PDU) array.

annot - Variable in class com.itextpdf.text.pdf.richmedia.RichMediaAnnotation

The annotation object

annots - Variable in class com.itextpdf.text.pdf.mc.MCParser

the annotations of the page that is being processed.

arcTolerance - Static variable in class com.itextpdf.text.pdf.pdfcleanup.PdfCleanUpProcessor

Used as the criterion of a good approximation of rounded line joins and line caps.

assetsmap - Variable in class com.itextpdf.text.pdf.richmedia.RichMediaAnnotation

a map with the assets (will be used to construct a name tree.)

B

baos - Variable in class com.itextpdf.text.pdf.mc.MCParser

The contents of the new content stream of the page.

baos - Static variable in class com.itextpdf.text.pdf.ocg.OCGParser

The OutputStream of this worker object.

btWrite - Variable in class com.itextpdf.text.pdf.mc.MCParser

Did we postpone writing a BT operator?

C

checkBT() - Method in class com.itextpdf.text.pdf.mc.MCParser

Checks if a BT operator is waiting to be added.

checkMarkedContentEnd() - Method in class com.itextpdf.text.pdf.ocg.OCGParser

Keeps track of the MarkedContent state.

checkMarkedContentStart(PdfName) - Method in class com.itextpdf.text.pdf.ocg.OCGParser

Keeps track of the MarkedContent state.

checkMCID(int, int) - Method in class com.itextpdf.text.pdf.mc.StructureItem

Checks if an MCID corresponds with the MCID stored in the StructureItem.

checkMCID(int, int) - Method in class com.itextpdf.text.pdf.mc.StructureMCID

Checks if the MCID in this object corresponds with the stored number

checkStructParent(int, int) - Method in class com.itextpdf.text.pdf.mc.StructureItem

Checks if a StructParent corresponds with the StructParent stored in the StructureItem.

checkStructParent(int, int) - Method in class com.itextpdf.text.pdf.mc.StructureObject

Checks if a StructParent corresponds with the StructParent stored in the object.

cleanUp() - Method in class com.itextpdf.text.pdf.pdfcleanup.PdfCleanUpProcessor

Cleans the document by erasing all the areas which are either provided or extracted from redaction annotations.

com.itextpdf.text.pdf.mc - package com.itextpdf.text.pdf.mc

com.itextpdf.text.pdf.ocg - package com.itextpdf.text.pdf.ocg

com.itextpdf.text.pdf.pdfcleanup - package com.itextpdf.text.pdf.pdfcleanup

com.itextpdf.text.pdf.richmedia - package com.itextpdf.text.pdf.richmedia

com.itextpdf.text.pdf.spatial - package com.itextpdf.text.pdf.spatial

com.itextpdf.text.pdf.spatial.objects - package com.itextpdf.text.pdf.spatial.objects

com.itextpdf.text.pdf.spatial.units - package com.itextpdf.text.pdf.spatial.units

com.itextpdf.text.pdf.util - package com.itextpdf.text.pdf.util

configurations - Variable in class com.itextpdf.text.pdf.richmedia.RichMediaAnnotation

an array with configurations (will be added to the RichMediaContent).

convertToXObject(StructureObject) - Method in class com.itextpdf.text.pdf.mc.MCParser

Converts an annotation structure item to a Form XObject annotation.

CoordinateSystem - Class in com.itextpdf.text.pdf.spatial

The value of the GCS or DCS entry of a geospatial measure dictionary.

CoordinateSystem(PdfName) - Constructor for class com.itextpdf.text.pdf.spatial.CoordinateSystem

Creates a specific type of CoordinateSystem: GEOGCS (GeographicCoordinateSystem) or PROJCS (ProjectedCoordinateSystem).

createAnnotation() - Method in class com.itextpdf.text.pdf.richmedia.RichMediaAnnotation

Creates the actual annotation and adds different elements to the PdfWriter while doing so.

CuePoint - Class in com.itextpdf.text.pdf.richmedia

A video file can contain cue points that are encoded in a video stream or may be created by an associated ActionScript within the Flash content.

CuePoint(PdfName) - Constructor for class com.itextpdf.text.pdf.richmedia.CuePoint

Constructs a CuePoint object.

currentPage - Variable in class com.itextpdf.text.pdf.util.SmartPdfSplitter

D

dealWithMcid(PdfNumber) - Method in class com.itextpdf.text.pdf.mc.MCParser

When an MCID is encountered, the parser will check the list structure items and turn an annotation into an XObject if necessary.

dealWithXObj(PdfName) - Method in class com.itextpdf.text.pdf.mc.MCParser

When an XObject with a StructParent is encountered, we want to remove it from the stack.

DEFAULTOPERATOR - Static variable in class com.itextpdf.text.pdf.mc.MCParser

Constant used for the default operator.

DEFAULTOPERATOR - Static variable in class com.itextpdf.text.pdf.ocg.OCGParser

Constant used for the default operator.

E

etExtra - Variable in class com.itextpdf.text.pdf.mc.MCParser

Did we postpone writing a BT operator?

F

fillCleanedArea - Static variable in class com.itextpdf.text.pdf.pdfcleanup.PdfCleanUpProcessor

flash - Variable in class com.itextpdf.text.pdf.richmedia.RichMediaInstance

True if the instance is a flash animation.

floatMultiplier - Static variable in class com.itextpdf.text.pdf.pdfcleanup.PdfCleanUpProcessor

When a document with line arts is being cleaned up, there are lot of calculations with floating point numbers.

Fraction - Enum in com.itextpdf.text.pdf.spatial.units

Indicates whether and in what manner to display a fractional value from the result of converting to the units

G

GeographicCoordinateSystem - Class in com.itextpdf.text.pdf.spatial

A geographic coordinate system (GEOGCS) specifies an ellipsoidal object in geographic coordinates: angular units of latitude and longitude.

GeographicCoordinateSystem() - Constructor for class com.itextpdf.text.pdf.spatial.GeographicCoordinateSystem

Creates a GeographicCoordinateSystem.

getCleanUpColor() - Method in class com.itextpdf.text.pdf.pdfcleanup.PdfCleanUpLocation

Returns a color used to fill the area after erasing it.

getLength(Map<Integer, PdfObject>) - Method in class com.itextpdf.text.pdf.util.PdfResourceCounter

Returns the resources needed for the object that was used to create this PdfResourceCounter.

getObjAsDict() - Method in class com.itextpdf.text.pdf.mc.StructureObject

Returns the object referred to by the OBJR dictionary.

getObjRef() - Method in class com.itextpdf.text.pdf.mc.StructureObject

Returns the reference to the object.

getPage() - Method in class com.itextpdf.text.pdf.pdfcleanup.PdfCleanUpLocation

getPageref() - Method in class com.itextpdf.text.pdf.mc.StructureItem

Returns the number of the page object to which the structure item belongs.

getPdfName() - Method in enum com.itextpdf.text.pdf.spatial.units.Angular

Gets the PdfName.

getPdfName() - Method in enum com.itextpdf.text.pdf.spatial.units.Fraction

Gets the PdfName.

getPdfName() - Method in enum com.itextpdf.text.pdf.spatial.units.Linear

Gets the PdfName.

getPdfName() - Method in enum com.itextpdf.text.pdf.spatial.units.PtIdentifier

Gets the PdfName.

getPdfName() - Method in enum com.itextpdf.text.pdf.spatial.units.Square

Gets the PdfName.

getRef() - Method in class com.itextpdf.text.pdf.mc.StructureObject

Returns the structure element's reference.

getRegion() - Method in class com.itextpdf.text.pdf.pdfcleanup.PdfCleanUpLocation

getResources() - Method in class com.itextpdf.text.pdf.util.PdfResourceCounter

Returns a map with the resources.

getRichMediaContentReference() - Method in class com.itextpdf.text.pdf.richmedia.RichMediaAnnotation

Gets a reference to the RichMediaContent for reuse of the rich media content.

getStructElem() - Method in class com.itextpdf.text.pdf.mc.StructureObject

Returns the structure element.

H

hasMorePages() - Method in class com.itextpdf.text.pdf.util.SmartPdfSplitter

I

instances - Variable in class com.itextpdf.text.pdf.richmedia.RichMediaConfiguration

An array of indirect object references to RichMediaInstance dictionaries.

inText - Variable in class com.itextpdf.text.pdf.mc.MCParser

Are we inside a BT/ET sequence?

isOverSized() - Method in class com.itextpdf.text.pdf.util.SmartPdfSplitter

isToRemoved() - Method in class com.itextpdf.text.pdf.ocg.OCGParser

Checks if the parser is currently parsing content that needs to be ignored.

isVisible(List<PdfObject>) - Method in class com.itextpdf.text.pdf.ocg.OCGParser

Checks operands to find out if the corresponding operator needs to be present or not.

items - Variable in class com.itextpdf.text.pdf.mc.MCParser

The list with structure items.

L

Linear - Enum in com.itextpdf.text.pdf.spatial.units

Linear display units for use in a Preferred Display Units (PDU) array.

LOGGER - Static variable in class com.itextpdf.text.pdf.mc.MCParser

The Logger instance

LOGGER - Static variable in class com.itextpdf.text.pdf.mc.StructureItems

The Logger instance

loopOver(PdfObject) - Method in class com.itextpdf.text.pdf.util.PdfResourceCounter

In case an object is an array, a dictionary or a stream, we need to loop over the entries and process them one by one.

M

mc_balance - Variable in class com.itextpdf.text.pdf.ocg.OCGParser

Keeps track of BMC/EMC balance.

MCFieldFlattener - Class in com.itextpdf.text.pdf.mc

Removes all interactivity from an AcroForm, maintaining the structure tree.

MCFieldFlattener() - Constructor for class com.itextpdf.text.pdf.mc.MCFieldFlattener

mcid - Variable in class com.itextpdf.text.pdf.mc.StructureMCID

The mcid of the structure element.

MCParser - Class in com.itextpdf.text.pdf.mc

This class will parse page content streams and add Do operators in a marked-content sequence for every field that needs to be flattened.

MCParser(StructureItems) - Constructor for class com.itextpdf.text.pdf.mc.MCParser

Creates an MCParser object.

MCParser.PdfOperator - Interface in com.itextpdf.text.pdf.mc

PDF Operator interface.

Measure - Class in com.itextpdf.text.pdf.spatial

Parent class for the Measure dictionaries.

Measure() - Constructor for class com.itextpdf.text.pdf.spatial.Measure

Creates a Measure dictionary.

MeasureGeospatial - Class in com.itextpdf.text.pdf.spatial

Geospatial Measure dictionary.

MeasureGeospatial() - Constructor for class com.itextpdf.text.pdf.spatial.MeasureGeospatial

MeasureRectilinear - Class in com.itextpdf.text.pdf.spatial

Rectilinear Measure dictionary.

MeasureRectilinear() - Constructor for class com.itextpdf.text.pdf.spatial.MeasureRectilinear

N

names - Variable in class com.itextpdf.text.pdf.spatial.PointData

An array of names that identify the internal data elements of the individual point arrays in the XPTS array.

NumberFormatArray - Class in com.itextpdf.text.pdf.spatial.objects

An array consisting of NumberFormatDictionary objects.

NumberFormatArray(NumberFormatDictionary...) - Constructor for class com.itextpdf.text.pdf.spatial.objects.NumberFormatArray

Creates a PdfArray consisting of NumberFormatDictionary objects.

NumberFormatArray(List<NumberFormatDictionary>) - Constructor for class com.itextpdf.text.pdf.spatial.objects.NumberFormatArray

Creates a PdfArray consisting of NumberFormatDictionary objects.

NumberFormatDictionary - Class in com.itextpdf.text.pdf.spatial.objects

A dictionary that represents a specific unit of measurement (such as miles or feet).

NumberFormatDictionary() - Constructor for class com.itextpdf.text.pdf.spatial.objects.NumberFormatDictionary

Creates a new NumberFormat dictionary.

numberOfPages - Variable in class com.itextpdf.text.pdf.util.SmartPdfSplitter

O

obj - Variable in class com.itextpdf.text.pdf.mc.StructureObject

An object referred to by an OBJR dictionary.

objref - Variable in class com.itextpdf.text.pdf.mc.StructureObject

The reference to the object.

OCGParser - Class in com.itextpdf.text.pdf.ocg

A helper class for OCGRemover.

OCGParser(Set<String>) - Constructor for class com.itextpdf.text.pdf.ocg.OCGParser

Creates an instance of the OCGParser.

OCGParser.PdfOperator - Interface in com.itextpdf.text.pdf.ocg

PDF Operator interface.

OCGRemover - Class in com.itextpdf.text.pdf.ocg

Class that knows how to remove OCG layers.

OCGRemover() - Constructor for class com.itextpdf.text.pdf.ocg.OCGRemover

ocgs - Variable in class com.itextpdf.text.pdf.ocg.OCGParser

The OCGs that need to be removed.

operators - Variable in class com.itextpdf.text.pdf.mc.MCParser

A map with all supported operators operators (PDF syntax).

operators - Static variable in class com.itextpdf.text.pdf.ocg.OCGParser

A map with all supported operators operators (PDF syntax).

overSized - Variable in class com.itextpdf.text.pdf.util.SmartPdfSplitter

P

page - Variable in class com.itextpdf.text.pdf.mc.MCParser

The page dictionary

pageref - Variable in class com.itextpdf.text.pdf.mc.MCParser

The reference to the page dictionary

pageref - Variable in class com.itextpdf.text.pdf.mc.StructureItem

The object number of the page to which this structure item belongs.

parentTree - Variable in class com.itextpdf.text.pdf.mc.StructureItems

The StructParents number tree values.

parse(PdfDictionary, PdfIndirectReference) - Method in class com.itextpdf.text.pdf.mc.MCParser

Parses the content of a page, inserting the normal (/N) appearances (/AP) of annotations into the content stream as Form XObjects.

parse(PRStream, PdfDictionary) - Method in class com.itextpdf.text.pdf.ocg.OCGParser

Parses a stream object and removes OCGs.

PdfCleanUpLocation - Class in com.itextpdf.text.pdf.pdfcleanup

Defines the region to be erased in a PDF document.

PdfCleanUpLocation(int, Rectangle) - Constructor for class com.itextpdf.text.pdf.pdfcleanup.PdfCleanUpLocation

Constructs a PdfCleanUpLocation object.

PdfCleanUpLocation(int, Rectangle, BaseColor) - Constructor for class com.itextpdf.text.pdf.pdfcleanup.PdfCleanUpLocation

Constructs a PdfCleanUpLocation object.

PdfCleanUpProcessor - Class in com.itextpdf.text.pdf.pdfcleanup

Represents the main mechanism for cleaning a PDF document.

PdfCleanUpProcessor(List<PdfCleanUpLocation>, PdfStamper) - Constructor for class com.itextpdf.text.pdf.pdfcleanup.PdfCleanUpProcessor

Creates a PdfCleanUpProcessor object based on the given List of PdfCleanUpLocations representing regions to be erased from the document.

PdfCleanUpProcessor(PdfStamper) - Constructor for class com.itextpdf.text.pdf.pdfcleanup.PdfCleanUpProcessor

Creates a PdfCleanUpProcessor object.

PdfResourceCounter - Class in com.itextpdf.text.pdf.util

This class can be used to count the number of bytes needed when copying pages from an existing PDF into a newly created PDF.

PdfResourceCounter(PdfObject) - Constructor for class com.itextpdf.text.pdf.util.PdfResourceCounter

Creates a PdfResourceCounter instance to be used to count the resources needed for either a page (in this case pass a page dictionary) or the trailer (root and info dictionary) of a PDF file.

PointData - Class in com.itextpdf.text.pdf.spatial

A Point Data dictionary.

PointData() - Constructor for class com.itextpdf.text.pdf.spatial.PointData

Creates a Point Data dictionary.

populateOperators() - Method in class com.itextpdf.text.pdf.mc.MCParser

Populates the operators variable.

populateOperators() - Method in class com.itextpdf.text.pdf.ocg.OCGParser

Populates the operators variable.

println(PdfObject) - Method in class com.itextpdf.text.pdf.mc.MCParser

Writes a PDF object to the OutputStream, followed by a newline character.

println(PdfObject) - Method in class com.itextpdf.text.pdf.ocg.OCGParser

Writes a PDF object to the OutputStream, followed by a newline character.

printOperator(PdfLiteral, List<PdfObject>) - Method in class com.itextpdf.text.pdf.mc.MCParser

Adds an operator and its operands (if any) to baos.

printsp(PdfObject) - Method in class com.itextpdf.text.pdf.mc.MCParser

Writes a PDF object to the OutputStream, followed by a space character.

printsp(PdfObject) - Method in class com.itextpdf.text.pdf.ocg.OCGParser

Writes a PDF object to the OutputStream, followed by a space character.

printTextOperator(PdfLiteral, List<PdfObject>) - Method in class com.itextpdf.text.pdf.mc.MCParser

Adds an operator and its operands (if any) to baos, keeping track of the text state.

process(PdfReader, OutputStream) - Method in class com.itextpdf.text.pdf.mc.MCFieldFlattener

Processes a properly tagged PDF form.

process(MCParser, PdfLiteral, List<PdfObject>) - Method in interface com.itextpdf.text.pdf.mc.MCParser.PdfOperator

Methods that processes an operator

process(OCGParser, PdfLiteral, List<PdfObject>) - Method in interface com.itextpdf.text.pdf.ocg.OCGParser.PdfOperator

Methods that processes an operator

process(PdfLiteral, List<PdfObject>, boolean) - Method in class com.itextpdf.text.pdf.ocg.OCGParser

Processes an operator

process(PdfObject) - Method in class com.itextpdf.text.pdf.util.PdfResourceCounter

Processes an object.

processMCID(PdfNumber, PdfIndirectReference) - Method in class com.itextpdf.text.pdf.mc.StructureItems

Creates a new MCID in the parent tree of the page and returns that new MCID so that it can be used in the content stream

processOperator(PdfLiteral, List<PdfObject>) - Method in class com.itextpdf.text.pdf.mc.MCParser

Processes an operator, for instance: write the operator and its operands to baos.

processOperator(OCGParser, PdfLiteral, List<PdfObject>) - Static method in class com.itextpdf.text.pdf.ocg.OCGParser

Processes an operator.

processStructElemKids(PdfDictionary, PdfIndirectReference, PdfObject) - Method in class com.itextpdf.text.pdf.mc.StructureItems

Processes the kids object of a StructElem dictionary.

processStructElems(PdfDictionary, PdfIndirectReference) - Method in class com.itextpdf.text.pdf.mc.StructureItems

Looks at a StructElem dictionary, and processes it.

ProjectedCoordinateSystem - Class in com.itextpdf.text.pdf.spatial

A projected coordinate system (PROJCS), which includes an embedded GEOGCS, specifies the algorithms and associated parameters used to transform points between geographic coordinates and a two-dimensional (projected) coordinate system.

ProjectedCoordinateSystem() - Constructor for class com.itextpdf.text.pdf.spatial.ProjectedCoordinateSystem

Creates a ProjectedCoordinateSystem.

properties - Variable in class com.itextpdf.text.pdf.ocg.OCGParser

The OCG properties.

PtIdentifier - Enum in com.itextpdf.text.pdf.spatial.units

Identifier for use in the Names array that identifies the internal data elements of the individual point arrays in the XPTS array

R

RASFACTORY - Static variable in class com.itextpdf.text.pdf.mc.MCParser

Factory that will help us build a RandomAccessSource.

reader - Variable in class com.itextpdf.text.pdf.util.SmartPdfSplitter

ref - Variable in class com.itextpdf.text.pdf.mc.StructureObject

The reference of the structure element of which the properties are stored.

removeFromParentTree(PdfNumber) - Method in class com.itextpdf.text.pdf.mc.StructureItems

Removes a StructParent from the parent tree.

removeLayers(PdfReader, String...) - Method in class com.itextpdf.text.pdf.ocg.OCGRemover

Removes layers from a PDF document

resources - Variable in class com.itextpdf.text.pdf.util.PdfResourceCounter

A map of the resources that are already taken into account

RichMediaActivation - Class in com.itextpdf.text.pdf.richmedia

The RichMediaActivation dictionary specifies the style of presentation, default script behavior, default view information, and animation style when the annotation is activated.

RichMediaActivation() - Constructor for class com.itextpdf.text.pdf.richmedia.RichMediaActivation

Creates a RichMediaActivation dictionary.

RichMediaAnimation - Class in com.itextpdf.text.pdf.richmedia

A RichMediaAnimation dictionary specifies the preferred method that conforming readers should use to apply timeline scaling to keyframe animations.

RichMediaAnimation(PdfName) - Constructor for class com.itextpdf.text.pdf.richmedia.RichMediaAnimation

Constructs a RichMediaAnimation.

RichMediaAnnotation - Class in com.itextpdf.text.pdf.richmedia

Object that is able to create Rich Media Annotations as described in the document "Acrobat Supplement to the ISO 32000", referenced in the code as "ExtensionLevel 3".

RichMediaAnnotation(PdfWriter, Rectangle) - Constructor for class com.itextpdf.text.pdf.richmedia.RichMediaAnnotation

Creates a RichMediaAnnotation.

RichMediaAnnotation(PdfWriter, Rectangle, PdfIndirectReference) - Constructor for class com.itextpdf.text.pdf.richmedia.RichMediaAnnotation

Creates a RichMediaAnnotation using rich media content that has already been added to the writer.

RichMediaCommand - Class in com.itextpdf.text.pdf.richmedia

the annotation handler specific to the target instance specified by the TI key in the parent rich-media-execute action dictionary.

RichMediaCommand(PdfString) - Constructor for class com.itextpdf.text.pdf.richmedia.RichMediaCommand

Creates a RichMediaCommand dictionary.

RichMediaConfiguration - Class in com.itextpdf.text.pdf.richmedia

The RichMediaConfiguration dictionary describes a set of instances that are loaded for a given scene configuration.

RichMediaConfiguration(PdfName) - Constructor for class com.itextpdf.text.pdf.richmedia.RichMediaConfiguration

Creates a RichMediaConfiguration object.

richMediaContent - Variable in class com.itextpdf.text.pdf.richmedia.RichMediaAnnotation

the rich media content (can be reused for different annotations)

richMediaContentReference - Variable in class com.itextpdf.text.pdf.richmedia.RichMediaAnnotation

a reference to the RichMediaContent that can be reused.

RichMediaDeactivation - Class in com.itextpdf.text.pdf.richmedia

The RichMediaActivation dictionary specifies the condition that causes deactivation of the annotation.

RichMediaDeactivation() - Constructor for class com.itextpdf.text.pdf.richmedia.RichMediaDeactivation

Creates a RichMediaActivation dictionary.

RichMediaExecuteAction - Class in com.itextpdf.text.pdf.richmedia

A rich-media-execute action identifies a rich media annotation and specifies a command to be sent to that annotation's handler.

RichMediaExecuteAction(PdfIndirectReference, RichMediaCommand) - Constructor for class com.itextpdf.text.pdf.richmedia.RichMediaExecuteAction

Creates a RichMediaExecute action dictionary.

RichMediaInstance - Class in com.itextpdf.text.pdf.richmedia

The RichMediaInstance dictionary, referenced by the Instances entry of the RichMediaConfiguration, describes a single instance of an asset with settings to populate the artwork of an annotation.

RichMediaInstance(PdfName) - Constructor for class com.itextpdf.text.pdf.richmedia.RichMediaInstance

Creates a RichMediaInstance.

RichMediaParams - Class in com.itextpdf.text.pdf.richmedia

Dictionary containing parameters related to an active Flash subtype in a RichMediaInstance dictionary.

RichMediaParams() - Constructor for class com.itextpdf.text.pdf.richmedia.RichMediaParams

Creates a RichMediaParams object.

RichMediaPosition - Class in com.itextpdf.text.pdf.richmedia

The position of the window in the reader presentation area is described by the RichMediaPosition dictionary.

RichMediaPosition() - Constructor for class com.itextpdf.text.pdf.richmedia.RichMediaPosition

Constructs a RichMediaPosition dictionary.

RichMediaPresentation - Class in com.itextpdf.text.pdf.richmedia

The RichMediaPresentation dictionary contains information about how the annotation and user interface elements are to be visually laid out and drawn.

RichMediaPresentation() - Constructor for class com.itextpdf.text.pdf.richmedia.RichMediaPresentation

Creates a RichMediaPresentation dictionary.

richMediaSettings - Variable in class com.itextpdf.text.pdf.richmedia.RichMediaAnnotation

the rich media settings (specific for this annotation)

RichMediaWindow - Class in com.itextpdf.text.pdf.richmedia

The RichMediaWindow dictionary stores the dimensions and position of the floating window presented to the user.

RichMediaWindow() - Constructor for class com.itextpdf.text.pdf.richmedia.RichMediaWindow

Creates a RichMediaWindow dictionary.

S

setA(NumberFormatArray) - Method in class com.itextpdf.text.pdf.spatial.MeasureRectilinear

A number format array for measurement of area.

setAction(PdfObject) - Method in class com.itextpdf.text.pdf.richmedia.CuePoint

Sets an action dictionary defining the action that is executed if this cue point is triggered, meaning that the Flash content reached the matching cue point during its playback.

setActivation(RichMediaActivation) - Method in class com.itextpdf.text.pdf.richmedia.RichMediaAnnotation

Sets the RichMediaActivation dictionary specifying the style of presentation, default script behavior, default view information, and animation style when the annotation is activated.

setAnimation(RichMediaAnimation) - Method in class com.itextpdf.text.pdf.richmedia.RichMediaActivation

Sets the animation dictionary describing the preferred method that conforming readers should use to drive keyframe animations present in this artwork.

setArguments(PdfObject) - Method in class com.itextpdf.text.pdf.richmedia.RichMediaCommand

Sets the arguments for the command.

setAsset(PdfIndirectReference) - Method in class com.itextpdf.text.pdf.richmedia.RichMediaInstance

Sets a dictionary that shall be an indirect object reference to a file specification dictionary that is also referenced in the Assets name tree of the content of the annotation.

setBBox(Rectangle) - Method in class com.itextpdf.text.pdf.spatial.Viewport

(Required) A rectangle in default user space coordinates specifying the location of the viewport on the page.
The two coordinate pairs of the rectangle shall be specified in normalized form; that is, lower-left followed by upper-right, relative to the measuring coordinate system.

setBinding(PdfName) - Method in class com.itextpdf.text.pdf.richmedia.RichMediaParams

Sets the binding.

setBindingMaterialName(PdfString) - Method in class com.itextpdf.text.pdf.richmedia.RichMediaParams

Stores the material name that content is to be bound to.

setBounds(NumberArray) - Method in class com.itextpdf.text.pdf.spatial.MeasureGeospatial

An array of numbers that shall be taken pairwise to define a series of points that describes the bounds of an area for which geospatial transformations are valid.

setCipherGroupingCharacter(PdfString) - Method in class com.itextpdf.text.pdf.spatial.objects.NumberFormatDictionary

Text that shall be used between orders of thousands in display of numerical values.

setCondition(PdfName) - Method in class com.itextpdf.text.pdf.richmedia.RichMediaActivation

Sets the activation condition.

setCondition(PdfName) - Method in class com.itextpdf.text.pdf.richmedia.RichMediaDeactivation

Sets the activation condition.

setConfiguration(PdfIndirectReference) - Method in class com.itextpdf.text.pdf.richmedia.RichMediaActivation

Sets an indirect object reference to a RichMediaConfiguration dictionary that shall also be referenced by the Configurations array in the RichMediaContent dictionary (which is part of the RichMediaAnnotation object).

setConversionFactor(PdfNumber) - Method in class com.itextpdf.text.pdf.spatial.objects.NumberFormatDictionary

The conversion factor used to multiply a value in partial units of the previous number format array element to obtain a value in the units of this dictionary.

setCoordinateSystem(CoordinateSystem) - Method in class com.itextpdf.text.pdf.spatial.MeasureGeospatial

A projected or geographic coordinate system dictionary.

setCuePoints(PdfArray) - Method in class com.itextpdf.text.pdf.richmedia.RichMediaParams

Sets an array of CuePoint dictionaries containing points in time within a Flash animation.

setCYX(PdfNumber) - Method in class com.itextpdf.text.pdf.spatial.MeasureRectilinear

A factor that shall be used to convert the largest units along the y axis to the largest units along the x axis.

setD(NumberFormatArray) - Method in class com.itextpdf.text.pdf.spatial.MeasureRectilinear

A number format array for measurement of distance in any direction.

setDeactivation(RichMediaDeactivation) - Method in class com.itextpdf.text.pdf.richmedia.RichMediaAnnotation

Sets the RichMediaDeactivation dictionary specifying the condition that causes deactivation of the annotation.

setDecimalChartacter(PdfString) - Method in class com.itextpdf.text.pdf.spatial.objects.NumberFormatDictionary

Text that shall be used as the decimal position in displaying numerical values.

setDisplayCoordinateSystem(GeographicCoordinateSystem) - Method in class com.itextpdf.text.pdf.spatial.MeasureGeospatial

Optional coordinate system that allows a document to be authored to display values in a coordinate system other than that associated with the source data.

setDisplayUnits(Linear, Square, Angular) - Method in class com.itextpdf.text.pdf.spatial.MeasureGeospatial

Three names that identify in order a linear display unit, an area display unit, and an angular display unit.

setEPSG(int) - Method in class com.itextpdf.text.pdf.spatial.CoordinateSystem

Sets the EPSG code.

setFixedDenominator(PdfBoolean) - Method in class com.itextpdf.text.pdf.spatial.objects.NumberFormatDictionary

If true, a fractional value formatted according to Precision may not have its denominator reduced or low-order zeros truncated.

setFlashVars(String) - Method in class com.itextpdf.text.pdf.richmedia.RichMediaParams

Sets a text string containing formatted name value pairs passed to the Flash Player context when activated.

setFractionalValue(Fraction) - Method in class com.itextpdf.text.pdf.spatial.objects.NumberFormatDictionary

Indicate whether and in what manner to display a fractional value from the result of converting to the units of this NumberFormat means of the conversion factor entry.

setGPTS(NumberArray) - Method in class com.itextpdf.text.pdf.spatial.MeasureGeospatial

An array of numbers that shall be taken pairwise, defining points in geographic space as degrees of latitude and longitude.

setHAlign(PdfName) - Method in class com.itextpdf.text.pdf.richmedia.RichMediaPosition

Set the horizontal alignment.

setHeight(float, float, float) - Method in class com.itextpdf.text.pdf.richmedia.RichMediaWindow

Sets a dictionary with keys Default, Max, and Min describing values for the height of the Window in default user space units.

setHOffset(float) - Method in class com.itextpdf.text.pdf.richmedia.RichMediaPosition

Sets the offset from the alignment point specified by the HAlign key.

setInText(boolean) - Method in class com.itextpdf.text.pdf.mc.MCParser

Informs the parser that we're inside or outside a text object.

setLabel(PdfString) - Method in class com.itextpdf.text.pdf.spatial.objects.NumberFormatDictionary

A text string specifying a label for displaying the units represented by this NumberFormat in a user interface; the label should use a universally recognized abbreviation.

setLabelLeftString(PdfString) - Method in class com.itextpdf.text.pdf.spatial.objects.NumberFormatDictionary

Text that shall be concatenated to the left of the label specified by setLabel.

setLabelPosition(PdfName) - Method in class com.itextpdf.text.pdf.spatial.objects.NumberFormatDictionary

A name indicating the position of the label specified by setLabel with respect to the calculated unit value.

setLabelRightString(PdfString) - Method in class com.itextpdf.text.pdf.spatial.objects.NumberFormatDictionary

Text that shall be concatenated after the label specified by setLabel.

setLPTS(NumberArray) - Method in class com.itextpdf.text.pdf.spatial.MeasureGeospatial

An array of numbers that shall be taken pairwise to define points in a 2D unit square.

setMeasure(Measure) - Method in class com.itextpdf.text.pdf.spatial.Viewport

A measure dictionary that specifies the scale and units that shall apply to measurements taken on the contents within the viewport.

setName(PdfString) - Method in class com.itextpdf.text.pdf.richmedia.CuePoint

Set the name of the cue point to match against the cue point within Flash content and for display purposes.

setName(PdfString) - Method in class com.itextpdf.text.pdf.richmedia.RichMediaConfiguration

Sets the name of the configuration (must be unique).

setName(PdfString) - Method in class com.itextpdf.text.pdf.spatial.Viewport

(Optional) A descriptive text string or title of the viewport, intended for use in a user interface.

setNavigationPane(PdfBoolean) - Method in class com.itextpdf.text.pdf.richmedia.RichMediaPresentation

Sets a flag that indicates the default behavior of the navigation pane user interface element.

setO(XYArray) - Method in class com.itextpdf.text.pdf.spatial.MeasureRectilinear

An array of two numbers that shall specify the origin of the measurement coordinate system in default user space coordinates.

setParams(RichMediaParams) - Method in class com.itextpdf.text.pdf.richmedia.RichMediaInstance

Sets the parameters.

setPassContextClick(PdfBoolean) - Method in class com.itextpdf.text.pdf.richmedia.RichMediaPresentation

Sets a flag that indicates whether a context click on the rich media annotation is passed to the media player run time or is handled by the conforming reader.

setPlayCount(int) - Method in class com.itextpdf.text.pdf.richmedia.RichMediaAnimation

Sets the number of times the animation is played.

setPosition(RichMediaPosition) - Method in class com.itextpdf.text.pdf.richmedia.RichMediaWindow

Sets a RichMediaPosition dictionary describing the position of the RichMediaWindow.

setPrecision(PdfNumber) - Method in class com.itextpdf.text.pdf.spatial.objects.NumberFormatDictionary

A positive integer that shall specify the precision or denominator of a fractional amount: When the Fractional Value is Fraction.DECIMAL, this entry shall be the precision of a decimal display; it shall be a multiple of 10.

setPresentation(RichMediaPresentation) - Method in class com.itextpdf.text.pdf.richmedia.RichMediaActivation

Sets a RichMediaPresentation dictionary that contains information as to how the annotation and user interface elements will be visually laid out and drawn.

setPtData(PointData) - Method in class com.itextpdf.text.pdf.spatial.Viewport

PointData that shall specify the extended geospatial data that applies to the image.

setRichMediaInstance(PdfIndirectReference) - Method in class com.itextpdf.text.pdf.richmedia.RichMediaExecuteAction

Sets the target instance for this action.

setS(NumberFormatArray) - Method in class com.itextpdf.text.pdf.spatial.MeasureRectilinear

A number format array for measurement of the slope of a line.

setScaleRatio(PdfString) - Method in class com.itextpdf.text.pdf.spatial.MeasureRectilinear

A text string expressing the scale ratio of the drawing in the region corresponding to this dictionary.

setScripts(PdfArray) - Method in class com.itextpdf.text.pdf.richmedia.RichMediaActivation

Sets an array of indirect object references to file specification dictionaries, each of which describe a JavaScript file that shall be present in the Assets name tree of the RichMediaContent dictionary.

setSettings(PdfString) - Method in class com.itextpdf.text.pdf.richmedia.RichMediaParams

A text string used to store settings information associated with a Flash RichMediaInstance.

setSpeed(int) - Method in class com.itextpdf.text.pdf.richmedia.RichMediaAnimation

Sets the speed to be used when running the animation.

setSpeed(float) - Method in class com.itextpdf.text.pdf.richmedia.RichMediaAnimation

Sets the speed to be used when running the animation.

setStyle(PdfName) - Method in class com.itextpdf.text.pdf.richmedia.RichMediaPresentation

Sets the style for the presentation; can be embedded or windowed.

setT(NumberFormatArray) - Method in class com.itextpdf.text.pdf.spatial.MeasureRectilinear

A number format array for measurement of angles.

setTime(int) - Method in class com.itextpdf.text.pdf.richmedia.CuePoint

Sets the time value of the cue point in milliseconds to match against the cue point within Flash content and for display purposes.

setToolbar(PdfBoolean) - Method in class com.itextpdf.text.pdf.richmedia.RichMediaPresentation

Sets a flag that indicates the default behavior of an interactive toolbar associated with this annotation.

setTransparent(PdfBoolean) - Method in class com.itextpdf.text.pdf.richmedia.RichMediaPresentation

Set a flag that indicates whether the page content is displayed through the transparent areas of the rich media content (where the alpha value is less than 1.0).

setVAlign(PdfName) - Method in class com.itextpdf.text.pdf.richmedia.RichMediaPosition

Set the horizontal alignment.

setView(PdfIndirectReference) - Method in class com.itextpdf.text.pdf.richmedia.RichMediaActivation

Sets an indirect object reference to a 3D view dictionary that shall also be referenced by the Views array within the annotation's RichMediaContent dictionary.

setVOffset(float) - Method in class com.itextpdf.text.pdf.richmedia.RichMediaPosition

Sets the offset from the alignment point specified by the VAlign key.

setWidth(float, float, float) - Method in class com.itextpdf.text.pdf.richmedia.RichMediaWindow

Sets a dictionary with keys Default, Max, and Min describing values for the width of the Window in default user space units.

setWindow(RichMediaWindow) - Method in class com.itextpdf.text.pdf.richmedia.RichMediaPresentation

A RichMediaWindow Dictionary that describes the size and position of the floating user interface window when the value for Style is set to Windowed.

setWKT(String) - Method in class com.itextpdf.text.pdf.spatial.CoordinateSystem

Sets the Well Known Text.

setX(NumberFormatArray) - Method in class com.itextpdf.text.pdf.spatial.MeasureRectilinear

A number format array for measurement of change along the x axis and, if Y is not present, along the y axis as well.

setY(NumberFormatArray) - Method in class com.itextpdf.text.pdf.spatial.MeasureRectilinear

A number format array for measurement of change along the y axis.

SmartPdfSplitter - Class in com.itextpdf.text.pdf.util

Splits a PDF based on a given file size.

SmartPdfSplitter(PdfReader) - Constructor for class com.itextpdf.text.pdf.util.SmartPdfSplitter

split(OutputStream, long) - Method in class com.itextpdf.text.pdf.util.SmartPdfSplitter

Square - Enum in com.itextpdf.text.pdf.spatial.units

Area display units for use in a Preferred Display Units (PDU) array.

structElem - Variable in class com.itextpdf.text.pdf.mc.StructureObject

The structure element of which the properties are stored.

structParent - Variable in class com.itextpdf.text.pdf.mc.StructureObject

The StructParent value of the object.

structParents - Variable in class com.itextpdf.text.pdf.mc.MCParser

the StructParents of the page that is being processed.

structTreeRoot - Variable in class com.itextpdf.text.pdf.mc.StructureItems

The StructTreeRoot dictionary

StructureItem - Class in com.itextpdf.text.pdf.mc

The abstract StructureItem class is extended by StructureMCID and StructureObject.

StructureItem() - Constructor for class com.itextpdf.text.pdf.mc.StructureItem

StructureItems - Class in com.itextpdf.text.pdf.mc

Creates a list of StructureItem objects extracted from the Structure Tree of a PDF document.

StructureItems(PdfReader) - Constructor for class com.itextpdf.text.pdf.mc.StructureItems

Creates a list of StructuredItem objects.

StructureMCID - Class in com.itextpdf.text.pdf.mc

Object that stores an item that is part of the document structure.

StructureMCID(PdfIndirectReference, PdfNumber) - Constructor for class com.itextpdf.text.pdf.mc.StructureMCID

Creates a StructureMCID using an MCID.

StructureMCID(PdfDictionary) - Constructor for class com.itextpdf.text.pdf.mc.StructureMCID

Creates a StructurItem using an MCR dictionary.

StructureObject - Class in com.itextpdf.text.pdf.mc

A StructureItem that refers to an object from an OBJR dictionary.

StructureObject(PdfDictionary, PdfIndirectReference, PdfDictionary) - Constructor for class com.itextpdf.text.pdf.mc.StructureObject

Creates a StructureObject for an OBJR dictionary.

T

text - Variable in class com.itextpdf.text.pdf.mc.MCParser

A buffer containing text state.

toString() - Method in class com.itextpdf.text.pdf.mc.StructureMCID

Creates a String representation of the object.

toString() - Method in class com.itextpdf.text.pdf.mc.StructureObject

Creates a String representation of the object.

TSTAR - Static variable in class com.itextpdf.text.pdf.mc.MCParser

A new line operator

V

valueOf(String) - Static method in enum com.itextpdf.text.pdf.spatial.units.Angular

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.itextpdf.text.pdf.spatial.units.Fraction

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.itextpdf.text.pdf.spatial.units.Linear

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.itextpdf.text.pdf.spatial.units.PtIdentifier

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.itextpdf.text.pdf.spatial.units.Square

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.itextpdf.text.pdf.spatial.units.Angular

Returns an array containing the constants of this enum type, in the order they're declared.

values() - Static method in enum com.itextpdf.text.pdf.spatial.units.Fraction

Returns an array containing the constants of this enum type, in the order they're declared.

values() - Static method in enum com.itextpdf.text.pdf.spatial.units.Linear

Returns an array containing the constants of this enum type, in the order they're declared.

values() - Static method in enum com.itextpdf.text.pdf.spatial.units.PtIdentifier

Returns an array containing the constants of this enum type, in the order they're declared.

values() - Static method in enum com.itextpdf.text.pdf.spatial.units.Square

Returns an array containing the constants of this enum type, in the order they're declared.

Viewport - Class in com.itextpdf.text.pdf.spatial

A ViewPort dictionary.

Viewport() - Constructor for class com.itextpdf.text.pdf.spatial.Viewport

Creates a ViewPort dictionary.

views - Variable in class com.itextpdf.text.pdf.richmedia.RichMediaAnnotation

an array of views (will be added to the RichMediaContent)

W

writeParentTree(PdfWriter) - Method in class com.itextpdf.text.pdf.mc.StructureItems

Writes the altered parent tree to a PdfWriter and updates the StructTreeRoot entry.

writer - Variable in class com.itextpdf.text.pdf.richmedia.RichMediaAnnotation

The PdfWriter to which the annotation will be added.

X

xobj - Variable in class com.itextpdf.text.pdf.ocg.OCGParser

The names of XObjects that shouldn't be shown.

xobjects - Variable in class com.itextpdf.text.pdf.mc.MCParser

the XObject dictionary of the page that is being processed.

xpts - Variable in class com.itextpdf.text.pdf.spatial.PointData

An array with XPTS values.

XYArray - Class in com.itextpdf.text.pdf.spatial.objects

Creates an Array with two PdfNumber elements, representing an X and Y coordinate.

XYArray(float, float) - Constructor for class com.itextpdf.text.pdf.spatial.objects.XYArray

Creates an XYArray object.

A B C D E F G H I L M N O P R S T V W X