MobileScreenCaptor (com.kms.katalon.core.mobile)

com.kms.katalon.core.mobile.helper.MobileScreenCaptor

public class MobileScreenCaptor
extends com.kms.katalon.core.helper.screenshot.ScreenCaptor

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected io.appium.java_client.AppiumDriver<?>`	`getAnyAppiumDriver()`
	`public static org.openqa.selenium.Rectangle`	`getBoundedRect(org.openqa.selenium.WebElement element, float scaleFactor, int statusBarHeight)` Get the actual rectangle that bounds the element.
	`public static BufferedImage`	`hideElements(BufferedImage screenshot, io.appium.java_client.AppiumDriver<? extends org.openqa.selenium.WebElement> driver, List<com.kms.katalon.core.testobject.TestObject> ignoredElements, Color hideColor, float scaleFactor, int statusBarHeight)` Hide elements by drawing overlap color layer.
	`protected boolean`	`internalSwitchToContext(io.appium.java_client.AppiumDriver<?> driver, String contextName)`
	`protected boolean`	`internalSwitchToNativeContext(io.appium.java_client.AppiumDriver<?> driver)`
	`public static BufferedImage`	`removeStatusBar(BufferedImage screenshot, int statusBarHeight)`
	`protected void`	`take(File newFile)` Takes screenshot by using org.openqa.selenium.TakesScreenshot#getScreenshotAs(org.openqa.selenium.OutputType).
	`public static BufferedImage`	`takeAreaScreenshot(io.appium.java_client.AppiumDriver<? extends org.openqa.selenium.WebElement> driver, org.openqa.selenium.Rectangle rect, List<com.kms.katalon.core.testobject.TestObject> ignoredElements, Color hidingColor)`
	`public static BufferedImage`	`takeElementScreenshot(io.appium.java_client.AppiumDriver<? extends org.openqa.selenium.WebElement> driver, com.kms.katalon.core.testobject.TestObject to, List<com.kms.katalon.core.testobject.TestObject> ignoredElements, Color hidingColor)`
	`public static String`	`takeScreenshot(io.appium.java_client.AppiumDriver<? extends org.openqa.selenium.WebElement> driver, String fileName)`
	`protected static BufferedImage`	`takeScreenshot(io.appium.java_client.AppiumDriver<? extends org.openqa.selenium.WebElement> driver)`
	`public static BufferedImage`	`takeViewportScreenshot(io.appium.java_client.AppiumDriver<? extends org.openqa.selenium.WebElement> driver, List<com.kms.katalon.core.testobject.TestObject> ignoredElements, Color hidingColor)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class com.kms.katalon.core.helper.screenshot.ScreenCaptor`	com.kms.katalon.core.helper.screenshot.ScreenCaptor#takeScreenshotAndGetAttributes(boolean), com.kms.katalon.core.helper.screenshot.ScreenCaptor#wait(long, int), com.kms.katalon.core.helper.screenshot.ScreenCaptor#wait(), com.kms.katalon.core.helper.screenshot.ScreenCaptor#wait(long), com.kms.katalon.core.helper.screenshot.ScreenCaptor#equals(java.lang.Object), com.kms.katalon.core.helper.screenshot.ScreenCaptor#toString(), com.kms.katalon.core.helper.screenshot.ScreenCaptor#hashCode(), com.kms.katalon.core.helper.screenshot.ScreenCaptor#getClass(), com.kms.katalon.core.helper.screenshot.ScreenCaptor#notify(), com.kms.katalon.core.helper.screenshot.ScreenCaptor#notifyAll()

- Method Detail
  - protected io.appium.java_client.AppiumDriver<?> getAnyAppiumDriver()
  - public static org.openqa.selenium.Rectangle getBoundedRect(org.openqa.selenium.WebElement element, float scaleFactor, int statusBarHeight)
    
    Get the actual rectangle that bounds the element. Returned rectangle is affected by device pixel ratio.
    Parameters:
    driver - AppiumDriver that the element is linked to.
    element - The element that you want to get the rectangle.
    Returns:
    a rectangle in actual size that bounds the elements.
  - public static BufferedImage hideElements(BufferedImage screenshot, io.appium.java_client.AppiumDriver<? extends org.openqa.selenium.WebElement> driver, List<com.kms.katalon.core.testobject.TestObject> ignoredElements, Color hideColor, float scaleFactor, int statusBarHeight)
    
    Hide elements by drawing overlap color layer. Get the actual rectangle that bounds the element. Returned rectangle is
    Parameters:
    screenshot - the screenshot that need to hide elements
    driver - AppiumDriver used to detect hidden elements
    ignoredElements - hidden elements
    hideColor - color used to draw overlap layer.
    Returns:
    BufferedImage that all elements is hidden.
  - protected boolean internalSwitchToContext(io.appium.java_client.AppiumDriver<?> driver, String contextName)
  - protected boolean internalSwitchToNativeContext(io.appium.java_client.AppiumDriver<?> driver)
  - public static BufferedImage removeStatusBar(BufferedImage screenshot, int statusBarHeight)
  - @Override protected void take(File newFile)
    
    Takes screenshot by using org.openqa.selenium.TakesScreenshot#getScreenshotAs(org.openqa.selenium.OutputType).
    Using try with multi-catch to prevent error when generating groovy document.
  - public static BufferedImage takeAreaScreenshot(io.appium.java_client.AppiumDriver<? extends org.openqa.selenium.WebElement> driver, org.openqa.selenium.Rectangle rect, List<com.kms.katalon.core.testobject.TestObject> ignoredElements, Color hidingColor)
  - public static BufferedImage takeElementScreenshot(io.appium.java_client.AppiumDriver<? extends org.openqa.selenium.WebElement> driver, com.kms.katalon.core.testobject.TestObject to, List<com.kms.katalon.core.testobject.TestObject> ignoredElements, Color hidingColor)
  - public static String takeScreenshot(io.appium.java_client.AppiumDriver<? extends org.openqa.selenium.WebElement> driver, String fileName)
  - protected static BufferedImage takeScreenshot(io.appium.java_client.AppiumDriver<? extends org.openqa.selenium.WebElement> driver)
  - public static BufferedImage takeViewportScreenshot(io.appium.java_client.AppiumDriver<? extends org.openqa.selenium.WebElement> driver, List<com.kms.katalon.core.testobject.TestObject> ignoredElements, Color hidingColor)

Summary:
Method

| Detail:
Method

Groovy Documentation

[Java] Class MobileScreenCaptor

Methods Summary

Inherited Methods Summary

Method Detail

protected io.appium.java_client.AppiumDriver<?> getAnyAppiumDriver()

public static org.openqa.selenium.Rectangle getBoundedRect(org.openqa.selenium.WebElement element, float scaleFactor, int statusBarHeight)

public static BufferedImage hideElements(BufferedImage screenshot, io.appium.java_client.AppiumDriver<? extends org.openqa.selenium.WebElement> driver, List<com.kms.katalon.core.testobject.TestObject> ignoredElements, Color hideColor, float scaleFactor, int statusBarHeight)

protected boolean internalSwitchToContext(io.appium.java_client.AppiumDriver<?> driver, String contextName)

protected boolean internalSwitchToNativeContext(io.appium.java_client.AppiumDriver<?> driver)

public static BufferedImage removeStatusBar(BufferedImage screenshot, int statusBarHeight)

@Override protected void take(File newFile)

public static BufferedImage takeAreaScreenshot(io.appium.java_client.AppiumDriver<? extends org.openqa.selenium.WebElement> driver, org.openqa.selenium.Rectangle rect, List<com.kms.katalon.core.testobject.TestObject> ignoredElements, Color hidingColor)

public static BufferedImage takeElementScreenshot(io.appium.java_client.AppiumDriver<? extends org.openqa.selenium.WebElement> driver, com.kms.katalon.core.testobject.TestObject to, List<com.kms.katalon.core.testobject.TestObject> ignoredElements, Color hidingColor)

public static String takeScreenshot(io.appium.java_client.AppiumDriver<? extends org.openqa.selenium.WebElement> driver, String fileName)

protected static BufferedImage takeScreenshot(io.appium.java_client.AppiumDriver<? extends org.openqa.selenium.WebElement> driver)

public static BufferedImage takeViewportScreenshot(io.appium.java_client.AppiumDriver<? extends org.openqa.selenium.WebElement> driver, List<com.kms.katalon.core.testobject.TestObject> ignoredElements, Color hidingColor)