SeAnyChildWindow.java

/*
    ==============================================================================
      Author: Zoltán Hrabovszki <zh@openkeyword.de>
 
      Copyright © 2012 - 2019 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/>.
*/
 
package okw.gui.adapter.selenium;
 
import java.util.*;
 
import okw.exceptions.OKWFrameObjectMethodNotImplemented;
import okw.exceptions.OKWGUIObjectNotFoundException;
import okw.gui.*;
import okw.gui.adapter.selenium.webdriver.SeDriver;
import okw.log.Logger_Sngltn;
import okw.LogMessenger;
import okw.OKW_Const_Sngltn;
 
import org.apache.commons.lang3.StringUtils;
import org.openqa.selenium.By;
import org.openqa.selenium.WebElement;
 
public class SeAnyChildWindow extends AnyChildwindow
{
    protected LogMessenger  LM       = new LogMessenger( "GUI" );
    
    //protected OKWLocatorXPath _locator = null;
    
    protected String        iframeID = null;
 
    public String get_iframeID() throws OKWGUIObjectNotFoundException
    {
        LogFunctionStartDebug( this.getClass().getSimpleName() + ".get_iframeID" );
 
        // Wenn die iframeID 
        if ( iframeID == null )
        {
            try
            {   
                String myLocator = this.getLocator();
                
                LogPrintDebug( "Find iframe ID for the Locator: '" + myLocator + "'..." );
                // ID ist noch nicht ermittelt -> ID Ermitteln
                String myiframeID = SeDriver.getInstance().getFrameID4Locator( myLocator );
                LogPrintDebug( "Frame ID found: '" + myiframeID + "'" );
 
                // Denn Aktuellen wert merken.
                set_iframeID( myiframeID );
            }
            finally
            {
                LogFunctionEndDebug( iframeID );
            }
        }
        else
        {
            LogFunctionEndDebug( iframeID );
        }
        
        return iframeID;
    }
 
    public void set_iframeID( String iframeID )
    {
        LogFunctionStartDebug( "SeAnyChildWindow.set_iframeID", "iframeID", iframeID );
        this.iframeID = iframeID;
        LogFunctionEndDebug( );
    }
 
    public SeAnyChildWindow( )
    {
        _locator = new OKWLocatorXPath( );
    }
    
    
    public SeAnyChildWindow( String fpsLocator, OKWLocatorBase... locators )
    {
        _locator = new OKWLocatorXPath( fpsLocator,  locators );
        this.iframeID = null;
    }
    
    
    public void ClickOn()
    {
        try
        {
            this.LogFunctionStartDebug( "ClickOn" );
 
            // Warten auf das Objekt. Wenn es nicht existiert wird mit OKWGUIObjectNotFoundException beendet...
            this.WaitForMe();
 
            this.Me().click();
        }
        finally
        {
            this.LogFunctionEndDebug();
        }
    }
 
    
    public ArrayList<String> getCaption()
    {
        ArrayList<String> lvLsReturn = new ArrayList<String>();
 
        try
        {
            this.LogFunctionStartDebug( "GetCaption" );
 
            // Warten auf das Objekt. Wenn es nicht existiert wird mit OKWGUIObjectNotFoundException beendet...
            this.WaitForMe();
 
            // The Attribute "textContent" wird als Beschriftung angezeigt...
            String myAttribute = this.Me().getAttribute( "textContent" );
            myAttribute = StringUtils.normalizeSpace( myAttribute );
            
            lvLsReturn.add( myAttribute );
        }
        finally
        {
            this.LogFunctionEndDebug( lvLsReturn );
        }
        return lvLsReturn;
    }
 
    public Boolean getExists()
    {
        Boolean lvbReturn = false;
        List<WebElement> meme = null;
 
        String myLocator = null;
 
        try
        {
            LogFunctionStartDebug( "getExists" );
 
            myLocator = this.getLocator();
 
            // Wenn iframe gesetz umschalten auf das iframe sonst zurücksetzten auf default.
            meme = SeDriver.getInstance().getElements( get_iframeID(), myLocator );
 
            if ( meme.size() == 0 )
            {
                lvbReturn = false;
            }
            else if ( meme.size() > 1 )
            {
                String lvsPrintMe = "Locator ist nicht eindeutig, es wurden mehrer GUI-Objekt gefunden: Locator: >>" + this.getLocator() + "<<";
                LogWarning( lvsPrintMe );
 
                lvbReturn = false;
            }
            else
            {
                lvbReturn = true;
            }
        }
        catch (OKWGUIObjectNotFoundException e)
        {
            LogPrintDebug( "OKWGUIObjectNotFoundException" );
            lvbReturn = false;
        }
        finally
        {
            LogFunctionEndDebug( lvbReturn );
        }
        return lvbReturn;
    }
 
