com.htmlhifive.pitalium.core.selenium

クラス PtlWebDriver

java.lang.Object

org.openqa.selenium.remote.RemoteWebDriver

com.htmlhifive.pitalium.core.selenium.PtlWebDriver

すべての実装されたインタフェース:

org.openqa.selenium.HasCapabilities, org.openqa.selenium.interactions.HasInputDevices, org.openqa.selenium.interactions.Interactive, org.openqa.selenium.internal.FindsByClassName, org.openqa.selenium.internal.FindsByCssSelector, org.openqa.selenium.internal.FindsById, org.openqa.selenium.internal.FindsByLinkText, org.openqa.selenium.internal.FindsByName, org.openqa.selenium.internal.FindsByTagName, org.openqa.selenium.internal.FindsByXPath, org.openqa.selenium.JavascriptExecutor, org.openqa.selenium.SearchContext, org.openqa.selenium.TakesScreenshot, org.openqa.selenium.WebDriver

public abstract class PtlWebDriver
extends org.openqa.selenium.remote.RemoteWebDriver

WebDriverの実装クラス。RemoteWebDriver の機能に加え、表示中のWebページに関する情報取得、ブラウザの差異を吸収したスクリーンショットの撮影を行います。
各ブラウザの操作に用いるWebDriverは、このクラスを拡張して実装します。

ネストされたクラスのサマリー

クラスから継承されたネストされたクラス/インタフェース org.openqa.selenium.remote.RemoteWebDriver

org.openqa.selenium.remote.RemoteWebDriver.RemoteTargetLocator, org.openqa.selenium.remote.RemoteWebDriver.RemoteWebDriverOptions, org.openqa.selenium.remote.RemoteWebDriver.When

インタフェースから継承されたネストされたクラス/インタフェース org.openqa.selenium.WebDriver

org.openqa.selenium.WebDriver.ImeHandler, org.openqa.selenium.WebDriver.Navigation, org.openqa.selenium.WebDriver.Options, org.openqa.selenium.WebDriver.TargetLocator, org.openqa.selenium.WebDriver.Timeouts, org.openqa.selenium.WebDriver.Window

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
static double	DEFAULT_SCREENSHOT_SCALE スクリーンショット画像とブラウザの表示領域のサイズ比。
protected org.slf4j.Logger	LOG

コンストラクタのサマリー

コンストラクタ

修飾子	コンストラクタと説明
protected	PtlWebDriver(org.openqa.selenium.remote.CommandExecutor executor, PtlCapabilities capabilities) コンストラクタ
protected	PtlWebDriver(java.net.URL remoteAddress, PtlCapabilities capabilities) コンストラクタ

メソッドのサマリー

