Interface to DOM node representing PDF-style Form XObjects. More...

#include <idomform.h>

Inheritance diagram for IDOMForm:

[legend]

Classes
class	Data
	Initialization data. More...

Public Member Functions
virtual DOMid	getFormId () const =0
	Obtain the uique DOMid of this form.

virtual const FMatrix &	getMatrix () const =0
	Retrieves the Matrix of the form contents (equivalent to the /Matrix entry in a PDF/PS form dictionary).

virtual void	setMatrix (const FMatrix &matrix)=0
	Sets the Matrix of the form contents (equivalent to the /Matrix entry in a PDF/PS form dictionary).

virtual void	setBounds (const FRect &bounds)=0
	Sets the form bounding box.

virtual JawsMako::IStructureElementReferencePtr	getStructureElementReference () const =0
	Get the JawsMako Logical structure element reference associated with this form.

virtual void	setStructureElementReference (const JawsMako::IStructureElementReferencePtr &elementRef)=0
	Set the JawsMako logical structure element reference to be associated with this form, or NULL to clear.

virtual JawsMako::IPDFDictionaryPtr	getPdfPropertiesDictionary () const =0
	Get the dictionary containing PDF properties attached to the form object. This dictionary will be as per the XObject dictionary in the original PDF, but with entries handled by existing DOM features stripped. In particular, the following entries described in the PDF specification will not be present in the dictionary:

virtual void	setPdfPropertiesDictionary (const JawsMako::IPDFDictionaryPtr &propertiesDictionary)=0
	Set the dictionary containing PDF properties attached to the form object. Please see getPdfPropertiesDictionary() above for information on the form of this dictionary.

Public Member Functions inherited from IDOMNode
virtual	~IDOMNode ()
	virtual destructor

virtual DOMid	getDOMid () const =0
	Retrieves the node ID.

virtual void	setDOMid (DOMid id)=0
	Sets the node ID.

virtual eDOMNodeType	getNodeType () const =0
	Retrieves the DOM node type.

virtual bool	getProperty (const EDLSysString &propertyName, PValue &propertyValue) const =0
	Retrieves the value of a property. The EDL DOM node can store non-content or relationship information through the use of the "properties" feature of the node. The data is represented as key-value pairs; the key being a string and the value being an abstract container called a PValue. PValues can represent integers, strings, DOM nodes, and so on.

virtual void	setProperty (const EDLSysString &propertyName, const PValue &propertyValue)=0
	Sets the value of a property. The EDL DOM node can store non-content or relationship information through the use of the "properties" feature of the node. The data is represented as key-value pairs; the key being a string and the value being an abstract container called a PValue. PValues can represent integers, strings, DOM nodes, and so on.

virtual void	removeProperty (const EDLSysString &propertyName)=0
	Removes property.

virtual IEDLSysStringCollectionEnumPtr	getPropertyCollectionEnum ()=0
	Retrieves a navigable list of the property names stored on this node.

virtual bool	hasChildNodes () const =0
	Function that indicates whether this node is a parent to other nodes.

virtual IDOMNodePtr	getParentNode () const =0
	Gets the parent node of this node.

virtual IDOMNodePtr	getFirstChild () const =0
	Gets the first child node of this node.

virtual IDOMNodePtr	getLastChild () const =0
	Gets the last child node of this node.

virtual IDOMNodePtr	getNextChild (const IDOMNodePtr &child) const =0
	Gets the child node which follows the node passed in.

virtual IDOMNodePtr	getPreviousChild (const IDOMNodePtr &child) const =0
	Gets the child node which precedes the node passed in.

virtual IDOMNodePtr	getPreviousSibling () const =0
	Retrieves the node's previous sibling node.

virtual IDOMNodePtr	getNextSibling () const =0
	Retrieves node's next sibling node.

virtual void	appendChild (const IDOMNodePtr &child)=0
	Appends a node to the end of the node's child list.

virtual void	insertChild (const IDOMNodePtr &ptrPreviousSibling, const IDOMNodePtr &child, bool bCheckComplete=true)=0
	Insert a child node after ptrPreviousSibling.

virtual IDOMNodePtr	extractChild (const IDOMNodePtr &child)=0
	Extracts (that is, finds and removes) a child node from the node children. After extraction the child node is no longer a part of the DOM. If no node is specified, the first available node will be extracted from the node's children.

