Interface IInliner

All Known Implementing Classes:
AbstractStandardInliner, NoOpInliner, StandardCSSInliner, StandardHTMLInliner, StandardJavaScriptInliner, StandardTextInliner, StandardXMLInliner

public interface IInliner

Interface to be implemented by all inliner implementations.

Inliners are objects in charge of processing logic appearing on textual-oriented nodes (IText, ICDATASection and IComment), as opposed to on elements. For example, inlined output expressions ([[${...}]]), javascript inlining artifacts, etc.

Since:
3.0.0
Author:
Daniel Fernández
  • Method Details

    • getName

      String getName()

      Returns an identifiable name for the inliner

      Returns:
      the name of the inliner.
    • inline

      CharSequence inline(ITemplateContext context, IText text)

      Perform the inlining operation on an IText node.

      Parameters:
      context - the template context.
      text - the event to be inlined.
      Returns:
      the modified event (or the same event if no modifications were required)
    • inline

      CharSequence inline(ITemplateContext context, ICDATASection cdataSection)

      Perform the inlining operation on an ICDATASection node.

      Parameters:
      context - the template context.
      cdataSection - the event to be inlined.
      Returns:
      the modified event (or the same event if no modifications were required)
    • inline

      CharSequence inline(ITemplateContext context, IComment comment)

      Perform the inlining operation on an IComment node.

      Parameters:
      context - the template context.
      comment - the event to be inlined.
      Returns:
      the modified event (or the same event if no modifications were required)