修飾子とタイプ	メソッドと説明
protected double	calcScale(double windowWidth, double imageWidth) viewport内の表示領域とスクリーンショットのサイズ比を計算します。
protected int	calcTrimLeft(int imageWidth, long scrollAmount, PtlWebElement targetElement, double currentScale) 画像の幅、スクロール量、要素のボーダー幅から横のトリム量を計算します。
protected int	calcTrimTop(int imageHeight, long scrollAmount, PtlWebElement targetElement, double currentScale) 画像の高さ、スクロール量、要素のボーダー幅から縦のトリム量を計算します。
protected boolean	canHideBodyScrollbar() bodyのスクロールバーを非表示にできるブラウザかどうかを取得します。
protected boolean	canHideElementScrollbar() 要素のスクロールバーを非表示にできるブラウザかどうかを取得します。
protected boolean	canMoveTarget() 要素を移動可能なブラウザかどうかを取得します。
protected boolean	canResizeElement() 要素をリサイズできるブラウザかどうかを取得します。
protected ScreenAreaResult	createExcludeScreenAreaResult(ScreenAreaWrapper target, java.lang.Integer index)
protected ScreenAreaResult	createScreenAreaResult(ScreenAreaWrapper target, java.lang.Integer index) ScreenAreaWrapperからScreenAreaResultを生成します。
<T> T	executeAsyncJavaScript(java.lang.String script, java.lang.Object... params)
java.lang.Object	executeAsyncScript(java.lang.String script, java.lang.Object... args)
<T> T	executeJavaScript(java.lang.String script, java.lang.Object... params)
java.lang.Object	executeScript(java.lang.String script, java.lang.Object... args)
protected java.util.List<PtlWebElement>	findElementsByDomSelectors(java.util.List<DomSelector> selectors) DomSelectorを指定して対応する要素の一覧を取得します。
void	get(java.lang.String url) 指定されたURLをブラウザで開きます。
protected java.lang.String	getBaseUrl() テスト対象アプリケーションのベースURLを取得します。
PtlCapabilities	getCapabilities() Capabilityを取得します。
ClientRect	getCurrentBodyClientRect() 現在のbodyのサイズを取得します。
long	getCurrentPageHeight() 現在のページの高さを取得します。
long	getCurrentPageWidth() 現在のページの幅を取得します。
double	getCurrentScrollLeft() 現在表示位置の左端座標を取得します。
double	getCurrentScrollTop() 現在表示位置の上端座標を取得します。
java.awt.image.BufferedImage	getEntirePageScreenshot() 画面全体のスクリーンショットを撮影し、BufferedImageとして返します。
protected java.awt.image.BufferedImage	getMinimumScreenshot(ScreenshotParams params) パラメータで指定された要素を含む最小範囲でスクリーンショットを撮影し、BufferedImageとして返します。
org.openqa.selenium.Capabilities	getRawCapabilities() RemoteWebDriverが保持しているCapabilityを取得します。
<X> X	getScreenshotAs(org.openqa.selenium.OutputType<X> outputType)
protected java.awt.image.BufferedImage	getScreenshotAsBufferedImage() スクリーンショットを撮影し、BufferedImageとして取得します。
protected ScreenshotImage	getScreenshotImage(ScreenshotParams params, ScreenshotParams... additionalParams) スクリーンショットを撮影し、ScreenshotImageとして取得します。
protected java.awt.image.BufferedImage	getScreenshotInternal(ScreenshotParams params, ScreenshotParams... additionalParams) 対象領域を定位置（0, 0)に移動し、スクリーンショットを撮影します。
protected java.awt.image.BufferedImage	getScreenshotInternalWithoutMoving(ScreenshotParams params, ScreenshotParams... additionalParams) 対象領域を移動せずにスクリーンショットを撮影します。
protected double	getScreenshotScale() スクリーンショットとviewportのサイズ比を取得します。
long	getScrollHeight() ページのscrollHeightを取得します。
long	getScrollNum() ページのスクロール回数を取得します。
long	getScrollWidth() ページのscrollWidthを取得します。
protected TargetResult	getTargetResult(CompareTarget compareTarget, java.util.List<DomSelector> hiddenElementSelectors, ScreenshotParams params, ScreenshotImage image) スクリーンショットを受け取り、ターゲットの領域を切り抜いてTargetResultとして返します。
protected TargetResult	getTargetResult(CompareTarget compareTarget, java.util.List<DomSelector> hiddenElementSelectors, ScreenshotParams params, ScreenshotParams... additionalParams) 一つのターゲットに対するスクリーンショットを撮影し、TargetResultとして取得します。
long	getWindowHeight() 可視領域の高さを取得します。
long	getWindowWidth() 可視領域の幅を取得します。
protected boolean	isHideElementsRequired() 要素を非表示にする必要があるブラウザかどうかを取得します。
protected boolean	isMoveTargetRequired(ScreenshotParams params) スクリーンショット撮影時に、対象領域を定位置に移動させるか否かを調べます。
protected boolean	isScrollTargetRequired(ScreenshotParams params) スクリーンショット撮影時に、対象領域をスクロールさせるか否かを調べます。
protected abstract PtlWebElement	newPtlWebElement() driverに対応するWebElementを生成します。
protected void	resetScreenshotScale() スクリーンショットとviewportのサイズ比を初期値に戻します。
void	scrollTo(double x, double y) 画面上の特定の位置にスクロールします。
protected void	setBaseUrl(java.lang.String baseUrl) テスト対象アプリケーションのベースURLを設定します。
protected void	setEnvironmentConfig(EnvironmentConfig environmentConfig) 環境情報を設定します。
protected void	setScreenshotScale(double screenshotScale) スクリーンショットとviewportのサイズ比を設定します。
protected TargetResult	takeMoveScreenshots(CompareTarget target, java.util.List<DomSelector> hiddenElementSelectors, ScreenshotParams params) isMoveがtrueに指定されているターゲットを撮影するメソッド。
protected java.util.List<TargetResult>	takeNonMoveScreenshots(TargetResult entireScreenshotResult, java.util.List<DomSelector> hiddenElementSelectors, ScreenshotParams entireScreenshotParams, java.util.List<org.apache.commons.lang3.tuple.Pair<CompareTarget,ScreenshotParams>> targetParams) isMoveがfalseに指定されているターゲットを一括で撮影するメソッド。
ScreenshotResult	takeScreenshot(ScreenshotArgument arg) スクリーンショットの撮影条件を指定してスクリーンショットを撮影します。
ScreenshotResult	takeScreenshot(java.lang.String screenshotId) 画面全体のスクリーンショットを撮影します。
ScreenshotResult	takeScreenshot(java.lang.String screenshotId, CompareTarget[] compareTargets) 指定範囲のスクリーンショットを撮影します。
ScreenshotResult	takeScreenshot(java.lang.String screenshotId, CompareTarget[] compareTargets, DomSelector[] hiddenElementsSelectors) 撮影時に非表示にする要素を指定し、指定範囲のスクリーンショットを撮影します。
ScreenshotResult	takeScreenshot(java.lang.String screenshotId, java.util.List<CompareTarget> compareTargets) 指定範囲のスクリーンショットを撮影します。
ScreenshotResult	takeScreenshot(java.lang.String screenshotId, java.util.List<CompareTarget> compareTargets, java.util.List<DomSelector> hiddenElementSelectors) 撮影時に非表示にする要素を指定し、指定範囲のスクリーンショットを撮影します。
protected void	trimBottomImage(java.util.List<java.awt.image.BufferedImage> images, long lastScrollAmount, PtlWebElement el, double currentScale) 指定されたリスト内の最後の画像の高さ、スクロール量、ボーダー幅から トリム量を計算し、縦の重複をトリムします。
protected void	trimMoveBorder(org.openqa.selenium.WebElement el, java.util.List<java.awt.image.BufferedImage> images, double currentScale) isMoveがtrueのとき、要素のborderを切り取る処理をします。
protected void	trimMovePadding(org.openqa.selenium.WebElement el, java.util.List<java.awt.image.BufferedImage> images) isMoveがtrueのとき、要素のpaddingを切り取る処理をします。
protected void	trimNonMoveBorder(java.util.List<java.util.List<java.awt.image.BufferedImage>> allTargetScreenshots, java.util.List<org.apache.commons.lang3.tuple.Pair<CompareTarget,ScreenshotParams>> targetParams, double currentScale) isMoveがfalseのとき、要素のborderを切り取る処理をします。
protected void	trimNonMovePadding(java.util.List<java.util.List<java.awt.image.BufferedImage>> allTargetScreenshots, java.util.List<org.apache.commons.lang3.tuple.Pair<CompareTarget,ScreenshotParams>> targetParams) isMoveがfalseのとき、要素のpaddingを切り取る処理をします。
protected java.awt.image.BufferedImage	trimOverlap(double captureTop, double captureLeft, long windowHeight, long windowWidth, double currentScale, java.awt.image.BufferedImage img) 次のキャプチャ開始位置と今回キャプチャした範囲を比較し、重なる部分がある場合は切り取ります。
protected void	trimRightImage(java.util.List<java.awt.image.BufferedImage> images, long lastScrollAmount, PtlWebElement el, double currentScale) 指定されたリスト内の最後の画像の幅、スクロール量、ボーダー幅から トリム量を計算し、横の重複をトリムします。
protected java.awt.image.BufferedImage	trimTargetBorder(org.openqa.selenium.WebElement el, java.awt.image.BufferedImage image, int num, int size, double currentScale) 要素の部分スクロール時、元画像からボーダーを切り取ります。
protected java.awt.image.BufferedImage	trimTargetPadding(org.openqa.selenium.WebElement el, java.awt.image.BufferedImage image, int num, int size) 要素の部分スクロール時、元画像からPaddingを切り取ります。

