public interface Settings extends ColorProvider
VisibilitySetting
for multiple purposes:Settings.EXPORT
,
Settings.FILTER
,
Settings.METAOPTION
,
Settings.OPTION
,
DiffGroup.GroupType
Modifier and Type | Interface and 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.
|
Modifier and Type | Field and 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.
|
Modifier and Type | Method and Description |
---|---|
Settings |
copy()
Create a copy of the current setting
|
java.util.List<ObjectSetting<?>> |
getAllObjectSettingNames()
Returns all registered additional settings.
|
java.awt.Color |
getColor(com.inet.pdfc.config.ColorSetting settingKey)
Get the color for a setting
|
java.lang.Object |
getSetting(java.lang.String settingKey)
Return the value for this setting
|
boolean |
isEnabled(VisibilitySetting settingKey)
Get the visibility for this setting
|
void |
setColor(java.awt.Color color,
com.inet.pdfc.config.ColorSetting settingKey)
Set the color for this setting.
|
void |
setEnabled(boolean visible,
VisibilitySetting... settingKey)
Set the visibility for this setting
|
void |
setMarkerColor(java.awt.Color color,
DiffGroup.GroupType groupType)
Set the color for the marker.
|
void |
setSetting(java.lang.Object value,
java.lang.String settingKey)
Set the specific setting with the value
|
getMarkerColor, getOutlineColor
static final ObjectSetting<java.lang.Integer> MAX_ERRORS_PER_FILE
Integer.MAX_VALUE
static final ObjectSetting<java.lang.Double> IMAGE_SCALE_FACTOR
java.util.List<ObjectSetting<?>> getAllObjectSettingNames()
VisibilitySetting.name()
to the getSetting(String)
method.null
void setMarkerColor(java.awt.Color color, DiffGroup.GroupType groupType)
ColorProvider.getMarkerColor(DiffGroup.GroupType)
.
(For visible set the alpha to 0)color
- the marker colorgroupType
- the group type tp set the marker color forvoid setColor(java.awt.Color color, com.inet.pdfc.config.ColorSetting settingKey)
DiffGroup.GroupType
, it overrides the default provided by ColorProvider.getOutlineColor(DiffGroup.GroupType)
).DiffGroup.GroupType
s should be semi-transparent.color
- the color to be used to the markupsettingKey
- the setting key. e.G. a DiffGroup.GroupType
or the Settings.METAOPTION.ALLOUTLINEMARKER
DiffGroup.GroupType
,
Settings.METAOPTION
void setEnabled(boolean visible, VisibilitySetting... settingKey)
visible
- true for visible otherwise falsesettingKey
- the visibility setting key(s) to update the vsibility forSettings.EXPORT
,
Settings.METAOPTION
,
Settings.OPTION
,
Settings.FILTER
,
DiffGroup.GroupType
boolean isEnabled(VisibilitySetting settingKey)
settingKey
- the setting key to get the visibility fortrue
for visible hence false
Settings.EXPORT
,
Settings.METAOPTION
,
Settings.OPTION
,
Settings.FILTER
,
DiffGroup.GroupType
java.awt.Color getColor(com.inet.pdfc.config.ColorSetting settingKey)
settingKey
- the key of the settingvoid setSetting(@Nullable java.lang.Object value, java.lang.String settingKey) throws java.lang.IllegalArgumentException
value
- value for the setting or null for remove the settingsettingKey
- the setting name, usually VisibilitySetting.name()
java.lang.IllegalArgumentException
- thrown in case the value has a wrong typ
or the value has wrong definition range for this setting@Nullable java.lang.Object getSetting(java.lang.String settingKey)
settingKey
- the setting name@Nonnull Settings copy()
Copyright © 2010-2022 by i-net software GmbH