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

Most commonly used top band in a report. More...

#include <oofrep.h>

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

Public Member Functions

oofAdornerListadorners ()
 
virtual OOF_mixBandWithSubBandsasBandWithSubBands ()
 
virtual OOF_mixBandWithTableWrappersasBandWithTableWrappers ()
 
virtual OOF_mixColumnarBandasColumnarBand ()
 
virtual OOF_mixIterableBandasIterableBand ()
 
void clearID ()
 
virtual oofRepBandclone () const
 
virtual void describeLayout ()
 central default call like draw() but still able to be overriden in extreme cases. More...
 
void dirtyColHeaders ()
 
virtual void draw ()
 central default call for drawing, but still able to be overriden in extreme cases. More...
 
void drawColumnHeaders ()
 
virtual void drawSquished (long &balanceToSave)
 
virtual void finishConstruction ()
 null base method occasionally overriden More...
 
virtual unsigned long fixedHeight ()
 
oofRepBreakListfooterBreaks ()
 
oofRepBandListfooters ()
 
bool hasAdorners () const
 
oofRepBreakListheaderBreaks ()
 
oofRepBandListheaders ()
 
oofString ID () const
 
void ID (const oofString &)
 
bool isBoxed () const
 
virtual bool isLayoutBand () const
 
oofRepTextStylelocalTextStyle () const
 Get style owned by this object. More...
 
virtual bool maybeComplexBand () const
 Overall guard flag to simplify checks for capabilities. More...
 
virtual unsigned long minHeight ()
 
 oofRepViewBand (const dbView &, bool isBoxed=false)
 
 oofRepViewBand (dbView *adoptedView=0, bool isBoxed=false)
 Constructor that can act as default. More...
 
 oofRepViewBand (const oofRepViewBand &)
 
void setBoxed ()
 
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 ~oofRepViewBand ()
 
implement iterators for OOF_mixIterableBand
virtual void start ()
 
virtual bool more ()
 
virtual void next ()
 
implement interface OOF_mixBandWithTableWrappers
virtual void startTableWrapper ()
 
virtual void startTableBody ()
 
virtual void endTableBody ()
 
virtual void endTableWrapper ()
 
implement interface OOF_mixColumnarBand
virtual oofRepDrawabledrawableContainingColumns ()
 
methods for the adorners to use to detect the edges of the tables
virtual bool lastRow (unsigned long row)
 
virtual bool lastCol (unsigned long col)
 
virtual int numCols () const
 
multi-method dispatch to factories for rendering report objects
virtual void makeRender (const oofRepMacEnv &env)
 
virtual void makeRender (const oofRepMacCGEnv &env)
 
virtual void makeRender (const oofRepWinEnv &env)
 
virtual void makeRender (const oofRepGDIPlusEnv &env)
 
virtual void makeRender (const oofRepTextEnv &env)
 
virtual void makeRender (const oofRepRTFEnv &env)
 
virtual void makeRender (const oofRepHTMLEnv &env)
 
virtual void makeRender (const oofRepCSVEnv &env)
 
virtual void makeRender (const oofRepTSVEnv &env)
 
virtual void makeRender (const oofRepXMLEnv &env)
 
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...
 
virtual oofRepEditLinkmakeEditLink (const oofRepEditingEnv &)
 Make an editor for this drawable - by default return a null link. More...
 
customDrawer control
oofRepCustomViewDrawercustomDrawer (unsigned short col)
 
void customDrawer (unsigned short col, oofRepCustomViewDrawer *adoptedDrawer)
 
bool hasCustomViewDrawers () const
 
fieldEditing control
bool fieldIsNonEditable (unsigned short col) const
 
void setFieldNonEditable (unsigned short col)
 

Protected Attributes

int mCurrentIteration
 ranges from 0 up to mMaxIterations-1 whilst iterating report More...
 
OOF_Dictionary mCustomDrawers
 
oofRepBreakList mFooterBreaks
 
oofRepBandList mFooters
 
oofRepBreakList mHeaderBreaks
 
oofRepBandList mHeaders
 
oofString mID
 
int mMaxIterations
 for simple subclasses that aren't driven by a database selection More...
 
bool * mNonEditableFields
 owned More...
 
