com.itextpdf.kernel.pdf.action

Class PdfWin

java.lang.Object

com.itextpdf.kernel.pdf.PdfObjectWrapper<PdfDictionary>

com.itextpdf.kernel.pdf.action.PdfWin

All Implemented Interfaces:

Serializable

public class PdfWin
extends PdfObjectWrapper<PdfDictionary>

This class is a wrapper around a Windows launch parameter dictionary.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PdfWin(PdfDictionary pdfObject) Creates a new wrapper around an existing Windows launch parameter dictionary.
PdfWin(PdfString f) Creates a new wrapper around a newly created Windows launch parameter dictionary.
PdfWin(PdfString f, PdfString d, PdfString o, PdfString p) Creates a new wrapper around a newly created Windows launch parameter dictionary.

Method Summary

Modifier and Type	Method and Description
protected boolean	isWrappedObjectMustBeIndirect() Defines if the object behind this wrapper must be an indirect object in the resultant document.

Methods inherited from class com.itextpdf.kernel.pdf.PdfObjectWrapper

ensureObjectIsAddedToDocument, ensureUnderlyingObjectHasIndirectReference, flush, getPdfObject, isFlushed, makeIndirect, makeIndirect, markObjectAsIndirect, setForbidRelease, setModified, setPdfObject, unsetForbidRelease

Methods inherited from class java.lang.Object

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

Constructor Detail

PdfWin

public PdfWin(PdfDictionary pdfObject)

Creates a new wrapper around an existing Windows launch parameter dictionary.

Parameters:

pdfObject - the dictionary to create a wrapper for

PdfWin

public PdfWin(PdfString f)

Creates a new wrapper around a newly created Windows launch parameter dictionary.

Parameters:

f - the file name of the application that shall be launched or the document that shall be opened or printed, in standard Windows pathname format. If the name string includes a backslash character (\), the backslash shall itself be preceded by a backslash.

PdfWin

public PdfWin(PdfString f,
              PdfString d,
              PdfString o,
              PdfString p)

Creates a new wrapper around a newly created Windows launch parameter dictionary.

Parameters:

f - the file name of the application that shall be launched or the document that shall be opened or printed, in standard Windows pathname format. If the name string includes a backslash character (\), the backslash shall itself be preceded by a backslash

d - a bye string specifying the default directory in standard DOS syntax

o - an ASCII string specifying the operation to perform on the file. Shall be one of the following: "open", "print"

p - a parameter string that shall be passed to the application. This entry shall be omitted if a document is abound to be opened

Method Detail

isWrappedObjectMustBeIndirect

protected boolean isWrappedObjectMustBeIndirect()

Defines if the object behind this wrapper must be an indirect object in the resultant document.

If this method returns true it doesn't necessarily mean that object must be in the indirect state at any moment, but rather defines that when the object will be written to the document it will be transformed into indirect object if it's not indirect yet.

Return value of this method shouldn't depend on any logic, it should return always true or false.

Specified by:

isWrappedObjectMustBeIndirect in class PdfObjectWrapper<PdfDictionary>

Returns:

true if in the resultant document the object behind the wrapper must be indirect, otherwise false.