Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- A4 - Enum constant in enum class com.nsdev.lettergenerator.model.layout.PageSize
-
ISO A4 portrait: 210 by 297 millimeters.
- A4 - Static variable in record class com.nsdev.lettergenerator.model.layout.PageSpec
-
A4 with 20 mm margins and zero-height reserved zones.
- address() - Method in record class com.nsdev.lettergenerator.letter.Party
-
Returns the value of the
addressrecord component. - Address - Record Class in com.nsdev.lettergenerator.letter
-
Application-supplied postal address lines in their intended display order.
- Address(List<String>) - Constructor for record class com.nsdev.lettergenerator.letter.Address
-
Snapshots address lines without imposing country-specific postal rules.
- addressLayout(AddressLayout) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Places configured sender/recipient/date fields inside an editable body-relative panel.
- AddressLayout - Record Class in com.nsdev.lettergenerator.letter
-
Optional freely positioned sender, recipient and date panel inside body flow.
- AddressLayout(Bounds, Bounds, Bounds, double) - Constructor for record class com.nsdev.lettergenerator.letter.AddressLayout
-
Creates an instance of a
AddressLayoutrecord class. - ALL - Enum constant in enum class com.nsdev.lettergenerator.model.layout.PageSelector
-
Every page, including the first.
- altText() - Method in record class com.nsdev.lettergenerator.model.block.ImageBlock
-
Returns the value of the
altTextrecord component. - ALWAYS - Enum constant in enum class com.nsdev.lettergenerator.model.layout.Keep
-
Strongly request a keep; impossible layouts remain subject to engine validation.
- appearance() - Method in record class com.nsdev.lettergenerator.model.block.BoxBlock
-
Returns the value of the
appearancerecord component. - appearance() - Method in record class com.nsdev.lettergenerator.model.table.TableCell
-
Returns the value of the
appearancerecord component. - asset(String, byte[]) - Method in class com.nsdev.lettergenerator.builder.HtmlLetterBuilder
-
Registers a defensive copy of named image bytes for later HTML asset resolution.
- asset(String, byte[]) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Registers a defensive copy of named image bytes for later HTML asset resolution.
- asset(String, byte[]) - Method in class com.nsdev.lettergenerator.builder.StationeryBuilder
-
Supplies a named image for deferred header/footer markup.
- asset(String, Path) - Method in class com.nsdev.lettergenerator.builder.HtmlLetterBuilder
-
Reads a local file immediately and registers its bytes as a named markup image asset.
- asset(String, Path) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Reads a local file immediately and registers its bytes as a named markup image asset.
- assets() - Method in record class com.nsdev.lettergenerator.template.TemplateRequirements
-
Returns the value of the
assetsrecord component. - at(String, double, double, double, double, Block...) - Method in class com.nsdev.lettergenerator.builder.CanvasBuilder
-
Appends bounded rich content using explicit physical coordinates.
- at(String, Bounds, Block...) - Method in class com.nsdev.lettergenerator.builder.CanvasBuilder
-
Appends bounded rich content with a stable identifier and inherited canvas typography.
- attach(PdfAttachment) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Appends an immutable existing PDF to the output pack.
- ATTACHMENT - Enum constant in enum class com.nsdev.lettergenerator.render.RenderPartKind
-
Pages copied from one explicitly supplied PDF attachment.
- attachments() - Method in record class com.nsdev.lettergenerator.model.LetterDocument
-
Returns the value of the
attachmentsrecord component. - author() - Method in record class com.nsdev.lettergenerator.model.DocumentMetadata
-
Returns the value of the
authorrecord component. - AUTO - Enum constant in enum class com.nsdev.lettergenerator.model.layout.Keep
-
Allow normal page breaks, including disabling an ordinary heading keep.
- AUTO - Enum constant in enum class com.nsdev.lettergenerator.model.layout.TextDirection
-
Select the base direction from the document language.
B
- backgroundColor() - Method in record class com.nsdev.lettergenerator.model.layout.BoxAppearance
-
Returns the value of the
backgroundColorrecord component. - backgroundColor() - Method in record class com.nsdev.lettergenerator.model.table.CellAppearance
-
Returns the value of the
backgroundColorrecord component. - backgroundColor() - Method in record class com.nsdev.lettergenerator.model.table.TableCell
-
Returns the value of the
backgroundColorrecord component. - baseStyle() - Method in record class com.nsdev.lettergenerator.model.style.Style
-
Returns the value of the
baseStylerecord component. - bind(Map<String, ?>) - Method in class com.nsdev.lettergenerator.template.PreparedLetterTemplate
-
Replaces all captured bindings for this call without changing the prepared template.
- block(Block) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Appends an advanced model block without leaving the fluent API.
- Block - Interface in com.nsdev.lettergenerator.model.block
-
Closed set of letter content blocks usable in body sections and positioned regions.
- blocks() - Method in record class com.nsdev.lettergenerator.component.LetterComponent
-
Returns the value of the
blocksrecord component. - blocks() - Method in record class com.nsdev.lettergenerator.model.block.BoxBlock
-
Returns the value of the
blocksrecord component. - blocks() - Method in record class com.nsdev.lettergenerator.model.block.GroupBlock
-
Returns the value of the
blocksrecord component. - blocks() - Method in record class com.nsdev.lettergenerator.model.block.LetterPartBlock
-
Returns the value of the
blocksrecord component. - blocks() - Method in record class com.nsdev.lettergenerator.model.layout.Column
-
Returns the value of the
blocksrecord component. - blocks() - Method in record class com.nsdev.lettergenerator.model.layout.FixedElement
-
Returns the value of the
blocksrecord component. - blocks() - Method in record class com.nsdev.lettergenerator.model.layout.PositionedContent
-
Returns the value of the
blocksrecord component. - blocks() - Method in record class com.nsdev.lettergenerator.model.layout.Signature
-
Returns the value of the
blocksrecord component. - blocks() - Method in record class com.nsdev.lettergenerator.model.Section
-
Returns the value of the
blocksrecord component. - blocks() - Method in record class com.nsdev.lettergenerator.model.table.TableCell
-
Returns the value of the
blocksrecord component. - blocks() - Method in class com.nsdev.lettergenerator.signature.ImageSignature
-
Exposes the ordered immutable blocks represented by this signature part.
- blocks() - Method in interface com.nsdev.lettergenerator.signature.SignatureContent
-
Exposes the ordered immutable blocks represented by this signature part.
- blocks() - Method in class com.nsdev.lettergenerator.signature.TextSignature
-
Exposes the ordered immutable blocks represented by this signature part.
- body(LetterComponent) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Appends an immutable fragment as a softly kept body group.
- body(Style) - Method in class com.nsdev.lettergenerator.theme.LetterTheme.Builder
-
Sets ordinary-content defaults.
- body(String...) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Appends plain text chunks in order.
- BODY - Enum constant in enum class com.nsdev.lettergenerator.theme.StyleRole
-
Shared fallback typography for ordinary content.
- bodyHtml(String) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Appends body content as a fragment of the supported HTML subset.
- bold() - Method in record class com.nsdev.lettergenerator.model.style.Style
-
Returns the value of the
boldrecord component. - bold() - Method in class com.nsdev.lettergenerator.model.style.Style.Builder
-
Enables bold, overriding an inherited regular weight.
- bold(boolean) - Method in class com.nsdev.lettergenerator.model.style.Style.Builder
-
Overrides the inherited bold flag, including explicitly disabling it.
- BOLD - Enum constant in enum class com.nsdev.lettergenerator.font.FontVariant
-
Bold, upright face.
- BOLD_ITALIC - Enum constant in enum class com.nsdev.lettergenerator.font.FontVariant
-
Face combining bold weight and italic posture.
- border() - Method in record class com.nsdev.lettergenerator.model.table.CellAppearance
-
Returns the value of the
borderrecord component. - Border - Record Class in com.nsdev.lettergenerator.model.table
-
Uniform border on all four cell edges.
- Border(double, BorderStyle, String) - Constructor for record class com.nsdev.lettergenerator.model.table.Border
-
Creates an instance of a
Borderrecord class. - borders() - Method in record class com.nsdev.lettergenerator.model.layout.BoxAppearance
-
Returns the value of the
bordersrecord component. - Borders - Record Class in com.nsdev.lettergenerator.model.layout
-
Independent optional physical borders for a flowing box.
- Borders(Border, Border, Border, Border) - Constructor for record class com.nsdev.lettergenerator.model.layout.Borders
-
Creates an instance of a
Bordersrecord class. - BorderStyle - Enum Class in com.nsdev.lettergenerator.model.table
-
Finite vocabulary of native table-cell border line styles.
- bottom() - Method in record class com.nsdev.lettergenerator.model.layout.Borders
-
Returns the value of the
bottomrecord component. - bottom() - Method in record class com.nsdev.lettergenerator.model.layout.Bounds
-
Returns the vertical coordinate of the bottom edge in the same zone.
- bottom() - Method in record class com.nsdev.lettergenerator.model.layout.Margins
-
Returns the value of the
bottomrecord component. - BOTTOM - Enum constant in enum class com.nsdev.lettergenerator.model.layout.Zone
-
Region below the body, measured downward from its own top edge; below the last-page signature zone.
- BOTTOM - Enum constant in enum class com.nsdev.lettergenerator.model.table.VerticalAlignment
-
Align content with the bottom of the inner cell.
- BOTTOM_LAST - Enum constant in enum class com.nsdev.lettergenerator.model.layout.SignaturePlacement
-
Place the signature in its bounds on the final page; requires a positive signature-zone height.
- bottomMm() - Method in record class com.nsdev.lettergenerator.model.table.Padding
-
Returns the value of the
bottomMmrecord component. - bottomZoneMm() - Method in record class com.nsdev.lettergenerator.model.layout.PageSpec
-
Returns the value of the
bottomZoneMmrecord component. - bottomZoneMm() - Method in record class com.nsdev.lettergenerator.theme.Stationery
-
Returns the value of the
bottomZoneMmrecord component. - Bounds - Record Class in com.nsdev.lettergenerator.model.layout
-
Rectangle measured from a containing zone's upper-left corner, in millimeters.
- Bounds(double, double, double, double) - Constructor for record class com.nsdev.lettergenerator.model.layout.Bounds
-
Creates an instance of a
Boundsrecord class. - boundsMm() - Method in record class com.nsdev.lettergenerator.model.layout.FixedElement
-
Returns the value of the
boundsMmrecord component. - boundsMm() - Method in record class com.nsdev.lettergenerator.model.layout.PositionedContent
-
Returns the value of the
boundsMmrecord component. - boundsMm() - Method in record class com.nsdev.lettergenerator.model.layout.Signature
-
Returns the value of the
boundsMmrecord component. - BoxAppearance - Record Class in com.nsdev.lettergenerator.model.layout
-
Optional flow-box decoration, independent of typography and pagination.
- BoxAppearance(Padding, Borders, String) - Constructor for record class com.nsdev.lettergenerator.model.layout.BoxAppearance
-
Creates an instance of a
BoxAppearancerecord class. - BoxBlock - Record Class in com.nsdev.lettergenerator.model.block
-
Rich flowing content with optional independent borders, padding and background color.
- BoxBlock(List<Block>, BoxAppearance, Style) - Constructor for record class com.nsdev.lettergenerator.model.block.BoxBlock
-
Snapshots content without validating nullable authoring values.
- build() - Method in class com.nsdev.lettergenerator.builder.CanvasBuilder
-
Returns an immutable snapshot; later builder mutations do not alter this model.
- build() - Method in class com.nsdev.lettergenerator.builder.HtmlLetterBuilder
-
Compiles the current source, bindings and assets into an immutable document snapshot.
- build() - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Resolves deferred HTML, assets, images and region geometry into an immutable snapshot.
- build() - Method in class com.nsdev.lettergenerator.builder.StationeryBuilder
-
Resolves regions and owned assets into an immutable reusable snapshot.
- build() - Method in class com.nsdev.lettergenerator.builder.TableBuilder
-
Snapshots headers, appended rows, relative widths and current styles into a table block.
- build() - Method in class com.nsdev.lettergenerator.LetterPdfGenerator.Builder
-
Reads and validates every registered font and creates an independent reusable generator.
- build() - Method in class com.nsdev.lettergenerator.model.style.Style.Builder
-
Snapshots the accumulated overrides without validating them or replacing nulls.
- build() - Method in class com.nsdev.lettergenerator.template.PreparedLetterTemplate
- build() - Method in class com.nsdev.lettergenerator.theme.LetterTheme.Builder
- builder() - Static method in class com.nsdev.lettergenerator.Letter
-
Creates a fresh mutable Java letter builder with default page, region and text settings.
- builder() - Static method in class com.nsdev.lettergenerator.LetterPdfGenerator
-
Starts mutable generator configuration for application-supplied TrueType fonts.
- builder() - Static method in record class com.nsdev.lettergenerator.model.style.Style
-
Starts a mutable builder with every override omitted.
- builder() - Static method in record class com.nsdev.lettergenerator.theme.LetterTheme
- builder() - Static method in record class com.nsdev.lettergenerator.theme.Stationery
- builder(double, double) - Static method in class com.nsdev.lettergenerator.Canvas
-
Starts a mutable local builder; resulting models snapshot all positioned elements.
- builder(String...) - Static method in class com.nsdev.lettergenerator.Table
-
Starts a table with equally weighted columns and a bold white-on-dark header row.
C
- canvas(CanvasBlock) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Appends one bounded arbitrary-position body canvas.
- Canvas - Class in com.nsdev.lettergenerator
-
Convenience entry point for stable, bounded positioned content within ordinary letter flow.
- CanvasBlock - Record Class in com.nsdev.lettergenerator.model.block
-
A fixed-size flow unit containing arbitrary bounded elements in stable paint order.
- CanvasBlock(double, double, List<PositionedContent>, Style) - Constructor for record class com.nsdev.lettergenerator.model.block.CanvasBlock
-
Snapshots elements while deferring geometry and content validation until generation.
- CanvasBuilder - Class in com.nsdev.lettergenerator.builder
-
Mutable, call-local authoring builder producing owned immutable canvas models.
- CanvasBuilder(double, double) - Constructor for class com.nsdev.lettergenerator.builder.CanvasBuilder
-
Creates an empty canvas declaration; generation performs path-aware geometry validation.
- cellAppearance() - Method in record class com.nsdev.lettergenerator.model.table.TableOptions
-
Returns the value of the
cellAppearancerecord component. - cellAppearance(CellAppearance) - Method in class com.nsdev.lettergenerator.builder.TableBuilder
-
Replaces cell appearance defaults while retaining configured row policies.
- CellAppearance - Record Class in com.nsdev.lettergenerator.model.table
-
Nullable cell appearance overrides.
- CellAppearance(Border, Padding, VerticalAlignment, String) - Constructor for record class com.nsdev.lettergenerator.model.table.CellAppearance
-
Creates an instance of a
CellAppearancerecord class. - cells() - Method in record class com.nsdev.lettergenerator.theme.TableAppearance
-
Returns the value of the
cellsrecord component. - CENTER - Enum constant in enum class com.nsdev.lettergenerator.model.style.TextAlign
-
Center content between the available edges.
- children() - Method in record class com.nsdev.lettergenerator.model.text.ListItem
-
Returns the value of the
childrenrecord component. - closing(String) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Replaces the nonblank closing phrase after body content.
- CLOSING - Enum constant in enum class com.nsdev.lettergenerator.letter.LetterElement
-
Closing phrase after body content.
- CLOSING - Enum constant in enum class com.nsdev.lettergenerator.theme.StyleRole
-
Closing greeting before the signature.
- code() - Method in record class com.nsdev.lettergenerator.diagnostics.Diagnostic
-
Returns the value of the
coderecord component. - collections() - Method in record class com.nsdev.lettergenerator.template.TemplateRequirements
-
Returns the value of the
collectionsrecord component. - color() - Method in record class com.nsdev.lettergenerator.model.style.Style
-
Returns the value of the
colorrecord component. - color() - Method in record class com.nsdev.lettergenerator.model.table.Border
-
Returns the value of the
colorrecord component. - color() - Method in record class com.nsdev.lettergenerator.model.watermark.TextWatermark
-
Returns the value of the
colorrecord component. - color(String) - Method in class com.nsdev.lettergenerator.model.style.Style.Builder
-
Sets the text-color override.
- Column - Record Class in com.nsdev.lettergenerator.model.layout
-
Independent flowing content occupying a weighted share of its parent columns block.
- Column(double, List<Block>, Style) - Constructor for record class com.nsdev.lettergenerator.model.layout.Column
-
Snapshots content without replacing null values needed by path-aware validation.
- columns() - Method in record class com.nsdev.lettergenerator.model.block.ColumnsBlock
-
Returns the value of the
columnsrecord component. - ColumnsBlock - Record Class in com.nsdev.lettergenerator.model.block
-
Side-by-side independent rich-content columns, using proportional widths after physical gaps.
- ColumnsBlock(List<Column>, double, Style) - Constructor for record class com.nsdev.lettergenerator.model.block.ColumnsBlock
-
Snapshots columns without prematurely validating document geometry.
- columnSpan() - Method in record class com.nsdev.lettergenerator.model.table.TableCell
-
Returns the value of the
columnSpanrecord component. - columnWeights() - Method in record class com.nsdev.lettergenerator.model.block.TableBlock
-
Returns the value of the
columnWeightsrecord component. - columnWeights(double...) - Method in class com.nsdev.lettergenerator.builder.TableBuilder
-
Replaces column widths with relative, unitless weights.
- com.nsdev.lettergenerator - package com.nsdev.lettergenerator
-
Public entry points for letter construction and PDF generation.
- com.nsdev.lettergenerator.builder - package com.nsdev.lettergenerator.builder
-
Mutable convenience builders that produce independent immutable model snapshots.
- com.nsdev.lettergenerator.component - package com.nsdev.lettergenerator.component
-
Immutable reusable content registered and resolved within an individual letter document.
- com.nsdev.lettergenerator.diagnostics - package com.nsdev.lettergenerator.diagnostics
-
Structured input validation and accepted rendering diagnostics.
- com.nsdev.lettergenerator.document - package com.nsdev.lettergenerator.document
-
Explicitly supplied immutable document resources, including appended PDF pages.
- com.nsdev.lettergenerator.exception - package com.nsdev.lettergenerator.exception
-
Unchecked failures exposed by
LetterPdfGenerator. - com.nsdev.lettergenerator.font - package com.nsdev.lettergenerator.font
-
Physical faces for custom font registration with
LetterPdfGenerator.Builder. - com.nsdev.lettergenerator.letter - package com.nsdev.lettergenerator.letter
-
Semantic sender/recipient/address values and optional address-panel positioning.
- com.nsdev.lettergenerator.localization - package com.nsdev.lettergenerator.localization
-
Explicit deterministic country-aware dates, numbers and currencies.
- com.nsdev.lettergenerator.model - package com.nsdev.lettergenerator.model
-
Immutable input model for PDF letters.
- com.nsdev.lettergenerator.model.block - package com.nsdev.lettergenerator.model.block
-
Content blocks shared by body sections, fixed elements, and visual signatures.
- com.nsdev.lettergenerator.model.layout - package com.nsdev.lettergenerator.model.layout
-
Physical-page geometry and placement rules.
- com.nsdev.lettergenerator.model.style - package com.nsdev.lettergenerator.model.style
-
Property-by-property typography and spacing inheritance.
- com.nsdev.lettergenerator.model.table - package com.nsdev.lettergenerator.model.table
-
Immutable cell content, appearance and body-row page policies for native tables.
- com.nsdev.lettergenerator.model.text - package com.nsdev.lettergenerator.model.text
-
Literal styled text, hierarchical list items, current/total page fields and optional external hyperlinks.
- com.nsdev.lettergenerator.model.watermark - package com.nsdev.lettergenerator.model.watermark
-
Optional text and image decorations centered behind the physical page content.
- com.nsdev.lettergenerator.render - package com.nsdev.lettergenerator.render
-
Complete PDF reports, native output profiles, source page ranges and opt-in authoring previews.
- com.nsdev.lettergenerator.signature - package com.nsdev.lettergenerator.signature
-
Immutable convenience parts for letter signatures.
- com.nsdev.lettergenerator.template - package com.nsdev.lettergenerator.template
-
Immutable prepared authoring templates and source requirement manifests.
- com.nsdev.lettergenerator.theme - package com.nsdev.lettergenerator.theme
-
Immutable per-document semantic roles, named typography, table appearance and reusable stationery.
- company(String, Address) - Static method in record class com.nsdev.lettergenerator.letter.Party
-
Creates an organization party.
- compile() - Method in class com.nsdev.lettergenerator.builder.HtmlLetterBuilder
-
Captures parsed source and owned configuration for concurrent repeated binding.
- component(String, LetterComponent) - Method in class com.nsdev.lettergenerator.builder.HtmlLetterBuilder
-
Registers a fragment referenced by an empty component tag with a ref attribute.
- component(String, LetterComponent) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Registers a reusable document-local fragment; later registrations replace the same name.
- ComponentBlock - Record Class in com.nsdev.lettergenerator.model.block
-
Reference to a document-local reusable component.
- ComponentBlock(String, Style) - Constructor for record class com.nsdev.lettergenerator.model.block.ComponentBlock
-
Creates an instance of a
ComponentBlockrecord class. - components() - Method in record class com.nsdev.lettergenerator.model.LetterDocument
-
Returns the value of the
componentsrecord component. - components() - Method in record class com.nsdev.lettergenerator.template.TemplateRequirements
-
Returns the value of the
componentsrecord component. - content(List<Block>) - Static method in record class com.nsdev.lettergenerator.model.table.TableCell
-
Creates a block-content cell; an empty list creates an explicit empty cell.
- contentItems() - Method in record class com.nsdev.lettergenerator.model.block.ListBlock
-
Returns the value of the
contentItemsrecord component. - currencyCode() - Method in record class com.nsdev.lettergenerator.localization.LocaleSettings
-
Returns the value of the
currencyCoderecord component. - CURRENT - Enum constant in enum class com.nsdev.lettergenerator.model.text.PageNumber
-
Number of the page on which the run is painted, starting at one.
- currentPage() - Static method in record class com.nsdev.lettergenerator.model.text.TextRun
D
- DASHED - Enum constant in enum class com.nsdev.lettergenerator.model.table.BorderStyle
-
Paint a dashed line.
- data() - Method in record class com.nsdev.lettergenerator.document.PdfAttachment
-
Returns the value of the
datarecord component. - data() - Method in record class com.nsdev.lettergenerator.model.block.ImageBlock
-
Returns a defensive copy of the encoded image.
- data() - Method in record class com.nsdev.lettergenerator.model.watermark.ImageWatermark
-
Returns a defensive copy of the encoded image.
- date() - Method in record class com.nsdev.lettergenerator.letter.AddressLayout
-
Returns the value of the
daterecord component. - date(LocalDate) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Defers date formatting until final builder locale is known.
- date(LocalDate, Style) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Defers a locally styled date until final locale is known.
- DATE - Enum constant in enum class com.nsdev.lettergenerator.letter.LetterElement
-
Letter date.
- DATE - Enum constant in enum class com.nsdev.lettergenerator.theme.StyleRole
-
Locale-formatted letter date.
- datePattern() - Method in record class com.nsdev.lettergenerator.localization.LocaleSettings
-
Returns the value of the
datePatternrecord component. - dateStyle() - Method in record class com.nsdev.lettergenerator.localization.LocaleSettings
-
Returns the value of the
dateStylerecord component. - debug() - Method in record class com.nsdev.lettergenerator.render.RenderOptions
-
Returns the value of the
debugrecord component. - DebugBox - Record Class in com.nsdev.lettergenerator.render
-
Declared layout rectangle, measured from the physical page's upper-left corner.
- DebugBox(int, String, double, double, double, double) - Constructor for record class com.nsdev.lettergenerator.render.DebugBox
-
Creates an instance of a
DebugBoxrecord class. - debugBoxes() - Method in record class com.nsdev.lettergenerator.render.RenderResult
-
Returns the value of the
debugBoxesrecord component. - debugPreview() - Static method in record class com.nsdev.lettergenerator.render.RenderOptions
- DEFAULT - Static variable in record class com.nsdev.lettergenerator.model.table.Border
-
Legacy white cell separator, one quarter of a point wide.
- DEFAULT - Static variable in record class com.nsdev.lettergenerator.model.table.CellAppearance
-
Complete legacy defaults; the background remains transparent.
- DEFAULT - Static variable in record class com.nsdev.lettergenerator.model.table.Padding
-
Legacy one-millimeter padding on each edge.
- defaultAppearance() - Method in record class com.nsdev.lettergenerator.model.table.TableCell
-
Returns the value of the
defaultAppearancerecord component. - defaults() - Static method in record class com.nsdev.lettergenerator.localization.LocaleSettings
- defaults() - Static method in record class com.nsdev.lettergenerator.model.DocumentSettings
- defaults() - Static method in record class com.nsdev.lettergenerator.model.layout.Margins
-
Creates the default margins of 20 millimeters on each side.
- defaults() - Static method in record class com.nsdev.lettergenerator.model.layout.PageSpec
-
Returns the default A4 specification.
- defaults() - Static method in record class com.nsdev.lettergenerator.render.RenderOptions
- defaultStyle() - Method in record class com.nsdev.lettergenerator.model.block.GroupBlock
-
Returns the value of the
defaultStylerecord component. - defaultStyle() - Method in record class com.nsdev.lettergenerator.model.LetterDocument
-
Returns the value of the
defaultStylerecord component. - Diagnostic - Record Class in com.nsdev.lettergenerator.diagnostics
-
Stable diagnostic code with a human-readable message and input location.
- Diagnostic(String, DiagnosticSeverity, DiagnosticPhase, String, String) - Constructor for record class com.nsdev.lettergenerator.diagnostics.Diagnostic
-
Creates an instance of a
Diagnosticrecord class. - DiagnosticPhase - Enum Class in com.nsdev.lettergenerator.diagnostics
-
Processing stage that produced a diagnostic.
- diagnostics() - Method in record class com.nsdev.lettergenerator.diagnostics.ValidationReport
-
Returns the value of the
diagnosticsrecord component. - diagnostics() - Method in exception com.nsdev.lettergenerator.exception.PdfGenerationException
- diagnostics() - Method in record class com.nsdev.lettergenerator.render.RenderResult
-
Returns the value of the
diagnosticsrecord component. - DiagnosticSeverity - Enum Class in com.nsdev.lettergenerator.diagnostics
-
Severity of a structured authoring or rendering diagnostic.
- dimensions() - Method in record class com.nsdev.lettergenerator.model.layout.PageSpec
-
Returns the value of the
dimensionsrecord component. - direction() - Method in record class com.nsdev.lettergenerator.model.DocumentSettings
-
Returns the value of the
directionrecord component. - direction(TextDirection) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Sets writing direction independently from formatting locale.
- DocumentMetadata - Record Class in com.nsdev.lettergenerator.model
-
Optional descriptive PDF metadata; null fields omit the corresponding document information.
- DocumentMetadata(String, String, String, String) - Constructor for record class com.nsdev.lettergenerator.model.DocumentMetadata
-
Creates an instance of a
DocumentMetadatarecord class. - DocumentSettings - Record Class in com.nsdev.lettergenerator.model
-
Optional language, formatting, metadata and explicit font fallback settings.
- DocumentSettings(LocaleSettings, DocumentMetadata, TextDirection, List<String>, Boolean) - Constructor for record class com.nsdev.lettergenerator.model.DocumentSettings
-
Snapshots options and supplies deterministic formatting defaults.
- DOTTED - Enum constant in enum class com.nsdev.lettergenerator.model.table.BorderStyle
-
Paint a dotted line.
E
- element() - Method in record class com.nsdev.lettergenerator.model.block.LetterPartBlock
-
Returns the value of the
elementrecord component. - element(PositionedContent) - Method in class com.nsdev.lettergenerator.builder.CanvasBuilder
-
Appends an already constructed immutable positioned element.
- elements() - Method in record class com.nsdev.lettergenerator.model.block.CanvasBlock
-
Returns the value of the
elementsrecord component. - elements() - Method in record class com.nsdev.lettergenerator.theme.Stationery
-
Returns the value of the
elementsrecord component. - equals(Object) - Method in record class com.nsdev.lettergenerator.component.LetterComponent
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.nsdev.lettergenerator.diagnostics.Diagnostic
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.nsdev.lettergenerator.diagnostics.ValidationReport
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.nsdev.lettergenerator.document.PdfAttachment
-
Compares exact encoded PDF contents.
- equals(Object) - Method in record class com.nsdev.lettergenerator.letter.Address
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.nsdev.lettergenerator.letter.AddressLayout
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.nsdev.lettergenerator.letter.Party
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.nsdev.lettergenerator.localization.LocaleSettings
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.nsdev.lettergenerator.model.block.BoxBlock
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.nsdev.lettergenerator.model.block.CanvasBlock
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.nsdev.lettergenerator.model.block.ColumnsBlock
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.nsdev.lettergenerator.model.block.ComponentBlock
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.nsdev.lettergenerator.model.block.GroupBlock
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.nsdev.lettergenerator.model.block.Heading
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.nsdev.lettergenerator.model.block.ImageBlock
-
Compares image byte contents and every other record component.
- equals(Object) - Method in record class com.nsdev.lettergenerator.model.block.LetterPartBlock
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.nsdev.lettergenerator.model.block.ListBlock
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.nsdev.lettergenerator.model.block.PageBreakBlock
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.nsdev.lettergenerator.model.block.Paragraph
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.nsdev.lettergenerator.model.block.TableBlock
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.nsdev.lettergenerator.model.DocumentMetadata
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.nsdev.lettergenerator.model.DocumentSettings
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.nsdev.lettergenerator.model.layout.Borders
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.nsdev.lettergenerator.model.layout.Bounds
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.nsdev.lettergenerator.model.layout.BoxAppearance
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.nsdev.lettergenerator.model.layout.Column
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.nsdev.lettergenerator.model.layout.FixedElement
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.nsdev.lettergenerator.model.layout.Margins
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.nsdev.lettergenerator.model.layout.PageDimensions
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.nsdev.lettergenerator.model.layout.PageSpec
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.nsdev.lettergenerator.model.layout.PositionedContent
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.nsdev.lettergenerator.model.layout.Signature
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.nsdev.lettergenerator.model.LetterDocument
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.nsdev.lettergenerator.model.Section
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.nsdev.lettergenerator.model.style.Style
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.nsdev.lettergenerator.model.table.Border
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.nsdev.lettergenerator.model.table.CellAppearance
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.nsdev.lettergenerator.model.table.Padding
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.nsdev.lettergenerator.model.table.TableCell
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.nsdev.lettergenerator.model.table.TableOptions
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.nsdev.lettergenerator.model.table.TableRowGroup
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.nsdev.lettergenerator.model.table.TableRowPolicy
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.nsdev.lettergenerator.model.text.ListItem
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.nsdev.lettergenerator.model.text.TextRun
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.nsdev.lettergenerator.model.watermark.ImageWatermark
-
Compares image byte contents and every other record component.
- equals(Object) - Method in record class com.nsdev.lettergenerator.model.watermark.TextWatermark
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.nsdev.lettergenerator.render.DebugBox
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.nsdev.lettergenerator.render.RenderOptions
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.nsdev.lettergenerator.render.RenderPart
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.nsdev.lettergenerator.render.RenderResult
-
Compares PDF contents and result metadata.
- equals(Object) - Method in record class com.nsdev.lettergenerator.template.TemplateRequirement
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.nsdev.lettergenerator.template.TemplateRequirements
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.nsdev.lettergenerator.theme.LetterTheme
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.nsdev.lettergenerator.theme.Stationery
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.nsdev.lettergenerator.theme.TableAppearance
-
Indicates whether some other object is "equal to" this one.
- ERROR - Enum constant in enum class com.nsdev.lettergenerator.diagnostics.DiagnosticSeverity
-
Invalid input or rejected layout.
F
- fallbackFonts() - Method in record class com.nsdev.lettergenerator.model.DocumentSettings
-
Returns the value of the
fallbackFontsrecord component. - fallbackFonts(String...) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Sets ordered explicit registered fallback font families.
- fieldPath() - Method in exception com.nsdev.lettergenerator.exception.InvalidLetterException
-
Returns the input location supplied when this exception was constructed.
- FIRST - Enum constant in enum class com.nsdev.lettergenerator.model.layout.PageSelector
-
Only the first page, including a document consisting of a single page.
- firstPage() - Method in record class com.nsdev.lettergenerator.render.RenderPart
-
Returns the value of the
firstPagerecord component. - fixedElement(FixedElement) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Appends an advanced fixed element using the configured header/footer zones.
- fixedElement(FixedElement) - Method in class com.nsdev.lettergenerator.builder.StationeryBuilder
-
Supplies explicit fixed content, with its own identifier and page selector.
- FixedElement - Record Class in com.nsdev.lettergenerator.model.layout
-
Positioned content repeated on selected pages inside a reserved top or bottom zone.
- FixedElement(String, Zone, PageSelector, Bounds, List<Block>) - Constructor for record class com.nsdev.lettergenerator.model.layout.FixedElement
-
Snapshots content into an unmodifiable list while retaining null lists and entries.
- fixedElements() - Method in record class com.nsdev.lettergenerator.model.LetterDocument
-
Returns the value of the
fixedElementsrecord component. - flags() - Method in record class com.nsdev.lettergenerator.template.TemplateRequirements
-
Returns the value of the
flagsrecord component. - FLOW - Enum constant in enum class com.nsdev.lettergenerator.model.layout.SignaturePlacement
-
Append the signature after all body sections; bounds must be null.
- FOLLOWING - Enum constant in enum class com.nsdev.lettergenerator.model.layout.PageSelector
-
Every page after the first; selects nothing in a single-page document.
- fontFamily() - Method in record class com.nsdev.lettergenerator.model.style.Style
-
Returns the value of the
fontFamilyrecord component. - fontFamily() - Method in record class com.nsdev.lettergenerator.model.watermark.TextWatermark
-
Returns the value of the
fontFamilyrecord component. - fontFamily(String) - Method in class com.nsdev.lettergenerator.model.style.Style.Builder
-
Sets the font-family override.
- fontSizePt() - Method in record class com.nsdev.lettergenerator.model.style.Style
-
Returns the value of the
fontSizePtrecord component. - fontSizePt() - Method in record class com.nsdev.lettergenerator.model.watermark.TextWatermark
-
Returns the value of the
fontSizePtrecord component. - fontSizePt(double) - Method in class com.nsdev.lettergenerator.model.style.Style.Builder
-
Sets the font size in points (1/72 inch).
- FontVariant - Enum Class in com.nsdev.lettergenerator.font
-
Physical font face selected from resolved bold and italic style flags.
- footer(byte[]) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Replaces the footer with a repeated PNG/JPEG/static SVG image.
- footer(LetterComponent) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Replaces footer content with a reusable fragment.
- footer(PageSelector, byte[]) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Replaces footer content for one page selection; ALL is fallback for unspecified selections.
- footer(PageSelector, Block...) - Method in class com.nsdev.lettergenerator.builder.StationeryBuilder
-
Replaces one footer variant with immutable rich blocks.
- footer(PageSelector, String...) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Replaces footer content for one page selection; ALL is fallback for unspecified selections.
- footer(PageSelector, Path) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Replaces footer content for one page selection; ALL is fallback for unspecified selections.
- footer(Style) - Method in class com.nsdev.lettergenerator.theme.LetterTheme.Builder
-
Sets reserved bottom-region defaults.
- footer(String) - Method in class com.nsdev.lettergenerator.builder.StationeryBuilder
-
Configures footer text.
- footer(String...) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Replaces the footer with plain text repeated on every page.
- footer(Path) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Reads a PNG/JPEG/static SVG file immediately and replaces the footer with its fitted image.
- FOOTER - Enum constant in enum class com.nsdev.lettergenerator.theme.StyleRole
-
Content in the reserved bottom page region.
- footerBlocks(Block...) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Replaces footer content with an ordered snapshot of advanced model blocks.
- footerBlocks(PageSelector, Block...) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Replaces footer content for one page selection; ALL is fallback for unspecified selections.
- footerHeightMm(double) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Replaces footer content-box height, initially 15 mm.
- footerHeightMm(double) - Method in class com.nsdev.lettergenerator.builder.StationeryBuilder
-
Configures footer height in millimeters.
- footerHtml(PageSelector, String) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Replaces footer content for one page selection; ALL is fallback for unspecified selections.
- footerHtml(String) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Replaces footer content with a fragment of the supported HTML subset.
- footerHtml(String) - Method in class com.nsdev.lettergenerator.builder.StationeryBuilder
-
Configures footer markup.
- footerStyle(PageSelector, Style) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Applies appearance overrides to one footer selection after the shared footer defaults.
- footerStyle(Style) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Replaces footer overrides on top of the default 9 pt gray text and zero before/after spacing.
- footerStyle(Style) - Method in class com.nsdev.lettergenerator.builder.StationeryBuilder
-
Sets common footer typography.
- format(Object, String, String, LocaleSettings, String) - Static method in class com.nsdev.lettergenerator.localization.ValueFormats
-
Formats one scalar using explicit locale configuration and optional exact pattern.
- fromHtml(String) - Static method in class com.nsdev.lettergenerator.Letter
-
Starts a builder for already-resolved markup in the supported
<letter>format. - fromJson(String) - Static method in class com.nsdev.lettergenerator.Letter
-
Parses strict schema-version-one JSON into the shared immutable model.
- fromStyle(boolean, boolean) - Static method in enum class com.nsdev.lettergenerator.font.FontVariant
-
Maps resolved style flags to the exact physical face required for rendering.
G
- gapMm() - Method in record class com.nsdev.lettergenerator.model.block.ColumnsBlock
-
Returns the value of the
gapMmrecord component. - generate(LetterDocument) - Method in class com.nsdev.lettergenerator.LetterPdfGenerator
-
Validates an immutable document and renders it using this generator's font snapshot.
- generateJson(String) - Method in class com.nsdev.lettergenerator.LetterPdfGenerator
-
Parses strict schema-version-1 JSON, validates the resulting model, and renders a PDF.
- group(Block...) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Appends an explicit softly kept group of immutable blocks.
- group(String...) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Appends grouped plain text using the ordinary newline/paragraph rules.
- GroupBlock - Record Class in com.nsdev.lettergenerator.model.block
-
Ordered content grouped under common typography and a soft page-keep preference.
- GroupBlock(List<Block>, Style) - Constructor for record class com.nsdev.lettergenerator.model.block.GroupBlock
-
Creates an ordinary group without fallback typography.
- GroupBlock(List<Block>, Style, Style) - Constructor for record class com.nsdev.lettergenerator.model.block.GroupBlock
-
Snapshots the child list without checking its content or renderability.
H
- hashCode() - Method in record class com.nsdev.lettergenerator.component.LetterComponent
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.nsdev.lettergenerator.diagnostics.Diagnostic
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.nsdev.lettergenerator.diagnostics.ValidationReport
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.nsdev.lettergenerator.document.PdfAttachment
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.nsdev.lettergenerator.letter.Address
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.nsdev.lettergenerator.letter.AddressLayout
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.nsdev.lettergenerator.letter.Party
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.nsdev.lettergenerator.localization.LocaleSettings
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.nsdev.lettergenerator.model.block.BoxBlock
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.nsdev.lettergenerator.model.block.CanvasBlock
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.nsdev.lettergenerator.model.block.ColumnsBlock
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.nsdev.lettergenerator.model.block.ComponentBlock
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.nsdev.lettergenerator.model.block.GroupBlock
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.nsdev.lettergenerator.model.block.Heading
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.nsdev.lettergenerator.model.block.ImageBlock
-
Hashes byte contents and every other record component consistently with equality.
- hashCode() - Method in record class com.nsdev.lettergenerator.model.block.LetterPartBlock
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.nsdev.lettergenerator.model.block.ListBlock
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.nsdev.lettergenerator.model.block.PageBreakBlock
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.nsdev.lettergenerator.model.block.Paragraph
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.nsdev.lettergenerator.model.block.TableBlock
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.nsdev.lettergenerator.model.DocumentMetadata
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.nsdev.lettergenerator.model.DocumentSettings
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.nsdev.lettergenerator.model.layout.Borders
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.nsdev.lettergenerator.model.layout.Bounds
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.nsdev.lettergenerator.model.layout.BoxAppearance
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.nsdev.lettergenerator.model.layout.Column
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.nsdev.lettergenerator.model.layout.FixedElement
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.nsdev.lettergenerator.model.layout.Margins
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.nsdev.lettergenerator.model.layout.PageDimensions
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.nsdev.lettergenerator.model.layout.PageSpec
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.nsdev.lettergenerator.model.layout.PositionedContent
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.nsdev.lettergenerator.model.layout.Signature
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.nsdev.lettergenerator.model.LetterDocument
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.nsdev.lettergenerator.model.Section
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.nsdev.lettergenerator.model.style.Style
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.nsdev.lettergenerator.model.table.Border
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.nsdev.lettergenerator.model.table.CellAppearance
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.nsdev.lettergenerator.model.table.Padding
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.nsdev.lettergenerator.model.table.TableCell
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.nsdev.lettergenerator.model.table.TableOptions
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.nsdev.lettergenerator.model.table.TableRowGroup
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.nsdev.lettergenerator.model.table.TableRowPolicy
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.nsdev.lettergenerator.model.text.ListItem
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.nsdev.lettergenerator.model.text.TextRun
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.nsdev.lettergenerator.model.watermark.ImageWatermark
-
Hashes byte contents and every other record component consistently with equality.
- hashCode() - Method in record class com.nsdev.lettergenerator.model.watermark.TextWatermark
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.nsdev.lettergenerator.render.DebugBox
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.nsdev.lettergenerator.render.RenderOptions
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.nsdev.lettergenerator.render.RenderPart
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.nsdev.lettergenerator.render.RenderResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.nsdev.lettergenerator.template.TemplateRequirement
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.nsdev.lettergenerator.template.TemplateRequirements
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.nsdev.lettergenerator.theme.LetterTheme
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.nsdev.lettergenerator.theme.Stationery
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.nsdev.lettergenerator.theme.TableAppearance
-
Returns a hash code value for this object.
- header() - Method in record class com.nsdev.lettergenerator.model.block.TableBlock
-
Returns the value of the
headerrecord component. - header() - Method in record class com.nsdev.lettergenerator.theme.TableAppearance
-
Returns the value of the
headerrecord component. - header(byte[]) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Replaces the header with a repeated PNG/JPEG/static SVG image.
- header(LetterComponent) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Replaces header content with a reusable fragment.
- header(PageSelector, byte[]) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Replaces header content for one page selection; ALL is fallback for unspecified selections.
- header(PageSelector, Block...) - Method in class com.nsdev.lettergenerator.builder.StationeryBuilder
-
Replaces one header variant with immutable rich blocks.
- header(PageSelector, String...) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Replaces header content for one page selection; ALL is fallback for unspecified selections.
- header(PageSelector, Path) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Replaces header content for one page selection; ALL is fallback for unspecified selections.
- header(Style) - Method in class com.nsdev.lettergenerator.theme.LetterTheme.Builder
-
Sets reserved top-region defaults.
- header(String) - Method in class com.nsdev.lettergenerator.builder.StationeryBuilder
-
Configures header text.
- header(String...) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Replaces the header with plain text repeated on every page.
- header(Path) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Reads a PNG/JPEG/static SVG file immediately and replaces the header with its fitted image.
- HEADER - Enum constant in enum class com.nsdev.lettergenerator.theme.StyleRole
-
Content in the reserved top page region.
- headerAlignment(TextAlign) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Positions an automatic header box within the space beside the logo and supplies default content alignment.
- headerAlignment(TextAlign) - Method in class com.nsdev.lettergenerator.builder.StationeryBuilder
-
Configures header alignment.
- headerBackground(String) - Method in class com.nsdev.lettergenerator.builder.TableBuilder
-
Replaces the header-cell background color, initially
#10384A. - headerBlocks(Block...) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Replaces header content with an ordered snapshot of advanced model blocks.
- headerBlocks(PageSelector, Block...) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Replaces header content for one page selection; ALL is fallback for unspecified selections.
- headerBounds(Bounds) - Method in class com.nsdev.lettergenerator.builder.StationeryBuilder
-
Configures exact inner-page header rectangle.
- headerBoundsMm(double, double, double, double) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Replaces automatic placement with an exact header box measured from the inner page upper-left corner.
- headerCells(TableCell...) - Method in class com.nsdev.lettergenerator.builder.TableBuilder
-
Replaces the repeating header with typed cells; an empty array removes the header.
- headerHeightMm(double) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Replaces the header content-box height, initially 25 mm.
- headerHeightMm(double) - Method in class com.nsdev.lettergenerator.builder.StationeryBuilder
-
Configures header height in millimeters.
- headerHtml(PageSelector, String) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Replaces header content for one page selection; ALL is fallback for unspecified selections.
- headerHtml(String) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Replaces header content with a fragment of the supported HTML subset.
- headerHtml(String) - Method in class com.nsdev.lettergenerator.builder.StationeryBuilder
-
Configures header markup.
- headerStyle(PageSelector, Style) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Applies appearance overrides to one header selection after the shared header defaults.
- headerStyle(Style) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Replaces header style overrides on top of zero before/after spacing and the currently selected header alignment.
- headerStyle(Style) - Method in class com.nsdev.lettergenerator.builder.StationeryBuilder
-
Sets common header typography.
- headerStyle(Style) - Method in class com.nsdev.lettergenerator.builder.TableBuilder
-
Replaces the header style overrides, overlaid on the default bold white text.
- headerWidthMm(double) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Replaces the header box width in millimeters.
- heading(Style) - Method in class com.nsdev.lettergenerator.theme.LetterTheme.Builder
-
Sets heading defaults.
- heading(String) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Appends a heading block whose appearance inherits the document style and heading defaults.
- Heading - Record Class in com.nsdev.lettergenerator.model.block
-
Text heading kept with the following block on the same page when layout permits.
- Heading(List<TextRun>, Style) - Constructor for record class com.nsdev.lettergenerator.model.block.Heading
-
Creates an ordinary heading without additional markup-tag defaults.
- Heading(List<TextRun>, Style, Style) - Constructor for record class com.nsdev.lettergenerator.model.block.Heading
-
Snapshots the run list without validating text or style.
- HEADING - Enum constant in enum class com.nsdev.lettergenerator.theme.StyleRole
-
Heading typography, before explicit heading overrides.
- height() - Method in record class com.nsdev.lettergenerator.model.layout.Bounds
-
Returns the value of the
heightrecord component. - heightMm() - Method in record class com.nsdev.lettergenerator.letter.AddressLayout
-
Returns the value of the
heightMmrecord component. - heightMm() - Method in record class com.nsdev.lettergenerator.model.block.CanvasBlock
-
Returns the value of the
heightMmrecord component. - heightMm() - Method in record class com.nsdev.lettergenerator.model.block.ImageBlock
-
Returns the value of the
heightMmrecord component. - heightMm() - Method in record class com.nsdev.lettergenerator.model.layout.PageDimensions
-
Returns the value of the
heightMmrecord component. - heightMm() - Method in enum class com.nsdev.lettergenerator.model.layout.PageSize
-
Returns the physical page height, before margins.
- heightMm() - Method in record class com.nsdev.lettergenerator.model.layout.PageSpec
- heightMm() - Method in record class com.nsdev.lettergenerator.model.watermark.ImageWatermark
-
Returns the value of the
heightMmrecord component. - heightMm() - Method in record class com.nsdev.lettergenerator.render.DebugBox
-
Returns the value of the
heightMmrecord component. - href() - Method in record class com.nsdev.lettergenerator.model.text.TextRun
-
Returns the value of the
hrefrecord component. - HtmlLetterBuilder - Class in com.nsdev.lettergenerator.builder
-
Mutable compiler input for the supported HTML-like letter template language.
- hyphenate() - Method in record class com.nsdev.lettergenerator.model.DocumentSettings
-
Returns the value of the
hyphenaterecord component. - hyphenate(boolean) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Enables dictionary hyphenation using explicitly registered trusted patterns.
- hyphenationPatterns(String, byte[]) - Method in class com.nsdev.lettergenerator.LetterPdfGenerator.Builder
-
Registers trusted TeX-style FOP hyphenation XML for one language or language-country.
I
- id() - Method in record class com.nsdev.lettergenerator.model.layout.FixedElement
-
Returns the value of the
idrecord component. - id() - Method in record class com.nsdev.lettergenerator.model.layout.PositionedContent
-
Returns the value of the
idrecord component. - ImageBlock - Record Class in com.nsdev.lettergenerator.model.block
-
PNG/JPEG/static SVG image scaled proportionally to fit an explicit box in millimeters.
- ImageBlock(byte[], String, Double, Double, Style) - Constructor for record class com.nsdev.lettergenerator.model.block.ImageBlock
-
Preserves construction without an image description.
- ImageBlock(byte[], String, Double, Double, Style, String) - Constructor for record class com.nsdev.lettergenerator.model.block.ImageBlock
-
Defensively copies image bytes without decoding or validating the supplied properties.
- ImageSignature - Class in com.nsdev.lettergenerator.signature
-
Immutable PNG/JPEG/static SVG signature part owning a defensive copy of its image bytes.
- ImageWatermark - Record Class in com.nsdev.lettergenerator.model.watermark
-
PNG/JPEG/static SVG image centered behind selected physical pages, with its aspect ratio preserved inside the supplied millimeter box.
- ImageWatermark(byte[], String, Double, Double, PageSelector, Double, Double) - Constructor for record class com.nsdev.lettergenerator.model.watermark.ImageWatermark
-
Defensively copies the encoded bytes.
- include(String) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Appends a reference to a registered fragment at this position in body flow.
- INFO - Enum constant in enum class com.nsdev.lettergenerator.diagnostics.DiagnosticSeverity
-
Information about accepted processing.
- INPUT - Enum constant in enum class com.nsdev.lettergenerator.diagnostics.DiagnosticPhase
-
Parsing, binding, asset decoding or declared model validation; no PDF layout.
- intersects(Bounds) - Method in record class com.nsdev.lettergenerator.model.layout.Bounds
-
Tests whether rectangles overlap with positive area.
- InvalidLetterException - Exception in com.nsdev.lettergenerator.exception
-
Indicates invalid JSON, markup, model data or registered font configuration.
- InvalidLetterException(String, String) - Constructor for exception com.nsdev.lettergenerator.exception.InvalidLetterException
-
Creates a validation failure without an underlying cause.
- InvalidLetterException(String, String, Throwable) - Constructor for exception com.nsdev.lettergenerator.exception.InvalidLetterException
-
Creates a validation failure retaining its input location and underlying cause.
- isBold() - Method in enum class com.nsdev.lettergenerator.font.FontVariant
-
Reports whether this physical face supplies bold weight.
- isItalic() - Method in enum class com.nsdev.lettergenerator.font.FontVariant
-
Reports whether this physical face supplies italic posture.
- isValid() - Method in record class com.nsdev.lettergenerator.diagnostics.ValidationReport
- italic() - Method in class com.nsdev.lettergenerator.model.style.Style.Builder
-
Enables italic, overriding an inherited upright style.
- italic() - Method in record class com.nsdev.lettergenerator.model.style.Style
-
Returns the value of the
italicrecord component. - italic(boolean) - Method in class com.nsdev.lettergenerator.model.style.Style.Builder
-
Overrides the inherited italic flag, including explicitly disabling it.
- ITALIC - Enum constant in enum class com.nsdev.lettergenerator.font.FontVariant
-
Italic, normal-weight face.
- items() - Method in record class com.nsdev.lettergenerator.model.block.ListBlock
-
Returns the value of the
itemsrecord component.
J
- JUSTIFY - Enum constant in enum class com.nsdev.lettergenerator.model.style.TextAlign
-
Distribute paragraph text across the available line width.
K
- Keep - Enum Class in com.nsdev.lettergenerator.model.layout
-
Page-breaking strength for a block, successor relationship or table row.
- keepTogether() - Method in class com.nsdev.lettergenerator.model.style.Style.Builder
- keepTogether() - Method in record class com.nsdev.lettergenerator.model.style.Style
-
Returns the value of the
keepTogetherrecord component. - keepTogether() - Method in record class com.nsdev.lettergenerator.model.table.TableRowGroup
-
Returns the value of the
keepTogetherrecord component. - keepTogether() - Method in record class com.nsdev.lettergenerator.model.table.TableRowPolicy
-
Returns the value of the
keepTogetherrecord component. - keepTogether(Keep) - Method in class com.nsdev.lettergenerator.model.style.Style.Builder
-
Sets the current block's page-keep strength.
- keepWithNext() - Method in class com.nsdev.lettergenerator.model.style.Style.Builder
- keepWithNext() - Method in record class com.nsdev.lettergenerator.model.style.Style
-
Returns the value of the
keepWithNextrecord component. - keepWithNext() - Method in record class com.nsdev.lettergenerator.model.table.TableRowPolicy
-
Returns the value of the
keepWithNextrecord component. - keepWithNext(Keep) - Method in class com.nsdev.lettergenerator.model.style.Style.Builder
-
Sets the keep strength between this block and its successor.
- keywords() - Method in record class com.nsdev.lettergenerator.model.DocumentMetadata
-
Returns the value of the
keywordsrecord component. - kind() - Method in record class com.nsdev.lettergenerator.render.DebugBox
-
Returns the value of the
kindrecord component. - kind() - Method in record class com.nsdev.lettergenerator.render.RenderPart
-
Returns the value of the
kindrecord component.
L
- landscape() - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
- LANDSCAPE - Enum constant in enum class com.nsdev.lettergenerator.model.layout.Orientation
-
The longer edge is horizontal.
- languageTag() - Method in record class com.nsdev.lettergenerator.localization.LocaleSettings
-
Returns the value of the
languageTagrecord component. - LAYOUT - Enum constant in enum class com.nsdev.lettergenerator.diagnostics.DiagnosticPhase
-
Pagination, painting or accepted layout recovery.
- left() - Method in record class com.nsdev.lettergenerator.model.layout.Borders
-
Returns the value of the
leftrecord component. - left() - Method in record class com.nsdev.lettergenerator.model.layout.Margins
-
Returns the value of the
leftrecord component. - LEFT - Enum constant in enum class com.nsdev.lettergenerator.model.style.TextAlign
-
Align content with the left edge.
- leftMm() - Method in record class com.nsdev.lettergenerator.model.table.Padding
-
Returns the value of the
leftMmrecord component. - Letter - Class in com.nsdev.lettergenerator
-
Starting point for content-first letters and the supported HTML letter template format.
- LETTER - Enum constant in enum class com.nsdev.lettergenerator.model.layout.PageSize
-
US Letter portrait: 215.9 by 279.4 millimeters.
- LETTER - Enum constant in enum class com.nsdev.lettergenerator.render.RenderPartKind
-
Pages generated from the letter model.
- LETTER - Static variable in record class com.nsdev.lettergenerator.model.layout.PageSpec
-
US Letter with 20 mm margins and zero-height reserved zones.
- LetterBuilder - Class in com.nsdev.lettergenerator.builder
-
Mutable builder for ordinary letters, obtained from
Letter.builder()or the public no-argument constructor. - LetterBuilder() - Constructor for class com.nsdev.lettergenerator.builder.LetterBuilder
- LetterComponent - Record Class in com.nsdev.lettergenerator.component
-
Reusable immutable content registered on an individual document.
- LetterComponent(List<Block>) - Constructor for record class com.nsdev.lettergenerator.component.LetterComponent
-
Snapshots content without validating it.
- LetterDocument - Record Class in com.nsdev.lettergenerator.model
-
Complete immutable input to PDF generation, shared by the Java builders and JSON input.
- LetterDocument(int, PageSpec, Style, List<Section>, List<FixedElement>, Signature, Watermark) - Constructor for record class com.nsdev.lettergenerator.model.LetterDocument
-
Preserves the original constructor with no theme or reusable-content registrations.
- LetterDocument(int, PageSpec, Style, List<Section>, List<FixedElement>, Signature, Watermark, LetterTheme, Map<String, LetterComponent>) - Constructor for record class com.nsdev.lettergenerator.model.LetterDocument
-
Preserves composition-aware construction without additional settings or attachments.
- LetterDocument(int, PageSpec, Style, List<Section>, List<FixedElement>, Signature, Watermark, LetterTheme, Map<String, LetterComponent>, DocumentSettings, List<PdfAttachment>) - Constructor for record class com.nsdev.lettergenerator.model.LetterDocument
-
Substitutes the default page and snapshots both lists without validating their contents.
- LetterElement - Enum Class in com.nsdev.lettergenerator.letter
-
Semantic content positions used by letter authoring and theme defaults.
- LetterPartBlock - Record Class in com.nsdev.lettergenerator.model.block
-
Semantic letter content that receives element-specific theme defaults before ordinary layout.
- LetterPartBlock(LetterElement, List<Block>, Style) - Constructor for record class com.nsdev.lettergenerator.model.block.LetterPartBlock
-
Snapshots content for shared semantic preparation.
- LetterPdfException - Exception in com.nsdev.lettergenerator.exception
-
Unchecked base for caller-facing letter validation and PDF rendering failures.
- LetterPdfException(String) - Constructor for exception com.nsdev.lettergenerator.exception.LetterPdfException
-
Creates a library failure with a descriptive message and no cause.
- LetterPdfException(String, Throwable) - Constructor for exception com.nsdev.lettergenerator.exception.LetterPdfException
-
Creates a library failure retaining the underlying failure for diagnosis.
- LetterPdfGenerator - Class in com.nsdev.lettergenerator
-
Generates complete PDF letters from immutable Java models or JSON.
- LetterPdfGenerator() - Constructor for class com.nsdev.lettergenerator.LetterPdfGenerator
-
Uses the PDF engine's built-in fonts; no font files or registration are required.
- LetterPdfGenerator.Builder - Class in com.nsdev.lettergenerator
-
Mutable configuration that accumulates trusted Java font sources in registration order.
- LetterTheme - Record Class in com.nsdev.lettergenerator.theme
-
Immutable per-document role defaults and named styles.
- LetterTheme(Map<StyleRole, Style>, Map<String, Style>) - Constructor for record class com.nsdev.lettergenerator.theme.LetterTheme
-
Preserves themes that configure only typography.
- LetterTheme(Map<StyleRole, Style>, Map<String, Style>, TableAppearance, Stationery) - Constructor for record class com.nsdev.lettergenerator.theme.LetterTheme
-
Snapshots both maps, preserving registration order and invalid entries for validation.
- LetterTheme.Builder - Class in com.nsdev.lettergenerator.theme
-
Mutable accumulator whose built themes own snapshots of both registrations.
- lineHeight() - Method in record class com.nsdev.lettergenerator.model.style.Style
-
Returns the value of the
lineHeightrecord component. - lineHeight(double) - Method in class com.nsdev.lettergenerator.model.style.Style.Builder
-
Sets the dimensionless line-height multiplier, applied to font size.
- lines() - Method in record class com.nsdev.lettergenerator.letter.Address
-
Returns the value of the
linesrecord component. - ListBlock - Record Class in com.nsdev.lettergenerator.model.block
-
Ordered or bulleted list with one sequence of text runs per item.
- ListBlock(List<List<TextRun>>, boolean, Style) - Constructor for record class com.nsdev.lettergenerator.model.block.ListBlock
-
Preserves the original flat-list constructor and its unchanged inline-item semantics.
- ListBlock(List<List<TextRun>>, boolean, Style, List<ListItem>) - Constructor for record class com.nsdev.lettergenerator.model.block.ListBlock
-
Snapshots the outer list and every nonnull item list into unmodifiable lists.
- ListItem - Record Class in com.nsdev.lettergenerator.model.text
-
A list item's literal inline content followed by zero or more nested ordered/bulleted lists.
- ListItem(List<TextRun>, List<ListBlock>) - Constructor for record class com.nsdev.lettergenerator.model.text.ListItem
-
Snapshots both collections without validating text or nested list content.
- locale() - Method in record class com.nsdev.lettergenerator.localization.LocaleSettings
- locale() - Method in record class com.nsdev.lettergenerator.model.DocumentSettings
-
Returns the value of the
localerecord component. - locale(LocaleSettings) - Method in class com.nsdev.lettergenerator.builder.HtmlLetterBuilder
-
Sets deterministic document locale while preserving other explicit settings.
- locale(LocaleSettings) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Sets deterministic country-aware formatting.
- locale(Locale) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Sets a locale using its language tag and default date/currency conventions.
- LocaleSettings - Record Class in com.nsdev.lettergenerator.localization
-
Deterministic per-document formatting, independent of JVM defaults.
- LocaleSettings(String) - Constructor for record class com.nsdev.lettergenerator.localization.LocaleSettings
-
Uses localized long dates, country currency and UTC.
- LocaleSettings(String, String, FormatStyle, String, String) - Constructor for record class com.nsdev.lettergenerator.localization.LocaleSettings
-
Validates and normalizes formatting choices immediately.
- logo(byte[]) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Replaces the logo by immediately decoding copied PNG/JPEG/static SVG bytes and fitting their aspect ratio into a 45 by 20 mm box.
- logo(byte[]) - Method in class com.nsdev.lettergenerator.builder.StationeryBuilder
-
Configures encoded image bytes.
- logo(ImageBlock) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Replaces the logo with an advanced image block retaining its supplied dimensions.
- logo(Path) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Reads and replaces the logo immediately, fitting it into a 45 by 20 mm box with its aspect ratio preserved.
- LTR - Enum constant in enum class com.nsdev.lettergenerator.model.layout.TextDirection
-
Left-to-right writing.
M
- margins(Margins) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Replaces the four page margins.
- margins(Margins) - Method in class com.nsdev.lettergenerator.builder.StationeryBuilder
-
Configures authoring margins.
- Margins - Record Class in com.nsdev.lettergenerator.model.layout
-
Physical-page insets in millimeters, outside both the body and reserved zones.
- Margins(double, double, double, double) - Constructor for record class com.nsdev.lettergenerator.model.layout.Margins
-
Creates an instance of a
Marginsrecord class. - marginsMm() - Method in record class com.nsdev.lettergenerator.model.layout.PageSpec
-
Returns the value of the
marginsMmrecord component. - marginsMm(double) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Replaces all four page margins with the same millimeter value.
- matchesPageIndex(int) - Method in enum class com.nsdev.lettergenerator.model.layout.PageSelector
-
Tests this selection against a zero-based renderer page index.
- mayCoincideWith(PageSelector) - Method in enum class com.nsdev.lettergenerator.model.layout.PageSelector
-
Tests whether two selections can address the same page.
- message() - Method in record class com.nsdev.lettergenerator.diagnostics.Diagnostic
-
Returns the value of the
messagerecord component. - metadata() - Method in record class com.nsdev.lettergenerator.model.DocumentSettings
-
Returns the value of the
metadatarecord component. - metadata(DocumentMetadata) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Replaces PDF metadata.
- MIDDLE - Enum constant in enum class com.nsdev.lettergenerator.model.table.VerticalAlignment
-
Center content vertically; the legacy default.
- mimeType() - Method in record class com.nsdev.lettergenerator.model.block.ImageBlock
-
Returns the value of the
mimeTyperecord component. - mimeType() - Method in record class com.nsdev.lettergenerator.model.watermark.ImageWatermark
-
Returns the value of the
mimeTyperecord component.
N
- name() - Method in record class com.nsdev.lettergenerator.letter.Party
-
Returns the value of the
namerecord component. - name() - Method in record class com.nsdev.lettergenerator.model.block.ComponentBlock
-
Returns the value of the
namerecord component. - name() - Method in record class com.nsdev.lettergenerator.model.Section
-
Returns the value of the
namerecord component. - name() - Method in record class com.nsdev.lettergenerator.template.TemplateRequirement
-
Returns the value of the
namerecord component. - named(String) - Method in class com.nsdev.lettergenerator.model.style.Style.Builder
-
References a named style below this builder's explicit overrides.
- named(String, Style) - Method in class com.nsdev.lettergenerator.theme.LetterTheme.Builder
-
Registers or replaces a named style.
- namedStyles() - Method in record class com.nsdev.lettergenerator.theme.LetterTheme
-
Returns the value of the
namedStylesrecord component. - nested(List<ListItem>, boolean, Style) - Static method in record class com.nsdev.lettergenerator.model.block.ListBlock
-
Creates hierarchical items whose child lists follow their inline content.
- NONE - Enum constant in enum class com.nsdev.lettergenerator.model.table.BorderStyle
-
Paint no border, irrespective of the configured width and color.
- NONE - Static variable in record class com.nsdev.lettergenerator.model.table.Border
-
Explicitly invisible border.
O
- of(byte[]) - Static method in record class com.nsdev.lettergenerator.document.PdfAttachment
-
Snapshots an already encoded PDF.
- of(byte[]) - Static method in record class com.nsdev.lettergenerator.model.watermark.ImageWatermark
-
Decodes supplied image bytes, detects PNG/JPEG/static SVG format, and proportionally fits the image within an 80 by 40 mm box.
- of(byte[]) - Static method in class com.nsdev.lettergenerator.signature.ImageSignature
-
Copies and decodes image bytes, fitting the aspect ratio inside a 40 by 20 mm box.
- of(Block...) - Static method in record class com.nsdev.lettergenerator.component.LetterComponent
-
Groups model blocks for document-local registration.
- of(Block...) - Static method in record class com.nsdev.lettergenerator.model.block.GroupBlock
-
Creates a group using inherited appearance and the ordinary soft keep.
- of(String) - Static method in record class com.nsdev.lettergenerator.model.watermark.TextWatermark
-
Creates a watermark for all pages using Helvetica, 50 pt,
#B0B0B0, opacity 0.12, and a 45-degree counterclockwise rotation. - of(String) - Static method in class com.nsdev.lettergenerator.signature.TextSignature
-
Creates a signature with inherited document typography and no explicit style overrides.
- of(String...) - Static method in record class com.nsdev.lettergenerator.letter.Address
-
Creates an address from ordered literal lines.
- of(String, Address) - Static method in record class com.nsdev.lettergenerator.letter.Party
-
Creates an individual party.
- of(Path) - Static method in record class com.nsdev.lettergenerator.document.PdfAttachment
-
Reads an explicitly trusted local PDF path once.
- of(Path) - Static method in record class com.nsdev.lettergenerator.model.watermark.ImageWatermark
-
Reads a local image and creates the same fitted default watermark as
ImageWatermark.of(byte[]). - of(Path) - Static method in class com.nsdev.lettergenerator.signature.ImageSignature
-
Reads and decodes an image immediately, fitting it inside a 40 by 20 mm box.
- opacity() - Method in record class com.nsdev.lettergenerator.model.watermark.ImageWatermark
-
Returns the value of the
opacityrecord component. - opacity() - Method in record class com.nsdev.lettergenerator.model.watermark.TextWatermark
-
Returns the value of the
opacityrecord component. - opacity() - Method in interface com.nsdev.lettergenerator.model.watermark.Watermark
-
Returns paint opacity, where zero is invisible and one is fully opaque.
- options() - Method in record class com.nsdev.lettergenerator.model.block.TableBlock
-
Returns the value of the
optionsrecord component. - options(TableOptions) - Method in class com.nsdev.lettergenerator.builder.TableBuilder
-
Replaces all cell defaults and row metadata with one immutable options value.
- ordered() - Method in record class com.nsdev.lettergenerator.model.block.ListBlock
-
Returns the value of the
orderedrecord component. - organization() - Method in record class com.nsdev.lettergenerator.letter.Party
-
Returns the value of the
organizationrecord component. - orientation() - Method in record class com.nsdev.lettergenerator.model.layout.PageSpec
-
Returns the value of the
orientationrecord component. - orientation(Orientation) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Selects the shorter or longer edge as the horizontal edge.
- Orientation - Enum Class in com.nsdev.lettergenerator.model.layout
-
Orientation applied to named or custom page dimensions.
- orphans() - Method in record class com.nsdev.lettergenerator.model.style.Style
-
Returns the value of the
orphansrecord component. - orphans(int) - Method in class com.nsdev.lettergenerator.model.style.Style.Builder
-
Sets the minimum opening paragraph lines on a page; generation requires a positive value.
- OutputProfile - Enum Class in com.nsdev.lettergenerator.render
-
Native output modes; conformance modes reject incompatible later processing.
- overlay(Style) - Method in record class com.nsdev.lettergenerator.model.style.Style
-
Combines these overrides with another style property by property.
- overlay(CellAppearance) - Method in record class com.nsdev.lettergenerator.model.table.CellAppearance
-
Overlays specified local properties independently, including zero padding and no border.
P
- padding() - Method in record class com.nsdev.lettergenerator.model.layout.BoxAppearance
-
Returns the value of the
paddingrecord component. - padding() - Method in record class com.nsdev.lettergenerator.model.table.CellAppearance
-
Returns the value of the
paddingrecord component. - Padding - Record Class in com.nsdev.lettergenerator.model.table
-
Cell inner spacing, in millimeters.
- Padding(double, double, double, double) - Constructor for record class com.nsdev.lettergenerator.model.table.Padding
-
Creates an instance of a
Paddingrecord class. - page() - Method in record class com.nsdev.lettergenerator.model.LetterDocument
-
Returns the value of the
pagerecord component. - page(PageSize) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Replaces the paper size, initially
PageSize.A4. - page(PageSize) - Method in class com.nsdev.lettergenerator.builder.StationeryBuilder
-
Configures authoring paper size.
- PAGE_BREAK - Static variable in class com.nsdev.lettergenerator.Letter
-
Form-feed marker accepted by
LetterBuilder.body(String...). - pageBreak() - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Appends an explicit break so subsequent body content begins on a new page.
- PageBreakBlock - Record Class in com.nsdev.lettergenerator.model.block
-
Explicit page boundary in the body flow.
- PageBreakBlock() - Constructor for record class com.nsdev.lettergenerator.model.block.PageBreakBlock
-
Creates an instance of a
PageBreakBlockrecord class. - pageCount() - Static method in record class com.nsdev.lettergenerator.model.text.TextRun
- pageCount() - Method in record class com.nsdev.lettergenerator.render.RenderPart
-
Returns the value of the
pageCountrecord component. - pageCount() - Method in record class com.nsdev.lettergenerator.render.RenderResult
-
Returns the value of the
pageCountrecord component. - PageDimensions - Record Class in com.nsdev.lettergenerator.model.layout
-
Custom physical paper dimensions, validated during generation.
- PageDimensions(double, double) - Constructor for record class com.nsdev.lettergenerator.model.layout.PageDimensions
-
Creates an instance of a
PageDimensionsrecord class. - pageNumber() - Method in record class com.nsdev.lettergenerator.model.text.TextRun
-
Returns the value of the
pageNumberrecord component. - pageNumber() - Method in record class com.nsdev.lettergenerator.render.DebugBox
-
Returns the value of the
pageNumberrecord component. - PageNumber - Enum Class in com.nsdev.lettergenerator.model.text
-
Dynamic physical page field evaluated by the renderer after pagination.
- pages() - Method in record class com.nsdev.lettergenerator.model.layout.FixedElement
-
Returns the value of the
pagesrecord component. - pages() - Method in record class com.nsdev.lettergenerator.model.watermark.ImageWatermark
-
Returns the value of the
pagesrecord component. - pages() - Method in record class com.nsdev.lettergenerator.model.watermark.TextWatermark
-
Returns the value of the
pagesrecord component. - pages() - Method in interface com.nsdev.lettergenerator.model.watermark.Watermark
-
Returns the pages on which to paint the decoration.
- PageSelector - Enum Class in com.nsdev.lettergenerator.model.layout
-
Page selection for fixed elements and watermarks.
- PageSize - Enum Class in com.nsdev.lettergenerator.model.layout
-
Portrait paper sizes used to derive page, body, and reserved-zone dimensions.
- pageSizeMm(double, double) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Selects custom physical paper dimensions, preserving the supplied orientation.
- PageSpec - Record Class in com.nsdev.lettergenerator.model.layout
-
Physical page layout with reserved regions inside the page margins.
- PageSpec(PageSize, Margins, Double, Double, Double) - Constructor for record class com.nsdev.lettergenerator.model.layout.PageSpec
-
Preserves the original named-page constructor.
- PageSpec(PageSize, Margins, Double, Double, Double, PageDimensions, Orientation) - Constructor for record class com.nsdev.lettergenerator.model.layout.PageSpec
-
Replaces omitted layout properties with defaults; numeric validity is checked during PDF generation.
- Paragraph - Record Class in com.nsdev.lettergenerator.model.block
-
Flowing literal text that can wrap and continue across pages.
- Paragraph(List<TextRun>, Style) - Constructor for record class com.nsdev.lettergenerator.model.block.Paragraph
-
Snapshots the run list without validating text or style.
- part(LetterElement, List<Block>) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Replaces one semantic role while preserving conventional letter order.
- part(LetterElement, List<Block>, Style) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Replaces one semantic role with explicit local wrapper styling.
- parts() - Method in record class com.nsdev.lettergenerator.render.RenderResult
-
Returns the value of the
partsrecord component. - Party - Record Class in com.nsdev.lettergenerator.letter
-
A sender or recipient with optional organization and address.
- Party(String, String, Address) - Constructor for record class com.nsdev.lettergenerator.letter.Party
-
Creates an instance of a
Partyrecord class. - path() - Method in record class com.nsdev.lettergenerator.diagnostics.Diagnostic
-
Returns the value of the
pathrecord component. - path() - Method in record class com.nsdev.lettergenerator.template.TemplateRequirement
-
Returns the value of the
pathrecord component. - PDF_A_2B - Enum constant in enum class com.nsdev.lettergenerator.render.OutputProfile
-
Native PDF/A-2b mode requiring embedded fonts and no later PDF modification.
- PdfAttachment - Record Class in com.nsdev.lettergenerator.document
-
Owned, validated PDF pages to append after a generated letter.
- PdfAttachment(byte[]) - Constructor for record class com.nsdev.lettergenerator.document.PdfAttachment
-
Takes a defensive snapshot and checks PDF readability without retaining parser state.
- pdfBytes() - Method in record class com.nsdev.lettergenerator.render.RenderResult
-
Returns the value of the
pdfBytesrecord component. - PdfGenerationException - Exception in com.nsdev.lettergenerator.exception
-
Indicates failure while composing, laying out, rendering or post-processing a PDF.
- PdfGenerationException(String, Throwable) - Constructor for exception com.nsdev.lettergenerator.exception.PdfGenerationException
-
Creates a rendering failure while retaining its underlying cause.
- PdfGenerationException(String, Throwable, List<Diagnostic>) - Constructor for exception com.nsdev.lettergenerator.exception.PdfGenerationException
-
Creates a rejected layout with classified errors and its underlying cause.
- phase() - Method in record class com.nsdev.lettergenerator.diagnostics.Diagnostic
-
Returns the value of the
phaserecord component. - placement() - Method in record class com.nsdev.lettergenerator.model.layout.Signature
-
Returns the value of the
placementrecord component. - plain() - Static method in record class com.nsdev.lettergenerator.model.style.Style
-
Creates an empty set of overrides.
- PORTRAIT - Enum constant in enum class com.nsdev.lettergenerator.model.layout.Orientation
-
The shorter edge is horizontal.
- PositionedContent - Record Class in com.nsdev.lettergenerator.model.layout
-
One stable, bounded canvas element.
- PositionedContent(String, Bounds, List<Block>, Style) - Constructor for record class com.nsdev.lettergenerator.model.layout.PositionedContent
-
Snapshots content while retaining invalid nulls for path-aware generation validation.
- PREFER - Enum constant in enum class com.nsdev.lettergenerator.model.layout.Keep
-
Prefer keeping content together, but allow a break when necessary.
- PreparedLetterTemplate - Class in com.nsdev.lettergenerator.template
-
Immutable parsed template and configuration, safe for concurrent independent binding.
- PreparedLetterTemplate(String, Map<String, ?>, Map<String, byte[]>, boolean, LetterTheme, Map<String, LetterComponent>, DocumentSettings) - Constructor for class com.nsdev.lettergenerator.template.PreparedLetterTemplate
-
Captures source and configuration from a builder, parsing once.
- profile() - Method in record class com.nsdev.lettergenerator.render.RenderOptions
-
Returns the value of the
profilerecord component.
R
- recipient() - Method in record class com.nsdev.lettergenerator.letter.AddressLayout
-
Returns the value of the
recipientrecord component. - recipient(Party) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Replaces the recipient identity/address.
- RECIPIENT - Enum constant in enum class com.nsdev.lettergenerator.letter.LetterElement
-
Recipient identity and address.
- RECIPIENT - Enum constant in enum class com.nsdev.lettergenerator.theme.StyleRole
-
Recipient identity and postal address.
- reference(String, String) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Replaces the reference with a bold label and literal value.
- REFERENCE - Enum constant in enum class com.nsdev.lettergenerator.letter.LetterElement
-
Labeled reference information.
- REFERENCE - Enum constant in enum class com.nsdev.lettergenerator.theme.StyleRole
-
Labeled reference details.
- registerClasspathFont(String, FontVariant, String) - Method in class com.nsdev.lettergenerator.LetterPdfGenerator.Builder
-
Appends a TrueType classpath source without resolving or reading it yet.
- registerFont(String, FontVariant, Path) - Method in class com.nsdev.lettergenerator.LetterPdfGenerator.Builder
-
Appends a local TrueType font source without reading the file yet.
- REGULAR - Enum constant in enum class com.nsdev.lettergenerator.font.FontVariant
-
Upright, normal-weight face; required for every custom font family.
- render(LetterDocument) - Method in class com.nsdev.lettergenerator.LetterPdfGenerator
-
Renders a validated model and returns its actual pagination and processing diagnostics.
- render(LetterDocument, RenderOptions) - Method in class com.nsdev.lettergenerator.LetterPdfGenerator
-
Renders with optional authoring overlays.
- renderJson(String) - Method in class com.nsdev.lettergenerator.LetterPdfGenerator
-
Renders strict JSON and returns actual pagination and diagnostic information.
- renderJson(String, RenderOptions) - Method in class com.nsdev.lettergenerator.LetterPdfGenerator
-
Renders strict JSON with the same output choices available to Java and HTML models.
- RenderOptions - Record Class in com.nsdev.lettergenerator.render
-
Per-call PDF output choices and optional authoring overlays.
- RenderOptions(boolean) - Constructor for record class com.nsdev.lettergenerator.render.RenderOptions
-
Preserves ordinary rendering and authoring previews through the original constructor.
- RenderOptions(boolean, OutputProfile) - Constructor for record class com.nsdev.lettergenerator.render.RenderOptions
-
Requires an explicit profile; incompatible content is rejected before native rendering.
- RenderPart - Record Class in com.nsdev.lettergenerator.render
-
One contiguous source part in output order; page numbers are one-based.
- RenderPart(RenderPartKind, int, int) - Constructor for record class com.nsdev.lettergenerator.render.RenderPart
-
Checks that the part denotes a nonempty positive page range.
- RenderPartKind - Enum Class in com.nsdev.lettergenerator.render
-
Identifies the origin of a contiguous range in a generated PDF pack.
- RenderResult - Record Class in com.nsdev.lettergenerator.render
-
Complete accepted PDF with actual page count and optional authoring geometry.
- RenderResult(byte[], int, List<Diagnostic>, List<DebugBox>) - Constructor for record class com.nsdev.lettergenerator.render.RenderResult
-
Preserves the original result constructor for one generated letter.
- RenderResult(byte[], int, List<Diagnostic>, List<DebugBox>, List<RenderPart>) - Constructor for record class com.nsdev.lettergenerator.render.RenderResult
-
Owns all mutable inputs.
- requirements() - Method in class com.nsdev.lettergenerator.template.PreparedLetterTemplate
- resolvedHtml(String) - Static method in class com.nsdev.lettergenerator.builder.HtmlLetterBuilder
-
Creates a builder for already-resolved letter markup with substitution disabled.
- right() - Method in record class com.nsdev.lettergenerator.model.layout.Borders
-
Returns the value of the
rightrecord component. - right() - Method in record class com.nsdev.lettergenerator.model.layout.Bounds
-
Returns the horizontal coordinate of the right edge in the same zone.
- right() - Method in record class com.nsdev.lettergenerator.model.layout.Margins
-
Returns the value of the
rightrecord component. - RIGHT - Enum constant in enum class com.nsdev.lettergenerator.model.style.TextAlign
-
Align content with the right edge.
- rightMm() - Method in record class com.nsdev.lettergenerator.model.table.Padding
-
Returns the value of the
rightMmrecord component. - role(StyleRole, Style) - Method in class com.nsdev.lettergenerator.theme.LetterTheme.Builder
-
Registers or replaces a semantic role default.
- roles() - Method in record class com.nsdev.lettergenerator.theme.LetterTheme
-
Returns the value of the
rolesrecord component. - rotationDegrees() - Method in record class com.nsdev.lettergenerator.model.watermark.ImageWatermark
-
Returns the value of the
rotationDegreesrecord component. - rotationDegrees() - Method in record class com.nsdev.lettergenerator.model.watermark.TextWatermark
-
Returns the value of the
rotationDegreesrecord component. - rotationDegrees() - Method in interface com.nsdev.lettergenerator.model.watermark.Watermark
-
Returns rotation about the physical page center.
- row(String...) - Method in class com.nsdev.lettergenerator.builder.TableBuilder
-
Appends one data row, copying its cell strings into plain text runs.
- row(List<TableCell>) - Method in class com.nsdev.lettergenerator.builder.TableBuilder
-
Appends a typed row, allowing spans and block content.
- rowCells(TableCell...) - Method in class com.nsdev.lettergenerator.builder.TableBuilder
-
Appends typed cells through an explicit varargs entry point, including a fully spanned empty row.
- rowCount() - Method in record class com.nsdev.lettergenerator.model.table.TableRowGroup
-
Returns the value of the
rowCountrecord component. - rowGroup(TableRowGroup) - Method in class com.nsdev.lettergenerator.builder.TableBuilder
-
Appends a consecutive body-row group.
- rowGroups() - Method in record class com.nsdev.lettergenerator.model.table.TableOptions
-
Returns the value of the
rowGroupsrecord component. - rowIndex() - Method in record class com.nsdev.lettergenerator.model.table.TableRowPolicy
-
Returns the value of the
rowIndexrecord component. - rowKeepTogether() - Method in record class com.nsdev.lettergenerator.model.table.TableOptions
-
Returns the value of the
rowKeepTogetherrecord component. - rowKeepTogether() - Method in record class com.nsdev.lettergenerator.theme.TableAppearance
-
Returns the value of the
rowKeepTogetherrecord component. - rowKeepTogether(Keep) - Method in class com.nsdev.lettergenerator.builder.TableBuilder
-
Sets the default row split control; AUTO permits normal splits, PREFER is the legacy soft keep, and ALWAYS strongly requests intact rows.
- rowPolicies() - Method in record class com.nsdev.lettergenerator.model.table.TableOptions
-
Returns the value of the
rowPoliciesrecord component. - rowPolicy(TableRowPolicy) - Method in class com.nsdev.lettergenerator.builder.TableBuilder
-
Appends an explicit body-row override.
- rows() - Method in record class com.nsdev.lettergenerator.model.block.TableBlock
-
Returns the value of the
rowsrecord component. - rowSpan() - Method in record class com.nsdev.lettergenerator.model.table.TableCell
-
Returns the value of the
rowSpanrecord component. - RTL - Enum constant in enum class com.nsdev.lettergenerator.model.layout.TextDirection
-
Right-to-left writing.
- runs() - Method in record class com.nsdev.lettergenerator.model.block.Heading
-
Returns the value of the
runsrecord component. - runs() - Method in record class com.nsdev.lettergenerator.model.block.Paragraph
-
Returns the value of the
runsrecord component. - runs() - Method in record class com.nsdev.lettergenerator.model.table.TableCell
-
Returns the value of the
runsrecord component. - runs() - Method in record class com.nsdev.lettergenerator.model.text.ListItem
-
Returns the value of the
runsrecord component.
S
- salutation(String) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Replaces the nonblank opening greeting.
- SALUTATION - Enum constant in enum class com.nsdev.lettergenerator.letter.LetterElement
-
Opening greeting.
- SALUTATION - Enum constant in enum class com.nsdev.lettergenerator.theme.StyleRole
-
Opening greeting.
- schemaVersion() - Method in record class com.nsdev.lettergenerator.model.LetterDocument
-
Returns the value of the
schemaVersionrecord component. - Section - Record Class in com.nsdev.lettergenerator.model
-
Named group of body blocks rendered in list order.
- Section(String, Style, List<Block>) - Constructor for record class com.nsdev.lettergenerator.model.Section
-
Snapshots the block list without validating the section or its content.
- sections() - Method in record class com.nsdev.lettergenerator.model.LetterDocument
-
Returns the value of the
sectionsrecord component. - semanticStyle() - Method in record class com.nsdev.lettergenerator.model.block.Heading
-
Returns the value of the
semanticStylerecord component. - semanticStyle() - Method in record class com.nsdev.lettergenerator.model.table.TableCell
-
Returns the value of the
semanticStylerecord component. - sender() - Method in record class com.nsdev.lettergenerator.letter.AddressLayout
-
Returns the value of the
senderrecord component. - sender(Party) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Replaces the sender identity/address.
- SENDER - Enum constant in enum class com.nsdev.lettergenerator.letter.LetterElement
-
Sender identity and address.
- SENDER - Enum constant in enum class com.nsdev.lettergenerator.theme.StyleRole
-
Sender identity and postal address.
- settings() - Method in record class com.nsdev.lettergenerator.model.LetterDocument
-
Returns the value of the
settingsrecord component. - settings(DocumentSettings) - Method in class com.nsdev.lettergenerator.builder.HtmlLetterBuilder
-
Sets immutable language, metadata and text configuration.
- settings(DocumentSettings) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Replaces optional language, font and PDF metadata settings.
- severity() - Method in record class com.nsdev.lettergenerator.diagnostics.Diagnostic
-
Returns the value of the
severityrecord component. - signature() - Method in record class com.nsdev.lettergenerator.model.LetterDocument
-
Returns the value of the
signaturerecord component. - signature(LetterComponent) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Replaces signature content with a reusable fragment.
- signature(Style) - Method in class com.nsdev.lettergenerator.theme.LetterTheme.Builder
-
Sets visual-signature defaults.
- signature(SignatureContent...) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Replaces signature content with the supplied immutable parts stacked in argument order.
- Signature - Record Class in com.nsdev.lettergenerator.model.layout
-
Visual signature content, either appended to the body or positioned on the final page.
- Signature(SignaturePlacement, List<Block>, Bounds) - Constructor for record class com.nsdev.lettergenerator.model.layout.Signature
-
Snapshots the blocks without checking placement, bounds, or content.
- SIGNATURE - Enum constant in enum class com.nsdev.lettergenerator.theme.StyleRole
-
Flowing or final-page visual signature content.
- signatureBlocks(Block...) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Replaces signature content with an ordered snapshot of advanced model blocks.
- SignatureContent - Interface in com.nsdev.lettergenerator.signature
-
Immutable visual signature content accepted by
LetterBuilder.signature(SignatureContent...). - signatureHeightMm(double) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Replaces the signature height, initially 20 mm.
- signatureHtml(String) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Replaces signature content with a fragment of the supported HTML subset.
- signaturePlacement(SignaturePlacement) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Replaces signature placement.
- SignaturePlacement - Enum Class in com.nsdev.lettergenerator.model.layout
-
Controls whether a visual signature follows body flow or occupies a reserved last-page region.
- signatureZoneMm() - Method in record class com.nsdev.lettergenerator.model.layout.PageSpec
-
Returns the value of the
signatureZoneMmrecord component. - size() - Method in record class com.nsdev.lettergenerator.model.layout.PageSpec
-
Returns the value of the
sizerecord component. - sizeMm(double, double) - Method in class com.nsdev.lettergenerator.signature.ImageSignature
-
Creates a signature refitted from the original image bytes into the given box.
- SOLID - Enum constant in enum class com.nsdev.lettergenerator.model.table.BorderStyle
-
Paint a continuous line.
- spaceAfterMm() - Method in record class com.nsdev.lettergenerator.model.style.Style
-
Returns the value of the
spaceAfterMmrecord component. - spaceAfterMm(double) - Method in class com.nsdev.lettergenerator.model.style.Style.Builder
-
Sets spacing after a block.
- spaceBeforeMm() - Method in record class com.nsdev.lettergenerator.model.style.Style
-
Returns the value of the
spaceBeforeMmrecord component. - spaceBeforeMm(double) - Method in class com.nsdev.lettergenerator.model.style.Style.Builder
-
Sets spacing before a block.
- span(int, int) - Method in record class com.nsdev.lettergenerator.model.table.TableCell
-
Returns this cell with explicit spans, preserving content and appearance.
- STANDARD - Enum constant in enum class com.nsdev.lettergenerator.render.OutputProfile
-
Ordinary PDF with optional metadata and optional appended PDFs.
- startRow() - Method in record class com.nsdev.lettergenerator.model.table.TableRowGroup
-
Returns the value of the
startRowrecord component. - stationery() - Method in record class com.nsdev.lettergenerator.theme.LetterTheme
-
Returns the value of the
stationeryrecord component. - stationery(Stationery) - Method in class com.nsdev.lettergenerator.theme.LetterTheme.Builder
-
Sets reusable header/footer/logo content and geometry.
- Stationery - Record Class in com.nsdev.lettergenerator.theme
-
Immutable header, footer and logo geometry shared by letters using a theme.
- Stationery(List<FixedElement>, double, double) - Constructor for record class com.nsdev.lettergenerator.theme.Stationery
-
Snapshots registrations without validating geometry.
- StationeryBuilder - Class in com.nsdev.lettergenerator.builder
-
Convenience authoring of reusable stationery using the same geometry as a letter builder.
- StationeryBuilder() - Constructor for class com.nsdev.lettergenerator.builder.StationeryBuilder
-
Creates an empty stationery builder.
- style() - Method in interface com.nsdev.lettergenerator.model.block.Block
-
Returns overrides layered on the inherited document and optional section style.
- style() - Method in record class com.nsdev.lettergenerator.model.block.BoxBlock
-
Returns the value of the
stylerecord component. - style() - Method in record class com.nsdev.lettergenerator.model.block.CanvasBlock
-
Returns the value of the
stylerecord component. - style() - Method in record class com.nsdev.lettergenerator.model.block.ColumnsBlock
-
Returns the value of the
stylerecord component. - style() - Method in record class com.nsdev.lettergenerator.model.block.ComponentBlock
-
Returns the value of the
stylerecord component. - style() - Method in record class com.nsdev.lettergenerator.model.block.GroupBlock
-
Returns the value of the
stylerecord component. - style() - Method in record class com.nsdev.lettergenerator.model.block.Heading
-
Returns the value of the
stylerecord component. - style() - Method in record class com.nsdev.lettergenerator.model.block.ImageBlock
-
Returns the value of the
stylerecord component. - style() - Method in record class com.nsdev.lettergenerator.model.block.LetterPartBlock
-
Returns the value of the
stylerecord component. - style() - Method in record class com.nsdev.lettergenerator.model.block.ListBlock
-
Returns the value of the
stylerecord component. - style() - Method in record class com.nsdev.lettergenerator.model.block.PageBreakBlock
-
Returns no style because a page boundary has no rendered content.
- style() - Method in record class com.nsdev.lettergenerator.model.block.Paragraph
-
Returns the value of the
stylerecord component. - style() - Method in record class com.nsdev.lettergenerator.model.block.TableBlock
-
Returns the value of the
stylerecord component. - style() - Method in record class com.nsdev.lettergenerator.model.layout.Column
-
Returns the value of the
stylerecord component. - style() - Method in record class com.nsdev.lettergenerator.model.layout.PositionedContent
-
Returns the value of the
stylerecord component. - style() - Method in record class com.nsdev.lettergenerator.model.Section
-
Returns the value of the
stylerecord component. - style() - Method in record class com.nsdev.lettergenerator.model.table.Border
-
Returns the value of the
stylerecord component. - style() - Method in record class com.nsdev.lettergenerator.model.table.TableCell
-
Returns the value of the
stylerecord component. - style() - Method in record class com.nsdev.lettergenerator.model.text.TextRun
-
Returns the value of the
stylerecord component. - style(Style) - Method in class com.nsdev.lettergenerator.builder.CanvasBuilder
-
Sets optional inherited canvas typography and outer spacing/pagination.
- style(Style) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Replaces body style overrides, overlaid on the default 3 mm paragraph gap.
- style(Style) - Method in class com.nsdev.lettergenerator.builder.TableBuilder
-
Replaces the table's inherited text and spacing style.
- style(Style) - Method in class com.nsdev.lettergenerator.signature.TextSignature
-
Creates a copy with replacement style overrides for all signature paragraphs.
- Style - Record Class in com.nsdev.lettergenerator.model.style
-
Immutable set of nullable typography and spacing overrides.
- Style(String, Double, String, Boolean, Boolean, Boolean, TextAlign, Double, Double, Double) - Constructor for record class com.nsdev.lettergenerator.model.style.Style
-
Creates typography/spacing overrides with no explicit pagination policy.
- Style(String, Double, String, Boolean, Boolean, Boolean, TextAlign, Double, Double, Double, Keep, Keep, Integer, Integer) - Constructor for record class com.nsdev.lettergenerator.model.style.Style
-
Preserves the pagination-aware constructor without a named reference.
- Style(String, Double, String, Boolean, Boolean, Boolean, TextAlign, Double, Double, Double, Keep, Keep, Integer, Integer, String) - Constructor for record class com.nsdev.lettergenerator.model.style.Style
-
Creates ordinary overrides with an optional named reference and no retained lower layer.
- Style(String, Double, String, Boolean, Boolean, Boolean, TextAlign, Double, Double, Double, Keep, Keep, Integer, Integer, String, Style) - Constructor for record class com.nsdev.lettergenerator.model.style.Style
-
Creates an instance of a
Stylerecord class. - Style.Builder - Class in com.nsdev.lettergenerator.model.style
-
Mutable accumulator for an immutable
Style. - styleName() - Method in record class com.nsdev.lettergenerator.model.style.Style
-
Returns the value of the
styleNamerecord component. - StyleRole - Enum Class in com.nsdev.lettergenerator.theme
-
Semantic locations whose theme defaults precede explicit document and content styles.
- styles() - Method in record class com.nsdev.lettergenerator.template.TemplateRequirements
-
Returns the value of the
stylesrecord component. - subject() - Method in record class com.nsdev.lettergenerator.model.DocumentMetadata
-
Returns the value of the
subjectrecord component. - subject(String) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Replaces the nonblank literal subject.
- SUBJECT - Enum constant in enum class com.nsdev.lettergenerator.letter.LetterElement
-
Letter subject.
- SUBJECT - Enum constant in enum class com.nsdev.lettergenerator.theme.StyleRole
-
Subject line.
- SUPPORTED_SCHEMA_VERSION - Static variable in record class com.nsdev.lettergenerator.model.LetterDocument
-
Schema version accepted by generation and by the JSON document model.
T
- table(TableBlock) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Appends a table block, commonly produced by
Table.builder(String...). - table(Style) - Method in class com.nsdev.lettergenerator.theme.LetterTheme.Builder
-
Sets table defaults.
- Table - Class in com.nsdev.lettergenerator
-
Convenience entry point for text tables embedded with
LetterBuilder.table(com.nsdev.lettergenerator.model.block.TableBlock). - TABLE - Enum constant in enum class com.nsdev.lettergenerator.theme.StyleRole
-
Table-wide typography and spacing.
- TABLE_CELL - Enum constant in enum class com.nsdev.lettergenerator.theme.StyleRole
-
Table-body cell typography.
- TABLE_HEADER - Enum constant in enum class com.nsdev.lettergenerator.theme.StyleRole
-
Repeating table-header cell typography.
- tableAppearance() - Method in record class com.nsdev.lettergenerator.theme.LetterTheme
-
Returns the value of the
tableAppearancerecord component. - tableAppearance(TableAppearance) - Method in class com.nsdev.lettergenerator.theme.LetterTheme.Builder
-
Sets table paint, padding and row defaults.
- TableAppearance - Record Class in com.nsdev.lettergenerator.theme
-
Table appearance defaults shared by every authoring API.
- TableAppearance(CellAppearance, CellAppearance, Keep) - Constructor for record class com.nsdev.lettergenerator.theme.TableAppearance
-
Creates an instance of a
TableAppearancerecord class. - TableBlock - Record Class in com.nsdev.lettergenerator.model.block
-
Full-width native table with positive proportional column weights, an optional repeating header and ordered body rows.
- TableBlock(List<Double>, List<TableCell>, List<List<TableCell>>, Style) - Constructor for record class com.nsdev.lettergenerator.model.block.TableBlock
-
Preserves the original constructor with legacy cell appearance and row keeps.
- TableBlock(List<Double>, List<TableCell>, List<List<TableCell>>, Style, TableOptions) - Constructor for record class com.nsdev.lettergenerator.model.block.TableBlock
-
Snapshots all supplied collections, retaining null rows and entries for field-path errors.
- TableBuilder - Class in com.nsdev.lettergenerator.builder
-
Mutable table builder with a fixed column count and ordered, appended rows.
- TableBuilder(String...) - Constructor for class com.nsdev.lettergenerator.builder.TableBuilder
-
Creates a table whose header array fixes the number of columns.
- tableCell(Style) - Method in class com.nsdev.lettergenerator.theme.LetterTheme.Builder
-
Sets table-body cell defaults.
- TableCell - Record Class in com.nsdev.lettergenerator.model.table
-
Cell containing either inline runs or ordinary blocks.
- TableCell(List<TextRun>, Style, String) - Constructor for record class com.nsdev.lettergenerator.model.table.TableCell
-
Creates a legacy text-only cell with one-column/one-row spans and default appearance.
- TableCell(List<TextRun>, Style, String, List<Block>, Integer, Integer, CellAppearance) - Constructor for record class com.nsdev.lettergenerator.model.table.TableCell
-
Creates a rich cell without tag-specific semantic defaults.
- TableCell(List<TextRun>, Style, String, List<Block>, Integer, Integer, CellAppearance, Style) - Constructor for record class com.nsdev.lettergenerator.model.table.TableCell
-
Preserves cells with tag-specific typography and no appearance fallback.
- TableCell(List<TextRun>, Style, String, List<Block>, Integer, Integer, CellAppearance, Style, CellAppearance) - Constructor for record class com.nsdev.lettergenerator.model.table.TableCell
-
Copies both content lists without validating their entries or exclusive content forms.
- tableHeader(Style) - Method in class com.nsdev.lettergenerator.theme.LetterTheme.Builder
-
Sets repeating table-header cell defaults.
- TableOptions - Record Class in com.nsdev.lettergenerator.model.table
-
Optional table appearance and body-row page policies.
- TableOptions(CellAppearance, Keep, List<TableRowPolicy>, List<TableRowGroup>) - Constructor for record class com.nsdev.lettergenerator.model.table.TableOptions
-
Snapshots row metadata without validating indices or appearance values.
- TableRowGroup - Record Class in com.nsdev.lettergenerator.model.table
-
Consecutive body rows requested to stay on one page.
- TableRowGroup(int, int, Keep) - Constructor for record class com.nsdev.lettergenerator.model.table.TableRowGroup
-
Creates an instance of a
TableRowGrouprecord class. - TableRowPolicy - Record Class in com.nsdev.lettergenerator.model.table
-
Overrides page-breaking behavior for one zero-based body row.
- TableRowPolicy(int, Keep, Keep) - Constructor for record class com.nsdev.lettergenerator.model.table.TableRowPolicy
-
Creates an instance of a
TableRowPolicyrecord class. - TAGGED - Enum constant in enum class com.nsdev.lettergenerator.render.OutputProfile
-
Native structure tags; this mode does not guarantee PDF/UA conformance or reading order.
- template(String) - Static method in class com.nsdev.lettergenerator.builder.HtmlLetterBuilder
-
Creates a builder with
${name}substitution enabled. - template(String) - Static method in class com.nsdev.lettergenerator.Letter
-
Starts a template builder that substitutes
${name}bindings in parsed text and attribute values. - TemplateRequirement - Record Class in com.nsdev.lettergenerator.template
-
One source occurrence in a template's input contract.
- TemplateRequirement(String, String) - Constructor for record class com.nsdev.lettergenerator.template.TemplateRequirement
-
Creates an instance of a
TemplateRequirementrecord class. - TemplateRequirements - Record Class in com.nsdev.lettergenerator.template
-
Immutable syntactic requirements, including conditional branches and scoped aliases.
- TemplateRequirements(List<TemplateRequirement>, List<TemplateRequirement>, List<TemplateRequirement>, List<TemplateRequirement>, List<TemplateRequirement>, List<TemplateRequirement>) - Constructor for record class com.nsdev.lettergenerator.template.TemplateRequirements
-
Owns all occurrence lists.
- text() - Method in record class com.nsdev.lettergenerator.model.text.TextRun
-
Returns the value of the
textrecord component. - text() - Method in record class com.nsdev.lettergenerator.model.watermark.TextWatermark
-
Returns the value of the
textrecord component. - text(String) - Static method in record class com.nsdev.lettergenerator.model.table.TableCell
-
Wraps plain text, including an empty string, in a compact cell.
- text(String...) - Static method in record class com.nsdev.lettergenerator.component.LetterComponent
-
Creates one ordinary paragraph per supplied literal string, suitable for address lines.
- text(String, Bounds, String) - Method in class com.nsdev.lettergenerator.builder.CanvasBuilder
-
Appends plain text converted through the ordinary letter paragraph rules.
- textAlign() - Method in record class com.nsdev.lettergenerator.model.style.Style
-
Returns the value of the
textAlignrecord component. - textAlign(TextAlign) - Method in class com.nsdev.lettergenerator.model.style.Style.Builder
-
Sets horizontal paragraph alignment.
- TextAlign - Enum Class in com.nsdev.lettergenerator.model.style
-
Horizontal paragraph alignment; images also use this value for their enclosing block.
- TextDirection - Enum Class in com.nsdev.lettergenerator.model.layout
-
Document reading direction; AUTO derives the base direction from the selected language.
- TextRun - Record Class in com.nsdev.lettergenerator.model.text
-
Literal inline text with optional style overrides and an external hyperlink.
- TextRun(String, Style, String) - Constructor for record class com.nsdev.lettergenerator.model.text.TextRun
-
Creates a literal text run without a dynamic page field.
- TextRun(String, Style, String, PageNumber) - Constructor for record class com.nsdev.lettergenerator.model.text.TextRun
-
Creates an instance of a
TextRunrecord class. - TextSignature - Class in com.nsdev.lettergenerator.signature
-
Immutable plain-text signature part: single newlines change lines and blank lines separate paragraphs.
- TextWatermark - Record Class in com.nsdev.lettergenerator.model.watermark
-
Text centered behind selected pages using a built-in or registered regular font.
- TextWatermark(String, String, Double, String, PageSelector, Double, Double) - Constructor for record class com.nsdev.lettergenerator.model.watermark.TextWatermark
-
Creates an instance of a
TextWatermarkrecord class. - theme() - Method in record class com.nsdev.lettergenerator.model.LetterDocument
-
Returns the value of the
themerecord component. - theme(LetterTheme) - Method in class com.nsdev.lettergenerator.builder.HtmlLetterBuilder
-
Supplies per-document role defaults and named styles.
- theme(LetterTheme) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Sets role defaults and named styles for this document.
- title() - Method in record class com.nsdev.lettergenerator.model.DocumentMetadata
-
Returns the value of the
titlerecord component. - top() - Method in record class com.nsdev.lettergenerator.model.layout.Borders
-
Returns the value of the
toprecord component. - top() - Method in record class com.nsdev.lettergenerator.model.layout.Margins
-
Returns the value of the
toprecord component. - TOP - Enum constant in enum class com.nsdev.lettergenerator.model.layout.Zone
-
Region above the body, measured downward from the top inner-page edge.
- TOP - Enum constant in enum class com.nsdev.lettergenerator.model.table.VerticalAlignment
-
Align content with the top of the inner cell.
- topMm() - Method in record class com.nsdev.lettergenerator.model.table.Padding
-
Returns the value of the
topMmrecord component. - topZoneMm() - Method in record class com.nsdev.lettergenerator.model.layout.PageSpec
-
Returns the value of the
topZoneMmrecord component. - topZoneMm() - Method in record class com.nsdev.lettergenerator.theme.Stationery
-
Returns the value of the
topZoneMmrecord component. - toString() - Method in record class com.nsdev.lettergenerator.component.LetterComponent
-
Returns a string representation of this record class.
- toString() - Method in record class com.nsdev.lettergenerator.diagnostics.Diagnostic
-
Returns a string representation of this record class.
- toString() - Method in record class com.nsdev.lettergenerator.diagnostics.ValidationReport
-
Returns a string representation of this record class.
- toString() - Method in record class com.nsdev.lettergenerator.document.PdfAttachment
-
Returns a string representation of this record class.
- toString() - Method in record class com.nsdev.lettergenerator.letter.Address
-
Returns a string representation of this record class.
- toString() - Method in record class com.nsdev.lettergenerator.letter.AddressLayout
-
Returns a string representation of this record class.
- toString() - Method in record class com.nsdev.lettergenerator.letter.Party
-
Returns a string representation of this record class.
- toString() - Method in record class com.nsdev.lettergenerator.localization.LocaleSettings
-
Returns a string representation of this record class.
- toString() - Method in record class com.nsdev.lettergenerator.model.block.BoxBlock
-
Returns a string representation of this record class.
- toString() - Method in record class com.nsdev.lettergenerator.model.block.CanvasBlock
-
Returns a string representation of this record class.
- toString() - Method in record class com.nsdev.lettergenerator.model.block.ColumnsBlock
-
Returns a string representation of this record class.
- toString() - Method in record class com.nsdev.lettergenerator.model.block.ComponentBlock
-
Returns a string representation of this record class.
- toString() - Method in record class com.nsdev.lettergenerator.model.block.GroupBlock
-
Returns a string representation of this record class.
- toString() - Method in record class com.nsdev.lettergenerator.model.block.Heading
-
Returns a string representation of this record class.
- toString() - Method in record class com.nsdev.lettergenerator.model.block.ImageBlock
-
Returns a string representation of this record class.
- toString() - Method in record class com.nsdev.lettergenerator.model.block.LetterPartBlock
-
Returns a string representation of this record class.
- toString() - Method in record class com.nsdev.lettergenerator.model.block.ListBlock
-
Returns a string representation of this record class.
- toString() - Method in record class com.nsdev.lettergenerator.model.block.PageBreakBlock
-
Returns a string representation of this record class.
- toString() - Method in record class com.nsdev.lettergenerator.model.block.Paragraph
-
Returns a string representation of this record class.
- toString() - Method in record class com.nsdev.lettergenerator.model.block.TableBlock
-
Returns a string representation of this record class.
- toString() - Method in record class com.nsdev.lettergenerator.model.DocumentMetadata
-
Returns a string representation of this record class.
- toString() - Method in record class com.nsdev.lettergenerator.model.DocumentSettings
-
Returns a string representation of this record class.
- toString() - Method in record class com.nsdev.lettergenerator.model.layout.Borders
-
Returns a string representation of this record class.
- toString() - Method in record class com.nsdev.lettergenerator.model.layout.Bounds
-
Returns a string representation of this record class.
- toString() - Method in record class com.nsdev.lettergenerator.model.layout.BoxAppearance
-
Returns a string representation of this record class.
- toString() - Method in record class com.nsdev.lettergenerator.model.layout.Column
-
Returns a string representation of this record class.
- toString() - Method in record class com.nsdev.lettergenerator.model.layout.FixedElement
-
Returns a string representation of this record class.
- toString() - Method in record class com.nsdev.lettergenerator.model.layout.Margins
-
Returns a string representation of this record class.
- toString() - Method in record class com.nsdev.lettergenerator.model.layout.PageDimensions
-
Returns a string representation of this record class.
- toString() - Method in record class com.nsdev.lettergenerator.model.layout.PageSpec
-
Returns a string representation of this record class.
- toString() - Method in record class com.nsdev.lettergenerator.model.layout.PositionedContent
-
Returns a string representation of this record class.
- toString() - Method in record class com.nsdev.lettergenerator.model.layout.Signature
-
Returns a string representation of this record class.
- toString() - Method in record class com.nsdev.lettergenerator.model.LetterDocument
-
Returns a string representation of this record class.
- toString() - Method in record class com.nsdev.lettergenerator.model.Section
-
Returns a string representation of this record class.
- toString() - Method in record class com.nsdev.lettergenerator.model.style.Style
-
Returns a string representation of this record class.
- toString() - Method in record class com.nsdev.lettergenerator.model.table.Border
-
Returns a string representation of this record class.
- toString() - Method in record class com.nsdev.lettergenerator.model.table.CellAppearance
-
Returns a string representation of this record class.
- toString() - Method in record class com.nsdev.lettergenerator.model.table.Padding
-
Returns a string representation of this record class.
- toString() - Method in record class com.nsdev.lettergenerator.model.table.TableCell
-
Returns a string representation of this record class.
- toString() - Method in record class com.nsdev.lettergenerator.model.table.TableOptions
-
Returns a string representation of this record class.
- toString() - Method in record class com.nsdev.lettergenerator.model.table.TableRowGroup
-
Returns a string representation of this record class.
- toString() - Method in record class com.nsdev.lettergenerator.model.table.TableRowPolicy
-
Returns a string representation of this record class.
- toString() - Method in record class com.nsdev.lettergenerator.model.text.ListItem
-
Returns a string representation of this record class.
- toString() - Method in record class com.nsdev.lettergenerator.model.text.TextRun
-
Returns a string representation of this record class.
- toString() - Method in record class com.nsdev.lettergenerator.model.watermark.ImageWatermark
-
Returns a string representation of this record class.
- toString() - Method in record class com.nsdev.lettergenerator.model.watermark.TextWatermark
-
Returns a string representation of this record class.
- toString() - Method in record class com.nsdev.lettergenerator.render.DebugBox
-
Returns a string representation of this record class.
- toString() - Method in record class com.nsdev.lettergenerator.render.RenderOptions
-
Returns a string representation of this record class.
- toString() - Method in record class com.nsdev.lettergenerator.render.RenderPart
-
Returns a string representation of this record class.
- toString() - Method in record class com.nsdev.lettergenerator.render.RenderResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.nsdev.lettergenerator.template.TemplateRequirement
-
Returns a string representation of this record class.
- toString() - Method in record class com.nsdev.lettergenerator.template.TemplateRequirements
-
Returns a string representation of this record class.
- toString() - Method in record class com.nsdev.lettergenerator.theme.LetterTheme
-
Returns a string representation of this record class.
- toString() - Method in record class com.nsdev.lettergenerator.theme.Stationery
-
Returns a string representation of this record class.
- toString() - Method in record class com.nsdev.lettergenerator.theme.TableAppearance
-
Returns a string representation of this record class.
- TOTAL - Enum constant in enum class com.nsdev.lettergenerator.model.text.PageNumber
-
Total physical pages, including an allocated signature-recovery page.
U
- underline() - Method in class com.nsdev.lettergenerator.model.style.Style.Builder
-
Enables underlining for text.
- underline() - Method in record class com.nsdev.lettergenerator.model.style.Style
-
Returns the value of the
underlinerecord component. - underline(boolean) - Method in class com.nsdev.lettergenerator.model.style.Style.Builder
-
Overrides the inherited underline flag, including explicitly disabling it.
- uniform(double) - Static method in record class com.nsdev.lettergenerator.model.layout.Margins
-
Creates equal margins without validating their value.
- uniform(double) - Static method in record class com.nsdev.lettergenerator.model.table.Padding
-
Creates equal padding on all edges, deferring range checks to generation.
- uniform(Border) - Static method in record class com.nsdev.lettergenerator.model.layout.Borders
-
Applies an immutable border value to every edge.
V
- validate() - Method in class com.nsdev.lettergenerator.builder.HtmlLetterBuilder
-
Inspects bindings, assets and declared model constraints using built-in fonts, without PDF layout.
- validate() - Method in class com.nsdev.lettergenerator.template.PreparedLetterTemplate
- validate(LetterPdfGenerator) - Method in class com.nsdev.lettergenerator.builder.HtmlLetterBuilder
-
Inspects with the selected generator's registered fonts.
- validate(LetterPdfGenerator) - Method in class com.nsdev.lettergenerator.template.PreparedLetterTemplate
-
Validates captured bindings and configuration without native layout.
- validate(LetterDocument) - Method in class com.nsdev.lettergenerator.LetterPdfGenerator
-
Validates composition references, declared geometry, fonts and content without running PDF layout.
- ValidationReport - Record Class in com.nsdev.lettergenerator.diagnostics
-
Immutable input inspection result.
- ValidationReport(List<Diagnostic>) - Constructor for record class com.nsdev.lettergenerator.diagnostics.ValidationReport
-
Snapshots the diagnostic list.
- ValueFormats - Class in com.nsdev.lettergenerator.localization
-
Finite text/date/number/currency formatting without reflection or global lookups.
- valueOf(String) - Static method in enum class com.nsdev.lettergenerator.diagnostics.DiagnosticPhase
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.nsdev.lettergenerator.diagnostics.DiagnosticSeverity
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.nsdev.lettergenerator.font.FontVariant
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.nsdev.lettergenerator.letter.LetterElement
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.nsdev.lettergenerator.model.layout.Keep
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.nsdev.lettergenerator.model.layout.Orientation
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.nsdev.lettergenerator.model.layout.PageSelector
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.nsdev.lettergenerator.model.layout.PageSize
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.nsdev.lettergenerator.model.layout.SignaturePlacement
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.nsdev.lettergenerator.model.layout.TextDirection
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.nsdev.lettergenerator.model.layout.Zone
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.nsdev.lettergenerator.model.style.TextAlign
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.nsdev.lettergenerator.model.table.BorderStyle
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.nsdev.lettergenerator.model.table.VerticalAlignment
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.nsdev.lettergenerator.model.text.PageNumber
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.nsdev.lettergenerator.render.OutputProfile
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.nsdev.lettergenerator.render.RenderPartKind
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.nsdev.lettergenerator.theme.StyleRole
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.nsdev.lettergenerator.diagnostics.DiagnosticPhase
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.nsdev.lettergenerator.diagnostics.DiagnosticSeverity
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.nsdev.lettergenerator.font.FontVariant
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.nsdev.lettergenerator.letter.LetterElement
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.nsdev.lettergenerator.model.layout.Keep
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.nsdev.lettergenerator.model.layout.Orientation
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.nsdev.lettergenerator.model.layout.PageSelector
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.nsdev.lettergenerator.model.layout.PageSize
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.nsdev.lettergenerator.model.layout.SignaturePlacement
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.nsdev.lettergenerator.model.layout.TextDirection
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.nsdev.lettergenerator.model.layout.Zone
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.nsdev.lettergenerator.model.style.TextAlign
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.nsdev.lettergenerator.model.table.BorderStyle
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.nsdev.lettergenerator.model.table.VerticalAlignment
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.nsdev.lettergenerator.model.text.PageNumber
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.nsdev.lettergenerator.render.OutputProfile
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.nsdev.lettergenerator.render.RenderPartKind
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.nsdev.lettergenerator.theme.StyleRole
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values(Map<String, ?>) - Method in class com.nsdev.lettergenerator.builder.HtmlLetterBuilder
-
Replaces all bindings with an owned typed snapshot.
- variables() - Method in record class com.nsdev.lettergenerator.template.TemplateRequirements
-
Returns the value of the
variablesrecord component. - verticalAlignment() - Method in record class com.nsdev.lettergenerator.model.table.CellAppearance
-
Returns the value of the
verticalAlignmentrecord component. - VerticalAlignment - Enum Class in com.nsdev.lettergenerator.model.table
-
Vertical position of cell content within the native table row.
W
- WARNING - Enum constant in enum class com.nsdev.lettergenerator.diagnostics.DiagnosticSeverity
-
Accepted output with a condition the caller should review.
- watermark() - Method in record class com.nsdev.lettergenerator.model.LetterDocument
-
Returns the value of the
watermarkrecord component. - watermark(Watermark) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Replaces the watermark configuration for PDF post-processing.
- watermark(String) - Method in class com.nsdev.lettergenerator.builder.LetterBuilder
-
Replaces the watermark with the default text-watermark configuration.
- Watermark - Interface in com.nsdev.lettergenerator.model.watermark
-
Optional decoration centered on the physical page and drawn behind letter content.
- weight() - Method in record class com.nsdev.lettergenerator.model.layout.Column
-
Returns the value of the
weightrecord component. - widows() - Method in record class com.nsdev.lettergenerator.model.style.Style
-
Returns the value of the
widowsrecord component. - widows(int) - Method in class com.nsdev.lettergenerator.model.style.Style.Builder
-
Sets the minimum trailing paragraph lines on a page; generation requires a positive value.
- width() - Method in record class com.nsdev.lettergenerator.model.layout.Bounds
-
Returns the value of the
widthrecord component. - widthMm() - Method in record class com.nsdev.lettergenerator.model.block.CanvasBlock
-
Returns the value of the
widthMmrecord component. - widthMm() - Method in record class com.nsdev.lettergenerator.model.block.ImageBlock
-
Returns the value of the
widthMmrecord component. - widthMm() - Method in record class com.nsdev.lettergenerator.model.layout.PageDimensions
-
Returns the value of the
widthMmrecord component. - widthMm() - Method in enum class com.nsdev.lettergenerator.model.layout.PageSize
-
Returns the physical page width, before margins.
- widthMm() - Method in record class com.nsdev.lettergenerator.model.layout.PageSpec
- widthMm() - Method in record class com.nsdev.lettergenerator.model.watermark.ImageWatermark
-
Returns the value of the
widthMmrecord component. - widthMm() - Method in record class com.nsdev.lettergenerator.render.DebugBox
-
Returns the value of the
widthMmrecord component. - widthPt() - Method in record class com.nsdev.lettergenerator.model.table.Border
-
Returns the value of the
widthPtrecord component. - windowEnvelope() - Static method in record class com.nsdev.lettergenerator.letter.AddressLayout
-
Supplies an editable example window-envelope arrangement without postal compliance claims.
- withAltText(String) - Method in record class com.nsdev.lettergenerator.model.block.ImageBlock
-
Replaces the description while preserving the image and its geometry.
- withAppearance(CellAppearance) - Method in record class com.nsdev.lettergenerator.model.table.TableCell
-
Returns a copy with replacement local appearance and all other properties retained.
- withAttachments(List<PdfAttachment>) - Method in record class com.nsdev.lettergenerator.model.LetterDocument
-
Replaces appended PDF registrations while retaining the letter.
- withComponents(Map<String, LetterComponent>) - Method in record class com.nsdev.lettergenerator.model.LetterDocument
-
Replaces component registrations with a defensive snapshot.
- withLocale(LocaleSettings) - Method in record class com.nsdev.lettergenerator.model.DocumentSettings
-
Returns a copy with country-aware formatting replaced.
- withSettings(DocumentSettings) - Method in record class com.nsdev.lettergenerator.model.LetterDocument
-
Replaces document settings while preserving all content and attachments.
- withStyle(Style) - Method in record class com.nsdev.lettergenerator.model.block.ImageBlock
-
Replaces local style overrides while preserving the description.
- withStyle(Style) - Method in record class com.nsdev.lettergenerator.model.block.TableBlock
-
Replaces typography while preserving spans, content, appearance and row metadata.
- withStyle(Style) - Method in record class com.nsdev.lettergenerator.model.table.TableCell
-
Returns a copy with replacement typography and all geometry/content retained.
- withTheme(LetterTheme) - Method in record class com.nsdev.lettergenerator.model.LetterDocument
-
Replaces the theme while retaining content and component registrations.
X
- x() - Method in record class com.nsdev.lettergenerator.model.layout.Bounds
-
Returns the value of the
xrecord component. - xMm() - Method in record class com.nsdev.lettergenerator.render.DebugBox
-
Returns the value of the
xMmrecord component.
Y
- y() - Method in record class com.nsdev.lettergenerator.model.layout.Bounds
-
Returns the value of the
yrecord component. - yMm() - Method in record class com.nsdev.lettergenerator.render.DebugBox
-
Returns the value of the
yMmrecord component.
Z
- ZERO - Static variable in record class com.nsdev.lettergenerator.model.table.Padding
-
Explicit zero padding on each edge.
- zone() - Method in record class com.nsdev.lettergenerator.model.layout.FixedElement
-
Returns the value of the
zonerecord component. - Zone - Enum Class in com.nsdev.lettergenerator.model.layout
-
Reserved region for positioned fixed elements, inside the outer page margins.
- zoneId() - Method in record class com.nsdev.lettergenerator.localization.LocaleSettings
-
Returns the value of the
zoneIdrecord component.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form