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

Specify a fixed height band containing an oofGraph with additional height & width. More...

#include <oofrep.h>

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

Public Member Functions

oofAdornerListadorners ()
 
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...
 
unsigned long drawingHeight () const
 
virtual void drawSquished (long &balanceToSave)
 
virtual void finishConstruction ()
 null base method occasionally overriden More...
 
virtual unsigned long fixedHeight ()
 
void fixedHeight (unsigned long height)
 
oofGraphgraph () const
 
unsigned long graphHeight () const
 
void graphHeight (unsigned long grHeight)
 
unsigned long graphWidth () const
 
void graphWidth (unsigned long grWidth)
 
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 &)
 
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 bool maybeComplexBand () const
 Overall guard flag to simplify checks for capabilities. More...
 
virtual unsigned long minHeight ()
 
unsigned long numOverlaid () const
 
 oofRepGraphBand (oofGraph *, unsigned long height, unsigned long grHgt=400, unsigned long grWid=400, const char *inGraphTitle=0)
 
 oofRepGraphBand (const oofRepGraphBand &rhs)
 
unsigned long originalGraphHeight () const
 
unsigned long originalGraphWidth () const
 
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 ~oofRepGraphBand ()
 
interfaces for subclasses
virtual OOF_mixIterableBandasIterableBand ()
 
virtual OOF_mixBandWithSubBandsasBandWithSubBands ()
 
virtual OOF_mixBandWithTableWrappersasBandWithTableWrappers ()
 
virtual OOF_mixColumnarBandasColumnarBand ()
 
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 oofRepEditingEnv &)
 Just make a renderer for the GUI environment as if not editing because by default most drawables are not editable! More...
 

Protected Attributes

oofString mID
 
oofRepRendermRender
 
oofRepTextStylemStyle
 

Detailed Description

Specify a fixed height band containing an oofGraph with additional height & width.

Definition at line 1080 of file oofrep.h.

Constructor & Destructor Documentation

oofRepGraphBand::oofRepGraphBand ( oofGraph inGraphPtr,
unsigned long  height,
unsigned long  grHgt = 400,
unsigned long  grWid = 400,
const char *  inGraphTitle = 0 
)

Definition at line 632 of file oofrep2.cpp.

References oofGraph::setPaneRect(), and oofGraph::setTitle().

Referenced by clone().

oofRepGraphBand::oofRepGraphBand ( const oofRepGraphBand rhs)

Definition at line 651 of file oofrep2.cpp.

References oofGraph::clone().

oofRepGraphBand::~oofRepGraphBand ( )
virtual

Definition at line 666 of file oofrep2.cpp.

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
void oofRepDrawable::clearID ( )
inlineinherited

Definition at line 1863 of file oofrep.h.

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

Referenced by OOF_repXMLclearIDVisitor::VisitDrawable().

oofRepBand * oofRepGraphBand::clone ( ) const
virtual

Implements oofRepBand.

Definition at line 673 of file oofrep2.cpp.

References oofRepGraphBand().

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 oofRepGraphBand::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 710 of file oofrep2.cpp.

References oofRepDrawable::draw().

unsigned long oofRepGraphBand::drawingHeight ( ) const
inline

Definition at line 2707 of file oofrep.h.

Referenced by oofRepGraphBand_MacRender::draw().

void oofRepGraphBand::drawSquished ( long &  balanceToSave)
virtual

Reimplemented from oofRepBand.

Definition at line 741 of file oofrep2.cpp.

References oofRepDrawable::draw().

void oofRepGraphBand::finishConstruction ( )
virtual
unsigned long oofRepGraphBand::fixedHeight ( )
virtual

Reimplemented from oofRepBand.

Definition at line 768 of file oofrep2.cpp.

Referenced by oofRepGraphBand_XMLRender::describeLayout(), and oofRepGraphBand_RTFRender::draw().

void oofRepGraphBand::fixedHeight ( unsigned long  height)
inline

Definition at line 1105 of file oofrep.h.

oofGraph * oofRepGraphBand::graph ( ) const
inline
unsigned long oofRepGraphBand::graphHeight ( ) const
inline

Definition at line 2686 of file oofrep.h.

Referenced by oofRepGraphBand_MacRender::draw(), and oofRepGraphBand_RTFRender::draw().

