okw.gui.AnyWinBase Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of core Show documentation
This is the core-module of OpenKeyWord. This module is automatically integrated by the adapters. In GUI automation, the core module is automatically integrated by the GUI modules (dependencies).
The newest version!
/*
==============================================================================
  Author: Zoltán Hrabovszki 

  Copyright © 2012 - 2020, 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 .

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 .
 */
package okw.gui;

import okw.exceptions.OKWFrameObjectMethodNotImplemented;
import okw.log.*;

/** \brief
 * Description of AnyWin.
 */ 
public abstract class AnyWinBase
{
	private Logger_Sngltn myLogger = Logger_Sngltn.getInstance();

	protected OKWLocator _locator = null;

	/** \~german
	 *  CAT - Categorie Name des aktuellen GUI-Objektes.
	 *  
	 *  Wert wird 
	 *  
	 *  \~english
	 *  CAT - Category Name of the current GUI object.
	 *  
	 *  \~
	 *  @author Zoltán Hrabovszki
	 *  \date 2014.04.27
	 */    
	private String myCAT = "";


	/** \~german
	 *  Parent-Objekt FN des aktuellen GUI-Objektes.
	 *  
	 *  \~english
	 *  \brief
	 *  @todo TODO:  Übersetzung ins Englische fehlt...
	 *  
	 *  \~
	 *  @author Zoltán Hrabovszki
	 *  \date 2016.11.20
	 */    
	private String myKN = "";


	/** \~german
	 *  Parent-Objekt FN des aktuellen GUI-Objektes.
	 *  
	 *  \~english
	 *  \brief
	 *  @todo TODO:  Übersetzung ins Englische fehlt...
	 *  
	 *  \~
	 *  @author Zoltán Hrabovszki
	 *  \date 2016.11.20
	 */    
	private String myParentFN = "";


	/** \~german
	 *  Holt den vollständig (rekursiv) aufgelösten  (z.B. XPath-Wert) des Locators.
	 *  
	 *  Beim Aufruf dieser Methode wird der Locator vollständig neu berechnet und der aktuelle Wert zurückgeliefert.
	 *  (Dynamischer Locator)
	 *  
	 *  @return Aktueller Wert des Locators
	 *  
	 *  \~english
	 *  \brief
	 *  @todo TODO:  Übersetzung ins Englische fehlt...
	 *  
	 *  \~
	 *  @author Zoltán Hrabovszki
	 *  \date 2014.04.27
	 */
	public String getLocator()
	{
		return _locator.getLocator();
	}


	/** \~german
	 *  Holt die Refrenz auf den (OKWLocator) den Locator selbst.
	 *   
	 *  \~english
	 *  \brief
	 *  @todo TODO:  Übersetzung ins Englische fehlt...
	 *  
	 *  \~
	 *  @author Zoltán Hrabovszki
	 *  \date 2014.04.27
	 */  
	public OKWLocatorBase getLOCATOR()
	{
		return _locator;
	}


	/** \~german
	 *  Setzt den Locator für den aktuellen GUI-Adapter.
	 *   
	 *  \~english
	 *  \brief
	 *  @todo TODO:  Übersetzung ins Englische fehlt...
	 *  
	 *  \~
	 *  @author Zoltán Hrabovszki
	 *  \date 2014.04.27
	 */  
	public void setLocator( String fpsLocator, OKWLocatorBase... fpLocators )
	{
		_locator.setLocator( fpsLocator, fpLocators );
	}


	/** \~german
	 *  Prüft die Existenz des aktuellen Objektes.
	 *  
	 *  - Methode kann hier nicht implementiert werden.
	 *  - Hier wird die Ausnahme OKWFrameObjectMethodNotImplemented ausgelöst.
	 *  
	 *  Hinweis zur Implementierung:
	 *  - Implementierung durcg Methoden überschreiung in den GUI-Klassen.
	 *  - Ist eine elementare Funktion, muss Werkzeugspezifisch (für Selenium, AutoIt, SilkTets usw.) defiert sein/werden.
	 *  - Warten nicht auf die Existenz eines Objektes!
	 *  - Es wird nur ein eiziges mal die Existenz geprüft.
	 *  - Es wird keine Ausnahme ausgelöst, wenn das Object nicht vorhanden ist!
	 *  
	 *  @return true, falls das eindeutig Objekt gefunden worden ist ist, sonst false.
	 *  \~
	 *  @author Zoltán Hrabovszki
	 *  \date 2017.01.31
	 */  
	public Boolean getExists()
	{
		// TODO: /todo Meldung in xml-Auslagern
		throw new OKWFrameObjectMethodNotImplemented("The method getExists() is not definden for you GUI-Object. Please define first the methode!");
	}

