Note.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.objects;

using System;
using System.Collections.Generic;
using System.Drawing;

namespace it.stefanochizzolini.clown.documents.interaction.annotations{
  /**
    <summary>Text annotation [PDF:1.6:8.4.5].</summary>
    <remarks>It represents a sticky note attached to a point in the PDF document.</remarks>
  */
  public class Note
    : Annotation
  {
    #region types
    /**
      <summary>Icon to be used in displaying the annotation [PDF:1.6:8.4.5].</summary>
    */
    public enum IconTypeEnum
    {
      /**
        <summary>Comment.</summary>
      */
      Comment,
      /**
        <summary>Help.</summary>
      */
      Help,
      /**
        <summary>Insert.</summary>
      */
      Insert,
      /**
        <summary>Key.</summary>
      */
      Key,
      /**
        <summary>New paragraph.</summary>
      */
      NewParagraph,
      /**
        <summary>Note.</summary>
      */
      Note,
      /**
        <summary>Paragraph.</summary>
      */
      Paragraph
    };
    #endregion

    #region static
    #region fields
    private static readonly Dictionary<IconTypeEnum,PdfName> IconTypeEnumCodes;
    #endregion

    #region constructors
    static Note()
    {
      IconTypeEnumCodes = new Dictionary<IconTypeEnum,PdfName>();
      IconTypeEnumCodes[IconTypeEnum.Comment] = PdfName.Comment;
      IconTypeEnumCodes[IconTypeEnum.Help] = PdfName.Help;
      IconTypeEnumCodes[IconTypeEnum.Insert] = PdfName.Insert;
      IconTypeEnumCodes[IconTypeEnum.Key] = PdfName.Key;
      IconTypeEnumCodes[IconTypeEnum.NewParagraph] = PdfName.NewParagraph;
      IconTypeEnumCodes[IconTypeEnum.Note] = PdfName.Note;
      IconTypeEnumCodes[IconTypeEnum.Paragraph] = PdfName.Paragraph;
    }
    #endregion

    #region interface
    #region private
    /**
      <summary>Gets the code corresponding to the given value.</summary>
    */
    private static PdfName ToCode(
      IconTypeEnum value
      )
    {return IconTypeEnumCodes[value];}

    /**
      <summary>Gets the icon type corresponding to the given value.</summary>
    */
    private static IconTypeEnum ToIconTypeEnum(
      PdfName value
      )
    {
      foreach(KeyValuePair<IconTypeEnum,PdfName> iconType in IconTypeEnumCodes)
      {
        if(iconType.Value.Equals(value))
          return iconType.Key;
      }
      return IconTypeEnum.Note;
    }
    #endregion
    #endregion
    #endregion

    #region dynamic
    #region constructors
    public Note(
      Page page,
      PointF location,
      string text
      ) : base(
        page.Document,
        PdfName.Text,
        new RectangleF(location.X,location.Y,0,0),
        page
        )
    {Text = text;}

    public Note(
      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 icon to be used in displaying the annotation.</summary>
    */
    public IconTypeEnum IconType
    {
      get
      {return ToIconTypeEnum((PdfName)BaseDataObject[PdfName.Name]);}
      set
      {BaseDataObject[PdfName.Name] = ToCode(value);}
    }

    /**
      <summary>Gets/Sets whether the annotation should initially be displayed open.</summary>
    */
    public bool IsOpen
    {
      get
      {
        /*
          NOTE: 'Open' entry may be undefined.
        */
        PdfBoolean openObject = (PdfBoolean)BaseDataObject[PdfName.Open];
        if(openObject == null)
          return false;

        return openObject.RawValue;
      }
      set
      {BaseDataObject[PdfName.Open] = new PdfBoolean(value);}
    }

  //TODO:State and StateModel!!!
    #endregion
    #endregion
    #endregion
  }
}