Class: TPageImpositor

Declaration: PageCompositor.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TPageCompositor

Inherited By:

None.

Purpose:

This is the basic impositor class , which creates a page iterator that can use a TPageImpositionSequencer to do any sort of imposition.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

The basic imposition. This is a special derived class of TPageCompositor to perform imposition printing. Although it is possible to derive from this class, if the intent is to obtain different imposition behavior, the proper thing to do is derive from TPageImpositionSequencer and pass that class as a parameter to this class when CreatePageIterator is called.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TPageImpositor::TPageImpositor

TPageImpositor (const TPageImpositor &)
TPageImpositor (TPageImpositionSequencer * adoptSequencer, const TPageDescription & masterPage, const TPageDescription & tiledPage, TPageMapper :: EMapOrientation align =TPageMapper :: kPickBestWithLeftBinding)
TPageImpositor (TPageImpositionSequencer * adoptSequencer, const TPageDescription & masterPage, TPageMapper :: EMapOrientation align =TPageMapper :: kPickBestWithLeftBinding)
TPageImpositor (TPageImpositionSequencer * adoptSequencer, TPageMapper :: EMapOrientation align =TPageMapper :: kPickBestWithLeftBinding)
TPageImpositor ()

Interface Category:

API.

Purpose:

Copy constructor.
Constructs a page impositor from an adopted sequencer, a destination and source page description, and an orientation.
Constructs a page impositor from an adopted sequencer, a destination page description, and an orientation. The source page description defaults to the source page description when a page iterator is created.
Constructs a page impositor with both source and destination page descriptions deferred until a page iterator is created.
Default constructor.

Calling Context:

Called to copy an object.
Called to create a custom page impositor with some parameters defaulted.
Called to create a custom page impositor with some parameters defaulted.
Called to create a custom page impositor with some parameters defaulted.
Called by the stream-in operators and clients to create a page impositor.

Parameters:

const TPageImpositor & -The object to copy.
TPageImpositionSequencer * adoptSequencer -This is a sequencer that defines how the imposition is to be applied.
const TPageDescription & masterPage -The destination page description.
const TPageDescription & tiledPage -The source page description.
TPageMapper :: EMapOrientation align =TPageMapper :: kPickBestWithLeftBinding -The orientation of source pages to destination pages for the imposition.
TPageImpositionSequencer * adoptSequencer -This is a sequencer that defines how the imposition is to be applied.
const TPageDescription & masterPage -The destination page description.
TPageMapper :: EMapOrientation align =TPageMapper :: kPickBestWithLeftBinding -The orientation of source pages to destination pages for the imposition.
TPageImpositionSequencer * adoptSequencer -This is a sequencer that defines how the imposition is to be applied.
TPageMapper :: EMapOrientation align =TPageMapper :: kPickBestWithLeftBinding -The orientation of source pages to destination pages for the mapping.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPageImpositor::~TPageImpositor

virtual ~ TPageImpositor ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPageImpositor::CreatePageIterator

virtual TPrintPageIterator * CreatePageIterator (TPageIterator * aliasIterator, TPageRange * aliasRange =NIL) const

Interface Category:

API.

Purpose:

Creates the page iterator to do the imposition as defined by the target page iterator and the desired page range.

Calling Context:

Called directly to create a page iterator that does imposition.

Parameters:

TPageIterator * aliasIterator -A target page iterator. When a page compositor is created, it must build its pages from other pages. This iterator is used as the source of pages for the imposition When the imposition iterator is destroyed, the target page iterator is ignored. The iterator used for this argument can be a page iterator from another compositor or a page iterator created by a derived class of MPageFolio, that is, it can be a printable page iterator or not.
TPageRange * aliasRange =NIL -The page range to use on this iterator if any.

Return Value:

Returns a new page iterator to do imposition that the client is responsible for deleting.

Exceptions:

Throws TStandardPrintPreprocessingException::kTargetMissing if the adopted page iterator is NIL.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPageImpositor::operator=

TPageImpositor & operator =(const TPageImpositor &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TPageImpositor & -The object from which to assign.

Return Value:

A reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPageImpositor::Hash

virtual long Hash () const

Interface Category:

API.

Purpose:

Generates a hash value.

Calling Context:

Called directly to generate a hash value. Also called by the collection classes when this object is placed in a collection.

Parameters:

Takes no parameters.

Return Value:

Returns a hash value.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPageImpositor::operator<<=

virtual TStream & operator <<= (TStream & fromWhere)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called directly to stream in data.

Parameters:

TStream & fromWhere -The stream the object streams itself in from.

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPageImpositor::operator>>=

virtual TStream & operator >>=(TStream & toWhere) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called directly to stream out data.

Parameters:

TStream & toWhere -The stream the object streams itself out to.

Return Value:

Returns a reference to the stream the object streams itself out to.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.