de.lessvoid.nifty.html.NiftyHtmlGenerator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of nifty-html Show documentation

This module adds basic HTML support to Nifty. It creates Nifty elements from HTML directly. This is useful if you need to display messages or info boxes that contain more than simple elements.

There is a newer version: 1.4.3

Show newest version

package de.lessvoid.nifty.html;

import de.lessvoid.nifty.Nifty;
import de.lessvoid.nifty.builder.ElementBuilder;
import de.lessvoid.nifty.elements.Action;
import de.lessvoid.nifty.elements.Element;
import de.lessvoid.nifty.screen.Screen;
import de.lessvoid.nifty.spi.render.RenderFont;
import org.htmlparser.Parser;

import javax.annotation.Nonnull;

/**
 * This class will take a HTML String and transforms the HTML into Nifty elements.
 * @author void
 */
public class NiftyHtmlGenerator {
  private final Nifty nifty;
  private String defaultFontname = "aurulent-sans-16.fnt";
  private String defaultBoldFontname = "aurulent-sans-16-bold.fnt";
  private RenderFont defaultFont;
  private RenderFont defaultBoldFont;

  /**
   * Create the NiftyHtmlGenerator.
   * @param nifty the Nifty instance
   */
  public NiftyHtmlGenerator(final Nifty nifty) {
    this.nifty = nifty;

    // we could set this to true for debug purpose
    this.nifty.setDebugOptionPanelColors(false);
  }

  /**
   * Change the default font to be used.
   * @param name
   */
  public void setDefaultFont(final String name) {
    this.defaultFontname = name;
  }

  /**
   * Change the default bold font to be used.
   * @param name
   */
  public void setDefaultBoldFont(final String name) {
    this.defaultBoldFontname = name;
  }

  /**
   * Change the default font to be used.
   * @param defaultFont the RenderFont to use
   */
  public void setDefaultFont(final RenderFont defaultFont) {
    this.defaultFont = defaultFont;
  }

  /**
   * Change the default bold font to be used.
   * @param defaultBoldFont the RenderFont to use for bold output
   */
  public void setDefaultBoldFont(final RenderFont defaultBoldFont) {
    this.defaultBoldFont = defaultBoldFont;
  }

  /**
   * Parse the given XML and build the corresponding Nifty elements.
   * @param html the actual HTML string to parse and transform
   * @param screen the screen to generate elements for
   * @param parent parent element that all new Nifty elements will be added as child elements
   * @throws Exception in case of any error an Exception is thrown
   */
  public void generate(final String html, @Nonnull final Screen screen, @Nonnull final Element parent) throws Exception {
    removeAllChildren(parent);

    Parser parser = Parser.createParser(html, "ISO-8859-1");

    final NiftyVisitor visitor = new NiftyVisitor(nifty, new NiftyBuilderFactory(), getDefaultFontname(),
        getDefaultBoldFontname());
    parser.visitAllNodesWith(visitor);

    final ElementBuilder builder = visitor.builder();
    nifty.scheduleEndOfFrameElementAction(new Action() {
      @Override
      public void perform() {
        builder.build(nifty, screen, parent);
      }
    }, null);
  }

  /**
   * Remove all child elements of the given parent element.
   * @param parent the element we want to remove all children
   */
  private void removeAllChildren(@Nonnull final Element parent) {
    for (int i=0; i