oofRepBand Class Reference

#include <oofrep.h>

Inheritance diagram for oofRepBand:

[legend]Collaboration diagram for oofRepBand:

[legend]List of all members.

---

Detailed Description

Abstract base for report bands.

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

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 oofRepWinEnv &)
virtual void	makeRender (const oofRepTextEnv &)
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!
Public Member Functions
virtual	~oofRepBand ()
virtual oofRepBand *	clone () const=0
virtual unsigned long	fixedHeight ()
virtual unsigned long	minHeight ()
virtual bool	isViewBand () const
virtual bool	isLayoutBand () const
virtual void	drawSquished (long &balanceToSave)
virtual void	finishConstruction ()
	null base method occasionally overriden
virtual void	draw ()
	central default call for drawing, but still able to be overriden in extreme cases.
virtual void	describeLayout ()
	central default call like draw() but still able to be overriden in extreme cases.
virtual dbView *	view (unsigned short whichView=0) const
	Request a dbView which may be the source of data for the item.
virtual unsigned long	width ()
virtual oofRepEditLink *	makeEditLink (const oofRepEditingEnv &)
	Make an editor for this drawable - by default return a null link.
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

virtual oofRepBand::~oofRepBand (   )  [inline, virtual]

---

Member Function Documentation

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

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

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

Implemented in oofRepSpaceBand, oofRepGraphBand, oofRepLineBand, oofRepLayoutBand, oofRepViewBand, oofRepPictBand, and oofRepFreeImageBand.

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 oofRepDrawable::draw (   )  [virtual, inherited]

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 in oofRepGraphBand, oofRepLayoutBand, and oofRepViewBand.

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

Reimplemented in oofRepGraphBand.

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

null base method occasionally overriden Reimplemented in oofRepGraphBand.

unsigned long oofRepBand::fixedHeight (   )  [virtual]

Reimplemented from oofRepDrawable. Reimplemented in oofRepSpaceBand, oofRepGraphBand, oofRepLineBand, oofRepLayoutBand, oofRepViewBand, oofRepPictBand, and oofRepFreeImageBand.

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

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

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

bool oofRepBand::isLayoutBand (   )  const [virtual]

Reimplemented in oofRepLayoutBand.

bool oofRepBand::isViewBand (   )  const [virtual]

Reimplemented in oofRepViewBand.

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

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

oofRepEditLink * oofRepDrawable::makeEditLink (  const oofRepEditingEnv &  inEnv  )  [virtual, inherited]

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.

void oofRepDrawable::makeRender (  const oofRepEditingEnv &  inEnv  )  [virtual, inherited]

Just make a renderer for the GUI environment as if not editing because by default most drawables are not editable! Reimplemented in oofRepLayoutBand, oofRepViewBand, oofRepTextBlock, and oofRepPictBlock.

void oofRepDrawable::makeRender (  const oofRepXMLEnv &   )  [virtual, inherited]

Reimplemented in oofRepSpaceBand, oofRepGraphBand, oofRepLineBand, oofRepLayoutBand, oofRepViewBand, oofRepTextBlock, oofRepPictBlock, oofRepPageNoBlock, and oofRepPictBand.

void oofRepDrawable::makeRender (  const oofRepTSVEnv &   )  [virtual, inherited]

Reimplemented in oofRepSpaceBand, oofRepGraphBand, oofRepLineBand, oofRepLayoutBand, oofRepViewBand, oofRepTextBlock, oofRepPictBlock, and oofRepPictBand.

void oofRepDrawable::makeRender (  const oofRepCSVEnv &   )  [virtual, inherited]

Reimplemented in oofRepSpaceBand, oofRepGraphBand, oofRepLineBand, oofRepLayoutBand, oofRepViewBand, oofRepTextBlock, oofRepPictBlock, and oofRepPictBand.

void oofRepDrawable::makeRender (  const oofRepHTMLEnv &   )  [virtual, inherited]

Reimplemented in oofRepSpaceBand, oofRepGraphBand, oofRepLineBand, oofRepLayoutBand, oofRepViewBand, oofRepTextBlock, oofRepPictBlock, and oofRepPictBand.

void oofRepDrawable::makeRender (  const oofRepRTFEnv &   )  [virtual, inherited]

Reimplemented in oofRepSpaceBand, oofRepGraphBand, oofRepLineBand, oofRepLayoutBand, oofRepViewBand, oofRepTextBlock, oofRepPictBlock, oofRepPageNoBlock, oofRepPictBand, and oofRepFreeImageBand.

void oofRepDrawable::makeRender (  const oofRepTextEnv &   )  [virtual, inherited]

Reimplemented in oofRepSpaceBand, oofRepGraphBand, oofRepLineBand, oofRepLayoutBand, oofRepViewBand, oofRepTextBlock, oofRepPictBlock, and oofRepPictBand.

void oofRepDrawable::makeRender (  const oofRepWinEnv &   )  [virtual, inherited]

Reimplemented in oofRepSpaceBand, oofRepGraphBand, oofRepLineBand, oofRepLayoutBand, oofRepViewBand, oofRepTextBlock, oofRepPictBlock, oofRepPictBand, and oofRepFreeImageBand.

void oofRepDrawable::makeRender (  const oofRepMacEnv &   )  [virtual, inherited]

Reimplemented in oofRepSpaceBand, oofRepGraphBand, oofRepLineBand, oofRepLayoutBand, oofRepViewBand, oofRepTextBlock, oofRepPictBlock, and oofRepPictBand.

unsigned long oofRepBand::minHeight (   )  [virtual]

Reimplemented in oofRepGraphBand.

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 * oofRepDrawable::view (  unsigned short  whichView = 0  )  const [virtual, inherited]

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 in oofRepGraphBand, and oofRepViewBand.

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
• oofrep1.cpp

---