T
- the type of the propertypublic class PDFCProperty<T>
extends java.lang.Object
IProfile
Modifier and Type | Field and Description |
---|---|
static PDFCProperty<java.lang.Boolean> |
COMPARE_LINE_STYLES
This is a parameter for any type of line/shape comparison - either paged or continuous.
|
static PDFCProperty<java.lang.Boolean> |
COMPARE_TEXT_CASE_SENSITIVE
This switch toggles the case sensitivity of the text comparison.
|
static PDFCProperty<TextStyleType> |
COMPARE_TEXT_STYLES
Specifies a comma-separated list of textstyles.
|
static PDFCProperty<CompareType> |
COMPARE_TYPES
A comma separated list of
CompareType s to be included in the comparison |
static PDFCProperty<java.lang.String> |
CONTINUOUS_COMPARE
Enables / Disable continuous compare.
|
static PDFCProperty<java.lang.Integer> |
CONTINUOUS_DETECT_PAGES
Specifies whether the continuous compare can be splited instead of comparing all content at once.
|
static PDFCProperty<java.lang.String> |
CREATE_DIFFIMAGES
Deprecated.
As of i-net PDFC 5.0, see
Settings.EXPORT.CREATE_DIFFIMAGES_FIRST and Settings.EXPORT.CREATE_DIFFIMAGES_SECOND |
static PDFCProperty<java.lang.Boolean> |
CREATE_ORIGIMAGES
Deprecated.
As of i-net PDFC 5.0, see
Settings.EXPORT.CREATE_ORIGIMAGES |
static PDFCProperty<java.lang.Boolean> |
CREATE_XORIMAGES
Deprecated.
As of i-net PDFC 5.0, see
Settings.EXPORT.CREATE_XORIMAGES |
static PDFCProperty<java.lang.String> |
DOCUMENT_LANGUAGE
Specifies the default language for the documents.
|
static PDFCProperty<java.lang.Boolean> |
EXPORT_PDF_ALWAYS
Deprecated.
As of i-net PDFC 5.0, see
Settings.EXPORT.ONLY_ON_DIFFERENCES |
static PDFCProperty<java.lang.String> |
FILTERS
Defines the filters to be used before the elements of the documents are passed to the comparer.
|
static PDFCProperty<java.lang.String> |
FILTER_PATTERNS
The CR-separated list of patterns for the RegExp Filter.
|
static PDFCProperty<java.lang.Integer> |
FIXED_FOOTER_SIZE
Specify the property for header/footer filter
|
static PDFCProperty<java.lang.Integer> |
FIXED_HEADER_SIZE
Specify the property for header/footer filter
|
static PDFCProperty<java.lang.Boolean> |
IMAGE_CHANGE_AREA
If the image compare block by block with better result.
|
static PDFCProperty<java.lang.Double> |
IMAGE_SCALE_FACTOR
Deprecated.
As of i-net PDFC 5.0, see
Settings.IMAGE_SCALE_FACTOR |
static PDFCProperty<java.lang.String> |
LOG_FILE
Deprecated.
As of i-net PDFC 5.0, see
PDFCCorePlugin.configureLogging( java.io.File ) |
static PDFCProperty<java.lang.String> |
LOG_LEVEL
Deprecated.
As of i-net PDFC 5.0, see
PDFCCorePlugin.setLogLevel( com.inet.logging.LogLevel ) |
static PDFCProperty<java.lang.Integer> |
MAX_ERRORS_PER_FILE
Deprecated.
As of i-net PDFC 5.0, see
Settings.MAX_ERRORS_PER_FILE |
static PDFCProperty<java.lang.Double> |
TEXT_ALIGN_RATIO
This value is the maximum allowed y-jitter for the text line identification.
|
static PDFCProperty<java.lang.Integer> |
TOLERANCE_BOX_ROUND_EDGES
Specifies the maximum number of pixels (1 pixel is approximately 0.265mm) that a control point of a quadratic
Bézier curve may differ in total before it is viewed as a difference.
|
static PDFCProperty<java.lang.Double> |
TOLERANCE_COLOR
Defines the maximum color difference per RGB or HSB channel for all paints.
|
static PDFCProperty<java.lang.Integer> |
TOLERANCE_IMAGE_DISTANCE
Specifies the maximum number of pixels that the position of an image can differ before it is viewed as a
difference.
|
static PDFCProperty<java.lang.Double> |
TOLERANCE_IMAGE_PIXEL_VALUE
Specifies the maximal allowed discrepancy of pixel values (Double) before it is viewed as a difference.
|
static PDFCProperty<java.lang.Double> |
TOLERANCE_IMAGE_SIZE
Specifies the maximum relative difference that the area spanned by an image may differ before it is viewed as a
difference.
|
static PDFCProperty<java.lang.Integer> |
TOLERANCE_LINE_POSITION
Specifies the maximum number of pixels that the position of a line or curves can differ per axis before it is
viewed as a difference.
|
static PDFCProperty<java.lang.Integer> |
TOLERANCE_LINE_SIZE
Specifies the maximum number of pixels that the length of a line can differ in total before it is viewed as a
difference.
|
static PDFCProperty<java.lang.Boolean> |
TOLERANCE_LINE_STYLE
Specifies if a different line dash pattern, describing dashes and gaps used to stroke paths will be viewed as a
difference.
|
static PDFCProperty<java.lang.Integer> |
TOLERANCE_LINE_THICKNESS
Specifies the maximum difference in stroke thickness of two lines or curves before it is viewed as a difference.
|
static PDFCProperty<java.lang.Integer> |
TOLERANCE_PAGE_LEFTCORNER
Specifies the maximum number of pixels that the left or top margin of a page can differ (is the upper left corner
of all elements) before it is viewed as a difference.
|
static PDFCProperty<java.lang.Double> |
TOLERANCE_PAGE_RATIO
Specifies the tolerance for the aspect ratio of the PDF page.
|
static PDFCProperty<java.lang.Integer> |
TOLERANCE_PAGE_SIZE
Specifies the maximum number of pixels that the width or height of a page can differ before it is viewed as a
difference.
|
static PDFCProperty<java.lang.Integer> |
TOLERANCE_TEXT_LOCATION
Specifies the maximum allowed location jitter for matched text elements in pixels.
|
static PDFCProperty<java.lang.Double> |
TOLERANCE_TEXT_SIZE
Defines the maximum relative font size difference for text.
|
static PDFCProperty<java.lang.Double> |
TOLERANCE_UNDERLINE_LENGTH
Specifies the maximum difference in percent, in which the length of underlines may differ before it is viewed as
a difference.
|
static PDFCProperty<java.lang.Boolean> |
USE_PIXEL_MEDIUM_VALUE
Specifies whether i-net PDFC should compare images using the average pixel values instead of single pixel values.
|
Constructor and Description |
---|
PDFCProperty(java.lang.String name,
int defaultValue,
int lowerBound,
int upperBound)
Creates a new integer
PDFCProperty with the specified default value. |
PDFCProperty(java.lang.String name,
double defaultValue,
double lowerBound,
double upperBound)
Creates a new double
PDFCProperty with the specified default value. |
PDFCProperty(java.lang.String name,
boolean defaultValue)
Creates a new boolean
PDFCProperty with the specified default value. |
PDFCProperty(java.lang.String name,
java.lang.String defaultValue,
java.lang.String... validValues)
Creates a new single-choice
PDFCProperty with the specified default value and a set of valid values. |
PDFCProperty(java.lang.String name,
java.lang.String defaultValue,
ValidValueProvider provider)
Creates a new single-choice
PDFCProperty with the specified default value and a set of valid values. |
PDFCProperty(java.lang.String name,
java.lang.Class<T> validValues,
D... defaultValue)
Creates a new multi-choice
PDFCProperty with the specified default value and a set of valid values. |
Modifier and Type | Method and Description |
---|---|
java.util.List<ValidValueProvider.ValidValue> |
getAvialableValues()
Returns the available values in case of an
String or Enum type with an additional translation. |
T |
getDefaultValue()
Returns the default value of the property.
|
com.inet.pdfc.util.Pair<java.lang.Number> |
getLimits()
Returns the lower and upper limit for numeric properties.
|
static java.lang.Object[] |
getSelectedValues(IProfile config,
PDFCProperty<?> property)
Convenience function to get the selected enum values for an
Enum type property |
java.lang.Class<?> |
getType()
Returns the type of the property value.
|
java.lang.Object[] |
getValidValues()
Returns the available values in case of an
String or Enum type. |
java.lang.String |
name()
Get the name of the property
|
static java.lang.String |
toPropertyValue(java.lang.Object[] choice)
Convenience function to get the property value for a multi-choice property.
|
static PDFCProperty<?> |
valueOf(java.lang.String name)
Get a PDFCProperty by name
|
static java.util.Collection<PDFCProperty<?>> |
values()
Get all available values.
|
@Deprecated public static final PDFCProperty<java.lang.String> CREATE_DIFFIMAGES
Settings.EXPORT.CREATE_DIFFIMAGES_FIRST
and Settings.EXPORT.CREATE_DIFFIMAGES_SECOND
@Deprecated public static final PDFCProperty<java.lang.Boolean> CREATE_XORIMAGES
Settings.EXPORT.CREATE_XORIMAGES
@Deprecated public static final PDFCProperty<java.lang.Boolean> CREATE_ORIGIMAGES
Settings.EXPORT.CREATE_ORIGIMAGES
@Deprecated public static final PDFCProperty<java.lang.Double> IMAGE_SCALE_FACTOR
Settings.IMAGE_SCALE_FACTOR
@Deprecated public static final PDFCProperty<java.lang.String> LOG_LEVEL
PDFCCorePlugin.setLogLevel( com.inet.logging.LogLevel )
@Deprecated public static final PDFCProperty<java.lang.String> LOG_FILE
PDFCCorePlugin.configureLogging( java.io.File )
public static final PDFCProperty<java.lang.String> DOCUMENT_LANGUAGE
@Deprecated public static final PDFCProperty<java.lang.Integer> MAX_ERRORS_PER_FILE
Settings.MAX_ERRORS_PER_FILE
public static final PDFCProperty<java.lang.Integer> TOLERANCE_BOX_ROUND_EDGES
public static final PDFCProperty<java.lang.Integer> TOLERANCE_IMAGE_DISTANCE
public static final PDFCProperty<java.lang.Double> TOLERANCE_IMAGE_PIXEL_VALUE
public static final PDFCProperty<java.lang.Double> TOLERANCE_IMAGE_SIZE
public static final PDFCProperty<java.lang.Boolean> IMAGE_CHANGE_AREA
public static final PDFCProperty<java.lang.Integer> TOLERANCE_LINE_POSITION
public static final PDFCProperty<java.lang.Integer> TOLERANCE_LINE_SIZE
public static final PDFCProperty<java.lang.Boolean> TOLERANCE_LINE_STYLE
public static final PDFCProperty<java.lang.Integer> TOLERANCE_LINE_THICKNESS
public static final PDFCProperty<java.lang.Integer> TOLERANCE_PAGE_LEFTCORNER
public static final PDFCProperty<java.lang.Double> TOLERANCE_PAGE_RATIO
public static final PDFCProperty<java.lang.Integer> TOLERANCE_PAGE_SIZE
public static final PDFCProperty<java.lang.Double> TOLERANCE_UNDERLINE_LENGTH
public static final PDFCProperty<java.lang.Integer> TOLERANCE_TEXT_LOCATION
public static final PDFCProperty<java.lang.Double> TOLERANCE_TEXT_SIZE
public static final PDFCProperty<java.lang.Double> TOLERANCE_COLOR
public static final PDFCProperty<TextStyleType> COMPARE_TEXT_STYLES
TextStyleType
constants, comma-separated.TextStyleType
public static final PDFCProperty<java.lang.Double> TEXT_ALIGN_RATIO
public static final PDFCProperty<java.lang.Boolean> COMPARE_TEXT_CASE_SENSITIVE
public static final PDFCProperty<java.lang.Boolean> COMPARE_LINE_STYLES
public static final PDFCProperty<java.lang.Boolean> USE_PIXEL_MEDIUM_VALUE
TOLERANCE_IMAGE_PIXEL_VALUE
public static final PDFCProperty<java.lang.Integer> FIXED_HEADER_SIZE
public static final PDFCProperty<java.lang.Integer> FIXED_FOOTER_SIZE
public static final PDFCProperty<java.lang.String> FILTERS
FILTERS
property to be enabled. Furthermore there could be
additional properties to a filter. Please refer to the documentation of the filters for details.public static final PDFCProperty<CompareType> COMPARE_TYPES
CompareType
s to be included in the comparisonpublic static final PDFCProperty<java.lang.Integer> CONTINUOUS_DETECT_PAGES
public static final PDFCProperty<java.lang.String> CONTINUOUS_COMPARE
@Deprecated public static final PDFCProperty<java.lang.Boolean> EXPORT_PDF_ALWAYS
Settings.EXPORT.ONLY_ON_DIFFERENCES
public static final PDFCProperty<java.lang.String> FILTER_PATTERNS
public PDFCProperty(java.lang.String name, int defaultValue, int lowerBound, int upperBound)
PDFCProperty
with the specified default value.name
- the property name.defaultValue
- the default value for the propertylowerBound
- the lower bound for this int propertyupperBound
- the upper bound for this int propertyjava.lang.IllegalStateException
- if a property with that name was already definedpublic PDFCProperty(java.lang.String name, double defaultValue, double lowerBound, double upperBound)
PDFCProperty
with the specified default value.name
- the property name.defaultValue
- the default value for the propertylowerBound
- the lower bound for this lowerBound propertyupperBound
- the upper bound for this upperBound propertyjava.lang.IllegalStateException
- if a property with that name was already definedpublic PDFCProperty(java.lang.String name, boolean defaultValue)
PDFCProperty
with the specified default value.name
- the property name.defaultValue
- the default value for the propertyjava.lang.IllegalStateException
- if a property with that name was already definedpublic PDFCProperty(java.lang.String name, java.lang.String defaultValue, java.lang.String... validValues)
PDFCProperty
with the specified default value and a set of valid values.name
- the property name.defaultValue
- the default value for the propertyvalidValues
- the valid values for this propertyjava.lang.IllegalStateException
- if a property with that name was already definedpublic PDFCProperty(java.lang.String name, java.lang.String defaultValue, ValidValueProvider provider)
PDFCProperty
with the specified default value and a set of valid values.name
- the property name.defaultValue
- the default value for the propertyprovider
- the implementation that provides the valid values for this property along with the translations of these these valuesjava.lang.IllegalStateException
- if a property with that name was already defined@SafeVarargs public PDFCProperty(java.lang.String name, java.lang.Class<T> validValues, D... defaultValue)
PDFCProperty
with the specified default value and a set of valid values.name
- the property name.validValues
- the enum which defines the valid valuesdefaultValue
- the default value for the property, this allows multiple selection by defaultjava.lang.IllegalStateException
- if a property with that name was already definedpublic java.lang.String name()
public static PDFCProperty<?> valueOf(java.lang.String name)
name
- the property namenull
if there is no such propertypublic static java.util.Collection<PDFCProperty<?>> values()
public T getDefaultValue()
public java.lang.Class<?> getType()
public com.inet.pdfc.util.Pair<java.lang.Number> getLimits()
Integer.MAX_VALUE
or higher have to be interpreted as unlimitednull
if the type is not numericpublic java.lang.Object[] getValidValues()
String
or Enum
type.String
value, only a single choice of these values is allowed. If the type is
Enum
, it a multi-choice property. In that case, use toPropertyValue(Object[])
to simply get the
property value from the users choice.String
or Enum
, else null
public java.util.List<ValidValueProvider.ValidValue> getAvialableValues()
String
or Enum
type with an additional translation.String
value, only a single choice of these values is allowed. If the type is
Enum
, it a multi-choice property. In that case, use toPropertyValue(Object[])
to simply get the
property value from the users choice.String
or Enum
, else null
public static java.lang.String toPropertyValue(java.lang.Object[] choice)
choice
- the users choice, may be empty or null
as wellpublic static java.lang.Object[] getSelectedValues(IProfile config, PDFCProperty<?> property)
Enum
type propertyconfig
- the config to get the current value fromproperty
- the property to get the value fornull
if the property is not an Enum
type.Copyright © 2010-2022 by i-net software GmbH