Bookmark.cs :  » PDF » PDF-Clown » it » stefanochizzolini » clown » documents » interaction » navigation » document » C# / CSharp Open Source

/*
  Copyright 2006,2007,2008 Stefano Chizzolini. http://clown.stefanochizzolini.it

  Contributors:
    * Stefano Chizzolini (original code developer, http://www.stefanochizzolini.it)

  This file should be part of the source code distribution of "PDF Clown library"
  (the Program): see the accompanying README files for more info.

  This Program is free software; you can redistribute it and/or modify it under
  the terms of the GNU General Public License as published by the Free Software
  Foundation; either version 2 of the License, or (at your option) any later version.

  This Program is distributed in the hope that it will be useful, but WITHOUT ANY
  WARRANTY, either expressed or implied; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the License for more details.

  You should have received a copy of the GNU General Public License along with this
  Program (see README files); if not, go to the GNU website (http://www.gnu.org/).

  Redistribution and use, with or without modification, are permitted provided that such
  redistributions retain the above copyright notice, license and disclaimer, along with
  this list of conditions.
*/

using it.stefanochizzolini.clown.documents;
using it.stefanochizzolini.clown.documents.interaction;
using it.stefanochizzolini.clown.files;
using it.stefanochizzolini.clown.objects;

using System;

namespace it.stefanochizzolini.clown.documents.interaction.navigation.document{
  /**
    <summary>Outline item [PDF:1.6:8.2.2].</summary>
  */
  public class Bookmark
    : PdfObjectWrapper<PdfDictionary>
  {
    #region dynamic
    #region constructors
    public Bookmark(
      Document context,
      string title,
      LocalDestination destination
      ) : base(
        context.File,
        new PdfDictionary(
          new PdfName[3]
          {
            PdfName.Title,
            PdfName.Dest,
            PdfName.Count
          },
          new PdfDirectObject[3]
          {
            new PdfTextString(title),
            (destination == null)?
              null
              : destination.BaseObject,
            new PdfInteger(0)
          }
          )
        )
    {}

    internal Bookmark(
      PdfDirectObject baseObject
      ) : base(
        baseObject,
        null // NO container (bookmark MUST be an indirect object [PDF:1.6:8.2.2]).
        )
    {}
    #endregion

    #region interface
    #region public
    public Bookmarks Bookmarks
    {get{return new Bookmarks(BaseObject);}}

    public override object Clone(
      Document context
      )
    {throw new NotImplementedException();}

    /**
      <summary>Gets/Sets the destination to jump to.</summary>
    */
    public LocalDestination Destination
    {
      get
      {
        /*
          NOTE: 'Dest' entry may be undefined.
        */
        PdfDirectObject destinationObject = BaseDataObject[PdfName.Dest];
        if(destinationObject == null)
          return null;

        if(destinationObject is PdfName) // Named destination.
          return (LocalDestination)Document.Names.Destinations[
            (string)((PdfName)destinationObject).Value
            ];
        if(destinationObject is PdfString) // Named destination.
          return (LocalDestination)Document.Names.Destinations[
            (string)((PdfString)destinationObject).Value
            ];
        // Explicit specification.
        return new LocalDestination(
          destinationObject,
          Container
          );
      }
      set
      {
        /*
          NOTE: This entry is not permitted in bookmarks if an 'A' entry is present.
        */
        if(BaseDataObject.ContainsKey(PdfName.A)
          && value != null)
        {BaseDataObject.Remove(PdfName.A);}

        BaseDataObject[PdfName.Dest] = value.BaseObject;
      }
    }

    public bool Expanded
    {
      get
      {
        PdfInteger countObject = (PdfInteger)BaseDataObject[PdfName.Count];

        return (countObject == null
          || countObject.RawValue >= 0);
      }
      set
      {
        PdfInteger countObject = (PdfInteger)BaseDataObject[PdfName.Count];
        if(countObject == null)
          return;

        /*
          NOTE: Non-negative Count entry means open, negative Count entry means closed [PDF:1.6:8.2.2].
        */
        countObject.RawValue = (value ? 1 : -1) * Math.Abs(countObject.RawValue);
      }
    }

    public Bookmark NextSibling
    {
      get
      {
        PdfReference reference = (PdfReference)BaseDataObject[PdfName.Next];
        if(reference == null)
          return null; // This bookmark is the last one, no next sibling available.

        return new Bookmark(reference);
      }
      set
      {throw new NotImplementedException();}
    }

    public Bookmark Parent
    {
      get
      {
        PdfReference reference = (PdfReference)BaseDataObject[PdfName.Parent];
        // Is its parent a bookmark?
        /*
          NOTE: the Title entry can be used as a flag to distinguish bookmark
          (outline item) dictionaries from outline (root) dictionaries.
        */
        if(((PdfDictionary)File.Resolve(reference)).ContainsKey(PdfName.Title)) // Bookmark.
          return new Bookmark(reference);
        else // Outline root.
          return null; // NO parent bookmark.
      }
      set
      {throw new NotImplementedException();}
    }

    public Bookmark PreviousSibling
    {
      get
      {
        PdfReference reference = (PdfReference)BaseDataObject[PdfName.Prev];
        if(reference == null)
          return null; // This bookmark is the first one, no previous sibling available.

        return new Bookmark(reference);
      }
      set
      {throw new NotImplementedException();}
    }

    public string Title
    {
      get
      {return (String)((PdfTextString)BaseDataObject[PdfName.Title]).Value;}
      set
      {((PdfTextString)BaseDataObject[PdfName.Title]).Value = value;}
    }
    #endregion
    #endregion
    #endregion
  }
}