OOFILE  1.9
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members

Used by oofRepXMLEnv::StartReport to visit all adornable items to serialise adorner descriptions. More...

Inheritance diagram for OOF_repXMLadornerVisitor:
Inheritance graph
[legend]
Collaboration diagram for OOF_repXMLadornerVisitor:
Collaboration graph
[legend]

Public Member Functions

 OOF_repXMLadornerVisitor (oofIDfactory &identities)
 
virtual void visit (oofRep *)
 Top-level that iterates all the others, encapsulating report structure. More...
 

Protected Member Functions

virtual void VisitAdorner (oofAdorner *)
 
virtual void VisitDrawable (oofRepDrawable *)
 
void VisitTypedBand (oofRepBand *)
 
Visit Associated band or break lists
virtual void VisitFirstPageHeaders (oofRepBandList &)
 
virtual void VisitFirstPageFooters (oofRepBandList &)
 
virtual void VisitPageHeaders (oofRepBandList &)
 
virtual void VisitPageFooters (oofRepBandList &)
 
virtual void VisitBody (oofRepBand *)
 that top body is likely to be complex so doesn't bother testing. More...
 
virtual void VisitIterableBandBody (oofRepBand *)
 Isolates these bands so more complex visitors can optimise their querying. More...
 
virtual void VisitBandHeaders (oofRepBandList &)
 
virtual void VisitBandFooters (oofRepBandList &)
 
virtual void VisitBandHeaderBreaks (oofRepBreakList &)
 
virtual void VisitBandFooterBreaks (oofRepBreakList &)
 
core visit methods
virtual void VisitBandList (oofRepBandList &)
 
virtual void VisitBreakList (oofRepBreakList &)
 
virtual void VisitBlockList (oofRepBlockList &)
 
virtual void VisitComplexBand (oofRepBand *)
 Visit a band which is likely to provide one or more optional interfaces. More...
 
virtual void VisitLayoutBand (oofRepLayoutBand *)
 
virtual void VisitBlock (oofRepBlock *)
 
virtual void VisitBand (oofRepBand *)
 
methods for subclass to visit adorners, not called by default visit traversal
virtual void VisitAdornerList (oofAdornerList &)
 
override these if you need to update some kind of depth counter as the default traverses above are used
virtual void EnterLevel ()
 
virtual void LeaveLevel ()
 

Protected Attributes

oofIDfactorymIdentities
 
oofString mParentIDattrib
 
oofRepmRep
 

Detailed Description

Used by oofRepXMLEnv::StartReport to visit all adornable items to serialise adorner descriptions.

Users may provide their own adorners and have them serialised here and instantiated when the report is parsed. Each serialised adorner is responsible for encoding its own description as XML-compatible text. The same mechanism is used for our standard adorners such as oofBorderAdorner.

See also
oofSerializable

Definition at line 638 of file oofrpXML.cpp.

Constructor & Destructor Documentation

OOF_repXMLadornerVisitor::OOF_repXMLadornerVisitor ( oofIDfactory identities)
inline

Definition at line 641 of file oofrpXML.cpp.

Member Function Documentation

void oofRepVisitor::EnterLevel ( )
protectedvirtualinherited
void oofRepVisitor::LeaveLevel ( )
protectedvirtualinherited
void oofRepVisitor::visit ( oofRep inRep)
virtualinherited
void OOF_repXMLadornerVisitor::VisitAdorner ( oofAdorner inAdorner)
protectedvirtual

Reimplemented from oofRepVisitor.

Definition at line 667 of file oofrpXML.cpp.

References oofSerializable::makeSerializableElement(), and oofRepStreamEnv::out().

void oofRepVisitor::VisitAdornerList ( oofAdornerList inList)
protectedvirtualinherited
void oofRepVisitor::VisitBand ( oofRepBand inBand)
protectedvirtualinherited
void oofRepVisitor::VisitBandFooterBreaks ( oofRepBreakList inBreaks)
protectedvirtualinherited

Reimplemented in OOF_repXMLlayoutVisitor.

Definition at line 1593 of file oofrep2.cpp.

References oofRepVisitor::VisitBreakList().

Referenced by oofRepVisitor::VisitComplexBand().

void oofRepVisitor::VisitBandFooters ( oofRepBandList inBands)
protectedvirtualinherited

Reimplemented in OOF_repXMLlayoutVisitor.

Definition at line 1579 of file oofrep2.cpp.

