Interface Settings

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Interface Description
      static class  Settings.EXPORT
      Settings to configure the export to PDF or image format.
      static class  Settings.FILTER
      This is a convenience class to enable or disable the highlighting of changes by a filter.
      static class  Settings.METAOPTION
      Color options that are not related to a difference type.
      static class  Settings.OPTION
      Options affect the comparison result, but are not related to the actual export or output format.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static ObjectSetting<java.lang.Double> IMAGE_SCALE_FACTOR
      Defines a scale factor for the generated images (original and difference images).
      static ObjectSetting<java.lang.Integer> MAX_ERRORS_PER_FILE
      Specifies the maximum number of errors that can occur before the comparison will be stopped for the current PDF file.
    • Field Detail

      • MAX_ERRORS_PER_FILE

        static final ObjectSetting<java.lang.Integer> MAX_ERRORS_PER_FILE
        Specifies the maximum number of errors that can occur before the comparison will be stopped for the current PDF file. The default value is: 100.
        [value: -1 for unlimited]
        Accepted values: -1 to Integer.MAX_VALUE
      • IMAGE_SCALE_FACTOR

        static final ObjectSetting<java.lang.Double> IMAGE_SCALE_FACTOR
        Defines a scale factor for the generated images (original and difference images). The default is 1 which is no scaling.
        Accepted values: 0.1 to 100.0
        Since:
        5.0
    • Method Detail

      • getAllObjectSettingNames

        java.util.List<ObjectSetting<?>> getAllObjectSettingNames()
        Returns all registered additional settings. To query the current value of the setting pass VisibilitySetting.name() to the getSetting(String) method.
        Returns:
        all additional settings, not null
        Since:
        5.0
      • setMarkerColor

        void setMarkerColor​(java.awt.Color color,
                            DiffGroup.GroupType groupType)
        Set the color for the marker. Overrides the default provided by {link ColorProvider.getMarkerColor(DiffGroup.GroupType). (For visible set the alpha to 0)
        Parameters:
        color - the marker color
        groupType - the group type tp set the marker color for
        Since:
        4.1
      • getColor

        java.awt.Color getColor​(com.inet.pdfc.config.ColorSetting settingKey)
        Get the color for a setting
        Parameters:
        settingKey - the key of the setting
        Returns:
        the color for this setting
        Since:
        4.1
      • setSetting

        void setSetting​(@Nullable
                        java.lang.Object value,
                        java.lang.String settingKey)
                 throws java.lang.IllegalArgumentException
        Set the specific setting with the value
        Parameters:
        value - value for the setting or null for remove the setting
        settingKey - the setting name, usually VisibilitySetting.name()
        Throws:
        java.lang.IllegalArgumentException - thrown in case the value has a wrong typ or the value has wrong definition range for this setting
        Since:
        5.0
      • getSetting

        @Nullable
        java.lang.Object getSetting​(java.lang.String settingKey)
        Return the value for this setting
        Parameters:
        settingKey - the setting name
        Returns:
        value for this setting or null if no setting be set.
        Since:
        5.0
      • copy

        @Nonnull
        Settings copy()
        Create a copy of the current setting
        Returns:
        copy of the current setting
        Since:
        5.0