oofRepViewBand Class Reference
[OOFILE Report writer]

#include <oofrep.h>

Inheritance diagram for oofRepViewBand:

[legend]Collaboration diagram for oofRepViewBand:

[legend]List of all members.

---

Detailed Description

The main band of a report from which you can hang other bands.

Nested bands including other oofRepViewBand (deep hieararchies of 5 or more bands have been used). This is the only band type which is variable height and so knows how to break across pages. Allows for attached headers and footers as well as calculations performed

Note:

a common idiom to put just a graph on a report is to have an empty dbView attached and put the graph in the heading of the oofRepViewBand, which will draw nothing below the graph.

Todo:

new report architecture which abstracts variable-height bands

allow simpler band types to be top band on report.

Public Member Functions
	oofRepViewBand (const dbView &, bool isBoxed=false)
	oofRepViewBand (dbView *adoptedView=0, bool isBoxed=false)
	Constructor that can act as default.
	oofRepViewBand (const oofRepViewBand &)
virtual	~oofRepViewBand ()
virtual oofRepBand *	clone () const
virtual bool	isViewBand () const
virtual dbView *	view (unsigned short whichView=0) const
	Request a dbView which may be the source of data for the item.
virtual void	draw ()
	central default call for drawing, but still able to be overriden in extreme cases.
