Widget.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>Widget annotation [PDF:1.6:8.4.5].</summary>
  */
  public class Widget
    : Annotation
  {
    #region types
    /**
      <summary>Highlighting mode [PDF:1.6:8.4.5].</summary>
    */
    public enum HighlightModeEnum
    {
      /**
        <summary>No highlighting.</summary>
      */
      None,
      /**
        <summary>Invert the contents of the annotation rectangle.</summary>
      */
      Invert,
      /**
        <summary>Invert the annotation's border.</summary>
      */
      Outline,
      /**
        <summary>Display the annotation's down appearance.</summary>
      */
      Push,
      /**
        <summary>Same as Push (which is preferred).</summary>
      */
      Toggle
    };
    #endregion

    #region static
    #region fields
    private static readonly Dictionary<HighlightModeEnum,PdfName> HighlightModeEnumCodes;
    #endregion

    #region constructors
    static Widget()
    {
      HighlightModeEnumCodes = new Dictionary<HighlightModeEnum,PdfName>();
      HighlightModeEnumCodes[HighlightModeEnum.None] = PdfName.N;
      HighlightModeEnumCodes[HighlightModeEnum.Invert] = PdfName.I;
      HighlightModeEnumCodes[HighlightModeEnum.Outline] = PdfName.O;
      HighlightModeEnumCodes[HighlightModeEnum.Push] = PdfName.P;
      HighlightModeEnumCodes[HighlightModeEnum.Toggle] = PdfName.T;
    }
    #endregion

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

    /**
      <summary>Gets the highlighting mode corresponding to the given value.</summary>
    */
    private static HighlightModeEnum ToHighlightModeEnum(
      PdfName value
      )
    {
      foreach(KeyValuePair<HighlightModeEnum,PdfName> mode in HighlightModeEnumCodes)
      {
        if(mode.Value.Equals(value))
          return mode.Key;
      }
      return HighlightModeEnum.Invert;
    }
    #endregion
    #endregion
    #endregion

    #region dynamic
    #region constructors
    public Widget(
      Page page,
      RectangleF box
      ) : base(
        page.Document,
        PdfName.Widget,
        box,
        page
        )
    {FlagsEnum flags = Flags; flags |= FlagsEnum.Print; Flags = flags;}

    public Widget(
      PdfDirectObject baseObject,
      PdfIndirectObject container
      ) : base(baseObject,container)
    {}
    #endregion

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

    public override AnnotationActions Actions
    {
      get
      {
        PdfDirectObject actionsObject = BaseDataObject[PdfName.AA];
        if(actionsObject == null)
          return null;

        return new WidgetActions(this,actionsObject,Container);
      }
      set
      {base.Actions = value;}
    }

    /**
      <summary>Gets/Sets the annotation's appearance characteristics
      to be used for its visual presentation on the page.</summary>
    */
    public AppearanceCharacteristics AppearanceCharacteristics
    {
      get
      {
        /*
          NOTE: 'MK' entry may be undefined.
        */
        PdfDirectObject appearanceObject = BaseDataObject[PdfName.MK];
        if(appearanceObject == null)
          return null;

        return new AppearanceCharacteristics(appearanceObject,Container);
      }
      set
      {BaseDataObject[PdfName.MK] = value.BaseObject;}
    }

    /**
      <summary>Gets/Sets the annotation's highlighting mode, the visual effect to be used
      when the mouse button is pressed or held down inside its active area.</summary>
    */
    public HighlightModeEnum HighlightMode
    {
      get
      {return ToHighlightModeEnum((PdfName)BaseDataObject[PdfName.H]);}
      set
      {BaseDataObject[PdfName.H] = ToCode(value);}
    }
    #endregion
    #endregion
    #endregion
  }
}