OOFILE  1.9
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
oofRepLayoutBand Class Reference

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

#include <oofrep.h>

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

Public Member Functions

oofAdornerListadorners ()
 
oofRepBlockListblocks ()
 
void clearID ()
 
virtual oofRepBandclone () const
 
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 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 &env)
 Just make a renderer for the GUI environment as if not editing because by default most drawables are not editable! More...
 
virtual bool maybeComplexBand () const
 Overall guard flag to simplify checks for capabilities. More...
 
virtual unsigned long minHeight ()
 
 oofRepLayoutBand ()
 
oofRepLayoutBandoperator<< (dbField &)
 
oofRepLayoutBandoperator<< (dbField *)
 
oofRepLayoutBandoperator<< (const char *)
 
oofRepLayoutBandoperator<< (oofRepBlock *adoptedBlock)
 
oofRepLayoutBandoperator<< (const oofRepBlock &copiedBlock)
 
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 ~oofRepLayoutBand ()
 
interfaces for subclasses
virtual OOF_mixIterableBandasIterableBand ()
 
virtual OOF_mixBandWithSubBandsasBandWithSubBands ()
 
virtual OOF_mixBandWithTableWrappersasBandWithTableWrappers ()
 
virtual OOF_mixColumnarBandasColumnarBand ()
 

Static Public Member Functions

static oofRepLayoutBandcurrentLayout ()
 

Protected Attributes

oofString mID
 
oofRepRendermRender
 
oofRepTextStylemStyle
 

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().

Definition at line 1182 of file oofrep.h.

Constructor & Destructor Documentation

oofRepLayoutBand::oofRepLayoutBand ( )

Definition at line 517 of file oofrep2.cpp.

Referenced by clone().

virtual oofRepLayoutBand::~oofRepLayoutBand ( )
inlinevirtual

Definition at line 1186 of file oofrep.h.

Member Function Documentation

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

Reimplemented in oofRepViewBand.

Definition at line 1561 of file oofrep1.cpp.

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

OOF_mixColumnarBand * oofRepBand::asColumnarBand ( )
virtualinherited
OOF_mixIterableBand * oofRepBand::asIterableBand ( )
virtualinherited
oofRepBlockList & oofRepLayoutBand::blocks ( )
inline
void oofRepDrawable::clearID ( )
inlineinherited

Definition at line 1863 of file oofrep.h.

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

Referenced by OOF_repXMLclearIDVisitor::VisitDrawable().

oofRepBand * oofRepLayoutBand::clone ( ) const
virtual

Implements oofRepBand.

Definition at line 525 of file oofrep2.cpp.

References oofRepLayoutBand().

oofRepLayoutBand * oofRepLayoutBand::currentLayout ( )
inlinestatic

Definition at line 2195 of file oofrep.h.

Referenced by oofRepBlock::textStyle().

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

Definition at line 546 of file oofrep2.cpp.

References oofRepDrawable::draw().

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 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 oofRepLayoutBand::fixedHeight ( )
virtual

Reimplemented from oofRepBand.

Definition at line 554 of file oofrep2.cpp.

References oofRepBlockList::fixedHeight().

Referenced by oofRepLayoutBand_MacRender::draw().

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 oofRepLayoutBand::isLayoutBand ( ) const
virtual

Reimplemented from oofRepBand.

Definition at line 532 of file oofrep2.cpp.

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 oofRepLayoutBand::makeRender ( const oofRepMacEnv env)
virtual

Reimplemented from oofRepDrawable.

Definition at line 161 of file oofrepMac.cpp.

References oofRepDrawable::mRender.

Referenced by makeRender().

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

Reimplemented from oofRepDrawable.

Definition at line 133 of file oofrpdum.cpp.

void oofRepLayoutBand::makeRender ( const oofRepWinEnv env)
virtual

Reimplemented from oofRepDrawable.

Definition at line 177 of file oofrpWin.cpp.

void oofRepLayoutBand::makeRender ( const oofRepGDIPlusEnv env)
virtual

Reimplemented from oofRepDrawable.

Definition at line 272 of file oofrpdum.cpp.

void oofRepLayoutBand::makeRender ( const oofRepTextEnv env)
virtual

Reimplemented from oofRepDrawable.

Definition at line 142 of file oofrptxt.cpp.

References oofRepDrawable::mRender.

void oofRepLayoutBand::makeRender ( const oofRepRTFEnv env)
virtual

Reimplemented from oofRepDrawable.

Definition at line 601 of file oofrpRTF.cpp.

References oofRepDrawable::mRender.

void oofRepLayoutBand::makeRender ( const oofRepHTMLEnv env)
virtual

Reimplemented from oofRepDrawable.

Definition at line 204 of file oofrpHTM.cpp.

References oofRepDrawable::mRender.

void oofRepLayoutBand::makeRender ( const oofRepCSVEnv env)
virtual

Reimplemented from oofRepDrawable.

Definition at line 206 of file oofrpCSV.cpp.

References oofRepDrawable::mRender.

void oofRepLayoutBand::makeRender ( const oofRepTSVEnv env)
virtual

Reimplemented from oofRepDrawable.

Definition at line 207 of file oofrpTSV.cpp.

References oofRepDrawable::mRender.

void oofRepLayoutBand::makeRender ( const oofRepXMLEnv env)
virtual

Reimplemented from oofRepDrawable.

Definition at line 1394 of file oofrpXML.cpp.

References oofRepDrawable::mRender.

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.

Definition at line 1918 of file oofrepedit.cpp.

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

bool oofRepBand::maybeComplexBand ( ) const
virtualinherited

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 ( )
virtualinherited

Reimplemented in oofRepGraphBand.

Definition at line 1515 of file oofrep1.cpp.

References oofRepBand::fixedHeight().

Referenced by oofRepBandList::finishConstruction().

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

Definition at line 568 of file oofrep2.cpp.

References oofRepBlockList::append().

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

Definition at line 577 of file oofrep2.cpp.

References oofRepBlockList::append().

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

Definition at line 586 of file oofrep2.cpp.

References oofRepBlockList::append().

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

Definition at line 595 of file oofrep2.cpp.

References oofRepBlockList::append().

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

Definition at line 603 of file oofrep2.cpp.

References oofRepBlockList::append(), and oofRepBlock::clone().

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: