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

Abstract base for report bands. More...

#include <oofrep.h>

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

Public Member Functions

oofAdornerListadorners ()
 
void clearID ()
 
virtual oofRepBandclone () const =0
 
virtual void describeLayout ()
 central default call like draw() but still able to be overriden in extreme cases. More...
 
virtual void draw ()
 central default call for drawing, but still able to be overriden in extreme cases. More...
 
virtual void drawSquished (long &balanceToSave)
 
virtual void finishConstruction ()
 null base method occasionally overriden More...
 
virtual unsigned long fixedHeight ()
 
bool hasAdorners () const
 
oofString ID () const
 
void ID (const oofString &)
 
virtual bool isLayoutBand () const
 
oofRepTextStylelocalTextStyle () const
 Get style owned by this object. More...
 
virtual oofRepEditLinkmakeEditLink (const oofRepEditingEnv &)
 Make an editor for this drawable - by default return a null link. More...
 
virtual bool maybeComplexBand () const
 Overall guard flag to simplify checks for capabilities. More...
 
virtual unsigned long minHeight ()
 
void textStyle (oofRepTextStyle *adoptedStyle)
 Set style owned by this object. More...
 
void textStyle (const char *fontName, unsigned short fontSize, unsigned char styleNum=0, short leading=0, oofColor color=oofColor::Black)
 Set style owned by this object, creating from the font parameters. More...
 
virtual oofRepTextStyletextStyle () const
 Get the text style owned by this object or a default. More...
 
oofRepTextStyleuniqueTextStyle ()
 Get a style unique to this object, cloning the one we'd normally use if necessary. More...
 
virtual dbViewview (unsigned short whichView=0) const
 Request a dbView which may be the source of data for the item. More...
 
virtual unsigned long width ()
 
virtual ~oofRepBand ()
 
interfaces for subclasses
virtual OOF_mixIterableBandasIterableBand ()
 
virtual OOF_mixBandWithSubBandsasBandWithSubBands ()
 
virtual OOF_mixBandWithTableWrappersasBandWithTableWrappers ()
 
virtual OOF_mixColumnarBandasColumnarBand ()
 
multi-method dispatch to factories for rendering report objects.

one for each environment

Note
don't use pure virtuals as some subclasses may not implement
virtual void makeRender (const oofRepMacEnv &)
 
virtual void makeRender (const oofRepMacCGEnv &)
 
virtual void makeRender (const oofRepWinEnv &)
 
virtual void makeRender (const oofRepTextEnv &)
 
virtual void makeRender (const oofRepGDIPlusEnv &)
 
virtual void makeRender (const oofRepRTFEnv &)
 
virtual void makeRender (const oofRepHTMLEnv &)
 
virtual void makeRender (const oofRepCSVEnv &)
 
virtual void makeRender (const oofRepTSVEnv &)
 
virtual void makeRender (const oofRepXMLEnv &)
 
virtual void makeRender (const oofRepEditingEnv &)
 Just make a renderer for the GUI environment as if not editing because by default most drawables are not editable! More...
 

Protected Attributes

oofString mID
 
oofRepRendermRender
 
oofRepTextStylemStyle
 

Detailed Description

Abstract base for report bands.

The complicated subclasses of interest are oofRepViewBand and oofRepLayoutBand. All bands apart from oofRepViewBand are fixed height.

isViewBand
isViewBand has been replaced by maybeComplexBand which returns true or false similarly.

Definition at line 1026 of file oofrep.h.

Constructor & Destructor Documentation

virtual oofRepBand::~oofRepBand ( )
inlinevirtual

Definition at line 1028 of file oofrep.h.

Member Function Documentation

oofAdornerList & OOF_mixAdornable::adorners ( )
inlineinherited
OOF_mixBandWithSubBands * oofRepBand::asBandWithSubBands ( )
virtual
OOF_mixBandWithTableWrappers * oofRepBand::asBandWithTableWrappers ( )
virtual

Reimplemented in oofRepViewBand.

