Renders a paragraph of text (line breaks ignored) to an image (created and returned). : Text Layout « 2D Graphics GUI « Java

Renders a paragraph of text (line breaks ignored) to an image (created and returned).

 * Created on March 16, 2007, 4:34 PM
 * Copyright 2006-2007 Nigel Hughes
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 * licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
 * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language
 * governing permissions and limitations under the License.

import java.awt.Color;
import java.awt.Font;
import java.awt.Graphics;
import java.awt.Graphics2D;
import java.awt.GraphicsConfiguration;
import java.awt.GraphicsEnvironment;
import java.awt.RenderingHints;
import java.awt.Transparency;
import java.awt.font.FontRenderContext;
import java.awt.font.LineBreakMeasurer;
import java.awt.font.TextAttribute;
import java.awt.font.TextLayout;
import java.awt.image.BufferedImage;
import java.text.AttributedCharacterIterator;
import java.text.AttributedString;
import java.util.Hashtable;

 * @author nigel
public class Utils {
   * Renders a paragraph of text (line breaks ignored) to an image (created and returned). 
   * @param font The font to use
   * @param textColor The color of the text
   * @param text The message
   * @param width The width the text should be limited to
   * @return An image with the text rendered into it
  public static BufferedImage renderTextToImage(Font font, Color textColor, String text, int width){
      Hashtable   map = new Hashtable();
      map.put(TextAttribute.FONT, font);
      AttributedString attributedString = new AttributedString(text,map);
      AttributedCharacterIterator paragraph = attributedString.getIterator();
      FontRenderContext frc = new FontRenderContext(null, false, false);
      int paragraphStart = paragraph.getBeginIndex();
      int paragraphEnd = paragraph.getEndIndex();
      LineBreakMeasurer lineMeasurer = new LineBreakMeasurer(paragraph, frc);      
      float   drawPosY=0;
      //First time around, just determine the height
      while (lineMeasurer.getPosition() < paragraphEnd) {
          TextLayout layout = lineMeasurer.nextLayout(width);
          // Move it down
          drawPosY += layout.getAscent() + layout.getDescent() + layout.getLeading();
      BufferedImage image = createCompatibleImage(width,(int) drawPosY);
      Graphics2D graphics = (Graphics2D) image.getGraphics();
      graphics.setRenderingHint(RenderingHints.KEY_TEXT_ANTIALIASING, RenderingHints.VALUE_TEXT_ANTIALIAS_ON);
      while (lineMeasurer.getPosition() < paragraphEnd) {
          TextLayout layout = lineMeasurer.nextLayout(width);
          // Move y-coordinate by the ascent of the layout.
          drawPosY += layout.getAscent();
         /* Compute pen x position.  If the paragraph is
            right-to-left, we want to align the TextLayouts
            to the right edge of the panel.
          float drawPosX;
          if (layout.isLeftToRight()) {
              drawPosX = 0;
          } else {
              drawPosX = width - layout.getAdvance();
          // Draw the TextLayout at (drawPosX, drawPosY).
          layout.draw(graphics, drawPosX, drawPosY);
          // Move y-coordinate in preparation for next layout.
          drawPosY += layout.getDescent() + layout.getLeading();
      return image;
   * Creates an image compatible with the current display
   * @return A BufferedImage with the appropriate color model
  public static BufferedImage createCompatibleImage(int width, int height) {
    GraphicsConfiguration configuration = GraphicsEnvironment.getLocalGraphicsEnvironment()
    return configuration.createCompatibleImage(width, height, Transparency.TRANSLUCENT);


Related examples in the same category

1.JFreeChart: Draw String DemoJFreeChart: Draw String Demo
2.Unicode: test layoutUnicode: test layout
3.Unicode displayUnicode display
4.Line break for textlayoutLine break for textlayout
5.Mouse hit and textlayoutMouse hit and textlayout
6.TextLayout demoTextLayout demo
7.Draw text along a curveDraw text along a curve
8.TextHitInfo Demo: tell you which is the letter you are clickingTextHitInfo Demo: tell you which is the letter you are clicking
9.TextAttribute: Underline and strike throughTextAttribute: Underline and strike through
10.TextAttribute: color and fontTextAttribute: color and font
11.Hightlight text by drag and selectionHightlight text by drag and selection
12.LineMetrics: the metrics to layout characters along a lineLineMetrics: the metrics to layout characters along a line
13.Paragraph LayoutParagraph Layout
14.Caret actionCaret action
15.Caret and TextLayoutCaret and TextLayout
16.Another Line Break Demo
17.A display of text, formatted by us instead of by AWT/SwingA display of text, formatted by us instead of by AWT/Swing
18.Draw text with TextLayout
19.Drawing a Paragraph of Text
20.Getting the Shape from the Outline of Text
21.Drawing Text with Mixed Styles
22.Drawing multi-line text with AttributedString and LineBreakMeasurer
23.Draws the string at the specified location underlining the specified character