MobileScreenCaptor (Katalon Studio API Specification)

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

public class MobileScreenCaptor
extends ScreenCaptor

Inherited fields
Fields inherited from class	Fields
`class ScreenCaptor`	`SCREENSHOT_EXT, logger`

Methods Summary

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

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class ScreenCaptor`	`take, takeScreenshot, takeScreenshotAndGetAttributes`

- Method Detail
  - protected AppiumDriver<?> getAnyAppiumDriver()
  - public static Rectangle getBoundedRect(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, AppiumDriver<? extends WebElement> driver, List<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(AppiumDriver<?> driver, String contextName)
  - protected boolean internalSwitchToNativeContext(AppiumDriver<?> driver)
  - public static BufferedImage removeStatusBar(BufferedImage screenshot, int statusBarHeight)
  - @Override protected void take(File newFile)
    
    Takes screenshot by using TakesScreenshot#getScreenshotAs(OutputType)#getScreenshotAs(OutputType).
    Using try with multi-catch to prevent error when generating groovy document.
  - public static BufferedImage takeAreaScreenshot(AppiumDriver<? extends WebElement> driver, Rectangle rect, List<TestObject> ignoredElements, Color hidingColor)
  - public static BufferedImage takeElementScreenshot(AppiumDriver<? extends WebElement> driver, TestObject to, List<TestObject> ignoredElements, Color hidingColor)
  - public static String takeScreenshot(AppiumDriver<? extends WebElement> driver, String fileName)
  - protected static BufferedImage takeScreenshot(AppiumDriver<? extends WebElement> driver)
  - public static BufferedImage takeViewportScreenshot(AppiumDriver<? extends WebElement> driver, List<TestObject> ignoredElements, Color hidingColor)

Summary:
Method

| Detail:
Method

[Java] Class MobileScreenCaptor

Methods Summary

Inherited Methods Summary

Method Detail

protected AppiumDriver<?> getAnyAppiumDriver()

public static Rectangle getBoundedRect(WebElement element, float scaleFactor, int statusBarHeight)

public static BufferedImage hideElements(BufferedImage screenshot, AppiumDriver<? extends WebElement> driver, List<TestObject> ignoredElements, Color hideColor, float scaleFactor, int statusBarHeight)

protected boolean internalSwitchToContext(AppiumDriver<?> driver, String contextName)

protected boolean internalSwitchToNativeContext(AppiumDriver<?> driver)

public static BufferedImage removeStatusBar(BufferedImage screenshot, int statusBarHeight)

@Override protected void take(File newFile)

public static BufferedImage takeAreaScreenshot(AppiumDriver<? extends WebElement> driver, Rectangle rect, List<TestObject> ignoredElements, Color hidingColor)

public static BufferedImage takeElementScreenshot(AppiumDriver<? extends WebElement> driver, TestObject to, List<TestObject> ignoredElements, Color hidingColor)

public static String takeScreenshot(AppiumDriver<? extends WebElement> driver, String fileName)

protected static BufferedImage takeScreenshot(AppiumDriver<? extends WebElement> driver)

public static BufferedImage takeViewportScreenshot(AppiumDriver<? extends WebElement> driver, List<TestObject> ignoredElements, Color hidingColor)