GoToRemote.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.fileSpecs;
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 in another PDF file' action [PDF:1.6:8.5.3].</summary>
  */
  public class GoToRemote
    : Action
  {
    #region dynamic
    #region constructors
    /**
      <summary>Creates a new action within the given document context.</summary>
    */
    public GoToRemote(
      Document context,
      FileSpec fileSpec,
      RemoteDestination destination
      ) : base(
        context,
        PdfName.GoToR
        )
    {
      FileSpec = fileSpec;
      Destination = destination;
    }

    internal GoToRemote(
      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 RemoteDestination Destination
    {
      get
      {
        /*
          NOTE: 'D' entry MUST exist.
        */
        PdfDirectObject destinationObject = BaseDataObject[PdfName.D];
        if(destinationObject is PdfName) // Named destination.
          return (RemoteDestination)Document.Names.Destinations[
            (string)((PdfName)destinationObject).Value
            ];
        if(destinationObject is PdfString) // Named destination.
          return (RemoteDestination)Document.Names.Destinations[
            (string)((PdfString)destinationObject).Value
            ];

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

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

    /**
      <summary>Gets/Sets the file in which the destination is located.</summary>
    */
    public FileSpec FileSpec
    {
      get
      {
        /*
          NOTE: 'F' entry MUST exist.
        */
        return new FileSpec(BaseDataObject[PdfName.F],Container);
      }
      set
      {BaseDataObject[PdfName.F] = value.BaseObject;}
    }

    /**
      <summary>Gets/Sets the action options.</summary>
    */
    public OptionsEnum Options
    {
      get
      {
        OptionsEnum options = 0;

        PdfDirectObject optionsObject = BaseDataObject[PdfName.NewWindow];
        if(optionsObject != null
          && (bool)((PdfBoolean)optionsObject).Value)
        {options |= OptionsEnum.NewWindow;}

        return options;
      }
      set
      {
        if((value & OptionsEnum.NewWindow) == OptionsEnum.NewWindow)
        {BaseDataObject[PdfName.NewWindow] = PdfBoolean.True;}
        else if((value & OptionsEnum.SameWindow) == OptionsEnum.SameWindow)
        {BaseDataObject[PdfName.NewWindow] = PdfBoolean.False;}
        else
        {BaseDataObject.Remove(PdfName.NewWindow);} // NOTE: Forcing the absence of this entry ensures that the viewer application should behave in accordance with the current user preference.
      }
    }
    #endregion
    #endregion
    #endregion
  }
}