SeCheckBox.cs

#region Header
/*
    ==============================================================================
      Author: Zoltan Hrabovszki <zh@openkeyword.de>

      Copyright © 2012, 2013, 2014, 2015 IT-Beratung Hrabovszki
      www.OpenKeyWord.de
    ============================================================================== 

    This file is part of OpenKeyWord.

    OpenKeyWord 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 3 of the License, or
    (at your option) any later version.

    OpenKeyWord is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with OpenKeyWord.  If not, see <http://www.gnu.org/licenses/>.

    Diese Datei ist Teil von OpenKeyWord.

    OpenKeyWord ist Freie Software: Sie können es unter den Bedingungen
    der GNU General Public License, wie von der Free Software Foundation,
    Version 3 der Lizenz oder (nach Ihrer Wahl) jeder späteren
    veröffentlichten Version, weiterverbreiten und/oder modifizieren.

    OpenKeyWord wird in der Hoffnung, dass es nützlich sein wird, aber
    OHNE JEDE GEWÄHRLEISTUNG, bereitgestellt; sogar ohne die implizite
    Gewährleistung der MARKTFÄHIGKEIT oder EIGNUNG FÜR EINEN BESTIMMTEN ZWECK.
    Siehe die GNU General Public License für weitere Details.

    Sie sollten eine Kopie der GNU General Public License zusammen mit 
    OpenKeyWord erhalten haben. Wenn nicht, siehe <http://www.gnu.org/licenses/>.
*/
#endregion Header

namespace OKW.GUI.Selenium
{
    using System;
    using System.Collections.Generic;

    using OKW.GUI;

    public class SeCheckBox : SeSimpleDataObjBase
    {
        #region Constructors

        public SeCheckBox(string Locator)
            : base(Locator)
        {
            this.LM = new LogMessenger("GUI");
        }
        
        public SeCheckBox( string fpsLocator, params OKWLocator[] fpLocators ) : base (fpsLocator, fpLocators)
        {
            this.LM = new LogMessenger("GUI");
        }
        #endregion Constructors

        #region Methods

        public virtual bool IsSelected()
        {
            bool bOK = false;
            bool lvbReturn = false;
            
            this.LogFunctionStartDebug("IsSelected");

            try
            {
                // Hole Zusand: Frei nach William Shakespeare: Häckchen oder kein Häckchen, das ist hier die Frage?
                lvbReturn = this.Me().Selected;
                bOK = true;
            }
            finally
            {
                if (bOK)
                {
                    this.LogFunctionEndDebug(lvbReturn);
                }
                else
                {
                    this.LogFunctionEndDebug( );
                }
            }

            return lvbReturn;
        }
        

        public virtual void Checking()
        {
            this.LogFunctionStartDebug("Checking");

            try
            {
                // Hab ich ein Häckchen?
                if (!this.IsSelected())
                {
                    // Nö, Häckchensetzen
                    //this.Me().Click();
                    this.ClickOn();
                }
            }
            finally
            {
                this.LogFunctionEndDebug();
            }

            return;
        }

        public override List<string> GetValue()
        {
            List<string> lvls_Return = new List<string>();
            bool bOK = false;
            try
            {
                this.LogFunctionStartDebug("GetValue");

                // Wenn das Objekt nicht existiert mit Exception beenden...
                if (!this.GetExists())
                {
                    string lvsLM = this.LM.GetMessage("Common", "OKWGUIObjectNotFoundException", "GetValue()");
                    throw new OKWGUIObjectNotFoundException(lvsLM);
                }

                if (this.IsSelected())
                {
                    string lvsValue = OKW_Const.Instance.GetConst4Internalname("CHECKED");
                    lvls_Return.Add(lvsValue);
                }
                else
                {
                    string lvsValue = OKW_Const.Instance.GetConst4Internalname("UNCHECKED");
                    lvls_Return.Add(lvsValue);
                }

                bOK = true;
            }
            finally
            {
                if (bOK)
                {
                    this.LogFunctionEndDebug();
                }
                else
                {
                    this.LogFunctionEndDebug(lvls_Return);
                }
            }

            return lvls_Return;
        }

        // public virtual void TypeKey(List<string> Values) -> SeAnyWin.TypeKey()
        // public virtual void Set Focus -> SeAnyWin.Set_Focus()
        public virtual void Select(List<string> fps_Values)
        {
            this.LogFunctionStartDebug("Select", "fps_Values", fps_Values.ToString());

            try
            {
                // Wenn das Objekt nicht existiert mit Exception beenden...
                if (!this.GetExists())
                {
                    string lvsLM = this.LM.GetMessage("Common", "OKWGUIObjectNotFoundException", "Select()");
                    throw new OKWGUIObjectNotFoundException(lvsLM + "\\Locator: >>" + this.Locator+ "<<");
                }

                // Sprachabhängige Werte holen
                string lvsCHECKED = OKW_Const.Instance.GetConst4Internalname("CHECKED");
                string lvsUNCHECKED = OKW_Const.Instance.GetConst4Internalname("UNCHECKED");

                if (fps_Values[0].ToUpper() == lvsCHECKED.ToUpper())
                {
                    this.Checking();
                }
                else if (fps_Values[0].ToUpper() == lvsUNCHECKED.ToUpper())
                {
                    this.UnChecking();
                }
                else
                {
                    // LANGUAGE: Exceptionmeldungen in eine Eigene xml Auslagern.
                    string lvsLM = this.LM.GetMessage("Common", "OKWNotAllowedValueException", fps_Values[0]);
                    throw new OKWNotAllowedValueException(lvsLM);
                }
            }
            finally
            {
                this.LogFunctionEndDebug();
            }

            return;
        }

        public virtual void UnChecking()
        {
            this.LogFunctionStartDebug("UnChecking");

            try
            {
                // Hab ich ein Häckchen?
                if (this.IsSelected())
                {
                    // Jepp: dann klicken und Häckchen weg...
                    this.ClickOn();
                }
            }
            finally
            {
                this.LogFunctionEndDebug();
            }

            return;
        }

        #endregion Methods
    }
}