    public Boolean getHasFocus()
    {
        Boolean lvbReturn = false;
 
        try
        {
            this.LogFunctionStartDebug( "getHasFocus" );
 
            // Warten auf das Objekt. Wenn es nicht existiert wird mit OKWGUIObjectNotFoundException beendet...
            this.WaitForMe();
 
            WebElement currentElement = SeDriver.getInstance().getDriver().switchTo().activeElement();
 
            lvbReturn = currentElement.equals( this.Me() );
        }
        finally
        {
            this.LogFunctionEndDebug( lvbReturn );
        }
 
        return lvbReturn;
    }
 
    public Boolean getIsActive()
    {
        Boolean lvbReturn = false;
        String lvDisabled = null;
 
        try
        {
            LogFunctionStartDebug( "getIsActive" );
 
            // Warten auf das Objekt. Wenn es nicht existiert wird mit OKWGUIObjectNotFoundException beendet...
            this.WaitForMe();
 
            lvDisabled = this.Me().getAttribute( "disabled" );
 
            if ( lvDisabled != null )
            {
                if ( lvDisabled.equals( "true" ) )
                    lvbReturn = false;
            }
            else
            {
                lvbReturn = true;
            }
 
        }
        finally
        {
            this.LogFunctionEndDebug( lvbReturn );
        }
 
        return lvbReturn;
    }
 
    public ArrayList<String> getLabel()
    {
        ArrayList<String> lvLsReturn = new ArrayList<String>();
 
        try
        {
            this.LogFunctionStartDebug( "getLabel" );
 
            // Warten auf das Objekt. Wenn es nicht existiert wird mit OKWGUIObjectNotFoundException beendet...
            this.WaitForMe();
 
            // 1. Schritt: Attribute "id" is shown as Tooltip...
            String lvsID = this.Me().getAttribute( "id" );
 
            // 2.schritt nun Tag Label mit for= "${lvsID}" finden.
            WebElement label = SeDriver.getInstance().getDriver().findElement( By.xpath( "//label[@for='" + lvsID + "']" ) );
            
            // The Attribute "textContent" wird als Beschriftung angezeigt...
            String myAttribute = label.getAttribute( "textContent" );
            myAttribute = StringUtils.normalizeSpace( myAttribute );
            
            lvLsReturn.add( myAttribute );
        }
        finally
        {
            this.LogFunctionEndDebug( lvLsReturn );
        }
 
        return lvLsReturn;
    }
 
 
    public ArrayList<String> getTooltip()
 
    {
        ArrayList<String> lvLsReturn = new ArrayList<String>();
 
        try
        {
            this.LogFunctionStartDebug( "GetTooltip" );
 
            // Warten auf das Objekt. Wenn es nicht existiert wird mit OKWGUIObjectNotFoundException beendet...
            this.WaitForMe();
 
            // The Attribute "title" is shown as Tooltip...
            String myAttribute = this.Me().getAttribute( "title" );
            myAttribute = StringUtils.normalizeSpace( myAttribute );
            
            lvLsReturn.add( myAttribute );
        }
        finally
        {
            this.LogFunctionEndDebug( lvLsReturn );
        }
 
        return lvLsReturn;
    }
 
    public ArrayList<String> getValue()
    {
        ArrayList<String> lvLsReturn = new ArrayList<String>();
 
        try
        {
            this.LogFunctionStartDebug( "getValue" );
 
            // Warten auf das Objekt. Wenn es nicht existiert wird mit OKWGUIObjectNotFoundException beendet...
            this.WaitForMe();
 
            // Get Value from TextField and put this into the return ArrayList<String>
            lvLsReturn.add( this.Me().getAttribute( "textContent" ) );
        }
        finally
        {
            this.LogFunctionEndDebug( lvLsReturn );
        }
 
        return lvLsReturn;
    }
 
    
    public ArrayList<String> LogCaption()
    {
        ArrayList<String> lvLsReturn = null;
 
        try
        {
            this.LogFunctionStartDebug( "LogCaption" );
 
            lvLsReturn = this.getCaption();
        }
        finally
        {
            this.LogFunctionEndDebug( lvLsReturn );
        }
        return lvLsReturn;
    }
 
    public boolean LogExists()
    {
        Boolean lvbReturn = null;
 
        try
        {
            this.LogFunctionStartDebug( "LogExists" );
 
            lvbReturn = this.getExists();
        }
        finally
        {
            this.LogFunctionEndDebug( lvbReturn );
        }
 
        return lvbReturn;
    }
 