oofRepRendermRender
 
oofRepTextStylemStyle
 

Detailed Description

Most commonly used top band in a report.

Definition at line 1283 of file oofrep.h.

Constructor & Destructor Documentation

oofRepViewBand::oofRepViewBand ( const dbView view,
bool  isBoxed = false 
)

Definition at line 207 of file oofrep2.cpp.

Referenced by clone().

oofRepViewBand::oofRepViewBand ( dbView adoptedView = 0,
bool  isBoxed = false 
)

Constructor that can act as default.

If use purely as default, you MUST assign fields to the dbView later. Consider oofRep::useEmptyBody if you just want a report with a few fixed bands, rather than actually adding to this view band.

Definition at line 223 of file oofrep2.cpp.

oofRepViewBand::oofRepViewBand ( const oofRepViewBand rhs)

Definition at line 248 of file oofrep2.cpp.

References OOF_mixViewExtraRender::finishClone(), and oofRepDrawable::mRender.

oofRepViewBand::~oofRepViewBand ( )
virtual

Definition at line 258 of file oofrep2.cpp.

Member Function Documentation

oofAdornerList & OOF_mixAdornable::adorners ( )
inlineinherited
OOF_mixBandWithSubBands * oofRepIterableTreeBand::asBandWithSubBands ( )
virtualinherited

Reimplemented from oofRepBand.

Definition at line 112 of file oofrep2.cpp.

OOF_mixBandWithTableWrappers * oofRepViewBand::asBandWithTableWrappers ( )
virtual

Reimplemented from oofRepBand.

Definition at line 312 of file oofrep2.cpp.

OOF_mixColumnarBand * oofRepViewBand::asColumnarBand ( )
virtual

Reimplemented from oofRepBand.

Definition at line 319 of file oofrep2.cpp.

OOF_mixIterableBand * oofRepIterableTreeBand::asIterableBand ( )
virtualinherited

Reimplemented from oofRepBand.

Definition at line 105 of file oofrep2.cpp.

void oofRepDrawable::clearID ( )
inlineinherited

Definition at line 1863 of file oofrep.h.

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

Referenced by OOF_repXMLclearIDVisitor::VisitDrawable().

oofRepBand * oofRepViewBand::clone ( ) const
virtual

Implements oofRepBand.

Definition at line 265 of file oofrep2.cpp.

References oofRepViewBand().

oofRepCustomViewDrawer * OOF_mixColumnarBand::customDrawer ( unsigned short  col)
inherited
void OOF_mixColumnarBand::customDrawer ( unsigned short  col,
oofRepCustomViewDrawer adoptedDrawer 
)
inherited

Definition at line 184 of file oofrep2.cpp.

References OOF_mixColumnarBand::mCustomDrawers.

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 oofRepViewBand::dirtyColHeaders ( )
inline

Definition at line 2107 of file oofrep.h.

Referenced by oofRepColHeaderEditLink::setCellText().

void oofRepViewBand::draw ( )
virtual

central default call for drawing, but still able to be overriden in extreme cases.

Now that all is factored out to the render objects (Strategy pattern) we shouldn't need to do anything.regarding actual output

Reimplemented from oofRepDrawable.

Definition at line 333 of file oofrep2.cpp.

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

oofRepDrawable * oofRepViewBand::drawableContainingColumns ( )
virtual

Implements OOF_mixColumnarBand.

Definition at line 416 of file oofrep2.cpp.

void oofRepViewBand::drawColumnHeaders ( )
void oofRepBand::drawSquished ( long &  balanceToSave)
virtualinherited

Reimplemented in oofRepGraphBand.

Definition at line 1540 of file oofrep1.cpp.

References oofRepDrawable::draw().

Referenced by oofRep::DrawBandList().

void oofRepViewBand::endTableBody ( )
virtual

Reimplemented from OOF_mixBandWithTableWrappers.

Definition at line 360 of file oofrep2.cpp.

References OOF_mixViewExtraRender::endTableBody().

void oofRepViewBand::endTableWrapper ( )
virtual

Reimplemented from OOF_mixBandWithTableWrappers.

Definition at line 376 of file oofrep2.cpp.

References OOF_mixViewExtraRender::endTableWrapper().

