Class ScreenshotHandler
java.lang.Object
com.norconex.collector.http.fetch.util.DocImageHandler
com.norconex.collector.http.fetch.impl.webdriver.ScreenshotHandler
- All Implemented Interfaces:
IXMLConfigurable
Takes screenshot of pages using a Selenium WebDriver.
Either the entire page, or a specific DOM element.
Screenshot images can be stored in a document metadata/field or
in a local directory.
XML configuration usage:
<cssSelector>(Optional selector of element to capture.)</cssSelector>
<targets>[metadata|directory] (One or both, separated by comma.)</targets>
<imageFormat>(Image format. Default is "png".)</imageFormat>
<!-- The following applies to the "directory" target: -->
<targetDir
field="(Document field to store the local path to the image.)"
structure="[url2path|date|datetime]">
(Local directory where to save images.)
</targetDir>
<!-- The following applies to the "metadata" target: -->
<targetMetaField>(Document field where to store the image.)</targetMetaField>
The above XML configurable options can be nested in a supporting parent tag of any name. The expected parent tag name is defined by the consuming classes (e.g. "screenshot").
- Since:
- 3.0.0
- Author:
- Pascal Essiembre
-
Nested Class Summary
Nested classes/interfaces inherited from class com.norconex.collector.http.fetch.util.DocImageHandler
DocImageHandler.DirStructure, DocImageHandler.Target -
Field Summary
FieldsFields inherited from class com.norconex.collector.http.fetch.util.DocImageHandler
DEFAULT_IMAGE_FORMAT, DEFAULT_TYPES -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleaninthashCode()voidloadFromXML(XML xml) voidvoidsetCssSelector(String cssSelector) voidtakeScreenshot(org.openqa.selenium.WebDriver driver, Doc doc) toString()Methods inherited from class com.norconex.collector.http.fetch.util.DocImageHandler
getImageFormat, getTargetDir, getTargetDirField, getTargetDirStructure, getTargetMetaField, getTargets, handleImage, setImageFormat, setTargetDir, setTargetDirField, setTargetDirStructure, setTargetMetaField, setTargets, setTargets
-
Field Details
-
DEFAULT_SCREENSHOT_DIR
-
DEFAULT_SCREENSHOT_DIR_FIELD
- See Also:
-
DEFAULT_SCREENSHOT_META_FIELD
- See Also:
-
-
Constructor Details
-
ScreenshotHandler
public ScreenshotHandler() -
ScreenshotHandler
-
-
Method Details
-
getCssSelector
-
setCssSelector
-
takeScreenshot
-
loadFromXML
- Specified by:
loadFromXMLin interfaceIXMLConfigurable- Overrides:
loadFromXMLin classDocImageHandler
-
saveToXML
- Specified by:
saveToXMLin interfaceIXMLConfigurable- Overrides:
saveToXMLin classDocImageHandler
-
equals
- Overrides:
equalsin classDocImageHandler
-
hashCode
public int hashCode()- Overrides:
hashCodein classDocImageHandler
-
toString
- Overrides:
toStringin classDocImageHandler
-