MultiLineString.java

/*
This class was originally written by Cay S. Horstmann in Violet

The following is the copyright information originally written by Cay
 */

/*
Violet - A program for editing UML diagrams.

Copyright (C) 2002 Cay S. Horstmann (http://horstmann.com)

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 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 General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/

//package com.horstmann.violet.framework;

import java.awt.Dimension;
import java.awt.Graphics2D;
import java.awt.geom.Rectangle2D;
import java.io.Serializable;
import java.util.Arrays;
import java.util.List;
import java.util.StringTokenizer;

import javax.swing.JLabel;

/**
 * A string that can extend over multiple lines.
 */
public class MultiLineString implements Cloneable, Serializable {
    /**
     * Constructs an empty, centered, normal size multiline
     * string that is not underlined.
     */
    public MultiLineString() {
        text = "";
        justification = CENTER;
        size = NORMAL;
        underlined = false;
    }

    /**
     * Sets the value of the text property.
     *
     * @param newValue the text of the multiline string
     */
    public void setText(String newValue) {
        text = newValue;
        setLabelText();
    }

    /**
     * Gets the value of the text property.
     *
     * @return the text of the multiline string
     */
    public String getText() {
        return text;
    }

    /**
     * Sets the value of the justification property.
     *
     * @param newValue the justification, one of LEFT, CENTER,
     *                 RIGHT
     */
    public void setJustification(int newValue) {
        justification = newValue;
        setLabelText();
    }

    /**
     * Gets the value of the justification property.
     *
     * @return the justification, one of LEFT, CENTER,
     * RIGHT
     */
    public int getJustification() {
        return justification;
    }

    /**
     * Gets the value of the underlined property.
     *
     * @return true if the text is underlined
     */
    public boolean isUnderlined() {
        return underlined;
    }

    /**
     * Sets the value of the underlined property.
     *
     * @param newValue true to underline the text
     */
    public void setUnderlined(boolean newValue) {
        underlined = newValue;
        setLabelText();
    }

    /**
     * Sets the value of the size property.
     *
     * @param newValue the size, one of SMALL, NORMAL, LARGE
     */
    public void setSize(int newValue) {
        size = newValue;
        setLabelText();
    }

    /**
     * Gets the value of the size property.
     *
     * @return the size, one of SMALL, NORMAL, LARGE
     */
    public int getSize() {
        return size;
    }

    /**
     * @return a toString representation of this object
     */
    public String toString() {
        return text.replace('\n', '|');
    }

    /**
     * Internal method for setting the text with the way
     * the parameters are currently set
     */
    private void setLabelText() {
        StringBuffer prefix = new StringBuffer();
        StringBuffer suffix = new StringBuffer();
        StringBuffer htmlText = new StringBuffer();
        prefix.append(" ");
        suffix.insert(0, " ");
        if (underlined) {
            prefix.append("<u>");
            suffix.insert(0, "</u>");
        }
        if (size == LARGE) {
            prefix.append("<font size=\"+1\">");
            suffix.insert(0, "</font>");
        }
        if (size == SMALL) {
            prefix.append("<font size=\"-2\">");
            suffix.insert(0, "</font>");
        }
        htmlText.append("<html>");
        StringTokenizer tokenizer = new StringTokenizer(text, "\n");
        boolean first = true;
        while (tokenizer.hasMoreTokens()) {
            if (first) first = false;
            else htmlText.append("<br>");
            htmlText.append(prefix);
            htmlText.append(tokenizer.nextToken());
            htmlText.append(suffix);
        }
        htmlText.append("</html>");

        // replace any < that are not followed by {u, i, b, tt, font, br} with &lt;

        List dontReplace = Arrays.asList(new String[]{"u", "i", "b", "tt", "font", "br"});

        int ltpos = 0;
        while (ltpos != -1) {
            ltpos = htmlText.indexOf("<", ltpos + 1);
            if (ltpos != -1 && !(ltpos + 1 < htmlText.length() && htmlText.charAt(ltpos + 1) == '/')) {
                int end = ltpos + 1;
                while (end < htmlText.length() && Character.isLetter(htmlText.charAt(end))) end++;
                if (!dontReplace.contains(htmlText.substring(ltpos + 1, end)))
                    htmlText.replace(ltpos, ltpos + 1, "&lt;");
            }
        }

        label.setText(htmlText.toString());
        if (justification == LEFT) label.setHorizontalAlignment(JLabel.LEFT);
        else if (justification == CENTER) label.setHorizontalAlignment(JLabel.CENTER);
        else if (justification == RIGHT) label.setHorizontalAlignment(JLabel.RIGHT);
    }

    /**
     * Gets the bounding rectangle for this multiline string.
     *
     * @param g2 the graphics context
     * @return the bounding rectangle (with top left corner (0,0))
     */
    public Rectangle2D getBounds(Graphics2D g2) {
        if (text.length() == 0) return new Rectangle2D.Double();
        // setLabelText();
        Dimension dim = label.getPreferredSize();
        return new Rectangle2D.Double(0, 0, dim.getWidth(), dim.getHeight());
    }

    /**
     * Draws this multiline string inside a given rectangle
     *
     * @param g2 the graphics context
     * @param r  the rectangle into which to place this multiline string
     */
    public void draw(Graphics2D g2, Rectangle2D r) {
        // setLabelText();
        label.setFont(g2.getFont());
        label.setBounds(0, 0, (int) r.getWidth(), (int) r.getHeight());
        g2.translate(r.getX(), r.getY());
        label.paint(g2);
        g2.translate(-r.getX(), -r.getY());
    }

    /**
     * @return a new MultiLineString with the same parameters as this
     */
    public Object clone() {
        try {
            MultiLineString cloned = (MultiLineString) super.clone();
            cloned.label = new JLabel();
            cloned.setLabelText();
            return cloned;
        } catch (CloneNotSupportedException exception) {
            return null;
        }
    }

    public static final int LEFT = 0;
    public static final int CENTER = 1;
    public static final int RIGHT = 2;
    public static final int LARGE = 3;
    public static final int NORMAL = 4;
    public static final int SMALL = 5;

    private static final int GAP = 3;

    private String text;
    private int justification;
    private int size;
    private boolean underlined;

    private transient JLabel label = new JLabel();
}