virtual unsigned long	fixedHeight ()
void	incrementHeight (unsigned long addedHeight)
void	clearHeight ()
oofRepBandList &	headers ()
oofRepBandList &	footers ()
oofRepBreakList &	headerBreaks ()
oofRepBreakList &	footerBreaks ()
bool	isBoxed () const
oofRepCustomViewDrawer *	customDrawer (unsigned short col)
void	customDrawer (unsigned short col, oofRepCustomViewDrawer *adoptedDrawer)
bool	hasCustomViewDrawers () const
bool	fieldIsNonEditable (unsigned short col) const
void	setFieldNonEditable (unsigned short col)
bool	lastRow (unsigned long row)
bool	lastCol (unsigned long col)
void	startTableWrapper ()
void	startTableBody ()
void	endTableBody ()
void	endTableWrapper ()
void	drawColumnHeaders ()
void	dirtyColHeaders ()
void	setBoxed ()
virtual void	makeRender (const oofRepMacEnv &env)
virtual void	makeRender (const oofRepWinEnv &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!
virtual oofRepEditLink *	makeEditLink (const oofRepEditingEnv &)
	Make an editor for this drawable - by default return a null link.
virtual unsigned long	minHeight ()
virtual bool	isLayoutBand () const
virtual void	drawSquished (long &balanceToSave)
virtual void	finishConstruction ()
	null base method occasionally overriden
virtual void	describeLayout ()
	central default call like draw() but still able to be overriden in extreme cases.
virtual unsigned long	width ()
oofString	ID () const
void	ID (const oofString &)
void	clearID ()
oofRepTextStyle *	localTextStyle () const
	Get style owned by this object.
oofRepTextStyle *	uniqueTextStyle ()
	Get a style unique to this object, cloning the one we'd normally use if necessary.
void	textStyle (oofRepTextStyle *adoptedStyle)
	Set style owned by this object.
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.
virtual oofRepTextStyle *	textStyle () const
	Get the text style owned by this object or a default.
oofAdornerList &	adorners ()
bool	hasAdorners () const
Protected Attributes
oofRepRender *	mRender
oofString	mID
oofRepTextStyle *	mStyle

---

Constructor & Destructor Documentation

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

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.

oofRepViewBand::oofRepViewBand (  const oofRepViewBand &   )

oofRepViewBand::~oofRepViewBand (   )  [virtual]

---

Member Function Documentation

oofAdornerList & OOF_mixAdornable::adorners (   )  [inline, inherited]

void oofRepViewBand::clearHeight (   )

void oofRepDrawable::clearID (   )  [inline, inherited]

oofRepBand * oofRepViewBand::clone (   )  const [virtual]

Implements oofRepBand.

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

oofRepCustomViewDrawer * oofRepViewBand::customDrawer (  unsigned short  col  )

void oofRepDrawable::describeLayout (   )  [virtual, inherited]

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

void oofRepViewBand::dirtyColHeaders (   )  [inline]

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.

void oofRepViewBand::drawColumnHeaders (   )

void oofRepBand::drawSquished (  long &  balanceToSave  )  [virtual, inherited]

Reimplemented in oofRepGraphBand.

void oofRepViewBand::endTableBody (   )

void oofRepViewBand::endTableWrapper (   )

bool oofRepViewBand::fieldIsNonEditable (  unsigned short  col  )  const [inline]

void oofRepDrawable::finishConstruction (   )  [virtual, inherited]

null base method occasionally overriden Reimplemented in oofRepGraphBand.

unsigned long oofRepViewBand::fixedHeight (   )  [virtual]

Reimplemented from oofRepBand.

oofRepBreakList & oofRepViewBand::footerBreaks (   )  [inline]

oofRepBandList & oofRepViewBand::footers (   )  [inline]

bool OOF_mixAdornable::hasAdorners (   )  const [inline, inherited]

bool oofRepViewBand::hasCustomViewDrawers (   )  const [inline]

oofRepBreakList & oofRepViewBand::headerBreaks (   )  [inline]

oofRepBandList & oofRepViewBand::headers (   )  [inline]

void oofRepDrawable::ID (  const oofString &   )  [inline, inherited]

oofString oofRepDrawable::ID (   )  const [inline, inherited]

void oofRepViewBand::incrementHeight (  unsigned long  addedHeight  )

bool oofRepViewBand::isBoxed (   )  const [inline]

bool oofRepBand::isLayoutBand (   )  const [virtual, inherited]

Reimplemented in oofRepLayoutBand.

bool oofRepViewBand::isViewBand (   )  const [virtual]

Reimplemented from oofRepBand.

bool oofRepViewBand::lastCol (  unsigned long  col  )

bool oofRepViewBand::lastRow (  unsigned long  row  )

oofRepTextStyle * oofRepTextStylable::localTextStyle (   )  const [inline, inherited]

Get style owned by this object. Returns: may be null indicating use container's style.

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.

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.

void oofRepViewBand::makeRender (  const oofRepXMLEnv &  env  )  [virtual]

Reimplemented from oofRepDrawable.

void oofRepViewBand::makeRender (  const oofRepTSVEnv &  env  )  [virtual]

Reimplemented from oofRepDrawable.

void oofRepViewBand::makeRender (  const oofRepCSVEnv &  env  )  [virtual]

Reimplemented from oofRepDrawable.

void oofRepViewBand::makeRender (  const oofRepHTMLEnv &  env  )  [virtual]

Reimplemented from oofRepDrawable.

void oofRepViewBand::makeRender (  const oofRepRTFEnv &  env  )  [virtual]

Reimplemented from oofRepDrawable.

void oofRepViewBand::makeRender (  const oofRepTextEnv &  env  )  [virtual]

Reimplemented from oofRepDrawable.

void oofRepViewBand::makeRender (  const oofRepWinEnv &  env  )  [virtual]

Reimplemented from oofRepDrawable.

void oofRepViewBand::makeRender (  const oofRepMacEnv &  env  )  [virtual]

Reimplemented from oofRepDrawable.

unsigned long oofRepBand::minHeight (   )  [virtual, inherited]

Reimplemented in oofRepGraphBand.

void oofRepViewBand::setBoxed (   )  [inline]

void oofRepViewBand::setFieldNonEditable (  unsigned short  col  )

void oofRepViewBand::startTableBody (   )

void oofRepViewBand::startTableWrapper (   )

oofRepTextStyle * oofRepTextStylable::textStyle (   )  const [virtual, inherited]

Get the text style owned by this object or a default. Returns: never null, may be from default in report settings. Reimplemented in oofRepBlock.

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.

void oofRepTextStylable::textStyle (  oofRepTextStyle *  adoptedStyle  )  [inherited]

Set style owned by this object.

oofRepTextStyle * oofRepTextStylable::uniqueTextStyle (   )  [inherited]

Get a style unique to this object, cloning the one we'd normally use if necessary. Return values: Always  returns a style.

dbView * oofRepViewBand::view (  unsigned short  whichView = 0  )  const [virtual]

Request a dbView which may be the source of data for the item. Parameters: whichView  is 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 from oofRepDrawable.

unsigned long oofRepDrawable::width (   )  [virtual, inherited]

Reimplemented in oofRepPictBlock.

---

Member Data Documentation

oofString oofRepDrawable::mID [protected, inherited]

oofRepRender* oofRepDrawable::mRender [protected, inherited]

oofRepTextStyle* oofRepTextStylable::mStyle [protected, inherited]

---

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

• oofrep.h
• oofrepMac.cpp
• oofrpWin.cpp
• oofrep2.cpp
• oofrepedit.cpp
• oofrpCSV.cpp
• oofrpHTM.cpp
• oofrpnoed.cpp
• oofrpRTF.cpp
• oofrpTSV.cpp
• oofrptxt.cpp
• oofrpXML.cpp
• oofadCon.cpp

---