Skip to main content
Version: API v2 Preview

PDFObject

Kind: class
Module/package: com.pdfdancer.common.model
SDK: com.pdfdancer.client:pdfdancer-client-java 2.0.0

Abstract base class for all PDF objects that can be manipulated within the API. This class provides the fundamental properties and behaviors shared by all PDF content elements, including getPosition tracking, identification, and object reference generation.

The class uses Jackson polymorphic serialization to handle different concrete types during JSON serialization/deserialization, enabling type-safe API operations while maintaining flexibility for different PDF object types.

Declaration

public abstract class com.pdfdancer.common.model.PDFObject

Members

constructor

public com.pdfdancer.common.model.PDFObject()

Default constructor required for serialization frameworks. Creates an uninitialized PDF object that should be populated with appropriate values before use.

constructor

public com.pdfdancer.common.model.PDFObject(java.lang.String, com.pdfdancer.common.model.Position)

Constructs a PDF object with the specified identifier and getPosition. This constructor initializes the fundamental properties that all PDF objects require for proper identification and spatial location.

getId

public java.lang.String getId()

Returns the unique identifier for this PDF object.

getPosition

public com.pdfdancer.common.model.Position getPosition()

Returns the spatial getPosition information for this object.

setId

public void setId(java.lang.String)

Sets the unique identifier for this PDF object.

setPosition

public void setPosition(com.pdfdancer.common.model.Position)

Updates the spatial getPosition information for this object.

toObjectRef

public com.pdfdancer.common.model.ObjectRef toObjectRef()

Creates an object reference for this PDF object. Object references provide a lightweight way to refer to PDF objects without including their full content, enabling efficient API operations.

View source at 9c04036fe114