Documentation
¶
Index ¶
- type BasicInspector
- type Context
- type Extension
- type Hub
- type HubImpl
- type InspectionReport
- type Inspector
- type JSSanitizer
- type JavaScriptRunner
- type PDFAValidator
- type Phase
- type SanitizationAction
- type SanitizationReport
- type Sanitizer
- type Transformer
- type ValidationError
- type ValidationReport
- type ValidationWarning
- type Validator
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BasicInspector ¶
type BasicInspector struct{}
BasicInspector implements a simple document inspector.
func (*BasicInspector) Execute ¶
func (i *BasicInspector) Execute(ctx Context, doc *semantic.Document) error
func (*BasicInspector) Inspect ¶
func (i *BasicInspector) Inspect(ctx Context, doc *semantic.Document) (*InspectionReport, error)
func (*BasicInspector) Name ¶
func (i *BasicInspector) Name() string
func (*BasicInspector) Phase ¶
func (i *BasicInspector) Phase() Phase
func (*BasicInspector) Priority ¶
func (i *BasicInspector) Priority() int
type HubImpl ¶
type HubImpl struct {
// contains filtered or unexported fields
}
func (*HubImpl) Extensions ¶
type InspectionReport ¶
type Inspector ¶
type Inspector interface {
Extension
Inspect(ctx Context, doc *semantic.Document) (*InspectionReport, error)
}
Inspector is an extension that inspects the document and produces a report.
type JSSanitizer ¶
type JSSanitizer struct{}
JSSanitizer removes JavaScript actions from annotations.
func (*JSSanitizer) Execute ¶
func (s *JSSanitizer) Execute(ctx Context, doc *semantic.Document) error
func (*JSSanitizer) Name ¶
func (s *JSSanitizer) Name() string
func (*JSSanitizer) Phase ¶
func (s *JSSanitizer) Phase() Phase
func (*JSSanitizer) Priority ¶
func (s *JSSanitizer) Priority() int
func (*JSSanitizer) Sanitize ¶
func (s *JSSanitizer) Sanitize(ctx Context, doc *semantic.Document) (*SanitizationReport, error)
type JavaScriptRunner ¶
type JavaScriptRunner struct {
// contains filtered or unexported fields
}
JavaScriptRunner is a Transformer extension that executes JavaScript actions. This is primarily used for form calculations and document initialization scripts.
func NewJavaScriptRunner ¶
func NewJavaScriptRunner(engine scripting.Engine) *JavaScriptRunner
func (*JavaScriptRunner) Execute ¶
func (r *JavaScriptRunner) Execute(ctx Context, doc *semantic.Document) error
func (*JavaScriptRunner) Name ¶
func (r *JavaScriptRunner) Name() string
func (*JavaScriptRunner) Phase ¶
func (r *JavaScriptRunner) Phase() Phase
func (*JavaScriptRunner) Priority ¶
func (r *JavaScriptRunner) Priority() int
type PDFAValidator ¶
PDFAValidator wraps the pdfa package to provide validation.
func (*PDFAValidator) Execute ¶
func (v *PDFAValidator) Execute(ctx Context, doc *semantic.Document) error
func (*PDFAValidator) Name ¶
func (v *PDFAValidator) Name() string
func (*PDFAValidator) Phase ¶
func (v *PDFAValidator) Phase() Phase
func (*PDFAValidator) Priority ¶
func (v *PDFAValidator) Priority() int
func (*PDFAValidator) Validate ¶
func (v *PDFAValidator) Validate(ctx Context, doc *semantic.Document) (*ValidationReport, error)
type SanitizationAction ¶
type SanitizationReport ¶
type SanitizationReport struct {
ItemsRemoved int
ItemsFixed int
Actions []SanitizationAction
}
type Sanitizer ¶
type Sanitizer interface {
Extension
Sanitize(ctx Context, doc *semantic.Document) (*SanitizationReport, error)
}
Sanitizer is an extension that cleans up the document.
type Transformer ¶
Transformer is an extension that modifies the document structure.
type ValidationError ¶
type ValidationReport ¶
type ValidationReport struct {
Valid bool
Errors []ValidationError
Warnings []ValidationWarning
}
type ValidationWarning ¶
Click to show internal directories.
Click to hide internal directories.