クラスから継承されたメソッド org.openqa.selenium.remote.RemoteWebDriver

close, execute, execute, findElement, findElement, findElementByClassName, findElementByCssSelector, findElementById, findElementByLinkText, findElementByName, findElementByPartialLinkText, findElementByTagName, findElementByXPath, findElements, findElements, findElementsByClassName, findElementsByCssSelector, findElementsById, findElementsByLinkText, findElementsByName, findElementsByPartialLinkText, findElementsByTagName, findElementsByXPath, getCommandExecutor, getCurrentUrl, getElementConverter, getErrorHandler, getExecuteMethod, getFileDetector, getKeyboard, getMouse, getPageSource, getSessionId, getTitle, getWindowHandle, getWindowHandles, log, manage, navigate, perform, quit, resetInputState, setCommandExecutor, setElementConverter, setErrorHandler, setFileDetector, setFoundBy, setLogLevel, setSessionId, startClient, startClient, startSession, stopClient, stopClient, switchTo, toString

クラスから継承されたメソッド java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

フィールドの詳細

DEFAULT_SCREENSHOT_SCALE

public static final double DEFAULT_SCREENSHOT_SCALE

スクリーンショット画像とブラウザの表示領域のサイズ比。デフォルト値は1

関連項目:

定数フィールド値

