Package com.inet.pdfc.config

Class DefaultSetting

java.lang.Object

com.inet.pdfc.config.DefaultSetting

All Implemented Interfaces:

Settings, ColorProvider, Serializable

@JsonData
public class DefaultSetting
extends Object
implements Settings

This is the Defaultsetting with the default values. This setting will be used for the first installation. All setting for DiffGroup.GroupType and Settings.EXPORT are enabled Setting for Settings.OPTION are disabled Differencemarker color (Settings.METAOPTION) are blue AddAndRemoved Elements are red Modified content are orange Modified styles are red Meta Data changed are light blue

Since:

4.1

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.inet.pdfc.config.Settings

Settings.EXPORT, Settings.FILTER, Settings.METAOPTION, Settings.OPTION

Field Summary

Fields inherited from interface com.inet.pdfc.config.Settings

IMAGE_SCALE_FACTOR, MAX_ERRORS_PER_FILE

Constructor Summary

Constructors

Constructor	Description
DefaultSetting()	The Defaultsetting with the default values

Method Summary

Modifier and Type	Method	Description
@Nonnull Settings	copy()	Create a copy of the current setting
List<ObjectSetting<?>>	getAllObjectSettingNames()	Returns all registered additional settings.
Color	getColor(@Nonnull com.inet.pdfc.config.ColorSetting colorSetting)	Get the color for a setting
@Nonnull Color	getMarkerColor(DiffGroup.GroupType content)	Returns the color of the marker for a difference group of the given type
@Nonnull Color	getOutlineColor(DiffGroup.GroupType content)	Returns the color to mark the difference elements inside a difference group of the given type
@Nullable Object	getSetting(String setting)	Return the value for this setting
boolean	isEnabled(VisibilitySetting content)	Get the visibility for this setting
void	setColor(Color color, @Nonnull com.inet.pdfc.config.ColorSetting setting)	Set the color for this setting.
void	setEnabled(boolean isVisible, @Nonnull VisibilitySetting... visibles)	Set the visibility for this setting
void	setMarkerColor(@Nonnull Color color, DiffGroup.GroupType content)	Set the color for the marker.
void	setSetting(@Nullable Object value, String setting)	Set the specific setting with the value

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultSetting

public DefaultSetting()

The Defaultsetting with the default values

Since:

4.1

Method Details

getAllObjectSettingNames

public List<ObjectSetting<?>> getAllObjectSettingNames()

Returns all registered additional settings. To query the current value of the setting pass VisibilitySetting.name() to the Settings.getSetting(String) method.

Specified by:

getAllObjectSettingNames in interface Settings

Returns:

all additional settings, not null

setMarkerColor

public void setMarkerColor(@Nonnull
 @Nonnull Color color,
 @Nonnull
 DiffGroup.GroupType content)

Set the color for the marker. Overrides the default provided by {link ColorProvider.getMarkerColor(DiffGroup.GroupType). (For visible set the alpha to 0)

Specified by:

setMarkerColor in interface Settings

Parameters:

color - the marker color

content - the group type tp set the marker color for

setColor

public void setColor(Color color,
 @Nonnull
 @Nonnull com.inet.pdfc.config.ColorSetting setting)

Set the color for this setting. If the key is a DiffGroup.GroupType, it overrides the default provided by ColorProvider.getOutlineColor(DiffGroup.GroupType)).
Note: Colors for DiffGroup.GroupTypes should be semi-transparent.

Specified by:

setColor in interface Settings

Parameters:

color - the color to be used to the markup

setting - the setting key. e.G. a DiffGroup.GroupType or the Settings.METAOPTION.ALLOUTLINEMARKER

See Also:

• DiffGroup.GroupType
• Settings.METAOPTION

setEnabled

public void setEnabled(boolean isVisible,
 @Nonnull
 @Nonnull VisibilitySetting... visibles)

Set the visibility for this setting

Specified by:

setEnabled in interface Settings

Parameters:

isVisible - true for visible otherwise false

visibles - the visibility setting key(s) to update the vsibility for

See Also:

• Settings.EXPORT
• Settings.METAOPTION
• Settings.OPTION
• Settings.FILTER
• DiffGroup.GroupType

isEnabled

public boolean isEnabled(VisibilitySetting content)

Get the visibility for this setting

Specified by:

isEnabled in interface Settings

Parameters:

content - the setting key to get the visibility for

Returns:

true for visible hence false

See Also:

• Settings.EXPORT
• Settings.METAOPTION
• Settings.OPTION
• Settings.FILTER
• DiffGroup.GroupType

getMarkerColor

@Nonnull
public @Nonnull Color getMarkerColor(@Nonnull
 DiffGroup.GroupType content)

Returns the color of the marker for a difference group of the given type

Specified by:

getMarkerColor in interface ColorProvider

Parameters:

content - the type of the difference group

Returns:

the color of the marker for a difference group, should not be null

getColor

public Color getColor(@Nonnull
 @Nonnull com.inet.pdfc.config.ColorSetting colorSetting)

Get the color for a setting

Specified by:

getColor in interface Settings

Parameters:

colorSetting - the key of the setting

Returns:

the color for this setting

getSetting

@Nullable
public @Nullable Object getSetting(String setting)

Return the value for this setting

Specified by:

getSetting in interface Settings

Parameters:

setting - the setting name

Returns:

value for this setting or null if no setting be set.

setSetting

public void setSetting(@Nullable
 @Nullable Object value,
 String setting)

Set the specific setting with the value

Specified by:

setSetting in interface Settings

Parameters:

value - value for the setting or null for remove the setting

setting - the setting name, usually VisibilitySetting.name()

copy

@Nonnull
public @Nonnull Settings copy()

Create a copy of the current setting

Specified by:

copy in interface Settings

Returns:

copy of the current setting

getOutlineColor

@Nonnull
public @Nonnull Color getOutlineColor(DiffGroup.GroupType content)

Returns the color to mark the difference elements inside a difference group of the given type

Specified by:

getOutlineColor in interface ColorProvider

Parameters:

content - the type of the difference group

Returns:

the color to mark the difference elements, should not be null