XForm

Inheritance: java.lang.Object

All Implemented Interfaces: com.aspose.pdf.ISupportsMemoryCleanup, com.aspose.pdf.engine.IOperatorContainer

public final class XForm implements ISupportsMemoryCleanup, IOperatorContainer

Class represent XForm

Methods

MethodDescription
getEngineObj()Internal only
getBBox()Gets form bounding box.
setBBox(Rectangle value)Sets form bounding box.
getName()Gets form name.
setName(String value)Sets form name.
getIT()Gets form IT.
getSubtype()Gets form Subtype.
getContents()Gets operators of the form.
getOpi()Gets The Open Prepress Interface (OPI).
getMatrix()Gets matrix of the form.
setMatrix(Matrix value)Sets matrix of the form.
getResources(boolean allowCreate)Returns resources of Form X-Object
getResources()Returns resources of Form X-Object.
getResources2()Gets Form XObject resources.
createNewForm(ITrailerable trailerable)Creates new XForm in the document.
containsOwnResources()Returns True if contains Own Resources
createNewForm(Page source, ITrailerable trailerable, Copier copier)
createNewForm(Page source, IDocument document)Creates XForm which duplicates contents of the page.
getRectangle()Gets rectangel of the form.
freeMemory()Clears cached data

getEngineObj()

public IPdfObject getEngineObj()

Internal only

Returns: IPdfObject - IPdfObject object

getBBox()

public Rectangle getBBox()

Gets form bounding box.

Returns: Rectangle - Rectangle

setBBox(Rectangle value)

public void setBBox(Rectangle value)

Sets form bounding box.

Parameters:

ParameterTypeDescription
valueRectangleRectangle

getName()

public String getName()

Gets form name. Form name is name which used to reference form in XObejct ductionary in page resources.

Returns: java.lang.String - String

setName(String value)

public void setName(String value)

Sets form name. Form name is name which used to reference form in XObejct dictionary in page resources.

Parameters:

ParameterTypeDescription
valuejava.lang.StringString object

getIT()

public final String getIT()

Gets form IT. Form IT is a name describing the intent of the XObject.

Returns: java.lang.String

getSubtype()

public final String getSubtype()

Gets form Subtype.

Returns: java.lang.String

getContents()

public OperatorCollection getContents()

Gets operators of the form.

Returns: OperatorCollection - OperatorCollection object

getOpi()

public Opi getOpi()

Gets The Open Prepress Interface (OPI).

Returns: Opi - Opi instance

getMatrix()

public Matrix getMatrix()

Gets matrix of the form.

Returns: Matrix - Matrix

setMatrix(Matrix value)

public void setMatrix(Matrix value)

Sets matrix of the form.

Parameters:

ParameterTypeDescription
valueMatrixMatrix object

getResources(boolean allowCreate)

public final Resources getResources(boolean allowCreate)

Returns resources of Form X-Object

Parameters:

ParameterTypeDescription
allowCreatebooleanIf For does not have resources and allowCreate is true, Resources will be automatically created for the form.

Returns: Resources - Resources instance

getResources()

public Resources getResources()

Returns resources of Form X-Object. If For does not have resources and allowCreate is true, Resources will be automatically created for the form.

Returns: Resources - Resources instance

getResources2()

public final Resources getResources2()

Gets Form XObject resources.

Returns: Resources - Resources instance. If For does not have resources, Resources will be automatically created for the form.

createNewForm(ITrailerable trailerable)

public static XForm createNewForm(ITrailerable trailerable)

Creates new XForm in the document.

Parameters:

ParameterTypeDescription
trailerableITrailerableDescribes ITrailerable object

Returns: XForm - Newly created XForm

containsOwnResources()

public boolean containsOwnResources()

Returns True if contains Own Resources

Returns: boolean - boolean value

createNewForm(Page source, ITrailerable trailerable, Copier copier)

public static XForm createNewForm(Page source, ITrailerable trailerable, Copier copier)

Parameters:

ParameterTypeDescription
sourcePage
trailerableITrailerable
copierCopier

Returns: XForm

createNewForm(Page source, IDocument document)

public static XForm createNewForm(Page source, IDocument document)

Creates XForm which duplicates contents of the page.

Parameters:

ParameterTypeDescription
sourcePageSource page
documentIDocumentDocument where new XForm will be added.

Returns: XForm - Newly created XForm.

getRectangle()

public Rectangle getRectangle()

Gets rectangel of the form.

Returns: Rectangle - Rectangle

freeMemory()

public void freeMemory()

Clears cached data