lotuswordpro/source/filter/lwpfootnote.cxx

   1 /*************************************************************************
   2  *
   3  *  The Contents of this file are made available subject to the terms of
   4  *  either of the following licenses
   5  *
   6  *         - GNU Lesser General Public License Version 2.1
   7  *         - Sun Industry Standards Source License Version 1.1
   8  *
   9  *  Sun Microsystems Inc., October, 2000
  10  *
  11  *  GNU Lesser General Public License Version 2.1
  12  *  =============================================
  13  *  Copyright 2000 by Sun Microsystems, Inc.
  14  *  901 San Antonio Road, Palo Alto, CA 94303, USA
  15  *
  16  *  This library is free software; you can redistribute it and/or
  17  *  modify it under the terms of the GNU Lesser General Public
  18  *  License version 2.1, as published by the Free Software Foundation.
  19  *
  20  *  This library is distributed in the hope that it will be useful,
  21  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  22  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  23  *  Lesser General Public License for more details.
  24  *
  25  *  You should have received a copy of the GNU Lesser General Public
  26  *  License along with this library; if not, write to the Free Software
  27  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  28  *  MA  02111-1307  USA
  29  *
  30  *
  31  *  Sun Industry Standards Source License Version 1.1
  32  *  =================================================
  33  *  The contents of this file are subject to the Sun Industry Standards
  34  *  Source License Version 1.1 (the "License"); You may not use this file
  35  *  except in compliance with the License. You may obtain a copy of the
  36  *  License at http://www.openoffice.org/license.html.
  37  *
  38  *  Software provided under this License is provided on an "AS IS" basis,
  39  *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
  40  *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
  41  *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
  42  *  See the License for the specific provisions governing your rights and
  43  *  obligations concerning the Software.
  44  *
  45  *  The Initial Developer of the Original Code is: IBM Corporation
  46  *
  47  *  Copyright: 2008 by IBM Corporation
  48  *
  49  *  All Rights Reserved.
  50  *
  51  *  Contributor(s): _______________________________________
  52  *
  53  *
  54  ************************************************************************/
  55 /**
  56  * @file
  57  *  footnote
  58  */
  59 /*************************************************************************
  60  * Change History
  61  Mar 2005                       Created
  62  ************************************************************************/
  63 #include "lwpfootnote.hxx"
  64 #include "lwpstory.hxx"
  65 #include "xfilter/xffootnote.hxx"
  66 #include "xfilter/xfendnote.hxx"
  67 #include "xfilter/xffootnoteconfig.hxx"
  68 #include "xfilter/xfendnoteconfig.hxx"
  69 #include "xfilter/xfstylemanager.hxx"
  70 #include "xfilter/xftextspan.hxx"
  71 #include "lwppara.hxx"
  72 #include "lwpdoc.hxx"
  73 #include "lwpfnlayout.hxx"
  74 #include "lwpglobalmgr.hxx"
  75
  76 LwpFribFootnote::LwpFribFootnote(LwpPara* pPara ):LwpFrib(pPara)
  77 {
  78 }
  79
  80 /**
  81  * @descr  read footnote frib information
  82  */
  83 void LwpFribFootnote::Read(LwpObjectStream *pObjStrm, sal_uInt16 len)
  84 {
  85         m_Footnote.ReadIndexed(pObjStrm);
  86 }
  87
  88 /**
  89  * @descr  Register footnote style by calling LwpFootnote::RegisterStyle()
  90  */
  91 void LwpFribFootnote::RegisterStyle()
  92 {
  93         LwpFootnote* pFootnote = GetFootnote();
  94         if(pFootnote)
  95         {
  96                 //register footnote number font style
  97                 LwpFrib::RegisterStyle(m_pPara->GetFoundry());
  98                 //register footnote content style
  99                 pFootnote->SetFoundry(m_pPara->GetFoundry());
 100                 pFootnote->RegisterStyle();
 101         }
 102 }
 103
 104 /**
 105  * @descr  Parse footnote  by calling LwpFootnote::XFConvert()
 106  */
 107 void LwpFribFootnote::XFConvert(XFContentContainer* pCont)
 108 {
 109         LwpFootnote* pFootnote = GetFootnote();
 110         if(pFootnote)
 111         {
 112                 XFContentContainer* pContent = NULL;
 113                 if(pFootnote->GetType() == FN_FOOTNOTE)
 114                 {
 115                         pContent = new XFFootNote();
 116                 }
 117                 else
 118                 {
 119                         pContent = new XFEndNote();
 120                 }
 121                 pFootnote->XFConvert(pContent);
 122                 if(m_ModFlag)
 123                 {
 124                         //set footnote number font style
 125                         XFTextSpan *pSpan = new XFTextSpan();
 126                         pSpan->SetStyleName(GetStyleName());
 127                         //add the xffootnote into the content container
 128                         pSpan->Add(pContent);
 129                         pCont->Add(pSpan);
 130                 }
 131                 else
 132                 {
 133                         pCont->Add(pContent);
 134                 }
 135         }
 136 }
 137
 138 /**
 139  * @descr  Get foonote object
 140  */
 141 LwpFootnote* LwpFribFootnote::GetFootnote()
 142 {
 143         return static_cast<LwpFootnote*>(m_Footnote.obj());
 144 }
 145
 146
 147 LwpFootnote::LwpFootnote(LwpObjectHeader &objHdr, LwpSvStream *pStrm)
 148         : LwpOrderedObject(objHdr, pStrm)
 149 {
 150 }
 151
 152 LwpFootnote::~LwpFootnote()
 153 {
 154
 155 }
 156
 157 /**
 158  * @descr  Read foonote object
 159  */
 160 void LwpFootnote::Read()
 161 {
 162         LwpOrderedObject::Read();
 163         m_pObjStrm->QuickRead(&m_nType, sizeof(m_nType));
 164         m_pObjStrm->QuickRead(&m_nRow, sizeof(m_nRow));
 165         m_Content.ReadIndexed(m_pObjStrm);
 166         m_pObjStrm->SkipExtra();
 167 }
 168
 169 /**
 170  * @descr  Register footnote style
 171  */
 172 void LwpFootnote::RegisterStyle()
 173 {
 174         //Only register footnote contents style,
 175         //Endnote contents style registers in LwpEnSuperTableLayout::RegisterStyle
 176         if(m_nType == FN_FOOTNOTE)
 177         {
 178                 LwpContent* pContent = FindFootnoteContent();
 179                 if(pContent)
 180                 {
 181                         pContent->SetFoundry(m_pFoundry);
 182                         pContent->RegisterStyle();
 183                 }
 184         }
 185 }
 186
 187 /**
 188  * @descr  Parse footnote
 189  */
 190 void LwpFootnote::XFConvert(XFContentContainer * pCont)
 191 {
 192         LwpContent* pContent = FindFootnoteContent();
 193         if(pContent)
 194         {
 195                 pContent->XFConvert(pCont);
 196         }
 197 }
 198
 199 /**
 200  * @descr  Get endnote cell layout which contains current endnote content
 201  */
 202 LwpCellLayout* LwpFootnote::GetCellLayout()
 203 {
 204         LwpEnSuperTableLayout* pEnSuperLayout = FindFootnoteTableLayout();
 205         if(pEnSuperLayout)
 206         {
 207                 LwpTableLayout* pTableLayout = static_cast<LwpTableLayout*>(pEnSuperLayout->GetMainTableLayout());
 208                 if(pTableLayout)
 209                 {
 210                         LwpRowLayout* pRowLayout = pTableLayout->GetRowLayout(m_nRow);
 211                         if(pRowLayout)
 212                         {
 213                                 return static_cast<LwpCellLayout*>(pRowLayout->GetChildHead()->obj());
 214                         }
 215                 }
 216         }
 217         return NULL;
 218 }
 219 /**
 220  * @descr  Get endnote supertable layout which contains current endnote content, not used now
 221  */
 222 LwpEnSuperTableLayout* LwpFootnote::GetEnSuperTableLayout()
 223 {
 224         LwpDocument* pDivision = GetFootnoteTableDivision();
 225         if(pDivision)
 226                 return static_cast<LwpEnSuperTableLayout*>(pDivision->GetEnSuperTableLayout());
 227         return NULL;
 228 }
 229
 230 /**
 231  * @descr  Get division which footnote table contains current footnote content, copy from lwp source code
 232  */
 233 LwpDocument* LwpFootnote::GetFootnoteTableDivision()
 234 {
 235         if(!m_pFoundry)
 236                 return NULL;
 237
 238         LwpDocument* pPrev =NULL;
 239         LwpDocument* pDivision = NULL;
 240         LwpDocument* pFootnoteDivision =NULL;
 241
 242         // Make sure the footnote does belong to some division
 243         // The division might not have a DivisionInfo if it's being Destruct()ed
 244         pPrev = m_pFoundry->GetDocument();
 245         pFootnoteDivision = pPrev;
 246         if (!pPrev || pPrev->GetDivInfoID()->IsNull())
 247                 return NULL;
 248
 249         switch (m_nType)
 250         {
 251                 case FN_FOOTNOTE:
 252                 {
 253                         // Footnotes always use the source division
 254                         return pFootnoteDivision;
 255                 }
 256                 case FN_DIVISION:
 257                 {
 258                         // Start with the footnote's division
 259                         pDivision = pPrev;
 260                         break;
 261                 }
 262                 case FN_DIVISION_SEPARATE:
 263                 {
 264                         // It had better be the next division
 265                         pDivision = pPrev->GetNextDivision();
 266                         break;
 267                 }
 268                 case FN_DIVISIONGROUP:
 269                 case FN_DIVISIONGROUP_SEPARATE:
 270                 {
 271                         pDivision = pPrev->GetLastInGroupWithContents();
 272                         pPrev = pDivision;
 273                         break;
 274                 }
 275                 case FN_DOCUMENT:
 276                 case FN_DOCUMENT_SEPARATE:
 277                 {
 278                         pDivision = pFootnoteDivision->GetRootDocument();
 279                         if (pDivision)
 280                                 pDivision = pDivision->GetLastDivisionWithContents();
 281                         pPrev = pDivision;
 282                         break;
 283                 }
 284
 285         }
 286
 287         // Make sure we're using the proper endnote division, if it's separate
 288         if (m_nType & FN_MASK_SEPARATE)
 289                 pDivision = GetEndnoteDivision(pDivision);
 290         // Don't use a division that's specifically for endnotes
 291         else
 292         {
 293                 while (pDivision)
 294                 {
 295                         if (pDivision->GetEndnoteType() == FN_DONTCARE)
 296                                 break;
 297                         if (m_nType == FN_DIVISIONGROUP)
 298                                 pDivision = pDivision->GetPreviousInGroup();
 299                         else
 300                                 pDivision = pDivision->GetPreviousDivisionWithContents();
 301                 }
 302         }
 303         if (pDivision)
 304                 return pDivision;
 305         return NULL;
 306 }
 307
 308 /**
 309  * @descr  Get division which endnote table contains current endnote content, copy from lwp source code
 310  */
 311 LwpDocument* LwpFootnote::GetEndnoteDivision(LwpDocument* pPossible)
 312 {
 313         LwpDocument*  pDivision = pPossible;
 314         sal_uInt16 nDivType;
 315
 316         // In case we have multiple endnote divisions, walk backwards until
 317         // we find one.
 318         while (pDivision)
 319         {
 320                 // Do we already have the right division?
 321                 nDivType = pDivision->GetEndnoteType();
 322                 if (nDivType == m_nType)
 323                         return pDivision;
 324                 // When we hit the first non-endnote division, stop looking.
 325                 // -- SDC 10/8/96
 326                 if (nDivType == FN_DONTCARE)
 327                         break;
 328                 pDivision = pDivision->GetPreviousDivision();
 329         }
 330         return NULL;
 331 }
 332
 333 /**
 334  * @descr  Get footnote table class name
 335  */
 336 OUString LwpFootnote::GetTableClass()
 337 {
 338         OUString strClassName;
 339         switch (GetType() & FN_MASK_BASE)
 340         {
 341                 case FN_BASE_FOOTNOTE:
 342                 {
 343                         strClassName = A2OUSTR(STR_DivisionFootnote);
 344                         break;
 345                 }
 346                 case FN_BASE_DOCUMENT:
 347                 {
 348                         strClassName = A2OUSTR(STR_DocumentEndnote);
 349                         break;
 350                 }
 351                 case FN_BASE_DIVISION:
 352                 {
 353                         strClassName = A2OUSTR(STR_DivisionEndnote);
 354                         break;
 355                 }
 356                 case FN_BASE_DIVISIONGROUP:
 357                 {
 358                         strClassName = A2OUSTR(STR_DivisionGroupEndnote);
 359                         break;
 360                 }
 361         }
 362         return strClassName;
 363 }
 364
 365 /**
 366  * @descr  Find footnote tablelayout, copy from lwp source code
 367  */
 368 LwpEnSuperTableLayout* LwpFootnote::FindFootnoteTableLayout()
 369 {
 370         LwpDocument* pDivision = GetFootnoteTableDivision();
 371         if(!pDivision)
 372                 return NULL;
 373
 374         LwpFoundry* pFoundry = pDivision->GetFoundry();
 375         OUString strClassName = GetTableClass();
 376         if(strClassName.getLength() ==0 )
 377                 return NULL;
 378
 379         LwpContent* pContent = NULL;
 380
 381         while ((pContent = pFoundry->EnumContents(pContent)) != NULL)
 382                 if (pContent->IsTable() && (strClassName.equals(pContent->GetClassName())) &&
 383                         pContent->IsActive() && pContent->GetLayout(NULL))
 384                 {
 385                         // Found it!
 386                         return (LwpEnSuperTableLayout *)
 387                                 ((LwpTable*)pContent)->GetSuperTableLayout();
 388                 }
 389
 390         return NULL;
 391 }
 392
 393 /**
 394  * @descr  Find footnote table, not used now
 395  */
 396 LwpTable* LwpFootnote::FindFootnoteTable()
 397 {
 398         LwpEnSuperTableLayout* pLayout = FindFootnoteTableLayout();
 399         //if (!ShouldBeInTable(Footnote)) return NULL;
 400         return GetFootnoteTable(pLayout);
 401 }
 402
 403 /**
 404  * @descr  Find footnote table, not used now
 405  */
 406 LwpTable* LwpFootnote::GetFootnoteTable(LwpEnSuperTableLayout * pLayout)
 407 {
 408         if(pLayout)
 409         {
 410                 LwpEndnoteLayout* pEndnoteLayout = static_cast<LwpEndnoteLayout*>(pLayout->GetMainTableLayout());
 411                 if(pEndnoteLayout)
 412                         return static_cast<LwpTable*>(pEndnoteLayout->GetContent()->obj());
 413         }
 414         return NULL;
 415 }
 416
 417 /**
 418  * @descr  Find footnote contents
 419  */
 420 LwpContent* LwpFootnote::FindFootnoteContent()
 421 {
 422         LwpContent* pContent = static_cast<LwpContent*>(m_Content.obj());
 423         //if the content has layout, the content has footnote contents;
 424         //or looking for the celllayout and return the footnote contents.
 425         if(pContent && pContent->GetLayout(NULL))
 426                 return pContent;
 427
 428         LwpCellLayout* pCellLayout = GetCellLayout();
 429         if(pCellLayout)
 430         {
 431                 pContent =static_cast<LwpContent*>(pCellLayout->GetContent()->obj());
 432         }
 433
 434         return pContent;
 435 }
 436
 437 LwpFootnoteTable::LwpFootnoteTable(LwpObjectHeader &objHdr, LwpSvStream *pStrm)
 438         : LwpTable(objHdr, pStrm)
 439 {
 440 }
 441
 442 void LwpFootnoteTable::Read()
 443 {
 444         LwpTable::Read();
 445         m_pObjStrm->SkipExtra();
 446 }
 447
 448 /**
 449  * @descr  Read footnote number options information
 450  */
 451 void LwpFootnoteNumberOptions::Read(LwpObjectStream *pObjStrm)
 452 {
 453         pObjStrm->QuickRead(&m_nFlag, sizeof(m_nFlag));
 454         pObjStrm->QuickRead(&m_nStartingNumber, sizeof(m_nStartingNumber));
 455         m_LeadingText.Read(pObjStrm);
 456         m_TrailingText.Read(pObjStrm);
 457         pObjStrm->SkipExtra();
 458 }
 459
 460 /**
 461  * @descr  Read footnote seperator options information
 462  */
 463 void LwpFootnoteSeparatorOptions::Read(LwpObjectStream *pObjStrm)
 464 {
 465         pObjStrm->QuickRead(&m_nFlag, sizeof(m_nFlag));
 466         pObjStrm->QuickRead(&m_nLength, sizeof(m_nLength));
 467         pObjStrm->QuickRead(&m_nIndent, sizeof(m_nIndent));
 468         pObjStrm->QuickRead(&m_nAbove, sizeof(m_nAbove));
 469         pObjStrm->QuickRead(&m_nBelow, sizeof(m_nBelow));
 470         m_BorderStuff.Read(pObjStrm);
 471         pObjStrm->SkipExtra();
 472
 473 }
 474
 475
 476 LwpFootnoteOptions::LwpFootnoteOptions(LwpObjectHeader &objHdr, LwpSvStream *pStrm)
 477         : LwpObject(objHdr, pStrm)
 478 {
 479 }
 480
 481 LwpFootnoteOptions::~LwpFootnoteOptions()
 482 {
 483
 484 }
 485
 486 /**
 487  * @descr  Register footnote options object
 488  */
 489 void LwpFootnoteOptions::Read()
 490 {
 491         m_pObjStrm->QuickRead(&m_nFlag, sizeof(m_nFlag));
 492         m_FootnoteNumbering.Read(m_pObjStrm);
 493         m_EndnoteDivisionNumbering.Read(m_pObjStrm);
 494         m_EndnoteDivisionGroupNumbering.Read(m_pObjStrm);
 495         m_EndnoteDocNumbering.Read(m_pObjStrm);
 496         m_FootnoteSeparator.Read(m_pObjStrm);
 497         m_FootnoteContinuedSeparator.Read(m_pObjStrm);
 498         m_ContinuedOnMessage.Read(m_pObjStrm);
 499         m_ContinuedFromMessage.Read(m_pObjStrm);
 500         m_pObjStrm->SkipExtra();
 501 }
 502
 503 /**
 504  * @descr  Register footnote options style
 505  */
 506 void LwpFootnoteOptions::RegisterStyle()
 507 {
 508         RegisterFootnoteStyle();
 509         RegisterEndnoteStyle();
 510 }
 511
 512 /**
 513  * @descr  Register footnote configuration information
 514  */
 515 void LwpFootnoteOptions::RegisterFootnoteStyle()
 516 {
 517         XFFootnoteConfig* pFootnoteConfig = new XFFootnoteConfig();
 518         pFootnoteConfig->SetStartValue(m_FootnoteNumbering.GetStartingNumber() -1);
 519         pFootnoteConfig->SetNumPrefix(m_FootnoteNumbering.GetLeadingText());
 520         pFootnoteConfig->SetNumSuffix(m_FootnoteNumbering.GetTrailingText());
 521         if(m_FootnoteNumbering.GetReset() == LwpFootnoteNumberOptions::RESET_PAGE)
 522         {
 523                 pFootnoteConfig->SetRestartOnPage();
 524         }
 525         if(GetContinuedFrom())
 526         {
 527                 pFootnoteConfig->SetMessageFrom(GetContinuedFromMessage());
 528         }
 529         if(GetContinuedOn())
 530         {
 531                 pFootnoteConfig->SetMessageOn(GetContinuedOnMessage());
 532         }
 533
 534         pFootnoteConfig->SetMasterPage( m_strMasterPage);
 535         XFStyleManager* pXFStyleManager = LwpGlobalMgr::GetInstance()->GetXFStyleManager();
 536         pXFStyleManager->SetFootnoteConfig(pFootnoteConfig);
 537
 538 }
 539
 540 /**
 541  * @descr  Register endnote configuration information
 542  */
 543 void LwpFootnoteOptions::RegisterEndnoteStyle()
 544 {
 545         XFEndnoteConfig* pEndnoteConfig = new XFEndnoteConfig();
 546         pEndnoteConfig->SetStartValue(m_EndnoteDocNumbering.GetStartingNumber() -1);
 547         OUString message = m_EndnoteDocNumbering.GetLeadingText();
 548         if(message.getLength() == 0)
 549         {
 550                 message = A2OUSTR("[");//default prefix
 551         }
 552         pEndnoteConfig->SetNumPrefix(message);
 553         message = m_EndnoteDocNumbering.GetTrailingText();
 554         if(message.getLength() == 0)
 555         {
 556                 message = A2OUSTR("]");//default suffix
 557         }
 558         pEndnoteConfig->SetNumSuffix(message);
 559         if(m_EndnoteDocNumbering.GetReset() == LwpFootnoteNumberOptions::RESET_PAGE)
 560         {
 561                 pEndnoteConfig->SetRestartOnPage();
 562         }
 563
 564         pEndnoteConfig->SetMasterPage( m_strMasterPage);
 565
 566         XFStyleManager* pXFStyleManager = LwpGlobalMgr::GetInstance()->GetXFStyleManager();
 567         pXFStyleManager->SetEndnoteConfig(pEndnoteConfig);
 568 }
 569
 570
 571 /**
 572  * @descr  Get continue on message
 573  */
 574 OUString LwpFootnoteOptions::GetContinuedOnMessage()
 575 {
 576         if(m_ContinuedOnMessage.HasValue())
 577         {
 578                 return m_ContinuedOnMessage.str();
 579         }
 580         // else reture defauls message
 581         return A2OUSTR(STRID_FOOTCONTINUEDON);
 582 }
 583
 584 /**
 585  * @descr  Get continue from message
 586  */
 587 OUString LwpFootnoteOptions::GetContinuedFromMessage()
 588 {
 589         if(m_ContinuedFromMessage.HasValue())
 590         {
 591                 return m_ContinuedFromMessage.str();
 592         }
 593         // else reture defauls message
 594         return A2OUSTR(STRID_FOOTCONTINUEDFROM);
 595 }