HTMLGenerator.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2011 Lluis Turró Cutiller <http://www.turro.org/>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.turro.html;
 
import java.io.IOException;
import java.io.StringWriter;
import java.io.Writer;
import java.util.Stack;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.turro.string.Strings;
import org.turro.elephant.context.ElephantContext;
 
public class HTMLGenerator {
  protected Stack tags = new Stack();
  protected Writer out = null;
  
  private String extraAttributes;
  
  public HTMLGenerator() {
    this.out = new StringWriter();
  }
 
  public HTMLGenerator(Writer out) {
    this.out = out;
  }
 
  @Override
  public String toString() {
    return out.toString().replaceAll("&(?![a-z]+;)", "&amp;");
  }
  
  public void setOut(Writer out) {
    this.out = out;
  }
 
  public void setExtraAttributes(String extraAttributes) {
    this.extraAttributes = extraAttributes;
  }
  
  public HTMLGenerator doTag(String tag) {
    return doTag(tag, (String[]) null);
  }
  
  public HTMLGenerator doTag(String tag, String attributes) {
    return doTag(tag, new String[] { attributes });
  }
  
  public HTMLGenerator doTag(String tag, String[] attributes) {
    if(attributes != null) {
      write("<" + tag);
      for(int i = 0; i < attributes.length; i++) {
        if(!Strings.isBlank(attributes[i])) {
          write(" " + attributes[i]);
        }
      }
      return write(" />");
    }
    else {
      return write("<" + tag + " />");
    }
  }
  
  public HTMLGenerator startTag(String tag) {
    return startTag(tag, (String[]) null);
  }
  
  public HTMLGenerator startTag(String tag, String attributes) {
    return startTag(tag, new String[] { attributes });
  }
  
  public HTMLGenerator startTag(String tag, String[] attributes) {
    tags.push(tag);
    if(attributes != null) {
      write("<" + tag);
      for(int i = 0; i < attributes.length; i++) {
        if(!Strings.isBlank(attributes[i])) {
          write(" " + attributes[i]);
        }
      }
      if(!Strings.isBlank(extraAttributes)) {
        write(" " + extraAttributes);
        extraAttributes = null;
      }
      return write(">");
    }
    else {
      return write("<" + tag + ">");
    }
  }
  
  public HTMLGenerator startExtAnchor(String url, String hint) {
    return startTargetAnchor(url, "_blank", hint);
  }
  
  public HTMLGenerator startTargetAnchor(String url, String target, String hint) {
    return startTag("a", new String[] {
      "href='" + url + "'",
      (hint != null ? "title=\"" + hint + "\"" : ""),
      (hint != null ? "alt=\"" + hint + "\"" : ""),
      "target='" + target + "'",
      "onclick='event.stopPropagation();'",
      "class='newwindow'"
    });
  }
  
  public HTMLGenerator startAnchor(String url, String hint) {
    return startAnchor(url, hint, null, null);
  }
  
  public HTMLGenerator startAnchor(String url, String hint, String cssClass) {
    return startAnchor(url, hint, cssClass, null);
  }
  
  public HTMLGenerator startAnchor(String url, String hint, String cssClass, String onClick) {
    return startTag("a", new String[] {
      "href='" + url + "'",
      (hint != null ? "title=\"" + hint + "\"" : ""),
      (hint != null ? "alt=\"" + hint + "\"" : ""),
      (cssClass != null ? "class='" + cssClass + "'" : ""),
      (onClick != null ? "onclick=\"" + onClick + "\"" : "")
    });
  }
  
  public HTMLGenerator startTable(String attributes) {
    return startTable(new String[] { attributes });
  }
  
  public HTMLGenerator startTable(String[] attributes) {
    return startTag("table", attributes);
  }
  
  public HTMLGenerator endTable() {
    return endTag("table");
  }
  
  public HTMLGenerator startTableRow(String attributes) {
    return startTableRow(new String[] { attributes });
  }
  
  public HTMLGenerator startTableRow(String[] attributes) {
    if(!checkTag("table")) {
      startTable("");
    }
    return startTag("tr", attributes);
  }
  
  public HTMLGenerator endTableRow() {
    return endTag("tr");
  }
  
  public HTMLGenerator startTableCol(String attributes) {
    return startTableCol(new String[] { attributes });
  }
  
  public HTMLGenerator startTableCol(String[] attributes) {
    if(!checkTag("tr")) {
      startTableRow("");
    }
    return startTag("td", attributes);
  }
  
  public HTMLGenerator endTableCol() {
    return endTag("td");
  }
  
  public HTMLGenerator endTag() {
    String tag = (String) tags.pop();
    return write("</" + tag + ">");
  }
 
  public HTMLGenerator endTag(String tag) {
    if(!checkTag(tag)) return this;
    String tmp = null; 
    while(!tag.equals(tmp)) {
      tmp = (String) tags.pop();
      write("</" + tmp + ">");
    }
    return this;
  }
 
  public HTMLGenerator endBeforeTag(String tag) {
    if(!checkTag(tag)) return this;
    String tmp = null; 
    while(!tag.equals(tags.peek())) {
      tmp = (String) tags.pop();
      write("</" + tmp + ">");
    }
    return this;
  }
 
  public HTMLGenerator endAllTags() {
    while(!tags.empty()) {
      endTag();
    }
    return write("\n");
  }
  
  public boolean checkTag(String tag) {
    return tags.contains(tag);
  }
  
  public HTMLGenerator write(String value) {
    try {
      if (value == null) {
        return this;
      }
      out.write(value);
    } catch (IOException ex) {
      Logger.getLogger(HTMLGenerator.class.getName()).log(Level.SEVERE, ElephantContext.logMsg(null), ex);
    }
    return this;
  }
  
  public HTMLGenerator writeNewLine() {
    return doTag("br");
  }
  
  public HTMLGenerator writeSeparator() {
    return doTag("hr");
  }
  
  public HTMLGenerator writeHorizontalStrut(int pixels) {
    startTag("div", "style='height:" + pixels + "px'");
    write("&nbsp;");
    return endTag();
  }
  
  public HTMLGenerator startJavaScript() {
    return write("\n<script language='JavaScript' type='text/javascript'>\n");
  }
  
  public HTMLGenerator endJavaScript() {
    return write("\n</script>\n");
  }
  
  public HTMLGenerator startCSS() {
    return write("\n<style type='text/css'>\n");
  }
  
  public HTMLGenerator endCSS() {
    return write("\n</style>\n");
  }
  
  public HTMLGenerator addCSSLink(String cssFile) {
    return write("<link rel=\"stylesheet\" type=\"text/css\" href=\"" +
            cssFile +
            "\">");
  }
  
  public HTMLGenerator addJavaScriptLink(String jsFile) {
    return write("<script type=\"text/javascript\" src=\"" +
            jsFile +
            "\"></script>");
  }
  
}