    public boolean LogHasFocus()
    {
        Boolean lvbReturn = null;
 
        try
        {
            this.LogFunctionStartDebug( "LogHasFocus" );
 
            lvbReturn = this.getHasFocus();
        }
        finally
        {
            this.LogFunctionEndDebug( lvbReturn );
        }
 
        return lvbReturn;
    }
 
    public boolean LogIsActive()
    {
        Boolean lvbReturn = null;
 
        try
        {
            this.LogFunctionStartDebug( "LogIsActive" );
 
            lvbReturn = this.getIsActive();
        }
        finally
        {
            this.LogFunctionEndDebug( lvbReturn );
        }
 
        return lvbReturn;
    }
 
    public ArrayList<String> LogLabel()
    {
        ArrayList<String> lvLsReturn = null;
 
        try
        {
            this.LogFunctionStartDebug( "LogLabel" );
 
            lvLsReturn = this.getLabel();
        }
        finally
        {
            this.LogFunctionEndDebug( lvLsReturn );
        }
 
        return lvLsReturn;
    }
 
    public ArrayList<String> LogPlaceholder()
    {
        ArrayList<String> lvLsReturn = null;
 
        try
        {
            this.LogFunctionStartDebug( "LogLabel" );
 
            lvLsReturn = this.getLabel();
        }
        finally
        {
            this.LogFunctionEndDebug( lvLsReturn );
        }
 
        return lvLsReturn;
    }
 
    public ArrayList<String> LogTooltip()
    {
        ArrayList<String> lvLsReturn = null;
 
        try
        {
            this.LogFunctionStartDebug( "LogTooltip" );
 
            lvLsReturn = this.getTooltip();
        }
        finally
        {
            this.LogFunctionEndDebug( lvLsReturn );
        }
 
        return lvLsReturn;
    }
 
    public ArrayList<String> LogValue()
    {
        ArrayList<String> lvLsReturn = new ArrayList<String>();
 
        try
        {
            this.LogFunctionStartDebug( "LogValue" );
 
            lvLsReturn = this.getValue();
        }
        finally
        {
            this.LogFunctionEndDebug( lvLsReturn );
        }
 
        return lvLsReturn;
    }
 
    public WebElement Me()
    {
        WebElement me = null;
 
        me = SeDriver.getInstance().getElement( get_iframeID(), this.getLocator() );
 
        return me;
    }
 
    public ArrayList<String> MemorizeCaption()
    {
        ArrayList<String> lvLsReturn = null;
 
        try
        {
            this.LogFunctionStartDebug( "MemorizeCaption" );
 
            lvLsReturn = this.getCaption();
        }
        finally
        {
            this.LogFunctionEndDebug( lvLsReturn );
        }
 
        return lvLsReturn;
    }
 
    public boolean MemorizeExists()
    {
        Boolean lvbReturn = false;
 
        try
        {
            this.LogFunctionStartDebug( "MemorizeExists" );
 
            lvbReturn = this.getExists();
        }
        finally
        {
            this.LogFunctionEndDebug( lvbReturn );
        }
 
        return lvbReturn;
    }
 
    public boolean MemorizeHasFocus()
    {
        Boolean lvbReturn = null;
 
        try
        {
            this.LogFunctionStartDebug( "MemorizeHasFocus" );
 
            lvbReturn = this.getHasFocus();
        }
        finally
        {
            this.LogFunctionEndDebug( lvbReturn );
        }
 
        return lvbReturn;
    }
 
    public boolean MemorizeIsActive()
    {
        Boolean lvbReturn = false;
 
        try
        {
            LogFunctionStartDebug( "MemorizeIsActive" );
 
            lvbReturn = this.getIsActive();
        }
        finally
        {
            LogFunctionEndDebug( lvbReturn );
        }
 
        return lvbReturn;
    }
 
    public ArrayList<String> MemorizeLabel()
    {
        ArrayList<String> lvLsReturn = null;
 
        try
        {
            LogFunctionStartDebug( "MemorizeLabel" );
 
            lvLsReturn = this.getLabel();
        }
        finally
        {
            LogFunctionEndDebug( lvLsReturn );
        }
 
        return lvLsReturn;
    }
 