LOG

protected final org.slf4j.Logger LOG

コンストラクタの詳細

PtlWebDriver

protected PtlWebDriver(java.net.URL remoteAddress,
                       PtlCapabilities capabilities)

コンストラクタ

パラメータ:

remoteAddress - RemoteWebDriverServerのアドレス

capabilities - Capability

PtlWebDriver

protected PtlWebDriver(org.openqa.selenium.remote.CommandExecutor executor,
                       PtlCapabilities capabilities)

コンストラクタ

パラメータ:

executor - CommandExecutor

capabilities - Capability

メソッドの詳細

getBaseUrl

protected java.lang.String getBaseUrl()

テスト対象アプリケーションのベースURLを取得します。

戻り値:

テスト対象アプリケーションのベースURL

関連項目:

TestAppConfig.baseUrl

setBaseUrl

protected void setBaseUrl(java.lang.String baseUrl)

テスト対象アプリケーションのベースURLを設定します。

パラメータ:

baseUrl - テスト対象アプリケーションのベースURL

関連項目:

TestAppConfig.baseUrl

setEnvironmentConfig

protected final void setEnvironmentConfig(EnvironmentConfig environmentConfig)

環境情報を設定します。

パラメータ:

environmentConfig - 環境情報

get

public void get(java.lang.String url)

指定されたURLをブラウザで開きます。urlがhttp://またはhttps://から始まる場合はそのまま、それ以外の場合はbaseUrl + urlのアドレスを開きます。

定義:

get インタフェース内 org.openqa.selenium.WebDriver

オーバーライド:

get クラス内 org.openqa.selenium.remote.RemoteWebDriver

パラメータ:

url - 開きたいURL

getCapabilities

public PtlCapabilities getCapabilities()

Capabilityを取得します。

定義:

getCapabilities インタフェース内 org.openqa.selenium.HasCapabilities

オーバーライド:

getCapabilities クラス内 org.openqa.selenium.remote.RemoteWebDriver

戻り値:

Capability

getRawCapabilities

public org.openqa.selenium.Capabilities getRawCapabilities()

RemoteWebDriverが保持しているCapabilityを取得します。

戻り値:

Capability

getScreenshotAs

public <X> X getScreenshotAs(org.openqa.selenium.OutputType<X> outputType)
                      throws org.openqa.selenium.WebDriverException

定義:

getScreenshotAs インタフェース内 org.openqa.selenium.TakesScreenshot

オーバーライド:

getScreenshotAs クラス内 org.openqa.selenium.remote.RemoteWebDriver

例外:

org.openqa.selenium.WebDriverException

canMoveTarget

protected boolean canMoveTarget()

要素を移動可能なブラウザかどうかを取得します。

戻り値:

移動可能なブラウザならtrue、不可ならfalse

canHideBodyScrollbar

protected boolean canHideBodyScrollbar()

bodyのスクロールバーを非表示にできるブラウザかどうかを取得します。

戻り値:

非表示にできる場合はtrue、できない場合はfalse

canHideElementScrollbar

protected boolean canHideElementScrollbar()

要素のスクロールバーを非表示にできるブラウザかどうかを取得します。

戻り値:

非表示にできる場合はtrue、できない場合はfalse

isHideElementsRequired

protected boolean isHideElementsRequired()

要素を非表示にする必要があるブラウザかどうかを取得します。

戻り値:

非表示にする場合はtrue、しない場合はfalse

canResizeElement

protected boolean canResizeElement()

要素をリサイズできるブラウザかどうかを取得します。

戻り値:

リサイズできる場合はtrue、できない場合はfalse

executeJavaScript

public <T> T executeJavaScript(java.lang.String script,
                               java.lang.Object... params)

型パラメータ:

T - 実行結果の型

パラメータ:

script - 実行するJavaScript

params - スクリプトに渡すパラメータ