void oofRepGraphBand::graphHeight ( unsigned long  grHeight)

Definition at line 727 of file oofrep2.cpp.

unsigned long oofRepGraphBand::graphWidth ( ) const
inline

Definition at line 2679 of file oofrep.h.

Referenced by oofRepGraphBand_MacRender::draw(), and oofRepGraphBand_RTFRender::draw().

void oofRepGraphBand::graphWidth ( unsigned long  grWidth)

Definition at line 734 of file oofrep2.cpp.

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 oofRepBand::isLayoutBand ( ) const
virtualinherited

Reimplemented in oofRepLayoutBand.

Definition at line 1533 of file oofrep1.cpp.

Referenced by oofRepVisitor::VisitTypedBand().

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 oofRepDrawable::makeRender ( const oofRepEditingEnv inEnv)
virtualinherited

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

Reimplemented in oofRepPictBlock, oofRepTextBlock, oofRepEmptyRootBand, oofRepViewBand, and oofRepLayoutBand.

Definition at line 51 of file oofrepedit.cpp.

References oofRepEditingEnv::editor(), oofRepEditor::makeDefaultRenderWrapper(), and oofRepEditingEnv::parentGUIenv().

void oofRepGraphBand::makeRender ( const oofRepMacEnv env)
virtual

Reimplemented from oofRepDrawable.

Definition at line 137 of file oofrepMac.cpp.

References oofRepDrawable::mRender.

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

Reimplemented from oofRepDrawable.

Definition at line 112 of file oofrpdum.cpp.

void oofRepGraphBand::makeRender ( const oofRepWinEnv env)
virtual

Reimplemented from oofRepDrawable.

Definition at line 137 of file oofrpWin.cpp.

void oofRepGraphBand::makeRender ( const oofRepGDIPlusEnv env)
virtual

Reimplemented from oofRepDrawable.

Definition at line 251 of file oofrpdum.cpp.

void oofRepGraphBand::makeRender ( const oofRepTextEnv env)
virtual

Reimplemented from oofRepDrawable.

Definition at line 118 of file oofrptxt.cpp.

References oofRepDrawable::mRender.

void oofRepGraphBand::makeRender ( const oofRepRTFEnv env)
virtual

Reimplemented from oofRepDrawable.

Definition at line 577 of file oofrpRTF.cpp.

References oofRepDrawable::mRender.

void oofRepGraphBand::makeRender ( const oofRepHTMLEnv env)
virtual

Reimplemented from oofRepDrawable.

Definition at line 180 of file oofrpHTM.cpp.

References oofRepDrawable::mRender.

void oofRepGraphBand::makeRender ( const oofRepCSVEnv env)
virtual

Reimplemented from oofRepDrawable.

Definition at line 182 of file oofrpCSV.cpp.

References oofRepDrawable::mRender.

void oofRepGraphBand::makeRender ( const oofRepTSVEnv env)
virtual

Reimplemented from oofRepDrawable.

Definition at line 182 of file oofrpTSV.cpp.

References oofRepDrawable::mRender.

void oofRepGraphBand::makeRender ( const oofRepXMLEnv env)
virtual

Reimplemented from oofRepDrawable.

Definition at line 1370 of file oofrpXML.cpp.

References oofRepDrawable::mRender.

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 oofRepGraphBand::minHeight ( )
virtual

Reimplemented from oofRepBand.

Definition at line 775 of file oofrep2.cpp.

unsigned long oofRepGraphBand::numOverlaid ( ) const
unsigned long oofRepGraphBand::originalGraphHeight ( ) const
inline

Definition at line 2700 of file oofrep.h.

Referenced by oofRepGraphBand_XMLRender::describeLayout().

unsigned long oofRepGraphBand::originalGraphWidth ( ) const
inline

Definition at line 2693 of file oofrep.h.

Referenced by oofRepGraphBand_XMLRender::describeLayout().

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 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 * oofRepGraphBand::view ( unsigned short  whichView = 0) const
virtual

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

Definition at line 680 of file oofrep2.cpp.

References OOF_mixOverlayableGraph::getOverlayView(), and oofGraph::getView().

Referenced by oofRepGraphBand_XMLRender::describeLayout(), and oofRepGraphBand_XMLRender::draw().

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: