SLCTileManager.h

//========================================================================================
// 
// $File$
// 
// Owner: Adobe Developer Technologies
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
//========================================================================================

#ifndef __SLCTileManager_h__
#define __SLCTileManager_h__

#include "IParagraphComposer.h"

class PMReal;
class SLCLineMetrics;
//class K2Vector;

class SLCTileManager
{
public:
 SLCTileManager(void) : fTiler(nil), fTOPHeightMetric(Text::kFLOLeading), fAtTOP(kFalse), fParcelPositionDependent(kFalse)
 {
 }

 virtual ~SLCTileManager(void)
 {
 }

 virtual SLComposerStatusCode Initialise(const IParagraphComposer::Tiler* tiler, 
 ParcelKey parcelKey, 
 Text::FirstLineOffsetMetric flo,
 const PMReal& lineIndentLeft,
 const PMReal& lineIndentRight);

 virtual SLComposerStatusCode MakeTileMeasures(const PMReal& yPosition,
 const SLCLineMetrics& lineMetrics,
 Text::GridAlignmentMetric gridAlignment, 
 const PMReal& gridAlignmentMetricAdj, 
 const TextIndex& nCurrentPosition);

 virtual void Finish(void);

 bool16 IsStoryOverset(void) const
 {
 if (fParcelKey.IsValid() == kFalse) return kTrue;
 else return kFalse;
 }

 ParcelKey GetParcelKey(void) const
 {
 return fParcelKey;
 }

 const PMReal& GetHeight(void) const
 {
 return fHeight;
 }

 const PMReal& GetTOPHeight(void) const
 {
 return fTOPHeight;
 }

 Text::FirstLineOffsetMetric GetTOPHeightMetric(void)
 {
 return fTOPHeightMetric;
 }

 bool16 GetAtTOP(void) const
 {
 return fAtTOP;
 }

 bool16 GetParcelPositionDependent(void) const
 {
 return fParcelPositionDependent;
 }


 const PMReal& GetTileTop(void) const
 {
 return fTileTop;
 }

 const PMReal& GetTileBottom(void) const
 {
 return fTileBottom;
 }

 SLCTileMeasures& GetTileMeasures(void)
 {
 return fTileMeasures;
 }

 virtual void Dump(void);

private:
 SLComposerStatusCode GetTiles( const PMReal& yPosition, 
 const SLCLineMetrics& lineMetrics,
 Text::GridAlignmentMetric gridAlignmentMetric, 
 const PMReal& gridAlignmentMetricAdj, 
 const TextIndex& nCurrentPosition);

 SLComposerStatusCode BuildTileMeasures(void);

 /* Members set up on initialisation.
 */
 const IParagraphComposer::Tiler* fTiler;
 PMReal fLineIndentLeft;
 PMReal fLineIndentRight;

 /* Members updated each time Tiler is called for tiles.
 */
 ParcelKey fParcelKey;
 PMReal fHeight;
 PMReal fTOPHeight;
 Text::FirstLineOffsetMetric fTOPHeightMetric;
 PMRectCollection fTiles;
 PMReal fYOffset;
 bool16 fAtTOP;
 bool16 fParcelPositionDependent;
 PMReal fLeftMargin;
 PMReal fRightMargin;

 /* Members derived from the data returned by Tiler and used to flow text into the line.
 */
 PMReal fTileTop;
 PMReal fTileBottom;
 SLCTileMeasures fTileMeasures;
};

#endif // __SLCTileManager_h__

// End, SLCTileManager.h