    public ArrayList<String> MemorizePlaceholder()
    {
        ArrayList<String> lvLsReturn = null;
 
        try
        {
            this.LogFunctionStartDebug( "MemorizePlaceholder" );
 
            lvLsReturn = this.getPlaceholder();
        }
        finally
        {
            this.LogFunctionEndDebug( lvLsReturn );
        }
 
        return lvLsReturn;
    }
 
    
    public ArrayList<String> MemorizeTooltip()
    {
        ArrayList<String> lvLsReturn = null;
 
        try
        {
            this.LogFunctionStartDebug( "MemorizeTooltip" );
 
            lvLsReturn = this.getTooltip();
        }
        finally
        {
            this.LogFunctionEndDebug( lvLsReturn );
        }
 
        return lvLsReturn;
    }
 
    public ArrayList<String> MemorizeValue()
    {
        ArrayList<String> lvLsReturn = new ArrayList<String>();
 
        try
        {
            this.LogFunctionStartDebug( "MemorizeValue" );
 
            lvLsReturn = this.getValue();
        }
        finally
        {
            this.LogFunctionEndDebug( lvLsReturn );
        }
 
        return lvLsReturn;
    }
 
    public Boolean _NotExists() throws Exception
    {
        LogFunctionStartDebug( "NotExists" );
        Boolean lvb_Return = null;
 
        try
        {
            this.Me();
            lvb_Return = false;
        }
        catch (NoSuchElementException e)
        {
            LogPrint( "NoSuchElementException" );
            lvb_Return = true;
        }
        finally
        {
            LogFunctionEndDebug( lvb_Return );
        }
        return lvb_Return;
    }
 
    public void Select( ArrayList<String> Values )
    {
 
        try
        {
            this.LogFunctionStartDebug( "Select" );
 
            String lvsLM = this.LM.GetMessage( "Common", "OKWFrameObjectMethodNotImplemented", "Select( ArrayList<String> )" );
            throw new OKWFrameObjectMethodNotImplemented( lvsLM );
        }
        finally
        {
            this.LogFunctionEndDebug();
        }
    }
 
    public void SelectMenu()
    {
        // ArrayList<String> lvLsReturn = new ArrayList<String>();
        try
        {
            this.LogFunctionStartDebug( "SelectMenu" );
 
            String lvsLM = this.LM.GetMessage( "Common", "OKWFrameObjectMethodNotImplemented", "SelectMenu()" );
            throw new OKWFrameObjectMethodNotImplemented( lvsLM );
        }
        finally
        {
            this.LogFunctionEndDebug();
        }
    }
 
    public void SelectMenu( ArrayList<String> Values )
    {
 
        try
        {
            this.LogFunctionStartDebug( "SelectMenu_Value" );
 
            String lvsLM = this.LM.GetMessage( "Common", "OKWFrameObjectMethodNotImplemented", "SelectMenu_Value()" );
            throw new OKWFrameObjectMethodNotImplemented( lvsLM );
        }
        finally
        {
            this.LogFunctionEndDebug();
        }
    }
 
    public void SetFocus() throws Exception
    {
 
        try
        {
            LogFunctionStartDebug( "SetFocus" );
 
            // Warten auf das Objekt. Wenn es nicht existiert wird mit OKWGUIObjectNotFoundException beendet...
            this.WaitForMe();
 
            this.Me().sendKeys( "" );
        }
        finally
        {
            LogFunctionEndDebug();
        }
    }
 
    public void SetValue( ArrayList<String> Values )
    {
 
        try
        {
            LogFunctionStartDebug( "SetValue" );
 
            String lvsLM = this.LM.GetMessage( "Common", "OKWGUIObjectNotFoundException", "SetValue()" );
            throw new OKWFrameObjectMethodNotImplemented( lvsLM );
        }
        finally
        {
            LogFunctionEndDebug();
        }
    }
 
    public void TypeKey( ArrayList<String> fps_Values )
    {
        try
        {
            LogFunctionStartDebug( "TypeKey", "fps_Values", fps_Values.toString() );
 
            // Warten auf das Objekt. Wenn es nicht existiert wird mit OKWGUIObjectNotFoundException beendet...
            this.WaitForMe();
 
            // We are using a local-Variable to prevent multiple call of Me() in foreach-loop
            WebElement lv_WebElement = this.Me();
 
            // Loop through all List-Values with foreach...
            for ( String Value : fps_Values )
            {
                Logger_Sngltn.getInstance().LogPrintDebug( ">>" + Value + "<<" );
 
                if ( Value.equals( OKW_Const_Sngltn.getInstance().GetOKWConst4Internalname( "DELETE" ) ) )
                {
                    lv_WebElement.clear();
                }
                else
                {
                    lv_WebElement.sendKeys( Value );
                }
            }
        }
        finally
        {
            LogFunctionEndDebug();
        }
    }
 
