Package org.apache.fop.fo
Interface FOValidationEventProducer
- All Superinterfaces:
org.apache.fop.events.EventProducer
public interface FOValidationEventProducer
extends org.apache.fop.events.EventProducer
Event producer interface for XSL-FO validation messages.
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
Provider class for the event producer. -
Method Summary
Modifier and TypeMethodDescriptionvoid
altTextMissing
(Object source, String foElement, Locator loc) Alternate text is missing for a graphic element.void
changeBarClassNotUnique
(Object source, String elementName, String name, Locator loc) A class for change bars is not unique.void
changeBarNoBegin
(Object source, String elementName, Locator loc) Change bar ended without a start of bar occurredvoid
changeBarWrongAncestor
(Object source, String elementName, Locator loc) Change bar not descendant of fo:flow or fo:static-contentvoid
changeBarWrongStacking
(Object source, String elementName, String beginName, String endName, Locator loc) Change bars were not stacked correctlyvoid
colorProfileNameNotUnique
(Object source, String elementName, String name, Locator loc) There are multiple color profiles defined with the same name.void
columnCountErrorOnRegionBodyOverflowScroll
(Object source, String elementName, Locator loc) If overflow property is set to "scroll", a column-count other than "1" may not be specified.void
duplicateFlowNameInPageSequence
(Object source, String elementName, String flowName, Locator loc) There are multiple flows with the same name.void
emptyDocument
(Object source) No FO document was found.void
flowNameNotMapped
(Object source, String elementName, String flowName, Locator loc) A flow name could not be mapped to a region.void
idNotUnique
(Object source, String elementName, String id, boolean canRecover, Locator loc) An id was used twice in a document.void
illegalRegionName
(Object source, String elementName, String regionName, Locator loc) An illegal region name was used.void
invalidChild
(Object source, String elementName, org.apache.xmlgraphics.util.QName offendingNode, String ruleViolated, Locator loc) An invalid child was encountered.void
invalidFORoot
(Object source, String elementName, Locator loc) fo:root must be root.void
invalidProperty
(Object source, String elementName, org.apache.xmlgraphics.util.QName attr, boolean canRecover, Locator loc) An invalid property was found.void
invalidPropertyValue
(Object source, String elementName, String propName, String propValue, PropertyException e, Locator loc) An invalid property value was encountered.void
markerBlockContainerAbsolutePosition
(Object source, Locator loc) An fo:marker appears as initial descendant in an fo:block-container that generates absolutely positioned areasvoid
markerCloningFailed
(Object source, String markerClassName, FOPException fe, Locator loc) Indicates a problem while cloning a marker (ex.void
markerNotInitialChild
(Object source, String elementName, String mcname, Locator loc) A marker is not an initial child on a node.void
markerNotUniqueForSameParent
(Object source, String elementName, String mcname, Locator loc) A marker class name is not unique within the same parent.void
masterNameNotUnique
(Object source, String elementName, String name, Locator loc) There are multiple page masters defined with the same name.void
masterNotFound
(Object source, String elementName, String masterReference, Locator loc) A page master could not be found.void
missingChildElement
(Object source, String elementName, String contentModel, boolean canRecover, Locator loc) A required child element is missing.void
missingLinkDestination
(Object source, String elementName, Locator loc) Missing internal-/external-destination on basic-link or bookmark.void
missingProperty
(Object source, String elementName, String propertyName, Locator loc) An element is missing a required property.void
nodeOutOfOrder
(Object source, String elementName, String tooLateNode, String tooEarlyNode, boolean canRecover, Locator loc) The node order is wrong.void
nonZeroBorderPaddingOnRegion
(Object source, String elementName, String regionName, boolean canRecover, Locator loc) A non-zero border and/or padding has been encountered on a region.void
notSupportedChild
(Object source, String elementName, org.apache.xmlgraphics.util.QName offendingNode, Locator loc) A valid but not yet supported child was encountered.void
regionNameMappedToMultipleRegionClasses
(Object source, String regionName, String defaultRegionClass1, String defaultRegionClass2, Locator loc) A region name is mapped to multiple region classes.void
tooManyNodes
(Object source, String elementName, org.apache.xmlgraphics.util.QName offendingNode, Locator loc) Too many child nodes.void
unimplementedFeature
(Object source, String elementName, String feature, Locator loc) A feature is not supported, yet.void
unknownFormattingObject
(Object source, String elementName, org.apache.xmlgraphics.util.QName offendingNode, Locator loc) An unknown/unsupported formatting object has been encountered.void
warnOnInvalidPropertyValue
(Object source, String elementName, String propName, String propValue, PropertyException e, Locator loc) An invalid property value was encountered.
-
Method Details
-
tooManyNodes
void tooManyNodes(Object source, String elementName, org.apache.xmlgraphics.util.QName offendingNode, Locator loc) throws ValidationException Too many child nodes.- Parameters:
source
- the event sourceelementName
- the name of the context nodeoffendingNode
- the offending nodeloc
- the location of the error or null- Throws:
ValidationException
- the validation error provoked by the method call- Event severity level:
- FATAL
-
nodeOutOfOrder
void nodeOutOfOrder(Object source, String elementName, String tooLateNode, String tooEarlyNode, boolean canRecover, Locator loc) throws ValidationException The node order is wrong.- Parameters:
source
- the event sourceelementName
- the name of the context nodetooLateNode
- string name of node that should be earlier in documenttooEarlyNode
- string name of node that should be later in documentcanRecover
- indicates whether FOP can recover from this problem and continue workingloc
- the location of the error or null- Throws:
ValidationException
- the validation error provoked by the method call
-
invalidChild
void invalidChild(Object source, String elementName, org.apache.xmlgraphics.util.QName offendingNode, String ruleViolated, Locator loc) throws ValidationException An invalid child was encountered.- Parameters:
source
- the event sourceelementName
- the name of the context nodeoffendingNode
- the offending noderuleViolated
- the rule that was violated or nullloc
- the location of the error or null- Throws:
ValidationException
- the validation error provoked by the method call
-
notSupportedChild
void notSupportedChild(Object source, String elementName, org.apache.xmlgraphics.util.QName offendingNode, Locator loc) throws ValidationException A valid but not yet supported child was encountered.- Parameters:
source
- the event sourceelementName
- the name of the context nodeoffendingNode
- the offending nodeloc
- the location of the error or null- Throws:
ValidationException
- the validation error provoked by the method call
-
missingChildElement
void missingChildElement(Object source, String elementName, String contentModel, boolean canRecover, Locator loc) throws ValidationException A required child element is missing.- Parameters:
source
- the event sourceelementName
- the name of the context nodecontentModel
- the expected content modelcanRecover
- indicates whether FOP can recover from this problem and continue workingloc
- the location of the error or null- Throws:
ValidationException
- the validation error provoked by the method call- Event severity level:
- FATAL
-
missingProperty
void missingProperty(Object source, String elementName, String propertyName, Locator loc) throws ValidationException An element is missing a required property.- Parameters:
source
- the event sourceelementName
- the name of the context nodepropertyName
- the name of the missing propertyloc
- the location of the error or null- Throws:
ValidationException
- the validation error provoked by the method call- Event severity level:
- FATAL
-
idNotUnique
void idNotUnique(Object source, String elementName, String id, boolean canRecover, Locator loc) throws ValidationException An id was used twice in a document.- Parameters:
source
- the event sourceelementName
- the name of the context nodeid
- the id that was reusedcanRecover
- indicates whether FOP can recover from this problem and continue workingloc
- the location of the error or null- Throws:
ValidationException
- the validation error provoked by the method call- Event severity level:
- FATAL
-
colorProfileNameNotUnique
There are multiple color profiles defined with the same name.- Parameters:
source
- the event sourceelementName
- the name of the context nodename
- the duplicate color profile nameloc
- the location of the error or null- Event severity level:
- WARN
-
masterNameNotUnique
void masterNameNotUnique(Object source, String elementName, String name, Locator loc) throws ValidationException There are multiple page masters defined with the same name.- Parameters:
source
- the event sourceelementName
- the name of the context nodename
- the duplicate page master nameloc
- the location of the error or null- Throws:
ValidationException
- the validation error provoked by the method call- Event severity level:
- FATAL
-
markerBlockContainerAbsolutePosition
An fo:marker appears as initial descendant in an fo:block-container that generates absolutely positioned areas- Parameters:
source
- the event sourceloc
- the location of the error (possibly null)- Event severity level:
- ERROR
-
markerNotInitialChild
A marker is not an initial child on a node.- Parameters:
source
- the event sourceelementName
- the name of the context nodemcname
- the marker class nameloc
- the location of the error or null- Event severity level:
- ERROR
-
markerNotUniqueForSameParent
A marker class name is not unique within the same parent.- Parameters:
source
- the event sourceelementName
- the name of the context nodemcname
- the marker class nameloc
- the location of the error or null- Event severity level:
- ERROR
-
invalidProperty
void invalidProperty(Object source, String elementName, org.apache.xmlgraphics.util.QName attr, boolean canRecover, Locator loc) throws ValidationException An invalid property was found.- Parameters:
source
- the event sourceelementName
- the name of the context nodeattr
- the invalid attributecanRecover
- indicates whether FOP can recover from this problem and continue workingloc
- the location of the error or null- Throws:
ValidationException
- the validation error provoked by the method call- Event severity level:
- FATAL
-
invalidPropertyValue
void invalidPropertyValue(Object source, String elementName, String propName, String propValue, PropertyException e, Locator loc) An invalid property value was encountered.- Parameters:
source
- the event sourceelementName
- the name of the context nodepropName
- the property namepropValue
- the property valuee
- the property exception caused by the invalid valueloc
- the location of the error or null- Event severity level:
- ERROR
-
warnOnInvalidPropertyValue
void warnOnInvalidPropertyValue(Object source, String elementName, String propName, String propValue, PropertyException e, Locator loc) An invalid property value was encountered.- Parameters:
source
- the event sourceelementName
- the name of the context nodepropName
- the property namepropValue
- the property valuee
- the property exception caused by the invalid valueloc
- the location of the error or null- Event severity level:
- WARN
-
unimplementedFeature
A feature is not supported, yet.- Parameters:
source
- the event sourceelementName
- the name of the context nodefeature
- the unsupported featureloc
- the location of the error or null- Event severity level:
- WARN
-
missingLinkDestination
void missingLinkDestination(Object source, String elementName, Locator loc) throws ValidationException Missing internal-/external-destination on basic-link or bookmark.- Parameters:
source
- the event sourceelementName
- the name of the context nodeloc
- the location of the error or null- Throws:
ValidationException
- the validation error provoked by the method call- Event severity level:
- FATAL
-
markerCloningFailed
Indicates a problem while cloning a marker (ex. due to invalid property values).- Parameters:
source
- the event sourcemarkerClassName
- the "marker-class-name" of the markerfe
- the FOP exception that cause this problemloc
- the location of the error or null- Event severity level:
- ERROR
-
regionNameMappedToMultipleRegionClasses
void regionNameMappedToMultipleRegionClasses(Object source, String regionName, String defaultRegionClass1, String defaultRegionClass2, Locator loc) throws ValidationException A region name is mapped to multiple region classes.- Parameters:
source
- the event sourceregionName
- the region namedefaultRegionClass1
- the first default region classdefaultRegionClass2
- the second default region classloc
- the location of the error or null- Throws:
ValidationException
- the validation error provoked by the method call- Event severity level:
- FATAL
-
duplicateFlowNameInPageSequence
void duplicateFlowNameInPageSequence(Object source, String elementName, String flowName, Locator loc) throws ValidationException There are multiple flows with the same name.- Parameters:
source
- the event sourceelementName
- the name of the context nodeflowName
- the flow nameloc
- the location of the error or null- Throws:
ValidationException
- the validation error provoked by the method call- Event severity level:
- FATAL
-
flowNameNotMapped
void flowNameNotMapped(Object source, String elementName, String flowName, Locator loc) throws ValidationException A flow name could not be mapped to a region.- Parameters:
source
- the event sourceelementName
- the name of the context nodeflowName
- the flow nameloc
- the location of the error or null- Throws:
ValidationException
- the validation error provoked by the method call- Event severity level:
- FATAL
-
masterNotFound
void masterNotFound(Object source, String elementName, String masterReference, Locator loc) throws ValidationException A page master could not be found.- Parameters:
source
- the event sourceelementName
- the name of the context nodemasterReference
- the page master referenceloc
- the location of the error or null- Throws:
ValidationException
- the validation error provoked by the method call- Event severity level:
- FATAL
-
illegalRegionName
void illegalRegionName(Object source, String elementName, String regionName, Locator loc) throws ValidationException An illegal region name was used.- Parameters:
source
- the event sourceelementName
- the name of the context noderegionName
- the region nameloc
- the location of the error or null- Throws:
ValidationException
- the validation error provoked by the method call- Event severity level:
- FATAL
-
nonZeroBorderPaddingOnRegion
void nonZeroBorderPaddingOnRegion(Object source, String elementName, String regionName, boolean canRecover, Locator loc) throws ValidationException A non-zero border and/or padding has been encountered on a region.- Parameters:
source
- the event sourceelementName
- the name of the context noderegionName
- the region namecanRecover
- indicates whether FOP can recover from this problem and continue workingloc
- the location of the error or null- Throws:
ValidationException
- the validation error provoked by the method call- Event severity level:
- FATAL
-
columnCountErrorOnRegionBodyOverflowScroll
void columnCountErrorOnRegionBodyOverflowScroll(Object source, String elementName, Locator loc) throws ValidationException If overflow property is set to "scroll", a column-count other than "1" may not be specified.- Parameters:
source
- the event sourceelementName
- the name of the context nodeloc
- the location of the error or null- Throws:
ValidationException
- the validation error provoked by the method call- Event severity level:
- FATAL
-
invalidFORoot
fo:root must be root.- Parameters:
source
- the event sourceelementName
- the name of the context nodeloc
- the location of the error or null- Throws:
ValidationException
- the validation error provoked by the method call- Event severity level:
- FATAL
-
emptyDocument
No FO document was found.- Parameters:
source
- the event source- Throws:
ValidationException
- the validation error provoked by the method call- Event severity level:
- FATAL
-
unknownFormattingObject
void unknownFormattingObject(Object source, String elementName, org.apache.xmlgraphics.util.QName offendingNode, Locator loc) An unknown/unsupported formatting object has been encountered.- Parameters:
source
- the event sourceelementName
- the name of the context nodeoffendingNode
- the offending nodeloc
- the location of the error or null- Event severity level:
- WARN
-
changeBarClassNotUnique
A class for change bars is not unique.- Parameters:
source
- the event sourceelementName
- the name of the context nodename
- the class nameloc
- the location of the error or null- Event severity level:
- FATAL
-
changeBarWrongStacking
void changeBarWrongStacking(Object source, String elementName, String beginName, String endName, Locator loc) Change bars were not stacked correctly- Parameters:
source
- the event sourceelementName
- the name of the context nodebeginName
- the class name of the beginning change barendName
- the class name of the ending change barloc
- the location of the error or null- Event severity level:
- FATAL
-
changeBarNoBegin
Change bar ended without a start of bar occurred- Parameters:
source
- the event sourceelementName
- the name of the context nodeloc
- the location of the error or null- Event severity level:
- FATAL
-
changeBarWrongAncestor
Change bar not descendant of fo:flow or fo:static-content- Parameters:
source
- the event sourceelementName
- the name of the context nodeloc
- the location of the error or null- Event severity level:
- FATAL
-
altTextMissing
Alternate text is missing for a graphic element.- Parameters:
source
- the event sourcefoElement
- name of the element (external-graphic or instream-foreign-object)loc
- the location of the error or null- Event severity level:
- WARN
-