戻り値:

実行結果

関連項目:

JavascriptExecutor.executeScript(String, Object...)

executeScript

public java.lang.Object executeScript(java.lang.String script,
                                      java.lang.Object... args)

定義:

executeScript インタフェース内 org.openqa.selenium.JavascriptExecutor

オーバーライド:

executeScript クラス内 org.openqa.selenium.remote.RemoteWebDriver

executeAsyncJavaScript

public <T> T executeAsyncJavaScript(java.lang.String script,
                                    java.lang.Object... params)

型パラメータ:

T - 実行結果の型

パラメータ:

script - 実行するJavaScript

params - スクリプトに渡すパラメータ

戻り値:

実行結果

関連項目:

JavascriptExecutor.executeAsyncScript(String, Object...)

executeAsyncScript

public java.lang.Object executeAsyncScript(java.lang.String script,
                                           java.lang.Object... args)

定義:

executeAsyncScript インタフェース内 org.openqa.selenium.JavascriptExecutor

オーバーライド:

executeAsyncScript クラス内 org.openqa.selenium.remote.RemoteWebDriver

takeScreenshot

public ScreenshotResult takeScreenshot(java.lang.String screenshotId)

画面全体のスクリーンショットを撮影します。

パラメータ:

screenshotId - スクリーンショットID

戻り値:

スクリーンショット撮影結果

takeScreenshot

public ScreenshotResult takeScreenshot(java.lang.String screenshotId,
                                       CompareTarget[] compareTargets)

指定範囲のスクリーンショットを撮影します。

パラメータ:

screenshotId - スクリーンショットID

compareTargets - 撮影対象とする範囲

戻り値:

スクリーンショット撮影結果

takeScreenshot

public ScreenshotResult takeScreenshot(java.lang.String screenshotId,
                                       java.util.List<CompareTarget> compareTargets)

指定範囲のスクリーンショットを撮影します。

パラメータ:

screenshotId - スクリーンショットID

compareTargets - 撮影対象とする範囲

戻り値:

スクリーンショット撮影結果

takeScreenshot

public ScreenshotResult takeScreenshot(java.lang.String screenshotId,
                                       CompareTarget[] compareTargets,
                                       DomSelector[] hiddenElementsSelectors)

撮影時に非表示にする要素を指定し、指定範囲のスクリーンショットを撮影します。

パラメータ:

screenshotId - スクリーンショットID

compareTargets - 撮影対象とする範囲

hiddenElementsSelectors - 撮影時に非表示にする要素

戻り値:

スクリーンショット撮影結果

takeScreenshot

public ScreenshotResult takeScreenshot(ScreenshotArgument arg)

スクリーンショットの撮影条件を指定してスクリーンショットを撮影します。

パラメータ:

arg - スクリーンショット撮影条件

戻り値:

スクリーンショット撮影結果

takeScreenshot

public ScreenshotResult takeScreenshot(java.lang.String screenshotId,
                                       java.util.List<CompareTarget> compareTargets,
                                       java.util.List<DomSelector> hiddenElementSelectors)

撮影時に非表示にする要素を指定し、指定範囲のスクリーンショットを撮影します。

パラメータ:

screenshotId - スクリーンショットID

compareTargets - 撮影対象とする範囲

hiddenElementSelectors - 撮影時に非表示にする要素

戻り値:

スクリーンショット撮影結果

takeNonMoveScreenshots

protected java.util.List<TargetResult> takeNonMoveScreenshots(TargetResult entireScreenshotResult,
                                                              java.util.List<DomSelector> hiddenElementSelectors,
                                                              ScreenshotParams entireScreenshotParams,
                                                              java.util.List<org.apache.commons.lang3.tuple.Pair<CompareTarget,ScreenshotParams>> targetParams)

isMoveがfalseに指定されているターゲットを一括で撮影するメソッド。

パラメータ:

entireScreenshotResult - 予めページ全体を撮影した際のTargetResult

hiddenElementSelectors - 撮影時に非表示にする要素のリスト

targetParams - 撮影対象のターゲットリスト

entireScreenshotParams - ページ全体撮影用のパラメータ

戻り値:

各ターゲットのTargetResultリスト

takeMoveScreenshots

protected TargetResult takeMoveScreenshots(CompareTarget target,
                                           java.util.List<DomSelector> hiddenElementSelectors,
                                           ScreenshotParams params)

isMoveがtrueに指定されているターゲットを撮影するメソッド。