    public ArrayList<String> VerifyCaption()
    {
        ArrayList<String> lvLsReturn = new ArrayList<String>();
 
        try
        {
            this.LogFunctionStartDebug( "VerifyCaption" );
 
            // Nun mit dem erwarteten Sollwert und GetValue_TOOLTIP ggf. auf den Wert Warten.
            lvLsReturn = this.getCaption();
        }
        finally
        {
            this.LogFunctionEndDebug( lvLsReturn );
        }
 
        return lvLsReturn;
    }
 
    public Boolean VerifyExists()
    {
 
        Boolean lvbReturn = null;
 
        try
        {
            this.LogFunctionStartDebug( "VerifyExists" );
            lvbReturn = this.getExists();
        }
        finally
        {
            this.LogFunctionEndDebug( lvbReturn );
        }
 
        return lvbReturn;
    }
 
    public Boolean VerifyIsActive()
    {
 
        Boolean lvbReturn = null;
 
        try
        {
            LogFunctionStartDebug( "VerifyIsActive" );
 
            // Wert GetIsActive ggf. auf den erwarteten Wert warten.
            lvbReturn = this.getIsActive();
        }
        finally
        {
            LogFunctionEndDebug( lvbReturn );
        }
 
        return lvbReturn;
    }
 
    public Boolean VerifyHasFocus()
    {
        Boolean lvbReturn = false;
 
        try
        {
            this.LogFunctionStartDebug( "VerifyHasFocus" );
 
            lvbReturn = this.getHasFocus();
        }
        finally
        {
            this.LogFunctionEndDebug( lvbReturn );
        }
        return lvbReturn;
    }
 
    public ArrayList<String> VerifyLabel()
    {
        ArrayList<String> lvLsReturn = new ArrayList<String>();
 
        try
        {
            this.LogFunctionStartDebug( "VerifyLabel" );
 
            lvLsReturn = this.getLabel();
        }
        finally
        {
            this.LogFunctionEndDebug( lvLsReturn );
        }
 
        return lvLsReturn;
    }
 
 
     @Override
     public Integer VerifyMaxLength()
     {
         Integer lvLsReturn = null;
 
         try
         {
             this.LogFunctionStartDebug( "VerifyMaxLength" );
 
             lvLsReturn = this.getMaxLength();
         }
         finally
         {
             this.LogFunctionEndDebug( lvLsReturn.toString( ) );
         }
 
         return lvLsReturn;
     }
 
     
      @Override
      public Integer VerifyMinLength()
      {
          Integer lvLsReturn = null;
 
          try
          {
              this.LogFunctionStartDebug( "VerifyMinLength" );
 
              lvLsReturn = this.getMinLength();
          }
          finally
          {
              this.LogFunctionEndDebug( lvLsReturn.toString( ) );
          }
 
          return lvLsReturn;
      }     
 
     public ArrayList<String> VerifyPlaceholder()
     {
         ArrayList<String> lvLsReturn = new ArrayList<String>();
 
         try
         {
             this.LogFunctionStartDebug( "VerifyPlaceholder" );
 
             lvLsReturn = this.getPlaceholder();
         }
         finally
         {
             this.LogFunctionEndDebug( lvLsReturn );
         }
 
         return lvLsReturn;
     }
 
     
    public ArrayList<String> VerifyTooltip()
    {
        ArrayList<String> lvLsReturn = new ArrayList<String>();
 
        try
        {
            this.LogFunctionStartDebug( "VerifyTooltip" );
 
            lvLsReturn = this.getTooltip();
        }
        finally
        {
            this.LogFunctionEndDebug( lvLsReturn );
        }
 
        return lvLsReturn;
    }
 
    public ArrayList<String> VerifyValue()
    {
        ArrayList<String> lvLsReturn = null;
 
        try
        {
            this.LogFunctionStartDebug( "VerifyValue" );
 
            // get the Actual Value.
            lvLsReturn = this.getValue();
        }
        finally
        {
            this.LogFunctionEndDebug( lvLsReturn );
        }
 
        return lvLsReturn;
    }
 
    public Boolean WaitForMe()
    {
        Boolean lvbReturn = super.WaitForMe();
 
        if ( !lvbReturn )
        {
            ResOpenList( "GUI-Object not found..." );
            LogPrint( "Locator: '" + this.getLocator() + "'" );
            ResCloseList();
 
            String lvsLM = this.LM.GetMessage( "Common", "OKWGUIObjectNotFoundException", "WaitForMe()" );
            throw new OKWGUIObjectNotFoundException( lvsLM );
        }
        return lvbReturn;
    }}