ChoiceField.cs :  » PDF » PDF-Clown » it » stefanochizzolini » clown » documents » interaction » forms » 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.annotations;
using it.stefanochizzolini.clown.files;
using it.stefanochizzolini.clown.objects;

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

namespace it.stefanochizzolini.clown.documents.interaction.forms{
  /**
    <summary>Choice field [PDF:1.6:8.6.3].</summary>
  */
  public abstract class ChoiceField
    : Field
  {
    #region dynamic
    #region constructors
    /**
      <summary>Creates a new choice field within the given document context.</summary>
    */
    protected ChoiceField(
      string name,
      Widget widget
      ) : base(
        PdfName.Ch,
        name,
        widget
        )
    {}

    protected ChoiceField(
      PdfDirectObject baseObject
      ) : base(baseObject)
    {}
    #endregion

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

    public ChoiceItems Items
    {
      get
      {
        /*
          NOTE: 'Opt' entry may be undefined [PDF:1.6:8.6.3].
        */
        PdfArray items = (PdfArray)File.Resolve(BaseDataObject[PdfName.Opt]);
        if(items == null)
          return null;

        return new ChoiceItems(
          items,
          Container
          );
      }
      set
      {BaseDataObject[PdfName.Opt] = value.BaseObject;}
    }

    /**
      <summary>Gets/Sets whether more than one of the field's items may be selected simultaneously.</summary>
    */
    public bool MultiSelect
    {
      get
      {return ((Flags & FlagsEnum.MultiSelect) == FlagsEnum.MultiSelect);}
      set
      {
        FlagsEnum flags = Flags;
        if(value)
        {flags |= FlagsEnum.MultiSelect;}
        else
        {flags ^= FlagsEnum.MultiSelect;}
        Flags = flags;
      }
    }

    /**
      <summary>Gets/Sets whether validation action is triggered as soon as a selection is made,
      without requiring the user to exit the field.</summary>
    */
    public bool ValidatedOnChange
    {
      get
      {return ((Flags & FlagsEnum.CommitOnSelChange) == FlagsEnum.CommitOnSelChange);}
      set
      {
        FlagsEnum flags = Flags;
        if(value)
        {flags |= FlagsEnum.CommitOnSelChange;}
        else
        {flags ^= FlagsEnum.CommitOnSelChange;}
        Flags = flags;
      }
    }
    #endregion
    #endregion
    #endregion
  }
}