パラメータ:

target - 撮影対象のターゲット

hiddenElementSelectors - 撮影時に非表示にする要素のリスト

params - 撮影対象のパラメータ

戻り値:

ターゲットのTargetResult

trimBottomImage

protected void trimBottomImage(java.util.List<java.awt.image.BufferedImage> images,
                               long lastScrollAmount,
                               PtlWebElement el,
                               double currentScale)

指定されたリスト内の最後の画像の高さ、スクロール量、ボーダー幅から
トリム量を計算し、縦の重複をトリムします。

パラメータ:

images - 対象の画像

lastScrollAmount - 最後のスクロール量

el - 撮影対象の要素

currentScale - 表示領域とスクリーンショットのサイズ比

trimRightImage

protected void trimRightImage(java.util.List<java.awt.image.BufferedImage> images,
                              long lastScrollAmount,
                              PtlWebElement el,
                              double currentScale)

指定されたリスト内の最後の画像の幅、スクロール量、ボーダー幅から
トリム量を計算し、横の重複をトリムします。

パラメータ:

images - 対象の画像

lastScrollAmount - 最後のスクロール量

el - 撮影対象の要素

currentScale - 表示領域とスクリーンショットのサイズ比

trimTargetBorder

protected java.awt.image.BufferedImage trimTargetBorder(org.openqa.selenium.WebElement el,
                                                        java.awt.image.BufferedImage image,
                                                        int num,
                                                        int size,
                                                        double currentScale)

要素の部分スクロール時、元画像からボーダーを切り取ります。

パラメータ:

el - 対象の要素

image - 元画像

num - 何スクロール目の画像化

size - 全体のスクロール数

戻り値:

ボーダーを切り取ったBufferedImage

trimTargetPadding

protected java.awt.image.BufferedImage trimTargetPadding(org.openqa.selenium.WebElement el,
                                                         java.awt.image.BufferedImage image,
                                                         int num,
                                                         int size)

要素の部分スクロール時、元画像からPaddingを切り取ります。
スクロール

パラメータ:

el - 対象の要素

image - 元画像

num - 何スクロール目の画像か

size - 全体のスクロール数

戻り値:

Paddingを切り取ったBufferedImage

trimNonMoveBorder

protected void trimNonMoveBorder(java.util.List<java.util.List<java.awt.image.BufferedImage>> allTargetScreenshots,
                                 java.util.List<org.apache.commons.lang3.tuple.Pair<CompareTarget,ScreenshotParams>> targetParams,
                                 double currentScale)

isMoveがfalseのとき、要素のborderを切り取る処理をします。

パラメータ:

allTargetScreenshots - 撮影した全スクリーンショット

targetParams - 撮影対象のターゲットリスト

trimMoveBorder

protected void trimMoveBorder(org.openqa.selenium.WebElement el,
                              java.util.List<java.awt.image.BufferedImage> images,
                              double currentScale)

isMoveがtrueのとき、要素のborderを切り取る処理をします。

パラメータ:

el - ターゲットの要素

images - 撮影したスクリーンショット

trimNonMovePadding

protected void trimNonMovePadding(java.util.List<java.util.List<java.awt.image.BufferedImage>> allTargetScreenshots,
                                  java.util.List<org.apache.commons.lang3.tuple.Pair<CompareTarget,ScreenshotParams>> targetParams)

isMoveがfalseのとき、要素のpaddingを切り取る処理をします。

パラメータ:

allTargetScreenshots - 撮影した全スクリーンショット

targetParams - 撮影対象のターゲットリスト

trimMovePadding

protected void trimMovePadding(org.openqa.selenium.WebElement el,
                               java.util.List<java.awt.image.BufferedImage> images)

isMoveがtrueのとき、要素のpaddingを切り取る処理をします。

パラメータ:

el - ターゲットの要素

images - 撮影したスクリーンショット

trimOverlap

protected java.awt.image.BufferedImage trimOverlap(double captureTop,
                                                   double captureLeft,
                                                   long windowHeight,
                                                   long windowWidth,
                                                   double currentScale,
                                                   java.awt.image.BufferedImage img)

次のキャプチャ開始位置と今回キャプチャした範囲を比較し、重なる部分がある場合は切り取ります。

パラメータ:

captureTop - 今回のキャプチャ開始位置（上）

captureLeft - 今回のキャプチャ開始位置（左）

windowHeight - ウィンドウ（viewport内の表示領域）の高さ

