Link.cs :  » PDF » PDF-Clown » it » stefanochizzolini » clown » documents » interaction » annotations » 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.actions;
using it.stefanochizzolini.clown.documents.interaction.navigation.document;
using it.stefanochizzolini.clown.objects;

using System;
using System.Drawing;

namespace it.stefanochizzolini.clown.documents.interaction.annotations{
  /**
    <summary>Link annotation [PDF:1.6:8.4.5].</summary>
    <remarks>It represents either a hypertext link to a destination elsewhere in the document
    or an action to be performed.</remarks>
  */
  public class Link
    : Annotation
  {
    #region dynamic
    #region constructors
    public Link(
      Page page,
      RectangleF box,
      Destination destination
      ) : this(page,box)
    {Destination = destination;}

    public Link(
      Page page,
      RectangleF box,
      Action action
      ) : this(page,box)
    {
      AnnotationActions actions = new AnnotationActions(this);
      actions.OnActivate = action;
      Actions = actions;
    }

    public Link(
      PdfDirectObject baseObject,
      PdfIndirectObject container
      ) : base(baseObject,container)
    {}

    private Link(
      Page page,
      RectangleF box
      ) : base(
        page.Document,
        PdfName.Link,
        box,
        page
        )
    {}
    #endregion

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

    /**
      <summary>Gets/Sets the destination to jump to.</summary>
    */
    public Destination 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 Document.Names.Destinations[
            (string)((PdfName)destinationObject).Value
            ];
        if(destinationObject is PdfString) // Named destination.
          return Document.Names.Destinations[
            (string)((PdfString)destinationObject).Value
            ];

        // Explicit destination.
        return Destination.Wrap(
          destinationObject,
          Container
          );
      }
      set
      {
        /*
          NOTE: This entry is not permitted in link annotations if an 'A' entry is present.
        */
        if(BaseDataObject.ContainsKey(PdfName.A)
          && value != null)
        {BaseDataObject.Remove(PdfName.A);}

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