Windows Control API | QF-Test Handbuch

Die Elemente von nativen Windows-Anwendungen werden im Test durch Java-Objekte der Klasse WinControl repräsentiert. Diese stellt zum Beispiel für die Entwicklung eigener Resolver verschiedene Methoden öffentlich zur Verfügung.

Es folgt eine alphabetische Aufstellung aller Methoden der WinControl Klasse.


`WinControl getAncestorByUiaType(String typeName)`
Sucht ein Vorgänger-Control mit dem angegeben UIAutomation-Typ.
Parameter
`typeName`	Der Typ als Suchkriterium.
Rückgabewert	Der Vorgänger oder `null`.

`WinControl getChild(int index)`
Liefert das Kind des Controls mit dem angegebenen Index.
Parameter
`index`	Der Index des Kind-Controls.
Rückgabewert	Das Kind.
Exceptions
`IllegalArgumentException`	Wenn der Index negativ ist oder größer/gleich der Anzahl der Kind-Controls.

`int getChildCount()`
Liefert die Anzahl an Kind-Controls.
Rückgabewert	Die Anzahl der Kind-Controls.

`WinControl[] getChildren()`
Liefert alle Kind-Controls des `WinControls`.
Rückgabewert	Ein Array mit allen Kind-Controls.

`WinControl[] getChildrenByUiaClassName(String className)`
Liefert alle Kinder des Controls mit dem angegebenen UIAutomation-Klassennamen.
Parameter
`className`	Der Klassenname.
Rückgabewert	Ein Array mit den Kind-Controls.

`WinControl[] getChildrenByUiaType(String typeName)`
Liefert alle Kinder des Controls mit dem angegebenen UIAutomation-Typs.
Parameter
`typeName`	Der UIAutomation-Typ.
Rückgabewert	Ein Array mit den Kind-Controls.

`WinControl[] getElementsByClassName(String className)`
Liefert alle untergeordneten Controls zurück, die den angegeben Klassennamen haben.
Parameter
`className`	Der Klassenname als Suchkriterium.
Rückgabewert	Ein Array von `WinControl` Objekten, welche das aktuelle Control als Vorgänger und den angegebenen Klassennamen haben.

`WinControl[] getElementsByClassName(String[] classNames)`
Liefert alle untergeordneten Controls zurück, die einen der angegeben Klassennamen haben.
Parameter
`classNames`	Passende Klassennamen als Suchkriterium.
Rückgabewert	Ein Array von `WinControl` Objekten, welche das aktuelle Control als Vorgänger und einen der angegebenen Klassennamen haben.

`WinControl[] getElementsByClassName(String[] classNames, String[] stopClassNames)`
Liefert alle untergeordneten Controls zurück, die einen der angegeben Klassennamen haben, aber bricht die Suche bei jedem Control ab, welches einen Klassennamen aus `stopClassNames` hat.
Parameter
`classNames`	Passende Klassennamen als Suchkriterium.
`stopClassNames`	Klassennamen als Stop-Kriterium für die Tiefensuche.
Rückgabewert	Ein Array mit passenden Nachfolger-Controls.

`String[] getGenericClassNames()`
Liefert die generischen Klassennamen des Controls.
Rückgabewert	Ein String-Array mit den Klassennamen des Controls.

`int getHwnd()`
Liefert das native Windows-Handle des Controls.
Rückgabewert	Das native Windows-Handle.

`int[] getLocation()`
Liefert die (physikalische) Pixel-Position des Controls in seinem Eltern-Control.
Rückgabewert	Ein Array mit den X- und Y-Koordinaten.

`int[] getLocationOnScreen()`
Liefert die (physikalische) Pixel-Position des Controls auf dem Bildschirm.
Rückgabewert	Ein Array mit den X- und Y-Koordinaten, der Breite und der Höhe.

`WinControl getNextSibling()`
Liefert den nächsten Nachbarn des Controls zurück.
Rückgabewert	Das nächste Nachbar-Control oder `null`, wenn es keine weiteren Nachbarn mehr gibt.