windowWidth - ウィンドウ（viewport内の表示領域）の幅

currentScale - ウィンドウとスクリーンショットのサイズ比

img - スクリーンショット画像

戻り値:

重複を切り取った画像

getTargetResult

protected TargetResult getTargetResult(CompareTarget compareTarget,
                                       java.util.List<DomSelector> hiddenElementSelectors,
                                       ScreenshotParams params,
                                       ScreenshotParams... additionalParams)

一つのターゲットに対するスクリーンショットを撮影し、TargetResultとして取得します。

パラメータ:

compareTarget - 撮影対象とする範囲

hiddenElementSelectors - 撮影時に非表示にする要素のセレクタのリスト

params - スクリーンショットを撮影するためのパラメーター

additionalParams - 追加のスクリーンショット撮影用パラメータ。スクリーンショットはparams に設定した情報から撮影しますが、同時にこの引数に設定したパラメータの座標情報が更新されます。

戻り値:

スクリーンショット撮影結果

getTargetResult

protected TargetResult getTargetResult(CompareTarget compareTarget,
                                       java.util.List<DomSelector> hiddenElementSelectors,
                                       ScreenshotParams params,
                                       ScreenshotImage image)

スクリーンショットを受け取り、ターゲットの領域を切り抜いてTargetResultとして返します。

パラメータ:

compareTarget - 撮影対象の範囲

hiddenElementSelectors - 撮影時に非表示にする要素のセレクタのリスト

params - スクリーンショットを撮影するためのパラメーター

image - スクリーンショット画像

戻り値:

TargetResultオブジェクト

createScreenAreaResult

protected ScreenAreaResult createScreenAreaResult(ScreenAreaWrapper target,
                                                  java.lang.Integer index)

ScreenAreaWrapperからScreenAreaResultを生成します。

パラメータ:

target - 元となるScreenAreaWrapper

index - 対象とする要素のインデックス

戻り値:

ScreenAreaResult

createExcludeScreenAreaResult

protected ScreenAreaResult createExcludeScreenAreaResult(ScreenAreaWrapper target,
                                                         java.lang.Integer index)

getScreenshotImage

protected ScreenshotImage getScreenshotImage(ScreenshotParams params,
                                             ScreenshotParams... additionalParams)

スクリーンショットを撮影し、ScreenshotImageとして取得します。

パラメータ:

params - スクリーンショット撮影用パラメータ

additionalParams - 追加のスクリーンショット撮影用パラメータ。スクリーンショットはparams に設定した情報から撮影しますが、同時にこの引数に設定したパラメータの座標情報が更新されます。

戻り値:

撮影したスクリーンショット

isMoveTargetRequired

protected boolean isMoveTargetRequired(ScreenshotParams params)

スクリーンショット撮影時に、対象領域を定位置に移動させるか否かを調べます。

パラメータ:

params - スクリーンショット撮影用パラメータ

戻り値:

移動するか否か。移動する場合はtrue。

isScrollTargetRequired

protected boolean isScrollTargetRequired(ScreenshotParams params)

スクリーンショット撮影時に、対象領域をスクロールさせるか否かを調べます。

パラメータ:

params - スクリーンショット撮影用パラメータ

戻り値:

スクロールするか否か。スクロールする場合はtrue。

getScreenshotInternalWithoutMoving

protected java.awt.image.BufferedImage getScreenshotInternalWithoutMoving(ScreenshotParams params,
                                                                          ScreenshotParams... additionalParams)

対象領域を移動せずにスクリーンショットを撮影します。

パラメータ:

params - スクリーンショット撮影用パラメータ

additionalParams - スクリーンショット撮影用パラメータ

戻り値:

撮影したスクリーンショット

getScreenshotInternal

protected java.awt.image.BufferedImage getScreenshotInternal(ScreenshotParams params,
                                                             ScreenshotParams... additionalParams)

対象領域を定位置（0, 0)に移動し、スクリーンショットを撮影します。

パラメータ:

params - スクリーンショット撮影用パラメータ

additionalParams - スクリーンショット撮影用パラメータ

戻り値:

撮影したスクリーンショット

findElementsByDomSelectors

protected java.util.List<PtlWebElement> findElementsByDomSelectors(java.util.List<DomSelector> selectors)

DomSelectorを指定して対応する要素の一覧を取得します。

パラメータ:

selectors - 取得する要素のセレクタのリスト

戻り値:

取得した要素のリスト