bool OOF_mixColumnarBand::fieldIsNonEditable ( unsigned short  col) const
inlineinherited

Definition at line 2158 of file oofrep.h.

References OOF_mixColumnarBand::mNonEditableFields.

Referenced by oofRepViewEditLink::getCellText().

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 ( )
virtualinherited
oofRepBreakList & OOF_mixIterableBand::footerBreaks ( )
inlineinherited
oofRepBandList & OOF_mixBandWithSubBands::footers ( )
inlineinherited
bool OOF_mixAdornable::hasAdorners ( ) const
inlineinherited

Definition at line 361 of file oofadorn.h.

References oofAdornerList::count().

Referenced by OOF_repXMLstyleVisitor::VisitDrawable().

bool OOF_mixColumnarBand::hasCustomViewDrawers ( ) const
inlineinherited
oofRepBreakList & OOF_mixIterableBand::headerBreaks ( )
inlineinherited
oofRepBandList & OOF_mixBandWithSubBands::headers ( )
inlineinherited
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 oofRepViewBand::isBoxed ( ) const
inline
bool oofRepBand::isLayoutBand ( ) const
virtualinherited

Reimplemented in oofRepLayoutBand.

Definition at line 1533 of file oofrep1.cpp.

Referenced by oofRepVisitor::VisitTypedBand().

bool oofRepViewBand::lastCol ( unsigned long  col)
virtual

Implements OOF_mixColumnarBand.

Definition at line 406 of file oofrep2.cpp.

References view().

bool oofRepViewBand::lastRow ( unsigned long  row)
virtual

Implements OOF_mixColumnarBand.

Definition at line 394 of file oofrep2.cpp.

References dbTable::count(), dbView::table(), and view().

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 * oofRepViewBand::makeEditLink ( const oofRepEditingEnv inEnv)
virtual

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 from oofRepDrawable.

Definition at line 326 of file oofrep2.cpp.

void oofRepViewBand::makeRender ( const oofRepMacEnv env)
virtual

Reimplemented from oofRepDrawable.

Definition at line 110 of file oofrepMac.cpp.

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

Referenced by makeRender().

void oofRepViewBand::makeRender ( const oofRepMacCGEnv &  env)
virtual

Reimplemented from oofRepDrawable.

Definition at line 91 of file oofrpdum.cpp.

void oofRepViewBand::makeRender ( const oofRepWinEnv env)
virtual

Reimplemented from oofRepDrawable.

Definition at line 185 of file oofrpWin.cpp.

References oofRepViewBand_Render::finishConstruction().

void oofRepViewBand::makeRender ( const oofRepGDIPlusEnv env)
virtual

Reimplemented from oofRepDrawable.

Definition at line 230 of file oofrpdum.cpp.

void oofRepViewBand::makeRender ( const oofRepTextEnv env)
virtual

Reimplemented from oofRepDrawable.

Definition at line 92 of file oofrptxt.cpp.

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

void oofRepViewBand::makeRender ( const oofRepRTFEnv env)
virtual

Reimplemented from oofRepDrawable.

Definition at line 552 of file oofrpRTF.cpp.

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

void oofRepViewBand::makeRender ( const oofRepHTMLEnv env)
virtual

Reimplemented from oofRepDrawable.

Definition at line 154 of file oofrpHTM.cpp.

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

void oofRepViewBand::makeRender ( const oofRepCSVEnv env)
virtual

Reimplemented from oofRepDrawable.

Definition at line 163 of file oofrpCSV.cpp.

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

void oofRepViewBand::makeRender ( const oofRepTSVEnv env)
virtual

Reimplemented from oofRepDrawable.

Definition at line 156 of file oofrpTSV.cpp.

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

void oofRepViewBand::makeRender ( const oofRepXMLEnv env)
virtual

Reimplemented from oofRepDrawable.

Definition at line 1344 of file oofrpXML.cpp.

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

void oofRepViewBand::makeRender ( const oofRepEditingEnv inEnv)
virtual

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

Reimplemented from oofRepDrawable.

Definition at line 1899 of file oofrepedit.cpp.

References oofRepEditingEnv::editor(), makeRender(), oofRepEditor::makeViewRenderWrapper(), oofRepDrawable::mRender, and oofRepEditingEnv::parentGUIenv().