	public AnyWinBase( )
	{
		_locator = new OKWLocator( );
	}


	public AnyWinBase(String fpsLocator, OKWLocatorBase... fpLocators )
	{
		if ( fpLocators.length != 0 )
		{
			this._locator = new OKWLocator(fpsLocator, fpLocators);
		}
		else
		{
			this._locator = new OKWLocator(fpsLocator);
		}
	}

	public void ResOpenList( String fps_Name )
	{
		myLogger.ResOpenList( fps_Name );
	}

	public void ResOpenListDebug( String fps_Name )
	{
		myLogger.ResOpenListDebug( fps_Name );
	}

	public void ResCloseList( )
	{
		myLogger.ResCloseList( );
	}

	public void ResCloseListDebug( )
	{
		myLogger.ResCloseListDebug( );
	}

	public void LogPrint( String fps_Message )
	{
		myLogger.LogPrint( fps_Message );
	}

	public void LogPrintDebug( String fps_Message )
	{
		myLogger.LogPrintDebug( fps_Message );
	}

	public void LogWarning( String fps_Message )
	{
		myLogger.LogWarning( fps_Message );
	}

	public void LogVerifyError(String fps_Expected, String fps_Actual )
	{
		myLogger.LogVerifyError(fps_Expected, fps_Actual);;
	}

	public void LogException(String fps_Message)
	{
		myLogger.LogException(fps_Message);
	}
	
	
	/** \~german
	 *  Holt den Categorie Namen des GUI-Objektes.
	 * 
	 *  Hinweis: Die GUI-Adapter kennen ihre eigenen Kategorie-Namen.
	 *  Dieser wird beim Instanzieren der Frame-Objekte während des Frame-Klassen-Skans
	 *  in der Methode FrameObjectDictionary_Sngltn.FrameScan() gelesen und im Objekt gespeichet.
	 *  
	 *  \~english
	 *  Note: The GUI adapters know their own category names.
	 *  This is read in the method FrameObjectDictionary_Sngltn.FrameScan()
	 *  when the frame objects are instantiated during the frame class scan and stored in the object.
	 *  
	 *  \~
	 *  @author Zoltán Hrabovszki
	 *  \date 2014.04.27
	 */  
	public String getCAT( )
	{
		return this.myCAT;
	}

	/** \~german
	 *  Setzt das KN (KeyName) des GUI-Objektes.
	 *  
	 *  KN ist bei Fenstern nur der "WindowName" des Fensters und bei Kindobjekten Besteht dieser aus "WindowName.ChildName" 
	 *  
	 *  @return KN (KeyName) des GUI-Objektes. "WindowName" oder "WindowName.ChildName"
	 *  
	 *  \~english
	 *  @todo TODO:  Übersetzung ins Englische fehlt...
	 *  
	 *  \~
	 *  @author Zoltán Hrabovszki
	 *  \date 2016.11.20
	 */ 
	public String getKN( )
	{
		return this.myKN;
	}

	/** \~german
	 *  Setzten des Parent-Objekt FN.
	 *  
	 *  @return FN des Parent-Objektes.
	 *  
	 *  \~english
	 *  \brief
	 *  @todo TODO:  Übersetzung ins Englische fehlt...
	 *  
	 *  \~
	 *  @author Zoltán Hrabovszki
	 *  \date 2016.11.20
	 */ 
	public String getParentFN( )
	{
		return this.myParentFN;
	}


	public void setCAT(String fpsCAT)
	{
		this.myCAT =  fpsCAT;
	}

	/** \~german
	 *  Setzten des Keyname FN.
	 *  
	 *  @fpsParentFN KN des Objektes
	 *  
	 *  \~english
	 *  \brief
	 *  @todo TODO:  Übersetzung ins Englische fehlt...
	 *  
	 *  \~
	 *  @author Zoltán Hrabovszki
	 *  \date 2016.11.20
	 */    
	public void setKN(String fpsKN)
	{
		this.myKN =  fpsKN;
	}

	/** \~german
	 *  Setzten des Parent-Objekt FN.
	 *  
	 *  @fpsParentFN FN des Parent-Objektes
	 *  
	 *  \~english
	 *  \brief
	 *  @todo TODO:  Übersetzung ins Englische fehlt...
	 *  
	 *  \~
	 *  @author Zoltán Hrabovszki
	 *  \date 2016.11.20
	 */    
	public void setParentFN(String fpsParentFN)
	{
		this.myParentFN =  fpsParentFN;
	}
}