`String getPatterns()`
Liefert alle Pattern des Controls (mit Leerzeichen getrennt). Die Methode `hasPattern()` ist zu bevorzugen, damit man nicht mit dem genauen Format des Strings arbeiten muss.
Rückgabewert	Eine Zeichenkette mit den Pattern.

`int[] getSize()`
Liefert die (physikalische) Größe des Elements.
Rückgabewert	Ein Feld mit der Breite und Höhe.

`String getTextOrValue()`
Liefert den "Wert" eines Elements, der sich meist aus dem Value- oder Text-Pattern ergibt, falls verfügbar. Der Wert kann sich aus dem Text der Kind-Controls oder in einigen Fällen aus dem Automation Name ergeben.
Rückgabewert	Ein Wert oder `null`.

`WinControl getTopAncestor()`
Liefert den obersten Vorgänger des Controls.
Rückgabewert	Der obersten Vorgänger oder `null`.

`String getUiaClassName()`
Liefert den Klassennamen des `WinControl`s. Dieser ergibt sich aus dem UIAutomation-Klassennamen, dem ein PRefix vorangestellt ist, um Verwechslungen mit den generischen QF-Test Klassennamen vorzubeugen.
Rückgabewert	Eine Zeichenkette mit dem Klassennamen des Controls.

`AutomationBase getUiaControl()`
Erstellt für das `WinControl` ein `AutomationBase`, welches dann mit der `uiauto`-Skriptbibliothek verwendet werden kann (Kapitel 52).
Rückgabewert	Das `AutomationBase`-Objekt.

`String getUiaDescription()`
Liefert die UIAutomation-Beschreibung des Controls. Wenn es keine FullDescription gibt, wird als Fallback die Beschreibung aus der Accessibility Schnittstelle zurückgeliefert.
Rückgabewert	Die Beschreibung oder ein leerer String.

`String getUiaHelp()`
Liefert den Hilfetext des Controls.
Rückgabewert	Der Hilfetext oder ein leerer String.

`String getUiaId()`
Liefert die UIAutomation-ID des Controls.
Rückgabewert	Die ID, wenn gesetzt, sonst `null`.

`String getUiaName()`
Liefert den UIAutomation-Name des Controls.
Rückgabewert	Der Name, falls gesetzt, sonst `null`.

`String getUiaType()`
Liefert den Typ des `WinControl`s. Dieser ergibt sich aus dem Namen des UIAutomation-Typs, ergänzt um ein Präfix `Uia.`, um Verwechslungen mit den generischen QF-Test Klassennamen vorzubeugen.
Rückgabewert	Eine Zeichenkette mit dem Typ des Controls.

`boolean hasPattern(String pattern)`
Überprüft, ob das zugrundeliegende Automation Element das angegebene Pattern unterstützt.
Parameter
`pattern`	Das Pattern, z.B. "Invoke", "ExpandCollapse" usw.
Rückgabewert	`true` wenn das Element das Pattern unterstützt, sonst `false`.

`boolean isMatchingClass(String className)`
Prüft, ob dem Cantrol die angegebene Klasse zugeordnet ist.
Parameter
`className`	Der zu prüfende Klassenname.
Rückgabewert	`true` wenn dem Control die angegebene Klasse zugeordnet ist, sonst `false`.

`boolean isMatchingClass(String[] classNames)`
Prüft, ob das Cantrol eine der angegebenen Klassen zugeordnet ist.
Parameter
`classNames`	Die zu prüfende Klassennamen.
Rückgabewert	`true` wenn dem Control eine der angegebenen Klassen zugeordnet ist, sonst `false`.

`boolean isShowing()`
Liefert die Sichtbarkeit des Elements.
Rückgabewert	`true`, wenn das Control als "Sichtbar auf dem Bildschirm" angesehen wird, sonst `false`.