oofRepLayoutBand Class Reference
[OOFILE Report writer]

#include <oofrep.h>

Inheritance diagram for oofRepLayoutBand:

[legend]Collaboration diagram for oofRepLayoutBand:

[legend]List of all members.

---

Detailed Description

Specify a fixed-height band that contains a series of oofRepBlock's.

Blocks are either centred, right-aligned (one only) or presume to be dropped in one after the other left-aligned. This default mode makes it easy to effectively append data without cluttering up your code with width calculations - the appropriate oofRepLayoutBand_Render will either physically append data (streamed output) or advance the drawing position. Each block has a property indicating if the vertical position should change after it is drawn, set and read by oofRepBlock::moveDownAfter().

Public Member Functions
	oofRepLayoutBand ()
virtual	~oofRepLayoutBand ()
virtual oofRepBand *	clone () const
virtual bool	isLayoutBand () const
virtual void	draw ()
	central default call for drawing, but still able to be overriden in extreme cases.
virtual unsigned long	fixedHeight ()
oofRepBlockList &	blocks ()
oofRepLayoutBand &	operator<< (dbField &)
oofRepLayoutBand &	operator<< (dbField *)
oofRepLayoutBand &	operator<< (const char *)
oofRepLayoutBand &	operator<< (oofRepBlock *adoptedBlock)
oofRepLayoutBand &	operator<< (const oofRepBlock &copiedBlock)
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 &env)
	Just make a renderer for the GUI environment as if not editing because by default most drawables are not editable!
virtual unsigned long	minHeight ()
virtual bool	isViewBand () 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 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
Static Public Member Functions
oofRepLayoutBand *	currentLayout ()
Protected Attributes
oofRepRender *	mRender
oofString	mID
oofRepTextStyle *	mStyle

---

Constructor & Destructor Documentation

oofRepLayoutBand::oofRepLayoutBand (   )

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

---

Member Function Documentation

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

oofRepBlockList & oofRepLayoutBand::blocks (   )  [inline]

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

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

Implements oofRepBand.

oofRepLayoutBand * oofRepLayoutBand::currentLayout (   )  [inline, static]

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 oofRepLayoutBand::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 oofRepBand::drawSquished (  long &  balanceToSave  )  [virtual, inherited]

Reimplemented in oofRepGraphBand.

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

null base method occasionally overriden Reimplemented in oofRepGraphBand.

unsigned long oofRepLayoutBand::fixedHeight (   )  [virtual]

Reimplemented from oofRepBand.

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

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

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

bool oofRepLayoutBand::isLayoutBand (   )  const [virtual]

Reimplemented from oofRepBand.

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

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 oofRepLayoutBand::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 oofRepLayoutBand::makeRender (  const oofRepXMLEnv &  env  )  [virtual]

Reimplemented from oofRepDrawable.

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

Reimplemented from oofRepDrawable.

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

Reimplemented from oofRepDrawable.

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

Reimplemented from oofRepDrawable.

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

Reimplemented from oofRepDrawable.

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

Reimplemented from oofRepDrawable.

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

Reimplemented from oofRepDrawable.

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

Reimplemented from oofRepDrawable.

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

Reimplemented in oofRepGraphBand.

oofRepLayoutBand & oofRepLayoutBand::operator<< (  const oofRepBlock &  copiedBlock  )

oofRepLayoutBand & oofRepLayoutBand::operator<< (  oofRepBlock *  adoptedBlock  )

oofRepLayoutBand & oofRepLayoutBand::operator<< (  const char *   )

oofRepLayoutBand & oofRepLayoutBand::operator<< (  dbField *   )

oofRepLayoutBand & oofRepLayoutBand::operator<< (  dbField &   )

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
• oofrepMac.cpp
• oofrpWin.cpp
• oofrep1.cpp
• oofrep2.cpp
• oofrepedit.cpp
• oofrpCSV.cpp
• oofrpHTM.cpp
• oofrpnoed.cpp
• oofrpRTF.cpp
• oofrpTSV.cpp
• oofrptxt.cpp
• oofrpXML.cpp
• oofadCon.cpp

---