TableTagData.h

//========================================================================================
// 
// $File$
// 
// Owner: Will Lin
// 
// $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.
// 
// 
// Purpose:
// Data to indicate which tags to use when tagging tables
// 
//========================================================================================

#ifndef __TableTagData__
#define __TableTagData__

#include <vector>

class TableTagData
{
public:
 TableTagData(IDataBase *db = nil);

 void Initialize(IDataBase *db);
 
 bool16 IsInitialized(void) const;

 void SetTableTag(const WideString &name) {return SetTagName(kTable, name);}
 
 
 void SetHeaderTag(const WideString& name) { return SetTagName(kHeader, name); }
 
 void SetBodyTag(const WideString& name) { return SetTagName(kBody, name); }
 
 void SetFooterTag(const WideString& name) { return SetTagName(kFooter, name); }
 
 void SetRowTag(const WideString &name) {return SetTagName(kRow, name);}
 
 void SetCellTag(const WideString &name) {return SetTagName(kCell, name);}

 void SetTableTag(const UID &uid) {return SetTagUID(kTable, uid);}
 
 void SetHeaderTag(UID uid) { return SetTagUID(kHeader, uid); }
 
 void SetBodyTag(UID uid) { return SetTagUID(kBody, uid); }
 
 void SetFooterTag(UID uid) { return SetTagUID(kFooter, uid); }
 
 void SetRowTag(const UID &uid) {return SetTagUID(kRow, uid);}
 
 void SetCellTag(const UID &uid) {return SetTagUID(kCell, uid);}

 UID GetTableTag(bool16 lwProcessing = kFalse) const {return GetTagUID(kTable, lwProcessing);}
 
 bool16 HasTableTag(void) const { return HasTag(kTable); }

 UID GetHeaderTag(bool16 lwProcessing = kFalse) const { return GetTagUID(kHeader, lwProcessing); }
 
 bool16 HasHeaderTag(void) const { return HasTag(kHeader); }
 
 UID GetBodyTag(bool16 lwProcessing = kFalse) const { return GetTagUID(kBody, lwProcessing); }
 
 bool16 HasBodyTag(void) const { return HasTag(kBody); }
 
 UID GetFooterTag(bool16 lwProcessing = kFalse) const { return GetTagUID(kFooter, lwProcessing); }
 
 bool16 HasFooterTag(void) const { return HasTag(kFooter); }
 
 UID GetRowTag(bool16 lwProcessing = kFalse) const {return GetTagUID(kRow, lwProcessing);}
 
 bool16 HasRowTag(void) const { return HasTag(kRow); }

 UID GetCellTag(bool16 lwProcessing = kFalse) const {return GetTagUID(kCell, lwProcessing);}
 
 bool16 HasCellTag(void) const { return HasTag(kCell); }

private:
 // this enum is used to indicate which tag you care about. Please don't add
 // any values after kEnd because that is used to indicate the end of the list
 // programatically
 enum WhichTag {kTable = 0, kHeader, kBody, kFooter, kRow, kCell, kEnd /* Don't insert anything after kEnd */};

 // This is an internal method that is used to set the tag name for a given
 // part of the table. It sets the entire data structure up to know that the
 // tag has been set by name
 void SetTagName(WhichTag which, const WideString &name, UID colorUID = kInvalidUID);

 // This is an internal method that is used to set the tag UID for a given
 // part of the table. It sets the entire data structure up to know that the
 // tag has been set by UID
 void SetTagUID(WhichTag which, const UID &uid);

 // This is an internal method that is used to get the tag UID for a given
 // part of the table. If the tag information was set via name this method
 // will create a new tag if one doesn't already exist.
 UID GetTagUID(WhichTag which, bool16 lwProcessing) const ;
 
 // This is an internal method that is used to retrieve whether a particular tag type was 
 // specified/stored in this
 bool16 HasTag(WhichTag which) const;

 // This is a struct for holding all of the required information about a
 // tag for a particular part of the table.
 struct TagData {
 TagData() : fColorUID(kInvalidUID),
 fReceivedName(kFalse),
 fNameProcessed(kFalse),
 fTagUID(kInvalidUID)
 {}

 WideString fTagName;
 UID fColorUID;
 bool16 fReceivedName;
 mutable bool16 fNameProcessed;
 mutable UID fTagUID;
 };

 IDataBase *fDB;
 std::vector<TagData> fTagData;
 bool16 fInitialized;
};

#endif