References oofRepVisitor::VisitBandList().

Referenced by oofRepVisitor::VisitComplexBand().

void oofRepVisitor::VisitBandHeaderBreaks ( oofRepBreakList inBreaks)
protectedvirtualinherited

Reimplemented in OOF_repXMLlayoutVisitor.

Definition at line 1586 of file oofrep2.cpp.

References oofRepVisitor::VisitBreakList().

Referenced by oofRepVisitor::VisitComplexBand().

void oofRepVisitor::VisitBandHeaders ( oofRepBandList inBands)
protectedvirtualinherited

Reimplemented in OOF_repXMLlayoutVisitor.

Definition at line 1572 of file oofrep2.cpp.

References oofRepVisitor::VisitBandList().

Referenced by oofRepVisitor::VisitComplexBand().

void oofRepVisitor::VisitBandList ( oofRepBandList inBands)
protectedvirtualinherited
void oofRepVisitor::VisitBlock ( oofRepBlock inBlock)
protectedvirtualinherited

Definition at line 1665 of file oofrep2.cpp.

References oofRepVisitor::VisitDrawable().

Referenced by oofRepVisitor::VisitBlockList().

void oofRepVisitor::VisitBlockList ( oofRepBlockList inBlocks)
protectedvirtualinherited
void oofRepVisitor::VisitBody ( oofRepBand inBand)
protectedvirtualinherited

that top body is likely to be complex so doesn't bother testing.

Definition at line 1563 of file oofrep2.cpp.

References oofRepVisitor::EnterLevel(), oofRepVisitor::LeaveLevel(), and oofRepVisitor::VisitComplexBand().

void oofRepVisitor::VisitBreakList ( oofRepBreakList inBreaks)
protectedvirtualinherited
void oofRepVisitor::VisitComplexBand ( oofRepBand inBand)
protectedvirtualinherited
void OOF_repXMLadornerVisitor::VisitDrawable ( oofRepDrawable inDrawable)
protectedvirtual
void oofRepVisitor::VisitFirstPageFooters ( oofRepBandList inBands)
protectedvirtualinherited

Reimplemented in OOF_repXMLlayoutVisitor.

Definition at line 1539 of file oofrep2.cpp.

References oofRepVisitor::VisitBandList().

Referenced by oofRepVisitor::visit().

void oofRepVisitor::VisitFirstPageHeaders ( oofRepBandList inBands)
protectedvirtualinherited

Reimplemented in OOF_repXMLlayoutVisitor.

Definition at line 1532 of file oofrep2.cpp.

References oofRepVisitor::VisitBandList().

Referenced by oofRepVisitor::visit().

void oofRepVisitor::VisitIterableBandBody ( oofRepBand inBand)
protectedvirtualinherited

Isolates these bands so more complex visitors can optimise their querying.

Default case just treats as normal band.

Reimplemented in OOF_repEditSetupVisitor, and OOF_repXMLstyleVisitor.

Definition at line 1690 of file oofrep2.cpp.

References oofRepVisitor::VisitBand().

Referenced by oofRepVisitor::VisitComplexBand(), and OOF_repXMLstyleVisitor::VisitIterableBandBody().

void oofRepVisitor::VisitLayoutBand ( oofRepLayoutBand inBand)
protectedvirtualinherited
void oofRepVisitor::VisitPageFooters ( oofRepBandList inBands)
protectedvirtualinherited

Reimplemented in OOF_repXMLlayoutVisitor.

Definition at line 1553 of file oofrep2.cpp.

References oofRepVisitor::VisitBandList().

Referenced by oofRepVisitor::visit().

void oofRepVisitor::VisitPageHeaders ( oofRepBandList inBands)
protectedvirtualinherited

Reimplemented in OOF_repXMLlayoutVisitor.

Definition at line 1546 of file oofrep2.cpp.

References oofRepVisitor::VisitBandList().

Referenced by oofRepVisitor::visit().

void oofRepVisitor::VisitTypedBand ( oofRepBand inBand)
protectedinherited

Member Data Documentation

oofIDfactory& OOF_repXMLadornerVisitor::mIdentities
protected

Definition at line 650 of file oofrpXML.cpp.

oofString OOF_repXMLadornerVisitor::mParentIDattrib
protected

Definition at line 651 of file oofrpXML.cpp.

oofRep* oofRepVisitor::mRep
protectedinherited

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