bool oofRepIterableTreeBand::maybeComplexBand ( ) const
virtualinherited

Overall guard flag to simplify checks for capabilities.

Returns
false in overrides that mix in OOF_mixIterableBand and similar

Reimplemented from oofRepBand.

Definition at line 119 of file oofrep2.cpp.

unsigned long oofRepBand::minHeight ( )
virtualinherited

Reimplemented in oofRepGraphBand.

Definition at line 1515 of file oofrep1.cpp.

References oofRepBand::fixedHeight().

Referenced by oofRepBandList::finishConstruction().

bool oofRepViewBand::more ( )
virtual

Reimplemented from oofRepIterableTreeBand.

Definition at line 292 of file oofrep2.cpp.

References dbTable::more(), oofRepIterableTreeBand::more(), and dbView::table().

void oofRepViewBand::next ( )
virtual

Reimplemented from oofRepIterableTreeBand.

Definition at line 302 of file oofrep2.cpp.

References dbTable::next(), oofRepIterableTreeBand::next(), and dbView::table().

int oofRepViewBand::numCols ( ) const
virtual

Implements OOF_mixColumnarBand.

Definition at line 384 of file oofrep2.cpp.

References OOF_Dictionary::count().

void oofRepViewBand::setBoxed ( )
inline

Definition at line 2088 of file oofrep.h.

References OOF_mixAdornable::adorners(), and oofBorderAdorner::oneThin.

void OOF_mixColumnarBand::setFieldNonEditable ( unsigned short  col)
inherited
void oofRepViewBand::start ( )
virtual

Reimplemented from oofRepIterableTreeBand.

Definition at line 282 of file oofrep2.cpp.

References dbTable::start(), oofRepIterableTreeBand::start(), and dbView::table().

void oofRepViewBand::startTableBody ( )
virtual

Reimplemented from OOF_mixBandWithTableWrappers.

Definition at line 351 of file oofrep2.cpp.

References OOF_mixViewExtraRender::startTableBody().

void oofRepViewBand::startTableWrapper ( )
virtual

Reimplemented from OOF_mixBandWithTableWrappers.

Definition at line 368 of file oofrep2.cpp.

References OOF_mixViewExtraRender::startTableWrapper().

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 * oofRepViewBand::view ( unsigned short  whichView = 0) const
virtual
unsigned long oofRepDrawable::width ( )
virtualinherited

Member Data Documentation

int oofRepIterableTreeBand::mCurrentIteration
protectedinherited

ranges from 0 up to mMaxIterations-1 whilst iterating report

Definition at line 1275 of file oofrep.h.

Referenced by oofRepIterableTreeBand::more(), oofRepIterableTreeBand::next(), and oofRepIterableTreeBand::start().

OOF_Dictionary OOF_mixColumnarBand::mCustomDrawers
protectedinherited
oofRepBreakList OOF_mixIterableBand::mFooterBreaks
protectedinherited

Definition at line 932 of file oofrep.h.

Referenced by OOF_mixIterableBand::footerBreaks().

oofRepBandList OOF_mixBandWithSubBands::mFooters
protectedinherited

Definition at line 951 of file oofrep.h.

Referenced by OOF_mixBandWithSubBands::footers().

oofRepBreakList OOF_mixIterableBand::mHeaderBreaks
protectedinherited

Definition at line 931 of file oofrep.h.

Referenced by OOF_mixIterableBand::headerBreaks().

oofRepBandList OOF_mixBandWithSubBands::mHeaders
protectedinherited

Definition at line 950 of file oofrep.h.

Referenced by OOF_mixBandWithSubBands::headers().

oofString oofRepDrawable::mID
protectedinherited

Definition at line 902 of file oofrep.h.

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

int oofRepIterableTreeBand::mMaxIterations
protectedinherited

for simple subclasses that aren't driven by a database selection

Definition at line 1274 of file oofrep.h.

Referenced by oofRepIterableTreeBand::more().

bool* OOF_mixColumnarBand::mNonEditableFields
protectedinherited
oofRepRender* oofRepDrawable::mRender
protectedinherited
oofRepTextStyle* oofRepTextStylable::mStyle
protectedinherited

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