include/vrvCore/DtPageAssembler.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2010 MAK Technologies, Inc.
** All rights reserved.
******************************************************************************/
/******************************************************************************
** $RCSfile:  $ $Revision:  $ $State:  $
******************************************************************************/


#pragma once
#include <vrvCore/DtPagePath.h>
#include <vrvUtil/DtVirtualBaseClass.h>
#include <vrvCore/DtPageConfiguration.h>

namespace makVrv
{
   class DtPagePath;
   class DtDe;

   class DT_DLL_VRVCORE DtPageAssembler : public DtVirtualBaseClass
   {

   public:

      friend class DtPageAssemblerCreator;

      static DtPageAssembler& instance(DtDe&);

      virtual ~DtPageAssembler();

      virtual void assemble(const DtPageConfiguration& configuration);

      virtual void assemble(const DtPagePath& pagePath, 
         const DtPageConfiguration& configuration);

      virtual void placeCollectionPages( const DtPageConfiguration& configuration );

      virtual void assembleCollection(const DtPagePath& pagePath, const DtUnicode& pageTitle,
         const DtPageConfiguration::PageCollectionState& pageState);

   protected:

      typedef std::multimap<DtPageConfiguration::PageCollectionLocation, DtPagePath> LocationPathMap;
      typedef std::map<int, DtPagePath> PagePathsMap;

      DtPageAssembler(DtDe& de);

      virtual void assemblePagePath(const DtPagePath& pagePath, 
         const DtPageConfiguration& configuration);

      virtual void assemblePage(const DtPagePath& pagePath);

      virtual void updatePage( const DtPagePath& pagePath, const DtPageConfiguration& configuration );

      virtual void updatePage( const DtPagePath& pagePath, const DtPageConfiguration::PageCollectionState& state);      

      virtual void assembleAllPagesInLocation(const LocationPathMap& locMap, DtPageConfiguration::PageCollectionLocation loc, 
         const DtPageConfiguration& configuration);

      virtual void tabifyPagesInLocation(const LocationPathMap& locMap, DtPageConfiguration::PageCollectionLocation loc, 
         const DtPageConfiguration& configuration);

      virtual void populatePagePathsMap(const LocationPathMap& locMap, DtPageConfiguration::PageCollectionLocation loc, 
         const DtPageConfiguration& configuration, PagePathsMap& ppMap);

      virtual void tabify( const DtPagePath& pagePath1, const DtPagePath& pagePath2 );

      virtual void setSelectedPage(const DtPagePath& pPath);

   protected:
      DtDe& myDe;
   };

   class DT_DLL_VRVCORE DtPageAssemblerCreator : public DtVirtualBaseClass
   {
   public:      

      static DtPageAssemblerCreator& instance(DtDe& de);

      static void registerInstance(DtDe& de, DtPageAssemblerCreator* creator);

      virtual ~DtPageAssemblerCreator();

      virtual DtPageAssembler* create(DtDe& de);

   protected:

      DtPageAssemblerCreator();
   };
}