virtual void	replaceChild (const IDOMNodePtr &oldChild, const IDOMNodePtr &newChild)=0
	Replaces the child node with another.

virtual bool	isComplete () const =0
	Signals the completeness of the node. A complete node is one that has no more children to be added to it.

virtual void	setComplete ()=0
	Sets the node's completeness status to "true".

virtual IDOMNodeFlags *	getFlags ()=0
	Retrieves the node's flags property.

virtual void	setParentNode (const IDOMNodePtr &ptrParent)=0
	Sets the parent node.

virtual void	setPreviousSibling (const IDOMNodePtr &ptrPreviousSibling)=0
	Sets the previous sibling node.

virtual void	setNextSibling (const IDOMNodePtr &ptrNextSibling)=0
	Sets the next sibling node.

virtual bool	isAncestor (const IDOMNodePtr &ptrCandidate)=0
	Function tests whether a candidate node is a descendant of the node.

virtual FRect	getBounds (bool applyTransform=true, bool applyClip=true)
	Find the conservative bounding box of the marking content of the node.

virtual bool	copyNodeData (IDOMNode *pSourceNode)=0
	Copy the properties collection, the flags and the DOM ID from the given source node to this one.

virtual IDOMNodePtr	cloneNode (IEDLClassFactory *pFactory) const =0
	Simpified node cloning. An exception of type IEDLError will be thrown on failure.

virtual IDOMNodePtr	cloneTree (IEDLClassFactory *pFactory) const =0
	Clone the tree of nodes beginning at this node. An exception of type IEDLError will be thrown on failure.

virtual void	cloneTreeAndAppend (IEDLClassFactory *pFactory, const IDOMNodePtr &dest) const =0
	Clone the tree of nodes beginning at this node, and append the result to the destination tree.

virtual void	completeTree ()=0
	Mark the entire tree from this point as complete. You should not ordinarily need to call this function.

virtual void	removeCompleteFlagFromTree ()=0
	Mark the entire tree from this point as complete.

virtual void	findChildrenOfType (eDOMNodeType type, CDOMNodeVect &nodes, bool searchForms=false)=0
	Find all children of this node with the given type, appending to the given vector. Does not descend into brushes.

virtual void	walkTree (WalkTreeFunc func, void *priv, bool descendIntoBrushes=false, bool descendIntoForms=false)=0
	Walk through the DOM calling a given function on each node. The function is allowed to:

virtual void	notifyOnDestruct (NodeDeleteFunc func, void *priv)=0
	Register interest in being told when this node is about to be destroyed.

virtual void	unregisterNotify (NodeDeleteFunc func, void *priv)=0
	Unregister interest in being told when this node is about to be destroyed.

Public Member Functions inherited from IEDLObject
virtual const CClassID &	getClassID () const =0
	Returns class ID of IEDLObject.

virtual bool	init (CClassParams *pData)
	The init() method is called to perform any post-construction initialization of an IEDLObject that has been created by the EDL class factory, before it is actually returned by the factory.

virtual bool	clone (IEDLObjectPtr &ptrObject, IEDLClassFactory *pFactory)
	Create a copy of EDLObject.

Public Member Functions inherited from IRCObject
virtual void	addRef () const =0
	Increases the reference count of the actual object pointed to. This would take place during an assignment or copying.

virtual bool	decRef () const =0
	Decreases the reference count of the actual object pointed to. When the reference count falls to Zero, it deletes the actual object pointed to.

virtual int32	getRefCount () const =0
	Retrieve the current reference count of the actual object pointed to.

Static Public Member Functions
static EDL_API IDOMFormPtr	create (IEDLClassFactory *pFactory, const FMatrix &matrix=FMatrix(), const FRect &bounds=FRect(), const JawsMako::IPDFDictionaryPtr &propertiesDictionary=JawsMako::IPDFDictionaryPtr())
	Simplified creation function for IDOMForm. Throws an IEDLError exception on failure.

static const CClassID &	classID ()
	Retrieves class id of IDOMForm.

Static Public Member Functions inherited from IDOMNode
static EDL_API FMatrix	effectiveTransformationOfNode (const IDOMNodePtr &node)
	Attempt to find the effective transformation matrix external to the specified node relative to either a containing page or ultimate parent.

