GoToLocal.cs :  » PDF » PDF-Clown » it » stefanochizzolini » clown » documents » interaction » actions » C# / CSharp Open Source

/*
  Copyright 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.bytes;
using it.stefanochizzolini.clown.documents;
using it.stefanochizzolini.clown.documents.interaction.navigation.document;
using it.stefanochizzolini.clown.objects;

using System;

namespace it.stefanochizzolini.clown.documents.interaction.actions{
  /**
    <summary>'Change the view to a specified destination within the same PDF file' action [PDF:1.6:8.5.3].</summary>
  */
  public class GoToLocal
    : Action
  {
    #region dynamic
    #region constructors
    /**
      <summary>Creates a new action within the given document context.</summary>
    */
    public GoToLocal(
      Document context,
      LocalDestination destination
      ) : base(
        context,
        PdfName.GoTo
        )
    {Destination = destination;}

    internal GoToLocal(
      PdfDirectObject baseObject,
      PdfIndirectObject container
      ) : base(baseObject,container)
    {}
    #endregion

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

    /**
      <summary>Gets/Sets the destination to jump to.</summary>
    */
    public LocalDestination Destination
    {
      get
      {
        /*
          NOTE: 'D' entry MUST exist.
        */
        PdfDirectObject destinationObject = BaseDataObject[PdfName.D];
        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
            ];

        return new LocalDestination(
          destinationObject,
          Container
          ); // Explicit destination.
      }
      set
      {
        if(value == null)
          throw new ArgumentException("Destination MUST be defined.");

        BaseDataObject[PdfName.D] = value.BaseObject;
      }
    }
    #endregion
    #endregion
    #endregion
  }
}