getCurrentBodyClientRect

public ClientRect getCurrentBodyClientRect()

現在のbodyのサイズを取得します。

戻り値:

現在のbodyのclientRect

getScreenshotScale

protected double getScreenshotScale()

スクリーンショットとviewportのサイズ比を取得します。

戻り値:

サイズ比。PCの場合は1.0

setScreenshotScale

protected void setScreenshotScale(double screenshotScale)

スクリーンショットとviewportのサイズ比を設定します。

パラメータ:

screenshotScale - スクリーンショットとviewportのサイズ比

resetScreenshotScale

protected void resetScreenshotScale()

スクリーンショットとviewportのサイズ比を初期値に戻します。

getEntirePageScreenshot

public java.awt.image.BufferedImage getEntirePageScreenshot()

画面全体のスクリーンショットを撮影し、BufferedImageとして返します。

戻り値:

撮影したスクリーンショット

getMinimumScreenshot

protected java.awt.image.BufferedImage getMinimumScreenshot(ScreenshotParams params)

パラメータで指定された要素を含む最小範囲でスクリーンショットを撮影し、BufferedImageとして返します。

パラメータ:

params - スクリーンショット撮影用パラメータ

戻り値:

撮影したスクリーンショット

getScreenshotAsBufferedImage

protected java.awt.image.BufferedImage getScreenshotAsBufferedImage()

スクリーンショットを撮影し、BufferedImageとして取得します。

戻り値:

撮影したスクリーンショット

getCurrentScrollTop

public double getCurrentScrollTop()

現在表示位置の上端座標を取得します。

戻り値:

座標のy値（実数px）

getCurrentScrollLeft

public double getCurrentScrollLeft()

現在表示位置の左端座標を取得します。

戻り値:

座標のx値（実数px）

getWindowWidth

public long getWindowWidth()

可視領域の幅を取得します。

戻り値:

可視領域の幅（整数px）

getWindowHeight

public long getWindowHeight()

可視領域の高さを取得します。

戻り値:

可視領域の高さ（整数px）

getScrollWidth

public long getScrollWidth()

ページのscrollWidthを取得します。

戻り値:

scrollWidth（整数px）

getScrollHeight

public long getScrollHeight()

ページのscrollHeightを取得します。

戻り値:

scrollHeight（整数px）

getScrollNum

public long getScrollNum()

ページのスクロール回数を取得します。

戻り値:

スクロール回数

getCurrentPageWidth

public long getCurrentPageWidth()

現在のページの幅を取得します。

戻り値:

ページの幅（整数px）

getCurrentPageHeight

public long getCurrentPageHeight()

現在のページの高さを取得します。

戻り値:

ページの高さ（整数px）

scrollTo

public void scrollTo(double x,
                     double y)
              throws java.lang.InterruptedException

画面上の特定の位置にスクロールします。

パラメータ:

x - スクロール先のx座標（実数px）

y - スクロール先のy座標（実数px）

例外:

java.lang.InterruptedException - スクロール中に例外が発生した場合

calcScale

protected double calcScale(double windowWidth,
                           double imageWidth)

viewport内の表示領域とスクリーンショットのサイズ比を計算します。

パラメータ:

windowWidth - ウィンドウ（viewport内の表示領域）の幅

imageWidth - スクリーンショットの幅

戻り値:

サイズ比。PCの場合は1

calcTrimTop

protected int calcTrimTop(int imageHeight,
                          long scrollAmount,
                          PtlWebElement targetElement,
                          double currentScale)

画像の高さ、スクロール量、要素のボーダー幅から縦のトリム量を計算します。

パラメータ:

imageHeight - 元画像の高さ

scrollAmount - 最後のスクロール量

targetElement - ターゲット

currentScale - 表示領域とスクリーンショットのサイズ比

戻り値:

trim量

calcTrimLeft

protected int calcTrimLeft(int imageWidth,
                           long scrollAmount,
                           PtlWebElement targetElement,
                           double currentScale)

画像の幅、スクロール量、要素のボーダー幅から横のトリム量を計算します。

パラメータ:

imageWidth - 元画像の幅

scrollAmount - 最後のスクロール量

targetElement - ターゲット（nullの場合は無視）

currentScale - 表示領域とスクリーンショットのサイズ比

戻り値:

trim量

newPtlWebElement

protected abstract PtlWebElement newPtlWebElement()

driverに対応するWebElementを生成します。

戻り値:

WebElement