org.testingisdocumenting.znai.extensions.image

Class ImageIncludePlugin

java.lang.Object

org.testingisdocumenting.znai.extensions.image.ImageIncludePlugin

All Implemented Interfaces:

IncludePlugin, Plugin

public class ImageIncludePlugin
extends Object
implements IncludePlugin

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ALIGN_KEY
protected Path	annotationsPath
protected AuxiliaryFile	auxiliaryFile
protected static String	BORDER_KEY
protected static String	CAPTION_BOTTOM_KEY
protected static String	CAPTION_KEY
protected static String	FIT_KEY
protected boolean	isExternal
protected Double	pixelRatioFromOpts
protected static String	SCALE_DEPRECATED_KEY
protected static String	SCALE_KEY
protected static String	TITLE_KEY

Constructor Summary

Constructors

Constructor and Description
ImageIncludePlugin()

Method Summary

Modifier and Type	Method and Description
protected Stream<AuxiliaryFile>	additionalAuxiliaryFiles()
protected PluginParamsDefinition	additionalParameters()
protected List<Map<String,Object>>	annotationShapes(BufferedImage image)
Stream<AuxiliaryFile>	auxiliaryFiles(ComponentsRegistry componentsRegistry)
IncludePlugin	create()
String	id()
PluginParamsDefinition	parameters()
protected Double	pixelRatio()
PluginResult	process(ComponentsRegistry componentsRegistry, ParserHandler parserHandler, Path markupPath, PluginParams pluginParams)
protected PluginResult	process(ComponentsRegistry componentsRegistry, Path markupPath, PluginParams pluginParams)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.testingisdocumenting.znai.extensions.Plugin

auxiliaryFiles, id, parameters, preprocess, textForSearch

Field Detail

annotationsPath

protected Path annotationsPath

ALIGN_KEY

protected static final String ALIGN_KEY

See Also:

Constant Field Values

BORDER_KEY

protected static final String BORDER_KEY

See Also:

Constant Field Values

TITLE_KEY

protected static final String TITLE_KEY

See Also:

Constant Field Values

CAPTION_KEY

protected static final String CAPTION_KEY

See Also:

Constant Field Values

CAPTION_BOTTOM_KEY

protected static final String CAPTION_BOTTOM_KEY

See Also:

Constant Field Values

FIT_KEY

protected static final String FIT_KEY

See Also:

Constant Field Values

SCALE_KEY

protected static final String SCALE_KEY

See Also:

Constant Field Values

SCALE_DEPRECATED_KEY

protected static final String SCALE_DEPRECATED_KEY

See Also:

Constant Field Values

auxiliaryFile

protected AuxiliaryFile auxiliaryFile

isExternal

protected boolean isExternal

pixelRatioFromOpts

protected Double pixelRatioFromOpts

Constructor Detail

ImageIncludePlugin

public ImageIncludePlugin()

Method Detail

create

public IncludePlugin create()

Specified by:

create in interface IncludePlugin

Specified by:

create in interface Plugin

process

public PluginResult process(ComponentsRegistry componentsRegistry,
                            ParserHandler parserHandler,
                            Path markupPath,
                            PluginParams pluginParams)

Specified by:

process in interface IncludePlugin

annotationShapes

protected List<Map<String,Object>> annotationShapes(BufferedImage image)

pixelRatio

protected Double pixelRatio()

additionalParameters

protected PluginParamsDefinition additionalParameters()

additionalAuxiliaryFiles

protected Stream<AuxiliaryFile> additionalAuxiliaryFiles()

parameters

public PluginParamsDefinition parameters()

Specified by:

parameters in interface Plugin

id

public String id()

Specified by:

id in interface Plugin

auxiliaryFiles

public Stream<AuxiliaryFile> auxiliaryFiles(ComponentsRegistry componentsRegistry)

Specified by:

auxiliaryFiles in interface Plugin

process

protected PluginResult process(ComponentsRegistry componentsRegistry,
                               Path markupPath,
                               PluginParams pluginParams)