Additional Inherited Members
Protected Member Functions inherited from IRCObject
virtual	~IRCObject ()
	Virtual destructor.

Detailed Description

Interface to DOM node representing PDF-style Form XObjects.

Member Function Documentation

◆ classID()

static const CClassID & IDOMForm::classID ( )

inlinestatic

Retrieves class id of IDOMForm.

Returns: CClassID class id of the element

◆ create()

static EDL_API IDOMFormPtr IDOMForm::create	(	IEDLClassFactory *	pFactory,
		const FMatrix &	matrix = FMatrix(),
		const FRect &	bounds = FRect(),
		const JawsMako::IPDFDictionaryPtr &	propertiesDictionary = JawsMako::IPDFDictionaryPtr() )

static

Simplified creation function for IDOMForm. Throws an IEDLError exception on failure.

Parameters

pFactory	The EDL class factory
matrix	The desired form matrix
bounds	The desired form bounds
propertiesDictionary	Any additional PDF properties

Returns: IDOMFormPtr A smart pointer to the IDOMForm

◆ getFormId()

virtual DOMid IDOMForm::getFormId ( ) const

pure virtual

Obtain the uique DOMid of this form.

     This is distinct from that received from IDOMNode::getDOMid() which
     is user set and is copied when the node is cloned.

     This DOMid is unique to the form object, and is allocated when
     the form is allocated. Forms cloned from this object will receive
     a new DOMid.

Returns: DOMid The DOMid

◆ getMatrix()

virtual const FMatrix & IDOMForm::getMatrix ( ) const

pure virtual

Retrieves the Matrix of the form contents (equivalent to the /Matrix entry in a PDF/PS form dictionary).

Returns: FMatrix The matrix

◆ getPdfPropertiesDictionary()

virtual JawsMako::IPDFDictionaryPtr IDOMForm::getPdfPropertiesDictionary ( ) const

pure virtual

Get the dictionary containing PDF properties attached to the form object. This dictionary will be as per the XObject dictionary in the original PDF, but with entries handled by existing DOM features stripped. In particular, the following entries described in the PDF specification will not be present in the dictionary:

Type
Subtype
FormType
BBox
Matrix
Resources
Group
StructParent
StructParents
OC
Name
Returns
JawsMako::IPDFDictionary The properties dictionary, or NULL if not present. If non-null, the dictionary may be edited freely.

◆ getStructureElementReference()

virtual JawsMako::IStructureElementReferencePtr IDOMForm::getStructureElementReference ( ) const

pure virtual

Get the JawsMako Logical structure element reference associated with this form.

Returns: JawsMako::IStructureElementReferencePtr A smart pointer to the structure element reference

◆ setBounds()

virtual void IDOMForm::setBounds ( const FRect & bounds )

pure virtual

Sets the form bounding box.

Parameters

bounds Reference parameter to receive the bounding box.

◆ setMatrix()

virtual void IDOMForm::setMatrix ( const FMatrix & matrix )

pure virtual

Sets the Matrix of the form contents (equivalent to the /Matrix entry in a PDF/PS form dictionary).

Parameters

matrix Reference to receive the matrix

◆ setPdfPropertiesDictionary()

virtual void IDOMForm::setPdfPropertiesDictionary ( const JawsMako::IPDFDictionaryPtr & propertiesDictionary )

pure virtual

Set the dictionary containing PDF properties attached to the form object. Please see getPdfPropertiesDictionary() above for information on the form of this dictionary.

Parameters

propertiesDictionary The properties dictionary to set, or NULL to clear.

◆ setStructureElementReference()

virtual void IDOMForm::setStructureElementReference ( const JawsMako::IStructureElementReferencePtr & elementRef )

pure virtual

Set the JawsMako logical structure element reference to be associated with this form, or NULL to clear.

Parameters

elementRef The structure element reference to set

The documentation for this class was generated from the following file:

idomform.h

Classes

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ classID()

◆ create()

◆ getFormId()

◆ getMatrix()

◆ getPdfPropertiesDictionary()

◆ getStructureElementReference()

◆ setBounds()

◆ setMatrix()

◆ setPdfPropertiesDictionary()

◆ setStructureElementReference()