Definition at line 1561 of file oofrep1.cpp.

Referenced by oofRep::DrawComplexBand(), and oofRepVisitor::VisitComplexBand().

OOF_mixColumnarBand * oofRepBand::asColumnarBand ( )
virtual
OOF_mixIterableBand * oofRepBand::asIterableBand ( )
virtual
void oofRepDrawable::clearID ( )
inlineinherited

Definition at line 1863 of file oofrep.h.

References oofString::clear(), and oofRepDrawable::mID.

Referenced by OOF_repXMLclearIDVisitor::VisitDrawable().

virtual oofRepBand* oofRepBand::clone ( ) const
pure virtual
void oofRepDrawable::describeLayout ( )
virtualinherited

central default call like draw() but still able to be overriden in extreme cases.

Provides a second virtual function for renderers used by backends such as XML which have distinct drawing time and declarative time operations

Definition at line 1265 of file oofrep1.cpp.

References oofRepRender::describeLayout(), and oofRepDrawable::mRender.

Referenced by OOF_repXMLlayoutVisitor::VisitDrawable().

void oofRepDrawable::draw ( )
virtualinherited
void oofRepBand::drawSquished ( long &  balanceToSave)
virtual

Reimplemented in oofRepGraphBand.

Definition at line 1540 of file oofrep1.cpp.

References oofRepDrawable::draw().

Referenced by oofRep::DrawBandList().

void oofRepDrawable::finishConstruction ( )
virtualinherited

null base method occasionally overriden

Reimplemented in oofRepGraphBand.

Definition at line 1242 of file oofrep1.cpp.

Referenced by oofRepBreak::finishConstruction(), and OOF_repFinishConstructionVisitor::VisitDrawable().

unsigned long oofRepBand::fixedHeight ( )
virtual
bool OOF_mixAdornable::hasAdorners ( ) const
inlineinherited

Definition at line 361 of file oofadorn.h.

References oofAdornerList::count().

Referenced by OOF_repXMLstyleVisitor::VisitDrawable().

oofString oofRepDrawable::ID ( ) const
inlineinherited
void oofRepDrawable::ID ( const oofString inID)
inlineinherited

Definition at line 1855 of file oofrep.h.

References oofString::isEmpty(), and oofRepDrawable::mID.

bool oofRepBand::isLayoutBand ( ) const
virtual

Reimplemented in oofRepLayoutBand.

Definition at line 1533 of file oofrep1.cpp.

Referenced by oofRepVisitor::VisitTypedBand().

oofRepTextStyle * oofRepTextStylable::localTextStyle ( ) const
inlineinherited

Get style owned by this object.

Returns
may be null indicating use container's style.

Definition at line 2654 of file oofrep.h.

References oofRepTextStylable::mStyle.

Referenced by oofRepEditLink::localTextStyle(), and OOF_repXMLstyleVisitor::VisitDrawable().

oofRepEditLink * oofRepDrawable::makeEditLink ( const oofRepEditingEnv inEnv)
virtualinherited

Make an editor for this drawable - by default return a null link.

Note that this is separated from the making of render wrappers as editing may have its own complexities - a given drawable may therefore provide a subclassed edit link but use standard wrapping.

Reimplemented in oofRepViewBand.

Definition at line 1421 of file oofrep1.cpp.

void oofRepDrawable::makeRender ( const oofRepMacEnv )
virtualinherited
void oofRepDrawable::makeRender ( const oofRepMacCGEnv &  )
virtualinherited
void oofRepDrawable::makeRender ( const oofRepWinEnv )
virtualinherited
void oofRepDrawable::makeRender ( const oofRepTextEnv )
virtualinherited
void oofRepDrawable::makeRender ( const oofRepGDIPlusEnv )
virtualinherited
void oofRepDrawable::makeRender ( const oofRepRTFEnv )
virtualinherited
void oofRepDrawable::makeRender ( const oofRepHTMLEnv )
virtualinherited
void oofRepDrawable::makeRender ( const oofRepCSVEnv )
virtualinherited
void oofRepDrawable::makeRender ( const oofRepTSVEnv )
virtualinherited
void oofRepDrawable::makeRender ( const oofRepXMLEnv )
virtualinherited
void oofRepDrawable::makeRender ( const oofRepEditingEnv inEnv)
virtualinherited

