Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- a() - Method in record class dev.jcputney.mjml.css.CssSpecificity
-
Returns the value of the
arecord component. - AbstractSectionComponent - Class in dev.jcputney.mjml.component.body
-
Shared base class for
<mj-section>and<mj-wrapper>. - AbstractSectionComponent(MjmlNode, GlobalContext, RenderContext, ComponentRegistry) - Constructor for class dev.jcputney.mjml.component.body.AbstractSectionComponent
-
Creates a new section component with the given node, context, and registry.
- add(CssSpecificity) - Method in record class dev.jcputney.mjml.css.CssSpecificity
-
Adds two specificity values together (used for compound selectors).
- addBorderStyles(Map, String...) - Method in class dev.jcputney.mjml.component.BodyComponent
-
Adds border styles from the given attribute names to the style map.
- addChild(HtmlElement) - Method in class dev.jcputney.mjml.css.HtmlElement
-
Adds a child element to this element, setting its parent reference and caching its index.
- addChild(MjmlNode) - Method in class dev.jcputney.mjml.parser.MjmlNode
-
Adds a child node to this node and sets the child's parent reference.
- addComponentStyle(String) - Method in class dev.jcputney.mjml.context.StyleContext
-
Adds a component-specific CSS style block.
- addFileStartContent(String) - Method in class dev.jcputney.mjml.context.MetadataContext
-
Adds content that should appear at the start of the rendered file.
- addFont(String, String) - Method in class dev.jcputney.mjml.context.StyleContext
-
Registers a font with the given name and URL.
- addHeadComment(String) - Method in class dev.jcputney.mjml.context.MetadataContext
-
Adds a comment found in the
<mj-head>section to the list of head comments. - addIfPresent(Map, String) - Method in class dev.jcputney.mjml.component.BodyComponent
-
Adds an attribute value to the style map if the attribute is non-empty.
- addIfPresent(Map, String, String) - Method in class dev.jcputney.mjml.component.BodyComponent
-
Adds an attribute value to the style map under the given CSS property name if the attribute is non-empty.
- addInlineStyle(String) - Method in class dev.jcputney.mjml.context.StyleContext
-
Adds an inline CSS style block.
- addInnerTdBorderStyles(Map) - Method in class dev.jcputney.mjml.component.body.AbstractSectionComponent
-
Adds border styles to the inner td style map.
- addInnerTdBorderStyles(Map) - Method in class dev.jcputney.mjml.component.body.MjSection
- addInnerTdExtraStyles(Map) - Method in class dev.jcputney.mjml.component.body.AbstractSectionComponent
-
Adds extra styles between border-radius and font-size.
- addInnerTdPaddingOverrides(Map) - Method in class dev.jcputney.mjml.component.body.AbstractSectionComponent
-
Adds individual padding overrides.
- addInnerTdPaddingOverrides(Map) - Method in class dev.jcputney.mjml.component.body.MjSection
- addMediaQuery(String, String, String) - Method in class dev.jcputney.mjml.context.StyleContext
-
Adds a media query for responsive column width targeting the given CSS class.
- addStyle(String) - Method in class dev.jcputney.mjml.context.StyleContext
-
Adds a CSS style block.
- addStyleOnce(String, String) - Method in class dev.jcputney.mjml.context.StyleContext
-
Adds a CSS style block only if a style with the given key has not already been registered.
- ADJACENT_SIBLING - Enum constant in enum class dev.jcputney.mjml.css.CssSelector.Combinator
-
Adjacent sibling combinator (
+), matches the immediately following sibling. - allDescendants() - Method in class dev.jcputney.mjml.css.HtmlElement
-
Returns all descendant elements in document order (depth-first).
- argument() - Method in record class dev.jcputney.mjml.css.CssSelector.PseudoClassSelector
-
Returns the value of the
argumentrecord component. - assemble(String, GlobalContext) - Static method in class dev.jcputney.mjml.render.HtmlSkeleton
-
Assembles the full HTML document from the rendered body content.
- attribute() - Method in record class dev.jcputney.mjml.css.CssSelector.AttributeSelector
-
Returns the value of the
attributerecord component. - AttributeContext - Class in dev.jcputney.mjml.context
-
Attribute cascade state gathered during head processing.
- AttributeContext() - Constructor for class dev.jcputney.mjml.context.AttributeContext
-
Creates a new empty
AttributeContextwith no default, class, or HTML attributes. - AttributeResolver - Class in dev.jcputney.mjml.context
-
Resolves attributes for a component using the 5-level cascade: Inline attributes (on the element itself) mj-class attributes Tag-specific default attributes (mj-attributes > mj-section, etc.)
- attributes() - Method in class dev.jcputney.mjml.context.GlobalContext
-
Returns the attribute cascade sub-context (defaults, classes, HTML attributes).
- AttributeSelector(String, String, String) - Constructor for record class dev.jcputney.mjml.css.CssSelector.AttributeSelector
-
Creates an instance of a
AttributeSelectorrecord class. - attrIf(String, String) - Static method in class dev.jcputney.mjml.util.HtmlBuilder
-
Conditionally adds a single attribute if the value is non-null and non-empty.
- attrs(String...) - Static method in class dev.jcputney.mjml.util.HtmlBuilder
-
Builds an attribute string from key/value pairs.
- attrs(Map, String...) - Static method in class dev.jcputney.mjml.util.HtmlBuilder
-
Builds a sorted attribute string from a map.
- AUTO - Enum constant in enum class dev.jcputney.mjml.Direction
-
Automatic text direction determined by the browser.
B
- b() - Method in record class dev.jcputney.mjml.css.CssSpecificity
-
Returns the value of the
brecord component. - backgroundColor() - Method in record class dev.jcputney.mjml.util.SocialNetworkRegistry.NetworkInfo
-
Returns the value of the
backgroundColorrecord component. - BackgroundCssHelper - Class in dev.jcputney.mjml.util
-
Builds CSS background-related style maps for sections and wrappers.
- BackgroundPositionHelper - Class in dev.jcputney.mjml.util
-
Normalizes CSS background-position values to "x y" format.
- BaseComponent - Class in dev.jcputney.mjml.component
-
Abstract base class for all MJML components.
- BaseComponent(MjmlNode, GlobalContext, RenderContext) - Constructor for class dev.jcputney.mjml.component.BaseComponent
-
Creates a new component bound to the given node and contexts.
- BodyComponent - Class in dev.jcputney.mjml.component
-
Abstract base for body components that render to HTML.
- BodyComponent(MjmlNode, GlobalContext, RenderContext) - Constructor for class dev.jcputney.mjml.component.BodyComponent
-
Creates a new body component.
- borderLeftWidth() - Method in record class dev.jcputney.mjml.util.CssBoxModel
-
Returns the value of the
borderLeftWidthrecord component. - borderRightWidth() - Method in record class dev.jcputney.mjml.util.CssBoxModel
-
Returns the value of the
borderRightWidthrecord component. - build() - Method in class dev.jcputney.mjml.MjmlConfiguration.Builder
-
Builds and returns a new
MjmlConfigurationwith the current builder settings. - buildAttributes(Map) - Method in class dev.jcputney.mjml.component.BodyComponent
-
Helper to build HTML attributes string from a map.
- buildBackgroundCss() - Method in class dev.jcputney.mjml.component.body.AbstractSectionComponent
-
Builds the CSS background shorthand string from this component's background attributes.
- buildBackgroundCss(String, String, String, String, String) - Static method in class dev.jcputney.mjml.util.BackgroundCssHelper
-
Builds the CSS background shorthand for a component with background image.
- buildBgImageDivStyle() - Method in class dev.jcputney.mjml.component.body.AbstractSectionComponent
-
Builds the inline style string for the outer div when a background image is present.
- buildBgImageDivStyleMap(String, String, String, String, int) - Static method in class dev.jcputney.mjml.util.BackgroundCssHelper
-
Builds style map for outer div of a section/wrapper with background image.
- buildBgImageTableStyle() - Method in class dev.jcputney.mjml.component.body.AbstractSectionComponent
-
Builds the inline style string for the inner table when a background image is present.
- buildBgImageTableStyleMap(String, String, String, String) - Static method in class dev.jcputney.mjml.util.BackgroundCssHelper
-
Builds style map for inner table of a section/wrapper with background image.
- builder() - Static method in class dev.jcputney.mjml.MjmlConfiguration
-
Creates a new
MjmlConfiguration.Builderfor constructing anMjmlConfiguration. - buildInnerTableStyle() - Method in class dev.jcputney.mjml.component.body.AbstractSectionComponent
-
Builds the inline style string for the inner table element, including background color and optional border-collapse for border-radius support.
- buildInnerTdStyle() - Method in class dev.jcputney.mjml.component.body.AbstractSectionComponent
-
Builds the style for the inner td element.
- buildOuterDivStyle() - Method in class dev.jcputney.mjml.component.body.AbstractSectionComponent
-
Builds the outer div style with background color, max-width, and optional border-radius.
- buildRegisteredNameSet(GlobalContext) - Static method in class dev.jcputney.mjml.render.DefaultFontRegistry
-
Builds a mutable set of currently registered font names from the given context.
- buildResponsiveClass(String) - Static method in class dev.jcputney.mjml.component.BodyComponent
-
Builds a responsive CSS class name from a column width specification.
- buildSectionVmlRect(String, String, String, String, String, String) - Static method in class dev.jcputney.mjml.render.VmlHelper
-
Builds VML rect markup for MjSection background image support in MSO/Outlook.
- buildStyle(Map) - Method in class dev.jcputney.mjml.component.BodyComponent
-
Builds a CSS style string from a map of property/value pairs.
- buildWrapperVmlRect(String, String, String, String, String) - Static method in class dev.jcputney.mjml.render.VmlHelper
-
Builds VML rect markup for MjWrapper background image support in MSO/Outlook.
C
- c() - Method in record class dev.jcputney.mjml.css.CssSpecificity
-
Returns the value of the
crecord component. - calculatePixelWidths(List, double, boolean) - Static method in class dev.jcputney.mjml.util.ColumnWidthCalculator
-
Calculates pixel widths for each column.
- calculateWidthSpecs(List) - Static method in class dev.jcputney.mjml.util.ColumnWidthCalculator
-
Calculates column width specifications for responsive media queries.
- CHILD - Enum constant in enum class dev.jcputney.mjml.css.CssSelector.Combinator
-
Child combinator (
>), matches direct children only. - className() - Method in record class dev.jcputney.mjml.context.StyleContext.MediaQuery
-
Returns the value of the
classNamerecord component. - className() - Method in record class dev.jcputney.mjml.css.CssSelector.ClassSelector
-
Returns the value of the
classNamerecord component. - ClasspathIncludeResolver - Class in dev.jcputney.mjml
-
Resolves mj-include paths from the classpath.
- ClasspathIncludeResolver() - Constructor for class dev.jcputney.mjml.ClasspathIncludeResolver
-
Creates a resolver that uses the thread's context class loader.
- ClasspathIncludeResolver(ClassLoader) - Constructor for class dev.jcputney.mjml.ClasspathIncludeResolver
-
Creates a resolver that uses the given class loader.
- ClassSelector(String) - Constructor for record class dev.jcputney.mjml.css.CssSelector.ClassSelector
-
Creates an instance of a
ClassSelectorrecord class. - cleanUp() - Static method in class dev.jcputney.mjml.parser.MjmlParser
-
Removes the thread-local
DocumentBuilderfor the current thread. - close(String) - Method in class dev.jcputney.mjml.util.HtmlBuilder
-
Closes a tag: decreases indent, writes
{indent}</tag>\n. - closeInline(String) - Method in class dev.jcputney.mjml.util.HtmlBuilder
-
Appends a closing tag for the specified inline element to the internal StringBuilder.
- closeInlineLn(String) - Method in class dev.jcputney.mjml.util.HtmlBuilder
-
Appends a closing tag with a newline character to the StringBuilder.
- ColumnWidthCalculator - Class in dev.jcputney.mjml.util
-
Calculates column pixel widths and responsive width specifications from a list of column nodes and a container width.
- combinator() - Method in record class dev.jcputney.mjml.css.CssSelector.ComplexSelector
-
Returns the value of the
combinatorrecord component. - compareTo(CssSpecificity) - Method in record class dev.jcputney.mjml.css.CssSpecificity
-
Compares this CSS specificity with another based on the specificity values (a, b, c).
- ComplexSelector(CssSelector, CssSelector.Combinator, CssSelector) - Constructor for record class dev.jcputney.mjml.css.CssSelector.ComplexSelector
-
Creates an instance of a
ComplexSelectorrecord class. - ComponentFactory - Interface in dev.jcputney.mjml.component
-
Functional interface for creating component instances from parsed nodes.
- ComponentRegistry - Class in dev.jcputney.mjml.component
-
Registry mapping MJML tag names to component factories.
- ComponentRegistry() - Constructor for class dev.jcputney.mjml.component.ComponentRegistry
-
Creates a new, empty component registry.
- CompoundSelector(List) - Constructor for record class dev.jcputney.mjml.css.CssSelector.CompoundSelector
-
Creates an instance of a
CompoundSelectorrecord class. - conditionalEnd() - Static method in class dev.jcputney.mjml.util.MsoHelper
-
Closes an MSO conditional comment block.
- conditionalStart() - Static method in class dev.jcputney.mjml.util.MsoHelper
-
Opens an MSO conditional comment block.
- ContainerComponentFactory - Interface in dev.jcputney.mjml.component
-
Functional interface for creating container component instances that need access to the
ComponentRegistryin order to instantiate and render child components. - contentSanitizer(ContentSanitizer) - Method in class dev.jcputney.mjml.MjmlConfiguration.Builder
-
Sets an optional content sanitizer that is applied to the inner HTML of
<mj-text>,<mj-button>, and<mj-raw>elements. - ContentSanitizer - Interface in dev.jcputney.mjml
-
Optional hook for sanitizing HTML content within
<mj-text>,<mj-button>, and<mj-raw>elements. - create() - Static method in class dev.jcputney.mjml.MjmlRenderer
-
Creates a reusable renderer instance with default configuration.
- create(MjmlConfiguration) - Static method in class dev.jcputney.mjml.MjmlRenderer
-
Creates a reusable renderer instance with the given configuration.
- create(MjmlNode, GlobalContext, RenderContext) - Method in interface dev.jcputney.mjml.component.ComponentFactory
-
Creates a component instance from the given parsed node.
- create(MjmlNode, GlobalContext, RenderContext, ComponentRegistry) - Method in interface dev.jcputney.mjml.component.ContainerComponentFactory
-
Creates a container component instance from the given parsed node.
- createComponent(MjmlNode, GlobalContext, RenderContext) - Method in class dev.jcputney.mjml.component.ComponentRegistry
-
Creates a component instance for the given node.
- css() - Method in record class dev.jcputney.mjml.css.HtmlDocumentParser.StyleExtractionResult
-
Returns the value of the
cssrecord component. - cssAxisToVml(String) - Static method in class dev.jcputney.mjml.render.VmlHelper
-
Maps a CSS axis keyword to a VML coordinate value.
- CssBoxModel - Record Class in dev.jcputney.mjml.util
-
Calculates padding and border box dimensions from CSS shorthand values.
- CssBoxModel(double, double, double, double, double, double) - Constructor for record class dev.jcputney.mjml.util.CssBoxModel
-
Creates an instance of a
CssBoxModelrecord class. - CssDeclaration - Record Class in dev.jcputney.mjml.css
-
A single CSS property declaration, e.g.
- CssDeclaration(String, String, boolean) - Constructor for record class dev.jcputney.mjml.css.CssDeclaration
-
Creates an instance of a
CssDeclarationrecord class. - CssEscaper - Class in dev.jcputney.mjml.util
-
Utility to escape values for safe interpolation into CSS contexts.
- CssInliner - Class in dev.jcputney.mjml.css
-
Inlines CSS styles into HTML elements' style attributes.
- CssParser - Class in dev.jcputney.mjml.css
-
Parses CSS text into a list of
CssRuleobjects. - CssParser.ParseResult - Record Class in dev.jcputney.mjml.css
-
Result of parsing CSS: regular rules to inline and preserved at-rules.
- cssPositionToPercent(String, boolean) - Static method in class dev.jcputney.mjml.render.VmlHelper
-
Converts a CSS position keyword or percentage to a percentage value.
- CssRule - Record Class in dev.jcputney.mjml.css
-
A CSS rule consisting of a selector string and a list of declarations.
- CssRule(String, List) - Constructor for record class dev.jcputney.mjml.css.CssRule
-
Creates an instance of a
CssRulerecord class. - CssSelector - Interface in dev.jcputney.mjml.css
-
Sealed hierarchy of CSS selectors.
- CssSelector.AttributeSelector - Record Class in dev.jcputney.mjml.css
-
Attribute selector with operator.
- CssSelector.ClassSelector - Record Class in dev.jcputney.mjml.css
-
A class selector (e.g. ".red").
- CssSelector.Combinator - Enum Class in dev.jcputney.mjml.css
-
CSS combinator types used between selectors in a complex selector.
- CssSelector.ComplexSelector - Record Class in dev.jcputney.mjml.css
-
A complex selector joining two selectors with a combinator (e.g.
- CssSelector.CompoundSelector - Record Class in dev.jcputney.mjml.css
-
A compound selector consisting of a chain of simple selectors with no combinator (e.g.
- CssSelector.IdSelector - Record Class in dev.jcputney.mjml.css
-
An ID selector (e.g.
- CssSelector.PseudoClassSelector - Record Class in dev.jcputney.mjml.css
-
A pseudo-class selector (e.g.
- CssSelector.PseudoElementSelector - Record Class in dev.jcputney.mjml.css
-
A pseudo-element selector (e.g.
- CssSelector.SelectorList - Record Class in dev.jcputney.mjml.css
-
A comma-separated list of selectors (e.g.
- CssSelector.SimpleSelector - Interface in dev.jcputney.mjml.css
-
A single simple selector part (type, class, ID, attribute, pseudo-class, or pseudo-element).
- CssSelector.TypeSelector - Record Class in dev.jcputney.mjml.css
-
A type (element name) selector (e.g.
- CssSelector.UniversalSelector - Record Class in dev.jcputney.mjml.css
-
The universal selector (
*), which matches any element. - CssSelectorMatcher - Class in dev.jcputney.mjml.css
-
Matches CSS selectors against
HtmlElementnodes. - CssSelectorParser - Class in dev.jcputney.mjml.css
-
Recursive-descent parser for CSS selectors.
- CssSpecificity - Record Class in dev.jcputney.mjml.css
-
CSS specificity as an (a, b, c) tuple where: a = number of ID selectors b = number of class, attribute, and pseudo-class selectors c = number of type and pseudo-element selectors Inline styles have a virtual specificity of (1, 0, 0, 0) which always wins, handled separately by the inliner.
- CssSpecificity(int, int, int) - Constructor for record class dev.jcputney.mjml.css.CssSpecificity
-
Creates an instance of a
CssSpecificityrecord class. - CssUnitParser - Class in dev.jcputney.mjml.util
-
Parses CSS unit values (px, %, em) and converts them to pixel values.
D
- declarations() - Method in record class dev.jcputney.mjml.css.CssRule
-
Returns the value of the
declarationsrecord component. - DEFAULT_CONTAINER_WIDTH - Static variable in class dev.jcputney.mjml.MjmlConfiguration
-
Default container width in pixels, matching the MJML v4 default of 600px.
- DEFAULT_MAX_INCLUDE_DEPTH - Static variable in class dev.jcputney.mjml.MjmlConfiguration
-
Default maximum include depth.
- DEFAULT_MAX_INPUT_SIZE - Static variable in class dev.jcputney.mjml.MjmlConfiguration
-
Default maximum input size in characters (approximately 1 MB for ASCII).
- DEFAULT_MAX_NESTING_DEPTH - Static variable in class dev.jcputney.mjml.MjmlConfiguration
-
Default maximum nesting depth.
- DefaultFontRegistry - Class in dev.jcputney.mjml.render
-
Registry of well-known web fonts that MJML auto-imports when used in font-family.
- defaults() - Static method in class dev.jcputney.mjml.MjmlConfiguration
-
Returns a default configuration with all settings at their default values.
- depth() - Method in record class dev.jcputney.mjml.ResolverContext
-
Returns the value of the
depthrecord component. - DESCENDANT - Enum constant in enum class dev.jcputney.mjml.css.CssSelector.Combinator
-
Descendant combinator (space), matches any descendant.
- dev.jcputney.mjml - package dev.jcputney.mjml
- dev.jcputney.mjml.component - package dev.jcputney.mjml.component
- dev.jcputney.mjml.component.body - package dev.jcputney.mjml.component.body
- dev.jcputney.mjml.component.content - package dev.jcputney.mjml.component.content
- dev.jcputney.mjml.component.head - package dev.jcputney.mjml.component.head
- dev.jcputney.mjml.component.interactive - package dev.jcputney.mjml.component.interactive
- dev.jcputney.mjml.context - package dev.jcputney.mjml.context
- dev.jcputney.mjml.css - package dev.jcputney.mjml.css
- dev.jcputney.mjml.parser - package dev.jcputney.mjml.parser
- dev.jcputney.mjml.render - package dev.jcputney.mjml.render
- dev.jcputney.mjml.util - package dev.jcputney.mjml.util
- direction(Direction) - Method in class dev.jcputney.mjml.MjmlConfiguration.Builder
-
Sets the text direction using a
Directionenum value. - direction(String) - Method in class dev.jcputney.mjml.MjmlConfiguration.Builder
-
Sets the text direction from a string ("ltr", "rtl", or "auto", case-insensitive).
- Direction - Enum Class in dev.jcputney.mjml
-
Text direction for the HTML document.
E
- EntityTable - Class in dev.jcputney.mjml.parser
-
Maps HTML5 named entities to their numeric character references.
- equals(Object) - Method in record class dev.jcputney.mjml.context.StyleContext.FontDef
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class dev.jcputney.mjml.context.StyleContext.MediaQuery
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class dev.jcputney.mjml.css.CssDeclaration
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class dev.jcputney.mjml.css.CssParser.ParseResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class dev.jcputney.mjml.css.CssRule
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class dev.jcputney.mjml.css.CssSelector.AttributeSelector
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class dev.jcputney.mjml.css.CssSelector.ClassSelector
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class dev.jcputney.mjml.css.CssSelector.ComplexSelector
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class dev.jcputney.mjml.css.CssSelector.CompoundSelector
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class dev.jcputney.mjml.css.CssSelector.IdSelector
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class dev.jcputney.mjml.css.CssSelector.PseudoClassSelector
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class dev.jcputney.mjml.css.CssSelector.PseudoElementSelector
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class dev.jcputney.mjml.css.CssSelector.SelectorList
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class dev.jcputney.mjml.css.CssSelector.TypeSelector
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class dev.jcputney.mjml.css.CssSelector.UniversalSelector
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class dev.jcputney.mjml.css.CssSpecificity
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class dev.jcputney.mjml.css.HtmlDocumentParser.StyleExtractionResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in class dev.jcputney.mjml.MjmlConfiguration
- equals(Object) - Method in record class dev.jcputney.mjml.MjmlRenderResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class dev.jcputney.mjml.parser.MjmlDocument
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class dev.jcputney.mjml.ResolverContext
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class dev.jcputney.mjml.util.CssBoxModel
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class dev.jcputney.mjml.util.SocialNetworkRegistry.NetworkInfo
-
Indicates whether some other object is "equal to" this one.
- escapeAttr(String) - Method in class dev.jcputney.mjml.component.BodyComponent
-
Escapes an attribute value for safe HTML interpolation when sanitizeOutput is enabled.
- escapeAttributeValue(String) - Static method in class dev.jcputney.mjml.util.HtmlEscaper
-
Escapes HTML special characters in an attribute value:
&,",',<,>. - escapeCssUrl(String) - Static method in class dev.jcputney.mjml.util.CssEscaper
-
Escapes a URL for safe use inside a CSS
url("...")context. - escapeHref(String) - Static method in class dev.jcputney.mjml.component.BodyComponent
-
Escapes an href attribute value for safe HTML interpolation.
- Example - Section in interface dev.jcputney.mjml.ContentSanitizer
- extractStyles(String) - Static method in class dev.jcputney.mjml.css.HtmlDocumentParser
-
Extracts all CSS from <style> blocks in the HTML and returns the HTML with those blocks removed.
F
- FileSystemIncludeResolver - Class in dev.jcputney.mjml
-
Resolves mj-include paths from the file system relative to a base directory.
- FileSystemIncludeResolver(Path) - Constructor for class dev.jcputney.mjml.FileSystemIncludeResolver
-
Creates a resolver that resolves paths relative to the given base directory.
- FontDef(String, String) - Constructor for record class dev.jcputney.mjml.context.StyleContext.FontDef
-
Creates an instance of a
FontDefrecord class. - formatInt(double) - Static method in class dev.jcputney.mjml.util.CssUnitParser
-
Formats a pixel value as an integer string without any suffix.
- formatPx(double) - Static method in class dev.jcputney.mjml.util.CssUnitParser
-
Formats a pixel value as an integer string with "px" suffix.
- formatPxWidth(double) - Static method in class dev.jcputney.mjml.util.CssUnitParser
-
Formats a pixel width: integers without decimals, decimals as-is.
- formatVmlCoord(double) - Static method in class dev.jcputney.mjml.render.VmlHelper
-
Formats a VML coordinate value.
- freeze() - Method in class dev.jcputney.mjml.component.ComponentRegistry
-
Freezes this registry, preventing further registrations.
- fromAttributes(String, String, String, String) - Static method in record class dev.jcputney.mjml.util.CssBoxModel
-
Creates a CssBoxModel from padding and border attribute strings.
G
- GENERAL_SIBLING - Enum constant in enum class dev.jcputney.mjml.css.CssSelector.Combinator
-
General sibling combinator (
~), matches any following sibling. - getAllDefaults() - Method in class dev.jcputney.mjml.context.AttributeContext
-
Returns the global default attributes defined under the "mj-all" tag.
- getAttribute(String) - Method in class dev.jcputney.mjml.component.BaseComponent
-
Resolves an attribute value using the 5-level cascade.
- getAttribute(String) - Method in class dev.jcputney.mjml.css.HtmlElement
-
Returns the value of the attribute with the given name, or
nullif not present. - getAttribute(String) - Method in class dev.jcputney.mjml.parser.MjmlNode
-
Returns the value of the attribute with the given name, or
nullif not present. - getAttribute(String, String) - Method in class dev.jcputney.mjml.component.BaseComponent
-
Resolves an attribute value, returning the provided default if not found.
- getAttribute(String, String) - Method in class dev.jcputney.mjml.parser.MjmlNode
-
Returns the value of the attribute with the given name, or the default value if not present.
- getAttributes() - Method in class dev.jcputney.mjml.css.HtmlElement
-
Returns an unmodifiable view of all attributes on this element.
- getAttributes() - Method in class dev.jcputney.mjml.parser.MjmlNode
-
Returns an unmodifiable view of all attributes on this node.
- getBody() - Method in record class dev.jcputney.mjml.parser.MjmlDocument
-
Returns the mj-body node, or
nullif not present. - getBodyBackgroundColor() - Method in class dev.jcputney.mjml.context.MetadataContext
-
Returns the body background color CSS value.
- getBoxModel() - Method in class dev.jcputney.mjml.component.body.AbstractSectionComponent
- getBoxModel() - Method in class dev.jcputney.mjml.component.BodyComponent
-
Returns the box model for this component based on its padding and border attributes.
- getBreakpoint() - Method in class dev.jcputney.mjml.context.MetadataContext
-
Returns the responsive breakpoint as a CSS value string (e.g.
- getBreakpointPx() - Method in class dev.jcputney.mjml.context.MetadataContext
-
Returns the responsive breakpoint parsed as an integer pixel value.
- getChildren() - Method in class dev.jcputney.mjml.css.HtmlElement
-
Returns the list of child elements.
- getChildren() - Method in class dev.jcputney.mjml.parser.MjmlNode
-
Returns an unmodifiable view of this node's children.
- getChildrenByTag(String) - Method in class dev.jcputney.mjml.parser.MjmlNode
-
Returns direct children with the specified tag name.
- getChildrenByTags(Set) - Method in class dev.jcputney.mjml.component.BodyComponent
-
Returns child nodes whose tag names are in the given set.
- getClassAttributes(String) - Method in class dev.jcputney.mjml.context.AttributeContext
-
Returns the class-level attributes for a given MJML class name.
- getClassNames() - Method in class dev.jcputney.mjml.css.HtmlElement
-
Returns the set of CSS class names on this element, parsed from the
classattribute. - getColumnWidthSpec() - Method in class dev.jcputney.mjml.context.RenderContext
-
Returns the column width specification as computed by the parent section.
- getComponentStyles() - Method in class dev.jcputney.mjml.context.StyleContext
-
Returns an unmodifiable list of all registered component-specific CSS style blocks.
- getConfiguration() - Method in class dev.jcputney.mjml.context.GlobalContext
-
Returns the MJML configuration for this render.
- getContainerWidth() - Method in class dev.jcputney.mjml.context.MetadataContext
-
Returns the container width in pixels.
- getContainerWidth() - Method in class dev.jcputney.mjml.context.RenderContext
-
Returns the current container width in pixels.
- getContentSanitizer() - Method in class dev.jcputney.mjml.MjmlConfiguration
-
Returns the optional content sanitizer, or
nullif none is configured. - getContentWidth() - Method in class dev.jcputney.mjml.component.body.MjSection
- getContentWidth() - Method in class dev.jcputney.mjml.component.BodyComponent
-
Returns the content width after subtracting padding and borders.
- getCssClass() - Method in class dev.jcputney.mjml.component.body.AbstractSectionComponent
-
Returns the value of the css-class attribute for this component.
- getCustomComponents() - Method in class dev.jcputney.mjml.MjmlConfiguration
-
Returns the custom component factories registered via
MjmlConfiguration.Builder.registerComponent(String, ComponentFactory). - getCustomContainerComponents() - Method in class dev.jcputney.mjml.MjmlConfiguration
-
Returns the custom container component factories registered via
MjmlConfiguration.Builder.registerContainerComponent(String, ContainerComponentFactory). - getDefaultAttributes() - Method in class dev.jcputney.mjml.component.BaseComponent
-
Returns the default attribute values for this component.
- getDefaultAttributes() - Method in class dev.jcputney.mjml.component.body.MjBody
- getDefaultAttributes() - Method in class dev.jcputney.mjml.component.body.MjColumn
- getDefaultAttributes() - Method in class dev.jcputney.mjml.component.body.MjGroup
- getDefaultAttributes() - Method in class dev.jcputney.mjml.component.body.MjSection
- getDefaultAttributes() - Method in class dev.jcputney.mjml.component.body.MjWrapper
- getDefaultAttributes() - Method in class dev.jcputney.mjml.component.content.MjButton
- getDefaultAttributes() - Method in class dev.jcputney.mjml.component.content.MjDivider
- getDefaultAttributes() - Method in class dev.jcputney.mjml.component.content.MjImage
- getDefaultAttributes() - Method in class dev.jcputney.mjml.component.content.MjRaw
- getDefaultAttributes() - Method in class dev.jcputney.mjml.component.content.MjSpacer
- getDefaultAttributes() - Method in class dev.jcputney.mjml.component.content.MjTable
- getDefaultAttributes() - Method in class dev.jcputney.mjml.component.content.MjText
- getDefaultAttributes() - Method in class dev.jcputney.mjml.component.HeadComponent
- getDefaultAttributes() - Method in class dev.jcputney.mjml.component.interactive.MjAccordion
- getDefaultAttributes() - Method in class dev.jcputney.mjml.component.interactive.MjAccordionElement
- getDefaultAttributes() - Method in class dev.jcputney.mjml.component.interactive.MjAccordionText
- getDefaultAttributes() - Method in class dev.jcputney.mjml.component.interactive.MjAccordionTitle
- getDefaultAttributes() - Method in class dev.jcputney.mjml.component.interactive.MjCarousel
- getDefaultAttributes() - Method in class dev.jcputney.mjml.component.interactive.MjCarouselImage
- getDefaultAttributes() - Method in class dev.jcputney.mjml.component.interactive.MjHero
- getDefaultAttributes() - Method in class dev.jcputney.mjml.component.interactive.MjNavbar
- getDefaultAttributes() - Method in class dev.jcputney.mjml.component.interactive.MjNavbarLink
- getDefaultAttributes() - Method in class dev.jcputney.mjml.component.interactive.MjSocial
- getDefaultAttributes() - Method in class dev.jcputney.mjml.component.interactive.MjSocialElement
- getDefaultAttributes(String) - Method in class dev.jcputney.mjml.context.AttributeContext
-
Returns the default attributes for a given MJML tag name.
- getDirection() - Method in class dev.jcputney.mjml.MjmlConfiguration
-
Returns the text direction for the HTML document.
- getFileStartContent() - Method in class dev.jcputney.mjml.context.MetadataContext
-
Returns an unmodifiable list of content strings that should appear at the start of the rendered file.
- getFirstChildByTag(String) - Method in class dev.jcputney.mjml.parser.MjmlNode
-
Returns the first direct child with the specified tag name, or
nullif none match. - getFonts() - Method in class dev.jcputney.mjml.context.StyleContext
-
Returns an unmodifiable set of all registered font definitions.
- getFontUrlOverride(String) - Method in class dev.jcputney.mjml.context.StyleContext
-
Returns the overridden URL for the given font name, or
nullif no override exists. - getFontUrlOverrides() - Method in class dev.jcputney.mjml.context.StyleContext
-
Returns an unmodifiable map of all font URL overrides, keyed by font name.
- getHead() - Method in record class dev.jcputney.mjml.parser.MjmlDocument
-
Returns the mj-head node, or
nullif not present. - getHeadComments() - Method in class dev.jcputney.mjml.context.MetadataContext
-
Returns an unmodifiable list of comments found in the
<mj-head>section. - getHtmlAttributes() - Method in class dev.jcputney.mjml.context.AttributeContext
-
Returns an unmodifiable view of all HTML attributes keyed by CSS selector.
- getIconUrl(String) - Static method in class dev.jcputney.mjml.util.SocialNetworkRegistry
-
Returns the default icon URL for the given network name.
- getId() - Method in class dev.jcputney.mjml.css.HtmlElement
-
Returns the value of the
idattribute, ornullif not set. - getIncludeResolver() - Method in class dev.jcputney.mjml.MjmlConfiguration
-
Returns the include resolver used to resolve
mj-includepaths, ornullif none is configured. - getIndex() - Method in class dev.jcputney.mjml.context.RenderContext
-
Returns the zero-based index of this component among its siblings.
- getInlineStyles() - Method in class dev.jcputney.mjml.context.StyleContext
-
Returns an unmodifiable list of all registered inline CSS style blocks.
- getInnerHtml() - Method in class dev.jcputney.mjml.parser.MjmlNode
-
Returns the inner HTML content - the serialized content of all children.
- getLanguage() - Method in class dev.jcputney.mjml.MjmlConfiguration
-
Returns the language code for the HTML document.
- getMaxIncludeDepth() - Method in class dev.jcputney.mjml.MjmlConfiguration
-
Maximum allowed include nesting depth for
mj-include. - getMaxInputSize() - Method in class dev.jcputney.mjml.MjmlConfiguration
-
Maximum allowed input size in characters.
- getMaxNestingDepth() - Method in class dev.jcputney.mjml.MjmlConfiguration
-
Maximum allowed nesting depth for MJML elements.
- getMediaQueries() - Method in class dev.jcputney.mjml.context.StyleContext
-
Returns an unmodifiable set of all registered media queries.
- getMjClassNames() - Method in class dev.jcputney.mjml.parser.MjmlNode
-
Returns the cached array of mj-class names on this node.
- getNetwork(String) - Static method in class dev.jcputney.mjml.util.SocialNetworkRegistry
-
Returns the
SocialNetworkRegistry.NetworkInfofor the given network name, ornullif the name is not recognized. - getNode() - Method in class dev.jcputney.mjml.component.BaseComponent
-
Returns the parsed MJML node backing this component.
- getOuterHtml() - Method in class dev.jcputney.mjml.parser.MjmlNode
-
Returns the outer HTML of this node including its tag, attributes, and content.
- getParent() - Method in class dev.jcputney.mjml.css.HtmlElement
-
Returns the parent element, or
nullif this is the root element. - getParent() - Method in class dev.jcputney.mjml.parser.MjmlNode
-
Returns the parent node, or
nullif this is a root node. - getPreviewText() - Method in class dev.jcputney.mjml.context.MetadataContext
-
Returns the email preview text (shown in inbox previews).
- getStyle() - Method in class dev.jcputney.mjml.css.HtmlElement
-
Returns the value of the
styleattribute, ornullif not set. - getStyleAttrEnd() - Method in class dev.jcputney.mjml.css.HtmlElement
-
Returns the position immediately after the closing quote of the
styleattribute in the original HTML string, or-1if not set. - getStyleAttrStart() - Method in class dev.jcputney.mjml.css.HtmlElement
-
Returns the position of the
style="substring in the original HTML string, or-1if not set. - getStyles() - Method in class dev.jcputney.mjml.context.StyleContext
-
Returns an unmodifiable list of all registered CSS style blocks.
- getTagEnd() - Method in class dev.jcputney.mjml.css.HtmlElement
-
Returns the position immediately after the closing
>character in the original HTML string, or-1if not set. - getTagName() - Method in class dev.jcputney.mjml.component.BaseComponent
-
Returns the MJML tag name this component handles.
- getTagName() - Method in class dev.jcputney.mjml.component.body.MjBody
- getTagName() - Method in class dev.jcputney.mjml.component.body.MjColumn
- getTagName() - Method in class dev.jcputney.mjml.component.body.MjGroup
- getTagName() - Method in class dev.jcputney.mjml.component.body.MjSection
- getTagName() - Method in class dev.jcputney.mjml.component.body.MjWrapper
- getTagName() - Method in class dev.jcputney.mjml.component.content.MjButton
- getTagName() - Method in class dev.jcputney.mjml.component.content.MjDivider
- getTagName() - Method in class dev.jcputney.mjml.component.content.MjImage
- getTagName() - Method in class dev.jcputney.mjml.component.content.MjRaw
- getTagName() - Method in class dev.jcputney.mjml.component.content.MjSpacer
- getTagName() - Method in class dev.jcputney.mjml.component.content.MjTable
- getTagName() - Method in class dev.jcputney.mjml.component.content.MjText
- getTagName() - Method in class dev.jcputney.mjml.component.head.MjAttributes
- getTagName() - Method in class dev.jcputney.mjml.component.head.MjBreakpoint
- getTagName() - Method in class dev.jcputney.mjml.component.head.MjFont
- getTagName() - Method in class dev.jcputney.mjml.component.head.MjHead
- getTagName() - Method in class dev.jcputney.mjml.component.head.MjHtmlAttributes
- getTagName() - Method in class dev.jcputney.mjml.component.head.MjPreview
- getTagName() - Method in class dev.jcputney.mjml.component.head.MjStyle
- getTagName() - Method in class dev.jcputney.mjml.component.head.MjTitle
- getTagName() - Method in class dev.jcputney.mjml.component.interactive.MjAccordion
- getTagName() - Method in class dev.jcputney.mjml.component.interactive.MjAccordionElement
- getTagName() - Method in class dev.jcputney.mjml.component.interactive.MjAccordionText
- getTagName() - Method in class dev.jcputney.mjml.component.interactive.MjAccordionTitle
- getTagName() - Method in class dev.jcputney.mjml.component.interactive.MjCarousel
- getTagName() - Method in class dev.jcputney.mjml.component.interactive.MjCarouselImage
- getTagName() - Method in class dev.jcputney.mjml.component.interactive.MjHero
- getTagName() - Method in class dev.jcputney.mjml.component.interactive.MjNavbar
- getTagName() - Method in class dev.jcputney.mjml.component.interactive.MjNavbarLink
- getTagName() - Method in class dev.jcputney.mjml.component.interactive.MjSocial
- getTagName() - Method in class dev.jcputney.mjml.component.interactive.MjSocialElement
- getTagName() - Method in class dev.jcputney.mjml.css.HtmlElement
-
Returns the tag name of this element (always lowercase).
- getTagName() - Method in class dev.jcputney.mjml.parser.MjmlNode
-
Returns the tag name of this node.
- getTagStart() - Method in class dev.jcputney.mjml.css.HtmlElement
-
Returns the position of the opening
<character in the original HTML string, or-1if not set. - getTextContent() - Method in class dev.jcputney.mjml.parser.MjmlNode
-
Returns the text content of this node.
- getTitle() - Method in class dev.jcputney.mjml.context.MetadataContext
-
Returns the document title.
- globalContext - Variable in class dev.jcputney.mjml.component.BaseComponent
-
The global rendering context shared across all components.
- GlobalContext - Class in dev.jcputney.mjml.context
-
Document-wide context gathered during head processing.
- GlobalContext(MjmlConfiguration) - Constructor for class dev.jcputney.mjml.context.GlobalContext
-
Creates a new global context with the given configuration.
H
- hasBackgroundUrl() - Method in class dev.jcputney.mjml.component.body.AbstractSectionComponent
-
Checks whether this component has a non-empty background-url attribute.
- hasFactory(String) - Method in class dev.jcputney.mjml.component.ComponentRegistry
-
Returns whether a factory is registered for the given tag name.
- hashCode() - Method in record class dev.jcputney.mjml.context.StyleContext.FontDef
-
Returns a hash code value for this object.
- hashCode() - Method in record class dev.jcputney.mjml.context.StyleContext.MediaQuery
-
Returns a hash code value for this object.
- hashCode() - Method in record class dev.jcputney.mjml.css.CssDeclaration
-
Returns a hash code value for this object.
- hashCode() - Method in record class dev.jcputney.mjml.css.CssParser.ParseResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class dev.jcputney.mjml.css.CssRule
-
Returns a hash code value for this object.
- hashCode() - Method in record class dev.jcputney.mjml.css.CssSelector.AttributeSelector
-
Returns a hash code value for this object.
- hashCode() - Method in record class dev.jcputney.mjml.css.CssSelector.ClassSelector
-
Returns a hash code value for this object.
- hashCode() - Method in record class dev.jcputney.mjml.css.CssSelector.ComplexSelector
-
Returns a hash code value for this object.
- hashCode() - Method in record class dev.jcputney.mjml.css.CssSelector.CompoundSelector
-
Returns a hash code value for this object.
- hashCode() - Method in record class dev.jcputney.mjml.css.CssSelector.IdSelector
-
Returns a hash code value for this object.
- hashCode() - Method in record class dev.jcputney.mjml.css.CssSelector.PseudoClassSelector
-
Returns a hash code value for this object.
- hashCode() - Method in record class dev.jcputney.mjml.css.CssSelector.PseudoElementSelector
-
Returns a hash code value for this object.
- hashCode() - Method in record class dev.jcputney.mjml.css.CssSelector.SelectorList
-
Returns a hash code value for this object.
- hashCode() - Method in record class dev.jcputney.mjml.css.CssSelector.TypeSelector
-
Returns a hash code value for this object.
- hashCode() - Method in record class dev.jcputney.mjml.css.CssSelector.UniversalSelector
-
Returns a hash code value for this object.
- hashCode() - Method in record class dev.jcputney.mjml.css.CssSpecificity
-
Returns a hash code value for this object.
- hashCode() - Method in record class dev.jcputney.mjml.css.HtmlDocumentParser.StyleExtractionResult
-
Returns a hash code value for this object.
- hashCode() - Method in class dev.jcputney.mjml.MjmlConfiguration
- hashCode() - Method in record class dev.jcputney.mjml.MjmlRenderResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class dev.jcputney.mjml.parser.MjmlDocument
-
Returns a hash code value for this object.
- hashCode() - Method in record class dev.jcputney.mjml.ResolverContext
-
Returns a hash code value for this object.
- hashCode() - Method in record class dev.jcputney.mjml.util.CssBoxModel
-
Returns a hash code value for this object.
- hashCode() - Method in record class dev.jcputney.mjml.util.SocialNetworkRegistry.NetworkInfo
-
Returns a hash code value for this object.
- hasPositionInfo() - Method in class dev.jcputney.mjml.css.HtmlElement
-
Whether this element has position information for in-place style modification.
- hasPseudo(CssSelector) - Static method in class dev.jcputney.mjml.css.CssSelectorMatcher
-
Returns true if the selector contains pseudo-classes or pseudo-elements that cannot be inlined (e.g.
- HeadComponent - Class in dev.jcputney.mjml.component
-
Abstract base for head components (mj-attributes, mj-font, etc.).
- HeadComponent(MjmlNode, GlobalContext, RenderContext) - Constructor for class dev.jcputney.mjml.component.HeadComponent
- horizontalSpacing() - Method in record class dev.jcputney.mjml.util.CssBoxModel
-
Total horizontal spacing (left + right padding + borders).
- href() - Method in record class dev.jcputney.mjml.context.StyleContext.FontDef
-
Returns the value of the
hrefrecord component. - html() - Method in record class dev.jcputney.mjml.css.HtmlDocumentParser.StyleExtractionResult
-
Returns the value of the
htmlrecord component. - html() - Method in record class dev.jcputney.mjml.MjmlRenderResult
-
Returns the value of the
htmlrecord component. - HtmlBuilder - Class in dev.jcputney.mjml.util
-
Fluent HTML builder that manages indentation automatically.
- HtmlBuilder() - Constructor for class dev.jcputney.mjml.util.HtmlBuilder
-
Creates a builder at indent depth 0.
- HtmlBuilder(int) - Constructor for class dev.jcputney.mjml.util.HtmlBuilder
-
Creates a builder with the given starting indent depth in spaces.
- HtmlDocumentParser - Class in dev.jcputney.mjml.css
-
Lightweight HTML tokenizer that builds an
HtmlElementtree from HTML text. - HtmlDocumentParser.StyleExtractionResult - Record Class in dev.jcputney.mjml.css
-
Result of extracting CSS from HTML, containing the cleaned HTML and collected CSS text.
- HtmlElement - Class in dev.jcputney.mjml.css
-
Lightweight HTML element representation for CSS selector matching and style inlining.
- HtmlElement(String, Map) - Constructor for class dev.jcputney.mjml.css.HtmlElement
- HtmlEscaper - Class in dev.jcputney.mjml.util
-
Utility to escape HTML special characters in attribute values.
- HtmlSkeleton - Class in dev.jcputney.mjml.render
-
Generates the complete HTML document skeleton wrapping the rendered body.
I
- id() - Method in record class dev.jcputney.mjml.css.CssSelector.IdSelector
-
Returns the value of the
idrecord component. - IdSelector(String) - Constructor for record class dev.jcputney.mjml.css.CssSelector.IdSelector
-
Creates an instance of a
IdSelectorrecord class. - important() - Method in record class dev.jcputney.mjml.css.CssDeclaration
-
Returns the value of the
importantrecord component. - IncludeProcessor - Class in dev.jcputney.mjml.parser
-
Processes mj-include elements in the parsed MJML tree.
- IncludeProcessor(IncludeResolver) - Constructor for class dev.jcputney.mjml.parser.IncludeProcessor
-
Creates a processor with default limits for include depth and nesting depth.
- IncludeProcessor(IncludeResolver, int) - Constructor for class dev.jcputney.mjml.parser.IncludeProcessor
-
Creates a processor with a size limit for included content.
- IncludeProcessor(IncludeResolver, int, int) - Constructor for class dev.jcputney.mjml.parser.IncludeProcessor
-
Creates a processor with limits for included content and include depth.
- IncludeProcessor(IncludeResolver, int, int, int) - Constructor for class dev.jcputney.mjml.parser.IncludeProcessor
-
Creates a processor with all limits specified.
- includeResolver(IncludeResolver) - Method in class dev.jcputney.mjml.MjmlConfiguration.Builder
-
Sets the include resolver used to resolve
mj-includepaths. - IncludeResolver - Interface in dev.jcputney.mjml
-
Interface for resolving mj-include paths to content.
- includeType() - Method in record class dev.jcputney.mjml.ResolverContext
-
Returns the value of the
includeTyperecord component. - includingPath() - Method in record class dev.jcputney.mjml.ResolverContext
-
Returns the value of the
includingPathrecord component. - indent() - Method in class dev.jcputney.mjml.util.HtmlBuilder
-
Increases the current indentation depth by a predefined size.
- indexInParent() - Method in class dev.jcputney.mjml.css.HtmlElement
-
Returns the index of this element among its parent's children.
- inline(String) - Static method in class dev.jcputney.mjml.css.CssInliner
-
Inlines CSS from
<style>blocks in the HTML into element style attributes. - inline(String, String) - Static method in class dev.jcputney.mjml.css.CssInliner
-
Inlines CSS from
<style>blocks and additional CSS into element style attributes. - inlineAdditionalOnly(String, HtmlElement, String) - Static method in class dev.jcputney.mjml.css.CssInliner
-
Inlines only the provided CSS into HTML elements' style attributes using a pre-parsed element tree, avoiding redundant HTML re-parsing when the tree is already available.
- inlineAdditionalOnly(String, String) - Static method in class dev.jcputney.mjml.css.CssInliner
-
Inlines only the provided CSS into HTML elements' style attributes, without extracting or removing any existing
<style>blocks from the HTML. - isDescendantOf(HtmlElement) - Method in class dev.jcputney.mjml.css.HtmlElement
-
Checks if this element is a descendant of the given ancestor.
- isFirst() - Method in class dev.jcputney.mjml.context.RenderContext
-
Returns whether this component is the first among its siblings.
- isFluidOnMobileUsed() - Method in class dev.jcputney.mjml.context.StyleContext
-
Returns whether any component has indicated that fluid-on-mobile behavior is used.
- isInsideGroup() - Method in class dev.jcputney.mjml.context.RenderContext
-
Returns whether this component is nested inside an
mj-group. - isInsideWrapper() - Method in class dev.jcputney.mjml.context.RenderContext
-
Returns whether this component is nested inside an
mj-wrapper. - isLast() - Method in class dev.jcputney.mjml.context.RenderContext
-
Returns whether this component is the last among its siblings.
- isSanitizeOutput() - Method in class dev.jcputney.mjml.MjmlConfiguration
-
Whether to escape HTML special characters in attribute values in rendered output.
- isXValue(String) - Static method in class dev.jcputney.mjml.util.BackgroundPositionHelper
-
Checks whether the given value is a horizontal (x-axis) position keyword.
- isYValue(String) - Static method in class dev.jcputney.mjml.util.BackgroundPositionHelper
-
Checks whether the given value is a vertical (y-axis) position keyword.
L
- language(String) - Method in class dev.jcputney.mjml.MjmlConfiguration.Builder
-
Sets the language code for the HTML document (e.g.,
"en"). - left() - Method in record class dev.jcputney.mjml.css.CssSelector.ComplexSelector
-
Returns the value of the
leftrecord component. - line(String) - Method in class dev.jcputney.mjml.util.HtmlBuilder
-
Appends indented text followed by a newline.
- LTR - Enum constant in enum class dev.jcputney.mjml.Direction
-
Left-to-right text direction.
M
- matches(CssSelector, HtmlElement) - Static method in class dev.jcputney.mjml.css.CssSelectorMatcher
-
Tests whether the given selector matches the given element.
- maxIncludeDepth(int) - Method in class dev.jcputney.mjml.MjmlConfiguration.Builder
-
Sets the maximum allowed include nesting depth for
mj-include. - maxInputSize(int) - Method in class dev.jcputney.mjml.MjmlConfiguration.Builder
-
Sets the maximum allowed input size in characters (not bytes).
- maxNestingDepth(int) - Method in class dev.jcputney.mjml.MjmlConfiguration.Builder
-
Sets the maximum allowed nesting depth for MJML elements.
- MediaQuery(String, String, String) - Constructor for record class dev.jcputney.mjml.context.StyleContext.MediaQuery
-
Creates an instance of a
MediaQueryrecord class. - merge(List, List, CssSpecificity) - Static method in class dev.jcputney.mjml.css.StyleAttribute
-
Merges new declarations into existing inline style declarations.
- metadata() - Method in class dev.jcputney.mjml.context.GlobalContext
-
Returns the document metadata sub-context (title, preview, breakpoint, etc.).
- MetadataContext - Class in dev.jcputney.mjml.context
-
Document-level metadata gathered during head processing.
- MetadataContext() - Constructor for class dev.jcputney.mjml.context.MetadataContext
-
Creates a new
MetadataContextwith default values: empty title and preview text, a breakpoint of"480px", the default container width, and no head comments or file-start content. - MjAccordion - Class in dev.jcputney.mjml.component.interactive
-
The accordion component (
<mj-accordion>). - MjAccordion(MjmlNode, GlobalContext, RenderContext, ComponentRegistry) - Constructor for class dev.jcputney.mjml.component.interactive.MjAccordion
- MjAccordionElement - Class in dev.jcputney.mjml.component.interactive
-
A single accordion item (
<mj-accordion-element>). - MjAccordionElement(MjmlNode, GlobalContext, RenderContext, ComponentRegistry) - Constructor for class dev.jcputney.mjml.component.interactive.MjAccordionElement
- MjAccordionText - Class in dev.jcputney.mjml.component.interactive
-
The accordion text component (
<mj-accordion-text>). - MjAccordionText(MjmlNode, GlobalContext, RenderContext) - Constructor for class dev.jcputney.mjml.component.interactive.MjAccordionText
- MjAccordionTitle - Class in dev.jcputney.mjml.component.interactive
-
The accordion title component (
<mj-accordion-title>). - MjAccordionTitle(MjmlNode, GlobalContext, RenderContext) - Constructor for class dev.jcputney.mjml.component.interactive.MjAccordionTitle
- MjAttributes - Class in dev.jcputney.mjml.component.head
-
Processes mj-attributes to set default attribute values.
- MjAttributes(MjmlNode, GlobalContext, RenderContext, ComponentRegistry) - Constructor for class dev.jcputney.mjml.component.head.MjAttributes
- MjBody - Class in dev.jcputney.mjml.component.body
-
The root body component (<mj-body>).
- MjBody(MjmlNode, GlobalContext, RenderContext, ComponentRegistry) - Constructor for class dev.jcputney.mjml.component.body.MjBody
- MjBreakpoint - Class in dev.jcputney.mjml.component.head
-
Sets the responsive breakpoint from mj-breakpoint width attribute.
- MjBreakpoint(MjmlNode, GlobalContext, RenderContext) - Constructor for class dev.jcputney.mjml.component.head.MjBreakpoint
- MjButton - Class in dev.jcputney.mjml.component.content
-
The button component (<mj-button>).
- MjButton(MjmlNode, GlobalContext, RenderContext) - Constructor for class dev.jcputney.mjml.component.content.MjButton
- MjCarousel - Class in dev.jcputney.mjml.component.interactive
-
The carousel component (
<mj-carousel>). - MjCarousel(MjmlNode, GlobalContext, RenderContext, ComponentRegistry) - Constructor for class dev.jcputney.mjml.component.interactive.MjCarousel
- MjCarouselImage - Class in dev.jcputney.mjml.component.interactive
-
A single image in a carousel (
<mj-carousel-image>). - MjCarouselImage(MjmlNode, GlobalContext, RenderContext) - Constructor for class dev.jcputney.mjml.component.interactive.MjCarouselImage
- MjColumn - Class in dev.jcputney.mjml.component.body
-
The column component (<mj-column>).
- MjColumn(MjmlNode, GlobalContext, RenderContext, ComponentRegistry) - Constructor for class dev.jcputney.mjml.component.body.MjColumn
- MjDivider - Class in dev.jcputney.mjml.component.content
-
The divider component (<mj-divider>).
- MjDivider(MjmlNode, GlobalContext, RenderContext) - Constructor for class dev.jcputney.mjml.component.content.MjDivider
- MjFont - Class in dev.jcputney.mjml.component.head
-
Registers a web font from mj-font attributes (name, href).
- MjFont(MjmlNode, GlobalContext, RenderContext) - Constructor for class dev.jcputney.mjml.component.head.MjFont
- MjGroup - Class in dev.jcputney.mjml.component.body
-
The group component (<mj-group>).
- MjGroup(MjmlNode, GlobalContext, RenderContext, ComponentRegistry) - Constructor for class dev.jcputney.mjml.component.body.MjGroup
- MjHead - Class in dev.jcputney.mjml.component.head
-
The mj-head container component.
- MjHead(MjmlNode, GlobalContext, RenderContext) - Constructor for class dev.jcputney.mjml.component.head.MjHead
- MjHero - Class in dev.jcputney.mjml.component.interactive
-
The hero component (
<mj-hero>). - MjHero(MjmlNode, GlobalContext, RenderContext, ComponentRegistry) - Constructor for class dev.jcputney.mjml.component.interactive.MjHero
- MjHtmlAttributes - Class in dev.jcputney.mjml.component.head
-
Processes mj-html-attributes to add custom HTML attributes to output elements.
- MjHtmlAttributes(MjmlNode, GlobalContext, RenderContext) - Constructor for class dev.jcputney.mjml.component.head.MjHtmlAttributes
- MjImage - Class in dev.jcputney.mjml.component.content
-
The image component (<mj-image>).
- MjImage(MjmlNode, GlobalContext, RenderContext) - Constructor for class dev.jcputney.mjml.component.content.MjImage
- MjmlConfiguration - Class in dev.jcputney.mjml
-
Configuration for the MJML renderer.
- MjmlConfiguration.Builder - Class in dev.jcputney.mjml
-
Builder for constructing
MjmlConfigurationinstances. - MjmlDocument - Record Class in dev.jcputney.mjml.parser
-
Represents an MJML document's structure, containing a root node and methods to access key elements such as the head and body nodes.
- MjmlDocument(MjmlNode) - Constructor for record class dev.jcputney.mjml.parser.MjmlDocument
-
Creates an instance of a
MjmlDocumentrecord class. - MjmlException - Exception Class in dev.jcputney.mjml
-
Runtime exception thrown when MJML parsing or rendering fails.
- MjmlException(String) - Constructor for exception class dev.jcputney.mjml.MjmlException
- MjmlException(String, Throwable) - Constructor for exception class dev.jcputney.mjml.MjmlException
- MjmlIncludeException - Exception Class in dev.jcputney.mjml
-
Exception thrown when mj-include processing fails (missing file, circular includes, etc.).
- MjmlIncludeException(String) - Constructor for exception class dev.jcputney.mjml.MjmlIncludeException
- MjmlIncludeException(String, Throwable) - Constructor for exception class dev.jcputney.mjml.MjmlIncludeException
- MjmlNode - Class in dev.jcputney.mjml.parser
-
Lightweight mutable tree node representing an MJML element.
- MjmlNode(String) - Constructor for class dev.jcputney.mjml.parser.MjmlNode
- MjmlParseException - Exception Class in dev.jcputney.mjml
-
Exception thrown when MJML parsing fails (malformed XML, missing root element, etc.).
- MjmlParseException(String) - Constructor for exception class dev.jcputney.mjml.MjmlParseException
- MjmlParseException(String, Throwable) - Constructor for exception class dev.jcputney.mjml.MjmlParseException
- MjmlParser - Class in dev.jcputney.mjml.parser
-
Parses preprocessed MJML source into an MjmlDocument.
- MjmlPreprocessor - Class in dev.jcputney.mjml.parser
-
Preprocesses MJML source before XML parsing.
- MjmlRenderer - Class in dev.jcputney.mjml
-
Public API entry point for rendering MJML templates to HTML.
- MjmlRenderException - Exception Class in dev.jcputney.mjml
-
Exception thrown when a failure occurs during the MJML rendering phase (as opposed to parsing or input validation).
- MjmlRenderException(String) - Constructor for exception class dev.jcputney.mjml.MjmlRenderException
- MjmlRenderException(String, Throwable) - Constructor for exception class dev.jcputney.mjml.MjmlRenderException
- MjmlRenderResult - Record Class in dev.jcputney.mjml
-
Result of rendering an MJML template to HTML.
- MjmlRenderResult(String, String, String) - Constructor for record class dev.jcputney.mjml.MjmlRenderResult
-
Creates an instance of a
MjmlRenderResultrecord class. - MjmlValidationException - Exception Class in dev.jcputney.mjml
-
Exception thrown when MJML input validation fails (size limit, nesting depth, etc.).
- MjmlValidationException(String) - Constructor for exception class dev.jcputney.mjml.MjmlValidationException
- MjmlValidationException(String, Throwable) - Constructor for exception class dev.jcputney.mjml.MjmlValidationException
- MjNavbar - Class in dev.jcputney.mjml.component.interactive
-
The navbar component (
<mj-navbar>). - MjNavbar(MjmlNode, GlobalContext, RenderContext, ComponentRegistry) - Constructor for class dev.jcputney.mjml.component.interactive.MjNavbar
- MjNavbarLink - Class in dev.jcputney.mjml.component.interactive
-
A single link in a navbar (
<mj-navbar-link>). - MjNavbarLink(MjmlNode, GlobalContext, RenderContext) - Constructor for class dev.jcputney.mjml.component.interactive.MjNavbarLink
- MjPreview - Class in dev.jcputney.mjml.component.head
-
Sets the preview text (preheader) from mj-preview content.
- MjPreview(MjmlNode, GlobalContext, RenderContext) - Constructor for class dev.jcputney.mjml.component.head.MjPreview
- MjRaw - Class in dev.jcputney.mjml.component.content
-
The raw component (
<mj-raw>). - MjRaw(MjmlNode, GlobalContext, RenderContext) - Constructor for class dev.jcputney.mjml.component.content.MjRaw
- MjSection - Class in dev.jcputney.mjml.component.body
-
The section component (<mj-section>).
- MjSection(MjmlNode, GlobalContext, RenderContext, ComponentRegistry) - Constructor for class dev.jcputney.mjml.component.body.MjSection
- MjSocial - Class in dev.jcputney.mjml.component.interactive
-
The social component (
<mj-social>). - MjSocial(MjmlNode, GlobalContext, RenderContext, ComponentRegistry) - Constructor for class dev.jcputney.mjml.component.interactive.MjSocial
- MjSocialElement - Class in dev.jcputney.mjml.component.interactive
-
A single social element (
<mj-social-element>). - MjSocialElement(MjmlNode, GlobalContext, RenderContext) - Constructor for class dev.jcputney.mjml.component.interactive.MjSocialElement
- MjSpacer - Class in dev.jcputney.mjml.component.content
-
The spacer component (<mj-spacer>).
- MjSpacer(MjmlNode, GlobalContext, RenderContext) - Constructor for class dev.jcputney.mjml.component.content.MjSpacer
- MjStyle - Class in dev.jcputney.mjml.component.head
-
Adds CSS styles from
<mj-style>content to the rendered HTML. - MjStyle(MjmlNode, GlobalContext, RenderContext) - Constructor for class dev.jcputney.mjml.component.head.MjStyle
- MjTable - Class in dev.jcputney.mjml.component.content
-
The table component (<mj-table>).
- MjTable(MjmlNode, GlobalContext, RenderContext) - Constructor for class dev.jcputney.mjml.component.content.MjTable
- MjText - Class in dev.jcputney.mjml.component.content
-
The text component (<mj-text>).
- MjText(MjmlNode, GlobalContext, RenderContext) - Constructor for class dev.jcputney.mjml.component.content.MjText
- MjTitle - Class in dev.jcputney.mjml.component.head
-
Sets the document title from mj-title content.
- MjTitle(MjmlNode, GlobalContext, RenderContext) - Constructor for class dev.jcputney.mjml.component.head.MjTitle
- MjWrapper - Class in dev.jcputney.mjml.component.body
-
The wrapper component (<mj-wrapper>).
- MjWrapper(MjmlNode, GlobalContext, RenderContext, ComponentRegistry) - Constructor for class dev.jcputney.mjml.component.body.MjWrapper
- mso(Runnable) - Method in class dev.jcputney.mjml.util.HtmlBuilder
-
Wraps the output of a builder block in MSO conditional comments.
- mso(String) - Method in class dev.jcputney.mjml.util.HtmlBuilder
-
Wraps a string in MSO conditional comments followed by a newline.
- MSO_TD_STYLE - Static variable in class dev.jcputney.mjml.util.MsoHelper
-
Standard MSO td style for resetting line-height.
- MSO_TD_STYLE_HERO - Static variable in class dev.jcputney.mjml.util.MsoHelper
-
Variant used by mj-hero (no trailing 'px' on line-height).
- msoConditionalTableClosing() - Static method in class dev.jcputney.mjml.util.MsoHelper
-
Builds a complete MSO table closing wrapped in conditional comments.
- MsoHelper - Class in dev.jcputney.mjml.util
-
Shared helpers for generating MSO/IE conditional comments used by
<mj-section>,<mj-wrapper>, and<mj-hero>. - msoTableClosing() - Static method in class dev.jcputney.mjml.util.MsoHelper
-
Builds an MSO table closing.
- msoTableOpening(int, String, String, String) - Static method in class dev.jcputney.mjml.util.MsoHelper
-
Builds an MSO table opening with width constraint.
- msoWrapperNestedOpening(int, int) - Static method in class dev.jcputney.mjml.util.MsoHelper
-
Builds the MSO conditional opening for the first child inside an mj-wrapper.
- msoWrapperTransition(int, int) - Static method in class dev.jcputney.mjml.util.MsoHelper
-
Builds the MSO conditional transition markup between adjacent children inside an mj-wrapper.
N
- name() - Method in record class dev.jcputney.mjml.context.StyleContext.FontDef
-
Returns the value of the
namerecord component. - name() - Method in record class dev.jcputney.mjml.css.CssSelector.PseudoClassSelector
-
Returns the value of the
namerecord component. - name() - Method in record class dev.jcputney.mjml.css.CssSelector.PseudoElementSelector
-
Returns the value of the
namerecord component. - name() - Method in record class dev.jcputney.mjml.util.SocialNetworkRegistry.NetworkInfo
-
Returns the value of the
namerecord component. - nested(String) - Method in record class dev.jcputney.mjml.ResolverContext
-
Creates a nested context for includes within included files.
- NetworkInfo(String, String, String) - Constructor for record class dev.jcputney.mjml.util.SocialNetworkRegistry.NetworkInfo
-
Creates an instance of a
NetworkInforecord class. - newline() - Method in class dev.jcputney.mjml.util.HtmlBuilder
-
Appends a newline character to the internal string builder and returns the current instance of the
HtmlBuilder. - nextUniqueId(String) - Method in class dev.jcputney.mjml.context.RenderContext
-
Returns a deterministic unique ID with the given prefix.
- node - Variable in class dev.jcputney.mjml.component.BaseComponent
-
The parsed MJML node backing this component.
- normalize(String) - Static method in class dev.jcputney.mjml.util.BackgroundPositionHelper
-
Normalizes background position to "x y" format.
- notMso(Runnable) - Method in class dev.jcputney.mjml.util.HtmlBuilder
-
Wraps the output of a builder block in non-MSO conditional comments (
<!--[if !mso]><!-->...<!--<![endif]-->). - notMsoIE(Runnable) - Method in class dev.jcputney.mjml.util.HtmlBuilder
-
Wraps the output of a builder block in non-MSO/IE conditional comments (
<!--[if !mso | IE]><!-->...<!--<![endif]-->).
O
- of(String) - Static method in enum class dev.jcputney.mjml.Direction
-
Parses a direction string (case-insensitive).
- open(String) - Method in class dev.jcputney.mjml.util.HtmlBuilder
-
Opens a tag with no attributes.
- open(String, String) - Method in class dev.jcputney.mjml.util.HtmlBuilder
-
Opens a tag with attributes, writes a newline, and increases indent.
- openInline(String) - Method in class dev.jcputney.mjml.util.HtmlBuilder
-
Opens an inline tag with no attributes.
- openInline(String, String) - Method in class dev.jcputney.mjml.util.HtmlBuilder
-
Opens a tag on the current line WITHOUT a trailing newline.
- operator() - Method in record class dev.jcputney.mjml.css.CssSelector.AttributeSelector
-
Returns the value of the
operatorrecord component. - orderedMap(String...) - Method in class dev.jcputney.mjml.component.BodyComponent
-
Creates an ordered map for style building.
- outdent() - Method in class dev.jcputney.mjml.util.HtmlBuilder
-
Reduces the current indentation level by decreasing the depth.
P
- paddingBottom() - Method in record class dev.jcputney.mjml.util.CssBoxModel
-
Returns the value of the
paddingBottomrecord component. - paddingLeft() - Method in record class dev.jcputney.mjml.util.CssBoxModel
-
Returns the value of the
paddingLeftrecord component. - paddingRight() - Method in record class dev.jcputney.mjml.util.CssBoxModel
-
Returns the value of the
paddingRightrecord component. - paddingTop() - Method in record class dev.jcputney.mjml.util.CssBoxModel
-
Returns the value of the
paddingToprecord component. - parse(String) - Static method in record class dev.jcputney.mjml.css.CssDeclaration
-
Parses a single declaration string like "color: red !
- parse(String) - Static method in class dev.jcputney.mjml.css.CssParser
-
Parses CSS text into rules and preserved at-rules.
- parse(String) - Static method in class dev.jcputney.mjml.css.CssSelectorParser
-
Parses a selector string into a CssSelector tree.
- parse(String) - Static method in class dev.jcputney.mjml.css.HtmlDocumentParser
-
Parses HTML into an element tree rooted at a virtual document element.
- parse(String) - Static method in class dev.jcputney.mjml.css.StyleAttribute
-
Parses an inline style string into a list of declarations.
- parse(String) - Static method in class dev.jcputney.mjml.parser.MjmlParser
-
Parses raw MJML source into an MjmlDocument using the default maximum nesting depth.
- parse(String, int) - Static method in class dev.jcputney.mjml.parser.MjmlParser
-
Parses raw MJML source into an MjmlDocument with a configurable maximum nesting depth.
- parseIntPx(String) - Static method in class dev.jcputney.mjml.util.CssUnitParser
-
Parses an integer from a CSS pixel value like "10px", "10", or "10.5px".
- parsePixels(String, int) - Static method in class dev.jcputney.mjml.util.CssUnitParser
-
Parses an integer pixel value from a string like "600px" or "600".
- parsePx(String, double) - Static method in class dev.jcputney.mjml.util.CssUnitParser
-
Parses a pixel value from a string like "10px" or "10".
- ParseResult(List, List) - Constructor for record class dev.jcputney.mjml.css.CssParser.ParseResult
-
Creates an instance of a
ParseResultrecord class. - parseRules(String) - Static method in class dev.jcputney.mjml.css.CssParser
-
Parses CSS text and returns only the inlineable rules (convenience method).
- parseShorthand(String) - Static method in class dev.jcputney.mjml.util.CssUnitParser
-
Parses a 1-4 value CSS shorthand into [top, right, bottom, left] pixel values.
- parseWidth(String) - Method in class dev.jcputney.mjml.component.BodyComponent
-
Parses a CSS unit value to pixels, using the container width for percentages.
- parts() - Method in record class dev.jcputney.mjml.css.CssSelector.CompoundSelector
-
Returns the value of the
partsrecord component. - preprocess(String) - Static method in class dev.jcputney.mjml.parser.MjmlPreprocessor
-
Preprocesses MJML source for XML parsing.
- PRESENTATION_TABLE_ATTRS - Static variable in class dev.jcputney.mjml.util.HtmlBuilder
-
Base attributes shared by presentation-only tables in MJML email rendering:
border="0", cellpadding="0", cellspacing="0", role="presentation". - preservedAtRules() - Method in record class dev.jcputney.mjml.css.CssParser.ParseResult
-
Returns the value of the
preservedAtRulesrecord component. - previewText() - Method in record class dev.jcputney.mjml.MjmlRenderResult
-
Returns the value of the
previewTextrecord component. - previousSibling() - Method in class dev.jcputney.mjml.css.HtmlElement
-
Returns the previous sibling element, or null if this is the first child.
- process() - Method in class dev.jcputney.mjml.component.head.MjAttributes
- process() - Method in class dev.jcputney.mjml.component.head.MjBreakpoint
- process() - Method in class dev.jcputney.mjml.component.head.MjFont
- process() - Method in class dev.jcputney.mjml.component.head.MjHead
- process() - Method in class dev.jcputney.mjml.component.head.MjHtmlAttributes
- process() - Method in class dev.jcputney.mjml.component.head.MjPreview
- process() - Method in class dev.jcputney.mjml.component.head.MjStyle
- process() - Method in class dev.jcputney.mjml.component.head.MjTitle
- process() - Method in class dev.jcputney.mjml.component.HeadComponent
-
Processes this head component, updating the global context with extracted metadata (fonts, styles, attributes, etc.).
- process(MjmlDocument) - Method in class dev.jcputney.mjml.parser.IncludeProcessor
-
Processes all mj-include elements in the document tree, recursively resolving included content and replacing mj-include nodes with the resolved content.
- property() - Method in record class dev.jcputney.mjml.css.CssDeclaration
-
Returns the value of the
propertyrecord component. - PseudoClassSelector(String, String) - Constructor for record class dev.jcputney.mjml.css.CssSelector.PseudoClassSelector
-
Creates an instance of a
PseudoClassSelectorrecord class. - PseudoElementSelector(String) - Constructor for record class dev.jcputney.mjml.css.CssSelector.PseudoElementSelector
-
Creates an instance of a
PseudoElementSelectorrecord class.
R
- raw(String) - Method in class dev.jcputney.mjml.util.HtmlBuilder
-
Appends raw HTML at the current indent level, followed by a newline.
- rawVerbatim(String) - Method in class dev.jcputney.mjml.util.HtmlBuilder
-
Appends raw HTML verbatim with NO indentation or newline added.
- register(String, ComponentFactory) - Method in class dev.jcputney.mjml.component.ComponentRegistry
-
Registers a component factory for the given tag name.
- registerComponent(String, ComponentFactory) - Method in class dev.jcputney.mjml.MjmlConfiguration.Builder
-
Registers a custom component factory for the given MJML tag name.
- registerContainerComponent(String, ContainerComponentFactory) - Method in class dev.jcputney.mjml.MjmlConfiguration.Builder
-
Registers a custom container component factory for the given tag name.
- registerFontOverride(String, String) - Method in class dev.jcputney.mjml.context.StyleContext
-
Registers a font URL override, replacing the default URL for the given font name.
- registerMediaQuery(String, String) - Method in class dev.jcputney.mjml.component.BodyComponent
-
Registers a responsive media query for the given CSS class name and width specification.
- registerUsedFonts(String, GlobalContext) - Static method in class dev.jcputney.mjml.render.DefaultFontRegistry
-
Checks the given font-family string against known default fonts and registers any matches in the GlobalContext (unless already registered by an explicit mj-font).
- registerUsedFonts(String, GlobalContext, Set) - Static method in class dev.jcputney.mjml.render.DefaultFontRegistry
-
Checks the given font-family string against known default fonts and registers any matches in the GlobalContext (unless already registered by an explicit mj-font).
- registry - Variable in class dev.jcputney.mjml.component.body.AbstractSectionComponent
-
The component registry used to look up child components during rendering.
- render() - Method in class dev.jcputney.mjml.component.body.MjBody
- render() - Method in class dev.jcputney.mjml.component.body.MjColumn
- render() - Method in class dev.jcputney.mjml.component.body.MjGroup
- render() - Method in class dev.jcputney.mjml.component.body.MjSection
- render() - Method in class dev.jcputney.mjml.component.body.MjWrapper
- render() - Method in class dev.jcputney.mjml.component.BodyComponent
-
Renders this component to HTML.
- render() - Method in class dev.jcputney.mjml.component.content.MjButton
- render() - Method in class dev.jcputney.mjml.component.content.MjDivider
- render() - Method in class dev.jcputney.mjml.component.content.MjImage
- render() - Method in class dev.jcputney.mjml.component.content.MjRaw
- render() - Method in class dev.jcputney.mjml.component.content.MjSpacer
- render() - Method in class dev.jcputney.mjml.component.content.MjTable
- render() - Method in class dev.jcputney.mjml.component.content.MjText
- render() - Method in class dev.jcputney.mjml.component.interactive.MjAccordion
- render() - Method in class dev.jcputney.mjml.component.interactive.MjAccordionElement
- render() - Method in class dev.jcputney.mjml.component.interactive.MjAccordionText
- render() - Method in class dev.jcputney.mjml.component.interactive.MjAccordionTitle
- render() - Method in class dev.jcputney.mjml.component.interactive.MjCarousel
- render() - Method in class dev.jcputney.mjml.component.interactive.MjCarouselImage
- render() - Method in class dev.jcputney.mjml.component.interactive.MjHero
- render() - Method in class dev.jcputney.mjml.component.interactive.MjNavbar
- render() - Method in class dev.jcputney.mjml.component.interactive.MjNavbarLink
- render() - Method in class dev.jcputney.mjml.component.interactive.MjSocial
- render() - Method in class dev.jcputney.mjml.component.interactive.MjSocialElement
- render(String) - Static method in class dev.jcputney.mjml.MjmlRenderer
-
Renders an MJML template to HTML using default configuration.
- render(String) - Method in class dev.jcputney.mjml.render.RenderPipeline
-
Renders MJML source to a complete HTML document.
- render(String, MjmlConfiguration) - Static method in class dev.jcputney.mjml.MjmlRenderer
-
Renders an MJML template to HTML with the given configuration.
- render(Path) - Static method in class dev.jcputney.mjml.MjmlRenderer
-
Renders an MJML file to HTML using default configuration.
- render(Path, MjmlConfiguration) - Static method in class dev.jcputney.mjml.MjmlRenderer
-
Renders an MJML file to HTML with the given configuration.
- renderChildren(ComponentRegistry) - Method in class dev.jcputney.mjml.component.BodyComponent
-
Renders all child body components and concatenates their output.
- renderContext - Variable in class dev.jcputney.mjml.component.BaseComponent
-
The render-phase context for the current rendering pass.
- RenderContext - Class in dev.jcputney.mjml.context
-
Per-component render context that carries the current container width as the rendering pipeline descends the component tree.
- RenderContext(double) - Constructor for class dev.jcputney.mjml.context.RenderContext
-
Creates a new root render context with the given container width.
- renderHorizontal(MjSocial) - Method in class dev.jcputney.mjml.component.interactive.MjSocialElement
-
Renders this element in horizontal mode (each element in its own inline table).
- renderImage(String, int) - Method in class dev.jcputney.mjml.component.interactive.MjCarouselImage
-
Renders this carousel image.
- renderNormalScaffold(String, String, String) - Method in class dev.jcputney.mjml.component.body.AbstractSectionComponent
-
Renders the normal (non-full-width) scaffold shared by mj-section and mj-wrapper.
- RenderPipeline - Class in dev.jcputney.mjml.render
-
Orchestrates the 7-phase rendering pipeline: Preprocess (handled by MjmlParser) Parse (handled by MjmlParser) Resolve includes (expand mj-include) Process head (extract fonts, styles, attributes, etc.)
- RenderPipeline(MjmlConfiguration) - Constructor for class dev.jcputney.mjml.render.RenderPipeline
- renderTemplate(String) - Method in class dev.jcputney.mjml.MjmlRenderer
-
Renders an MJML template to HTML using this instance's configuration.
- renderTemplate(String, IncludeResolver) - Method in class dev.jcputney.mjml.MjmlRenderer
-
Renders an MJML template to HTML with a specific include resolver, overriding the instance's configured resolver for this call only.
- renderTemplate(Path) - Method in class dev.jcputney.mjml.MjmlRenderer
-
Renders an MJML file to HTML using this instance's configuration.
- renderVertical(MjSocial) - Method in class dev.jcputney.mjml.component.interactive.MjSocialElement
-
Renders this element in vertical mode (a single row in the parent's shared table).
- replaceEntities(String) - Static method in class dev.jcputney.mjml.parser.EntityTable
-
Replaces all known HTML named entities in the input string with their numeric character references.
- replaceWith(List) - Method in class dev.jcputney.mjml.parser.MjmlNode
-
Replaces this node in its parent's children list with the given nodes.
- resolve(MjmlNode, String, GlobalContext, Map) - Static method in class dev.jcputney.mjml.context.AttributeResolver
-
Resolves an attribute value using the 5-level cascade.
- resolve(String, ResolverContext) - Method in class dev.jcputney.mjml.ClasspathIncludeResolver
- resolve(String, ResolverContext) - Method in class dev.jcputney.mjml.FileSystemIncludeResolver
- resolve(String, ResolverContext) - Method in interface dev.jcputney.mjml.IncludeResolver
-
Resolves the given path to its content.
- resolveBackgroundPosition() - Method in class dev.jcputney.mjml.component.body.AbstractSectionComponent
-
Resolves background position from individual x/y properties or the combined property.
- ResolverContext - Record Class in dev.jcputney.mjml
-
Context information passed to
IncludeResolverwhen resolving includes. - ResolverContext(String, String, int) - Constructor for record class dev.jcputney.mjml.ResolverContext
-
Creates an instance of a
ResolverContextrecord class. - resolveShorthandSide(String, String, int) - Method in class dev.jcputney.mjml.component.BodyComponent
-
Resolves a single side of a CSS shorthand property.
- right() - Method in record class dev.jcputney.mjml.css.CssSelector.ComplexSelector
-
Returns the value of the
rightrecord component. - root() - Method in record class dev.jcputney.mjml.parser.MjmlDocument
-
Returns the root node of this document.
- root(String) - Static method in record class dev.jcputney.mjml.ResolverContext
-
Creates a root context for top-level includes.
- RTL - Enum constant in enum class dev.jcputney.mjml.Direction
-
Right-to-left text direction.
- rules() - Method in record class dev.jcputney.mjml.css.CssParser.ParseResult
-
Returns the value of the
rulesrecord component.
S
- sanitize(String) - Method in interface dev.jcputney.mjml.ContentSanitizer
-
Sanitizes the given HTML content.
- sanitizeContent(String) - Method in class dev.jcputney.mjml.component.BodyComponent
-
Applies the configured
ContentSanitizerto the given content, if one is set. - sanitizeHref(String) - Method in class dev.jcputney.mjml.component.BodyComponent
-
Sanitizes a URL using an allowlist of safe URI schemes when sanitizeOutput is enabled.
- sanitizeOutput(boolean) - Method in class dev.jcputney.mjml.MjmlConfiguration.Builder
-
Controls whether HTML special characters in attribute values are escaped in rendered output.
- SelectorList(List) - Constructor for record class dev.jcputney.mjml.css.CssSelector.SelectorList
-
Creates an instance of a
SelectorListrecord class. - selectors() - Method in record class dev.jcputney.mjml.css.CssSelector.SelectorList
-
Returns the value of the
selectorsrecord component. - selectorText() - Method in record class dev.jcputney.mjml.css.CssRule
-
Returns the value of the
selectorTextrecord component. - selfClose(String, String) - Method in class dev.jcputney.mjml.util.HtmlBuilder
-
Creates a self-closing HTML tag with optional attributes.
- serialize(List) - Static method in class dev.jcputney.mjml.css.StyleAttribute
-
Serializes a list of declarations back to an inline style string.
- setAttribute(String, String) - Method in class dev.jcputney.mjml.parser.MjmlNode
-
Sets the attribute with the given name to the given value.
- setBodyBackgroundColor(String) - Method in class dev.jcputney.mjml.context.MetadataContext
-
Sets the body background color.
- setBreakpoint(String) - Method in class dev.jcputney.mjml.context.MetadataContext
-
Sets the responsive breakpoint.
- setClassAttributes(String, Map) - Method in class dev.jcputney.mjml.context.AttributeContext
-
Sets class-level attributes for a given MJML class name.
- setContainerWidth(int) - Method in class dev.jcputney.mjml.context.MetadataContext
-
Sets the container width in pixels.
- setDefaultAttributes(String, Map) - Method in class dev.jcputney.mjml.context.AttributeContext
-
Sets default attributes for a given MJML tag name.
- setFluidOnMobileUsed(boolean) - Method in class dev.jcputney.mjml.context.StyleContext
-
Sets whether fluid-on-mobile behavior is used in the current render.
- setHtmlAttributes(String, Map) - Method in class dev.jcputney.mjml.context.AttributeContext
-
Sets HTML attributes for a given CSS selector.
- setPreviewText(String) - Method in class dev.jcputney.mjml.context.MetadataContext
-
Sets the email preview text.
- setStyle(String) - Method in class dev.jcputney.mjml.css.HtmlElement
-
Sets the inline
styleattribute on this element. - setStyleAttrEnd(int) - Method in class dev.jcputney.mjml.css.HtmlElement
-
Sets the position immediately after the closing quote of the
styleattribute in the original HTML string. - setStyleAttrStart(int) - Method in class dev.jcputney.mjml.css.HtmlElement
-
Sets the position of the
style="substring in the original HTML string. - setTagEnd(int) - Method in class dev.jcputney.mjml.css.HtmlElement
-
Sets the position immediately after the closing
>character in the original HTML string. - setTagStart(int) - Method in class dev.jcputney.mjml.css.HtmlElement
-
Sets the position of the opening
<character in the original HTML string. - setTextContent(String) - Method in class dev.jcputney.mjml.parser.MjmlNode
-
Sets the text content of this node.
- setTitle(String) - Method in class dev.jcputney.mjml.context.MetadataContext
-
Sets the document title.
- shareUrl() - Method in record class dev.jcputney.mjml.util.SocialNetworkRegistry.NetworkInfo
-
Returns the value of the
shareUrlrecord component. - SocialNetworkRegistry - Class in dev.jcputney.mjml.util
-
Registry of known social networks with default icon URLs, colors, and share URLs.
- SocialNetworkRegistry.NetworkInfo - Record Class in dev.jcputney.mjml.util
-
Describes a social network's display defaults.
- specificity() - Method in record class dev.jcputney.mjml.css.CssSelector.AttributeSelector
- specificity() - Method in record class dev.jcputney.mjml.css.CssSelector.ClassSelector
- specificity() - Method in record class dev.jcputney.mjml.css.CssSelector.ComplexSelector
- specificity() - Method in record class dev.jcputney.mjml.css.CssSelector.CompoundSelector
- specificity() - Method in record class dev.jcputney.mjml.css.CssSelector.IdSelector
- specificity() - Method in record class dev.jcputney.mjml.css.CssSelector.PseudoClassSelector
- specificity() - Method in record class dev.jcputney.mjml.css.CssSelector.PseudoElementSelector
- specificity() - Method in record class dev.jcputney.mjml.css.CssSelector.SelectorList
- specificity() - Method in interface dev.jcputney.mjml.css.CssSelector
-
Computes the specificity of this selector.
- specificity() - Method in record class dev.jcputney.mjml.css.CssSelector.TypeSelector
- specificity() - Method in record class dev.jcputney.mjml.css.CssSelector.UniversalSelector
- StyleAttribute - Class in dev.jcputney.mjml.css
-
Parses, merges, and serializes CSS inline style attributes.
- StyleContext - Class in dev.jcputney.mjml.context
-
CSS and font state gathered during head processing.
- StyleContext() - Constructor for class dev.jcputney.mjml.context.StyleContext
-
Creates a new empty style context with no fonts, styles, or media queries registered.
- StyleContext.FontDef - Record Class in dev.jcputney.mjml.context
-
Font definition record.
- StyleContext.MediaQuery - Record Class in dev.jcputney.mjml.context
-
Media query definition for responsive column widths. widthValue is the numeric value, widthUnit is "%" or "px".
- StyleExtractionResult(String, String) - Constructor for record class dev.jcputney.mjml.css.HtmlDocumentParser.StyleExtractionResult
-
Creates an instance of a
StyleExtractionResultrecord class. - styles() - Method in class dev.jcputney.mjml.context.GlobalContext
-
Returns the style sub-context (fonts, CSS, media queries, etc.).
T
- table(Runnable) - Method in class dev.jcputney.mjml.util.HtmlBuilder
-
Wraps content in a presentation table (
border="0" cellpadding="0" cellspacing="0" role="presentation" width="100%"). - table(String, Runnable) - Method in class dev.jcputney.mjml.util.HtmlBuilder
-
Creates an HTML table element with the specified attributes and content block.
- table(Map, Runnable) - Method in class dev.jcputney.mjml.util.HtmlBuilder
-
Wraps content in an HTML `
<table>` tag, applying attributes and executing the provided block within the table. - tagName() - Method in record class dev.jcputney.mjml.css.CssSelector.TypeSelector
-
Returns the value of the
tagNamerecord component. - text(String) - Method in class dev.jcputney.mjml.util.HtmlBuilder
-
Appends raw text on the current line (no indent, no newline).
- title() - Method in record class dev.jcputney.mjml.MjmlRenderResult
-
Returns the value of the
titlerecord component. - toBuilder() - Method in class dev.jcputney.mjml.MjmlConfiguration
-
Returns a builder pre-populated with this configuration's values.
- toPixels(String, double) - Static method in class dev.jcputney.mjml.util.CssUnitParser
-
Parses a CSS value and converts it to pixels.
- toString() - Method in record class dev.jcputney.mjml.context.StyleContext.FontDef
-
Returns a string representation of this record class.
- toString() - Method in record class dev.jcputney.mjml.context.StyleContext.MediaQuery
-
Returns a string representation of this record class.
- toString() - Method in record class dev.jcputney.mjml.css.CssDeclaration
-
Returns a string representation of this record class.
- toString() - Method in record class dev.jcputney.mjml.css.CssParser.ParseResult
-
Returns a string representation of this record class.
- toString() - Method in record class dev.jcputney.mjml.css.CssRule
-
Returns a string representation of this record class.
- toString() - Method in record class dev.jcputney.mjml.css.CssSelector.AttributeSelector
-
Returns a string representation of this record class.
- toString() - Method in record class dev.jcputney.mjml.css.CssSelector.ClassSelector
-
Returns a string representation of this record class.
- toString() - Method in record class dev.jcputney.mjml.css.CssSelector.ComplexSelector
-
Returns a string representation of this record class.
- toString() - Method in record class dev.jcputney.mjml.css.CssSelector.CompoundSelector
-
Returns a string representation of this record class.
- toString() - Method in record class dev.jcputney.mjml.css.CssSelector.IdSelector
-
Returns a string representation of this record class.
- toString() - Method in record class dev.jcputney.mjml.css.CssSelector.PseudoClassSelector
-
Returns a string representation of this record class.
- toString() - Method in record class dev.jcputney.mjml.css.CssSelector.PseudoElementSelector
-
Returns a string representation of this record class.
- toString() - Method in record class dev.jcputney.mjml.css.CssSelector.SelectorList
-
Returns a string representation of this record class.
- toString() - Method in record class dev.jcputney.mjml.css.CssSelector.TypeSelector
-
Returns a string representation of this record class.
- toString() - Method in record class dev.jcputney.mjml.css.CssSelector.UniversalSelector
-
Returns a string representation of this record class.
- toString() - Method in record class dev.jcputney.mjml.css.CssSpecificity
-
Returns a string representation of the CSS specificity as a tuple (a, b, c).
- toString() - Method in record class dev.jcputney.mjml.css.HtmlDocumentParser.StyleExtractionResult
-
Returns a string representation of this record class.
- toString() - Method in class dev.jcputney.mjml.css.HtmlElement
- toString() - Method in enum class dev.jcputney.mjml.Direction
- toString() - Method in class dev.jcputney.mjml.MjmlConfiguration
- toString() - Method in record class dev.jcputney.mjml.MjmlRenderResult
-
Returns a string representation of this record class.
- toString() - Method in record class dev.jcputney.mjml.parser.MjmlDocument
-
Returns a string representation of this record class.
- toString() - Method in class dev.jcputney.mjml.parser.MjmlNode
- toString() - Method in record class dev.jcputney.mjml.ResolverContext
-
Returns a string representation of this record class.
- toString() - Method in record class dev.jcputney.mjml.util.CssBoxModel
-
Returns a string representation of this record class.
- toString() - Method in class dev.jcputney.mjml.util.HtmlBuilder
- toString() - Method in record class dev.jcputney.mjml.util.SocialNetworkRegistry.NetworkInfo
-
Returns a string representation of this record class.
- TypeSelector(String) - Constructor for record class dev.jcputney.mjml.css.CssSelector.TypeSelector
-
Creates an instance of a
TypeSelectorrecord class.
U
- UniversalSelector() - Constructor for record class dev.jcputney.mjml.css.CssSelector.UniversalSelector
-
Creates an instance of a
UniversalSelectorrecord class. - unsortedAttrs(Map) - Static method in class dev.jcputney.mjml.util.HtmlBuilder
-
Builds an unsorted attribute string from a map of key-value pairs.
- Usage - Section in class dev.jcputney.mjml.ClasspathIncludeResolver
- Usage - Section in class dev.jcputney.mjml.FileSystemIncludeResolver
- Usage - Section in class dev.jcputney.mjml.MjmlRenderer
- Usage - Section in class dev.jcputney.mjml.css.CssInliner
V
- value() - Method in record class dev.jcputney.mjml.css.CssDeclaration
-
Returns the value of the
valuerecord component. - value() - Method in record class dev.jcputney.mjml.css.CssSelector.AttributeSelector
-
Returns the value of the
valuerecord component. - value() - Method in enum class dev.jcputney.mjml.Direction
-
Returns the lowercase string representation used in HTML output.
- valueOf(String) - Static method in enum class dev.jcputney.mjml.css.CssSelector.Combinator
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class dev.jcputney.mjml.Direction
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class dev.jcputney.mjml.css.CssSelector.Combinator
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class dev.jcputney.mjml.Direction
-
Returns an array containing the constants of this enum class, in the order they are declared.
- verticalSpacing() - Method in record class dev.jcputney.mjml.util.CssBoxModel
-
Total vertical spacing (top + bottom padding).
- VmlHelper - Class in dev.jcputney.mjml.render
-
Helper for generating Outlook VML (Vector Markup Language) for background images.
W
- WHITESPACE - Static variable in class dev.jcputney.mjml.util.CssUnitParser
-
Pre-compiled whitespace pattern for splitting CSS shorthand values.
- widthUnit() - Method in record class dev.jcputney.mjml.context.StyleContext.MediaQuery
-
Returns the value of the
widthUnitrecord component. - widthValue() - Method in record class dev.jcputney.mjml.context.StyleContext.MediaQuery
-
Returns the value of the
widthValuerecord component. - withColumnWidth(double, String) - Method in class dev.jcputney.mjml.context.RenderContext
-
Creates a child context with container width and column width specification.
- withInsideGroup(boolean) - Method in class dev.jcputney.mjml.context.RenderContext
-
Creates a child context indicating the component is inside a group.
- withInsideWrapper(boolean) - Method in class dev.jcputney.mjml.context.RenderContext
-
Creates a child context indicating the component is inside a wrapper.
- withPosition(int, boolean, boolean) - Method in class dev.jcputney.mjml.context.RenderContext
-
Creates a child context with positioning info for column rendering.
- withWidth(double) - Method in class dev.jcputney.mjml.context.RenderContext
-
Creates a child context with a narrower container width.
- wrap(String, Runnable) - Method in class dev.jcputney.mjml.util.HtmlBuilder
-
Wraps the output of a
Runnableblock with the specified HTML tag. - wrap(String, String, Runnable) - Method in class dev.jcputney.mjml.util.HtmlBuilder
-
Opens a tag with attributes, executes the block, and closes the tag.
Z
- ZERO - Static variable in record class dev.jcputney.mjml.css.CssSpecificity
-
Represents CSS specificity of zero, defined as (0, 0, 0).
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form