Mako 7.5.0 API
Loading...
Searching...
No Matches
JawsMako::IRedactorTransform Class Referenceabstract

A transform for applying redaction redactions. More...

#include <transforms.h>

Inheritance diagram for JawsMako::IRedactorTransform:

Public Member Functions

virtual void setTargetSpace (const IDOMColorSpacePtr &targetSpace)=0
 Set the color space to use when rendering redacted sections. The default is DeviceRGB. The color space must be supported by the IRendererTransform.
 
virtual void setResolution (uint32 resolution)=0
 Set the target resolution to use when rendering redacted sections. The default is 300dpi. The resolution must be supported by the IRendererTransform.
 
virtual void setGenerateMasks (bool generateMasks)=0
 Set whether masks should be generated when rendering redacted sections. The default is true.
 
- Public Member Functions inherited from JawsMako::ITransform
virtual IDOMBrushPtr transform (const IDOMBrushPtr &brush, eBrushUsage usage=eBUGeneral, const CTransformState &state=CTransformState())=0
 Apply the transform to the given brush, if applicable. These transforms are thread safe.
 
virtual IDOMImagePtr transform (const IDOMImagePtr &image, const CTransformState &state=CTransformState())=0
 Apply the transform to the given image, if applicable. These transforms are thread safe.
 
virtual IDOMColorPtr transform (const IDOMColorPtr &color, const CTransformState &state=CTransformState())=0
 Apply the transform to the given color, if applicable. These transforms are thread safe.
 
virtual IDOMColorSpacePtr transform (const IDOMColorSpacePtr &colorSpace, const CTransformState &state=CTransformState())=0
 Apply the transform to the given colorspace, if applicable. These transforms are thread safe.
 
virtual IDOMNodePtr transform (const IDOMNodePtr &node, bool &changed, bool transformChildren=true, const CTransformState &state=CTransformState())=0
 Apply the transform to the given node, if applicable. These transforms are thread safe, providing no other transforms are being applied to the same nodes at the same time.
 
virtual void transformPage (const IPagePtr &page, bool transformContent=true, bool transformAnnotations=true)=0
 Apply the transform to the given page, if applicable. These transforms are thread safe, providing no other transforms are being applied to the same nodes at the same time. The transform will also apply to the annotations appearances.
 
virtual void flushCaches ()=0
 Flush the caches used by the transform. Most transforms cache recently transformed results to improve the performance of repeated transformations of equivalent results. However, it is possible that some cached results may point to entities that no longer exist, such as content inside an XPS file that no longer exists. If you are deleting or replacing files where transforms have been used, it is advisable to invoke this routine to clear the caches.
 
virtual void setProgressMonitor (const IProgressMonitorPtr &progressMonitor)=0
 Set the IProgressMonitor object for this transform to allow for monitoring the progress of the transform.
 
- 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 JAWSMAKO_API IRedactorTransformPtr create (const IJawsMakoPtr &jawsMako, const IAbortPtr &abort=IAbortPtr())
 Create the transform.
 

Additional Inherited Members

- Protected Member Functions inherited from IRCObject
virtual ~IRCObject ()
 Virtual destructor.
 

Detailed Description

A transform for applying redaction redactions.

    This transform uses rendering to render the area covered by each
    redaction annotation including that annotation into an image, and
    removing any objects underneath that intersect with the annotation
    from the DOM tree entirely.
    This transform is only effective for page content, not for
    annotations and other off-page graphical content.

    As it requires knowledge of the annotations, this transform may
    only be applied to IPage objects; anything else will result in an
    exception.

    As such only transformPage() can be used and any other transform()
    routine will throw an exception. If the transformContent argument to
    transformPage() is not true the transform will do nothing. Further,
    the transformAnnotations parameter will be ignored.

    The redaction annotations are removed after they are applied.

Member Function Documentation

◆ create()

static JAWSMAKO_API IRedactorTransformPtr JawsMako::IRedactorTransform::create ( const IJawsMakoPtr & jawsMako,
const IAbortPtr & abort = IAbortPtr() )
static

Create the transform.

Parameters
jawsMakoThe JawsMako instance.
abortAn abort callback handler.
Returns
The new instance.

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