Package com.deltaxml.htmlcompare

Class HTMLConfiguration

java.lang.Object
com.deltaxml.htmlcompare.HTMLConfiguration
public class HTMLConfiguration extends Object
Configuration object containing parameters relating to the HTML output styling and presentation.

  • Field Details

    • DEFAULT_INPUT_A_HIGHLIGHT_COLOUR

      public static final String DEFAULT_INPUT_A_HIGHLIGHT_COLOUR

      The default input A highlight colour used by HTML Compare.

      See Also:

    • DEFAULT_INPUT_B_HIGHLIGHT_COLOUR

      public static final String DEFAULT_INPUT_B_HIGHLIGHT_COLOUR

      The default input B highlight colour used by HTML Compare.

      See Also:

  • Constructor Details

    • HTMLConfiguration

      public HTMLConfiguration()
      Create a new HTMLConfiguration object.

  • Method Details

    • getInputAHighlightColour

      public String getInputAHighlightColour()
      Get the value used for highlighting changes from the input A document.
      Returns:
      a String representing the value of the input A highlight colour parameter.

    • setInputAHighlightColour

      public void setInputAHighlightColour(String value)

      Set the colour used to highlight changes in the input A document.

      A valid value is a css property value appropriate for use with the 'background' css property.

      If comparing MathML, the value given must also be valid for the 'mathbackground' attribute.

      Parameters:
      value - a String that represents a valid value of the background css property.
      See Also:

    • getInputBHighlightColour

      public String getInputBHighlightColour()
      Get the value used for highlighting changes from the input B document.
      Returns:
      a String representing the value of the input B highlight colour parameter.

    • setInputBHighlightColour

      public void setInputBHighlightColour(String value)

      Set the colour used to highlight changes in the input B document.

      A valid value is a css property value appropriate for use with the 'background' css property.

      If comparing MathML, the value given must also be valid for the 'mathbackground' attribute.

      Parameters:
      value - a String that represents a valid value of the background css property.
      See Also:

    • getInputAStyling

      public String getInputAStyling()
      Get the current value of the styling used for changes from the input A document.
      Returns:
      the value of the styling used for the input A document.

    • setInputAStyling

      public void setInputAStyling(String value)

      Set the CSS applied to changed elements from the input A document.

      Note that this will override the highlight colour parameter if set using setInputAHighlightColour(String) (except in the case of MathML that uses the mathbackground attribute)

      Parameters:
      value - A valid string of inline CSS to apply.

    • getInputBStyling

      public String getInputBStyling()
      Get the current value of the styling used for changes from the input B document.
      Returns:
      the value of the styling used for the input B document.

    • setInputBStyling

      public void setInputBStyling(String value)

      Set the CSS applied to changed elements from the input B document.

      Note that this will override the highlight colour parameter if set using setInputBHighlightColour(String) (except in the case of MathML that uses the mathbackground attribute)

      Parameters:
      value - A valid string of inline CSS to apply.