mmarquee.automation.pattern.Text Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ui-automation Show documentation
Show all versions of ui-automation Show documentation
A Java library that wraps the MS UIAutomation library.
/*
* Copyright 2016-17 [email protected]
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package mmarquee.automation.pattern;
import com.sun.jna.platform.win32.COM.COMUtils;
import com.sun.jna.platform.win32.COM.Unknown;
import com.sun.jna.platform.win32.Guid;
import com.sun.jna.platform.win32.WinNT;
import com.sun.jna.ptr.IntByReference;
import com.sun.jna.ptr.PointerByReference;
import mmarquee.automation.AutomationException;
import mmarquee.automation.Element;
import mmarquee.automation.PatternID;
import mmarquee.automation.PropertyID;
import mmarquee.uiautomation.*;
/**
* Wrapper for the text pattern.
*
* @author Mark Humphreys
* Date 25/02/2016.
*/
public class Text extends BasePattern {
/**
* Constructor for the text pattern.
*
* @param element The automation element for which the pattern is valid
* @throws AutomationException If something goes wrong
*/
public Text(final Element element) throws AutomationException {
super(element);
this.IID = IUIAutomationTextPattern.IID;
this.patternID = PatternID.Text;
this.availabilityPropertyID = PropertyID.IsTextPatternAvailable;
}
/**
* The raw pattern.
*/
IUIAutomationTextPattern rawPattern;
/**
* Gets the pattern.
*
* @return The pattern
* @throws AutomationException Error in automation library
*/
private IUIAutomationTextPattern getPattern() throws AutomationException {
return getPattern(rawPattern, this::convertPointerOfTextPatternToInterface);
}
/**
* Converts the raw pointer to interface.
*
* @param pUnknownA The raw pointer
* @return The converted interface
*/
IUIAutomationTextPattern convertPointerOfTextPatternToInterface(
final PointerByReference pUnknownA) {
return IUIAutomationTextPatternConverter.pointerToInterface(pUnknownA);
}
/**
* Converts the raw pointer to array interface.
*
* @param pUnknownA The raw pointer
* @return The converted interface
*/
IUIAutomationTextRangeArray convertPointerToArrayInterface(
final PointerByReference pUnknownA) {
return IUIAutomationTextRangeArrayConverter.pointerToInterface(pUnknownA);
}
/**
* Gets the selection.
*
* @return String of the selection
* @throws AutomationException Something has gone wrong
*/
public String getSelection() throws AutomationException {
PointerByReference pbr = new PointerByReference();
final int res = this.getPattern().getSelection(pbr);
if (res != 0) {
throw new AutomationException(res);
}
Unknown unkConditionA = makeUnknown(pbr.getValue());
PointerByReference pUnknownA = new PointerByReference();
String selectionResult = "";
WinNT.HRESULT resultA = unkConditionA.QueryInterface(new Guid.REFIID(IUIAutomationTextRangeArray.IID), pUnknownA);
if (COMUtils.SUCCEEDED(resultA)) {
IUIAutomationTextRangeArray selection =
convertPointerToArrayInterface(pUnknownA);
// OK, now what?
IntByReference ibr = new IntByReference();
final int res1 = selection.getLength(ibr);
if (res1 != 0) {
throw new AutomationException(res1);
}
int count = ibr.getValue();
for (int i = 0; i < count; i++) {
PointerByReference pbr0 = new PointerByReference();
final int res2 = selection.getElement(i, pbr0);
if (res2 != 0) {
throw new AutomationException(res2);
}
Unknown unknown = makeUnknown(pbr0.getValue());
PointerByReference pUnknown = new PointerByReference();
WinNT.HRESULT result = unknown.QueryInterface(new Guid.REFIID(IUIAutomationTextRange.IID), pUnknown);
if (COMUtils.SUCCEEDED(result)) {
IUIAutomationTextRange range =
convertPointerToInterface(pUnknown);
PointerByReference sr = new PointerByReference();
final int res3 = range.getText(-1, sr);
if (res3 != 0) {
throw new AutomationException(res3);
}
selectionResult = sr.getValue().getWideString(0);
} else {
throw new AutomationException(result.intValue());
}
}
} else {
throw new AutomationException(resultA.intValue());
}
return selectionResult;
}
/**
* Gets the text from the pattern.
*
* @return The text.
* @throws AutomationException Something has gone wrong
*/
public String getText() throws AutomationException {
PointerByReference pbr = new PointerByReference();
final int res = this.getPattern().getDocumentRange(pbr);
if (res != 0) {
throw new AutomationException(res);
}
Unknown unkConditionA = makeUnknown(pbr.getValue());
PointerByReference pUnknownA = new PointerByReference();
WinNT.HRESULT resultA = unkConditionA.QueryInterface(new Guid.REFIID(IUIAutomationTextRange.IID), pUnknownA);
if (COMUtils.SUCCEEDED(resultA)) {
IUIAutomationTextRange range = convertPointerToInterface(pUnknownA);
PointerByReference sr = new PointerByReference();
final int res1 = range.getText(-1, sr);
if (res1 != 0) {
throw new AutomationException(res1);
}
return sr.getValue().getWideString(0);
} else {
throw new AutomationException(resultA.intValue());
}
}
/**
* Converts the pointer to the interface.
*
* @param pUnknownA The raw pointer
* @return Error in automation library
*/
IUIAutomationTextRange convertPointerToInterface(
final PointerByReference pUnknownA) {
return IUIAutomationTextRangeConverter.pointerToInterface(pUnknownA);
}
}