Package com.deltaxml.dita.config

Class ImageConfiguration

java.lang.Object
com.deltaxml.dita.config.ImageConfiguration
public class ImageConfiguration extends Object
Parameters managing image how images are compared and represented in the output.

  • Constructor Details

    • ImageConfiguration

      public ImageConfiguration()
      Creates a new ImageConfiguration instance. Parameters managing image how images are compared and represented in the output.

  • Method Details

    • isImageCompareEnabled

      public boolean isImageCompareEnabled()
      Gets the value of the imageCompareEnabled parameter.
      Returns:
      the value of the imageCompareEnabled parameter

    • setImageCompareEnabled

      public void setImageCompareEnabled(boolean value)

      Specifies whether to enable or disable image comparison.

      Default: true

      Parameters:
      value - the value to set for the image compare parameter

    • getOutputImageRefForm

      public OutputImageRefForm getOutputImageRefForm()
      Gets the value of the outputImageRefForm parameter.
      Returns:
      the value of the outputImageRefForm parameter

    • setOutputImageRefForm

      public void setOutputImageRefForm(OutputImageRefForm value)

      Specifies output image reference form after image comparison for topic only comparison.

      Default: OutputImageRefForm.SOURCE

      Parameters:
      value - a value for output image reference form
      Throws:
      IllegalArgumentException - if the value is null
      See Also:

    • getOutputImageRefFavourSourceDoc

      public OutputImageRefFavourSourceDoc getOutputImageRefFavourSourceDoc()

    • setOutputImageRefFavourSourceDoc

      public void setOutputImageRefFavourSourceDoc(OutputImageRefFavourSourceDoc outputImageRefFavourSourceDoc)

    • getImageComparisonGranularity

      public ImageComparisonGranularity getImageComparisonGranularity()

      Gets the image comparison granularity.

      Returns:
      the current image comparison granularity
      See Also:

    • setImageComparisonGranularity

      public void setImageComparisonGranularity(ImageComparisonGranularity value)

      Sets the image comparison granularity.

      Default: ImageComparisonGranularity.DETAILED_ADJACENT

      Parameters:
      value - the new image comparison granularity to use
      Throws:
      IllegalArgumentException - if the value is null
      See Also:

    • setInputAMarkupStyle

      public void setInputAMarkupStyle(String inputAMarkupStyle)
      Sets the Input A image markup style used for image comparison results. The default is "red".
      Parameters:
      inputAMarkupStyle - the Input A image markup style.

    • getInputAMarkupStyle

      public String getInputAMarkupStyle()
      Gets the Input A Image comparison markup style used for image comparison results.
      Returns:
      the Input A Image markup style.

    • setInputBMarkupStyle

      public void setInputBMarkupStyle(String inputBMarkupStyle)
      Sets the Input B image markup style used for image comparison results. The default is "green".
      Parameters:
      inputBMarkupStyle - the Input B image markup style.

    • getInputBMarkupStyle

      public String getInputBMarkupStyle()
      Gets the Input B Image comparison markup style used for image comparison results.
      Returns:
      the Input B Image markup style.