Just make a renderer for the GUI environment as if not editing because by default most drawables are not editable!

Reimplemented in oofRepPictBlock, oofRepTextBlock, oofRepEmptyRootBand, oofRepViewBand, and oofRepLayoutBand.

Definition at line 51 of file oofrepedit.cpp.

References oofRepEditingEnv::editor(), oofRepEditor::makeDefaultRenderWrapper(), and oofRepEditingEnv::parentGUIenv().

bool oofRepBand::maybeComplexBand ( ) const
virtual

Overall guard flag to simplify checks for capabilities.

Returns
false in overrides that mix in OOF_mixIterableBand and similar

Reimplemented in oofRepIterableTreeBand.

Definition at line 1526 of file oofrep1.cpp.

Referenced by oofRep::DrawBandList(), oofRep::DrawBreakList(), oofRepBandList::finishConstruction(), and oofRepVisitor::VisitTypedBand().

unsigned long oofRepBand::minHeight ( )
virtual

Reimplemented in oofRepGraphBand.

Definition at line 1515 of file oofrep1.cpp.

References fixedHeight().

Referenced by oofRepBandList::finishConstruction().

void oofRepTextStylable::textStyle ( oofRepTextStyle adoptedStyle)
inherited
void oofRepTextStylable::textStyle ( const char *  fontName,
unsigned short  fontSize,
unsigned char  styleNum = 0,
short  leading = 0,
oofColor  color = oofColor::Black 
)
inherited

Set style owned by this object, creating from the font parameters.

Definition at line 1815 of file oofrep1.cpp.

References oofRepTextStylable::mStyle.

oofRepTextStyle * oofRepTextStylable::textStyle ( ) const
virtualinherited

Get the text style owned by this object or a default.

Returns
never null, may be from default in report settings.

Reimplemented in oofRepBlock.

Definition at line 1827 of file oofrep1.cpp.

References oofRep::currentReport(), oofRepSettings::defaultTextStyle(), oofRepTextStylable::mStyle, and oofRep::settings().

Referenced by oofRepGraphBand::finishConstruction(), and oofRepTextStylable::uniqueTextStyle().

oofRepTextStyle * oofRepTextStylable::uniqueTextStyle ( )
inherited

Get a style unique to this object, cloning the one we'd normally use if necessary.

Return values
Alwaysreturns a style.

Definition at line 1842 of file oofrep1.cpp.

References oofRepTextStyle::clone(), oofRepTextStylable::mStyle, and oofRepTextStylable::textStyle().

dbView * oofRepDrawable::view ( unsigned short  whichView = 0) const
virtualinherited

Request a dbView which may be the source of data for the item.

Parameters
whichViewis zero-based index of views. eg: oofRepGraphBand has more than one view for some graph types.
Returns
null by default if no band matching index

Reimplemented in oofRepViewBand, and oofRepGraphBand.

Definition at line 1253 of file oofrep1.cpp.

Referenced by oofRepSection::drawSection(), OOF_repXMLschemaVisitor::VisitComplexBand(), OOF_repXMLlayoutVisitor::VisitComplexBand(), oofRepSchemaVisitor::VisitDrawable(), OOF_repEditSetupVisitor::VisitIterableBandBody(), and OOF_repXMLlayoutVisitor::WriteColumns().

unsigned long oofRepDrawable::width ( )
virtualinherited

Member Data Documentation

oofString oofRepDrawable::mID
protectedinherited

Definition at line 902 of file oofrep.h.

Referenced by oofRepDrawable::clearID(), and oofRepDrawable::ID().

oofRepRender* oofRepDrawable::mRender
protectedinherited
oofRepTextStyle* oofRepTextStylable::mStyle
protectedinherited

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