TextPane Elements : TextPane « Swing JFC « Java

TextPane Elements

TextPane Elements
Core SWING Advanced Programming 
By Kim Topley
ISBN: 0 13 083292 8       
Publisher: Prentice Hall  

import javax.swing.*;
import javax.swing.text.*;
import java.awt.*;
import java.net.URL;

public class TextPaneElements {  
  public static void createDocumentStyles(StyleContext sc) {  
    Style defaultStyle = sc.getStyle(StyleContext.DEFAULT_STYLE);

    // Create and add the main document style
    Style mainStyle = sc.addStyle(mainStyleName, defaultStyle);
    StyleConstants.setLeftIndent(mainStyle, 16);
    StyleConstants.setRightIndent(mainStyle, 16);
    StyleConstants.setFirstLineIndent(mainStyle, 16);
    StyleConstants.setFontFamily(mainStyle, "serif");
    StyleConstants.setFontSize(mainStyle, 12);

    // Create and add the constant width style
    Style cwStyle = sc.addStyle(charStyleName, null);
    StyleConstants.setFontFamily(cwStyle, "monospaced");
    StyleConstants.setForeground(cwStyle, Color.green);

    // Create and add the heading style
    Style heading2Style = sc.addStyle(heading2StyleName, null);
    StyleConstants.setForeground(heading2Style, Color.red);
    StyleConstants.setFontSize(heading2Style, 16);
    StyleConstants.setFontFamily(heading2Style, "serif");
    StyleConstants.setBold(heading2Style, true);
    StyleConstants.setLeftIndent(heading2Style, 8);
    StyleConstants.setFirstLineIndent(heading2Style, 0);

    // Create and add the Component style
    Class thisClass = TextPaneElements.class;
    URL url = thisClass.getResource("java2s.gif");
    ImageIcon icon = new ImageIcon(url);
    JLabel comp = new JLabel("Displaying text with attributes",
                  icon, JLabel.CENTER);
    comp.setFont(new Font("serif", Font.BOLD | Font.ITALIC, 14));
    Style componentStyle = sc.addStyle(componentStyleName, null);    
    StyleConstants.setComponent(componentStyle, comp);

    // The paragraph style for the component
    Style compParagraphStyle = sc.addStyle(compParaName, null);
    StyleConstants.setSpaceAbove(compParagraphStyle, (float)16.0);    

  public static void addText(JTextPane pane, StyleContext sc, Style logicalStyle,
                Paragraph[] content) {
    // The outer loop adds paragraphs, while the
    // inner loop adds character runs.
    int paragraphs = content.length;
    for (int i = 0; i < paragraphs; i++) {
      Run[] runs = content[i].content;
      for (int j = 0; j < runs.length; j++) {
          runs[j].styleName == null ? SimpleAttributeSet.EMPTY :
                  sc.getStyle(runs[j].styleName), true);

      // At the end of the paragraph, add the logical style and
      // any overriding paragraph style and then terminate the 
      // paragraph with a newline.
      pane.setParagraphAttributes(SimpleAttributeSet.EMPTY, true);
      if (logicalStyle != null) {

      if (content[i].styleName != null) {
        pane.setParagraphAttributes(sc.getStyle(content[i].styleName), false);

  public static void main(String[] args) {
    try {
    } catch (Exception evt) {}
    JFrame f = new JFrame("Text Pane Elements");
    // Create the StyleContext, the document and the pane
    final StyleContext sc = new StyleContext();
    final DefaultStyledDocument doc = new DefaultStyledDocument(sc);
    final JTextPane pane = new JTextPane(doc);

    // Build the styles

    try {
      // Add the text and apply the styles
      SwingUtilities.invokeAndWait(new Runnable() {
        public void run() {
          // Add the text
          addText(pane, sc, sc.getStyle(mainStyleName), content);  
          // Dump the element structure
    } catch (Exception e) {
      System.out.println("Exception when constructing document: " + e);

    f.getContentPane().add(new JScrollPane(pane));
    f.setSize(500, 300);

  // Style names
  public static final String mainStyleName = "MainStyle";
  public static final String heading2StyleName = "Heading2";
  public static final String charStyleName = "ConstantWidth";
  public static final String componentStyleName = "Component";
  public static final String compParaName = "CompPara";

  // Inner classes used to define paragraph structure
  public static class Run {
    public Run(String styleName, String content) {
      this.styleName = styleName;
      this.content = content;

    public String styleName;
    public String content;

  public static class Paragraph {
    public Paragraph(String styleName, Run[] content) {
      this.styleName = styleName;
      this.content = content;

    public String styleName;
    public Run[] content;

  public static final Paragraph[] content = new Paragraph[] {
    new Paragraph(heading2StyleName, new Run[] {      
        new Run(null, "Attributes, Styles and Style Contexts")
    new Paragraph(null, new Run[] {
        new Run(null, "The simple "),
        new Run(charStyleName, "PlainDocument"),
        new Run(null, " class that you saw in the previous " +
              "chapter is only capable of holding text. " +
              "The more complex text components use a more " +
              "sophisticated model that implements the "),
        new Run(charStyleName, "StyledDocument"),
        new Run(null, " interface. "),
        new Run(charStyleName, "StyledDocument"),
        new Run(null, " is a sub-interface of "),
        new Run(charStyleName, "Document"),
        new Run(null, " that contains methods for manipulating attributes " +
                "that control the way in which the text in the " +
                "document is displayed. The Swing text package " +
                "contains a concrete implementation of "),
        new Run(charStyleName, "StyledDocument"),
        new Run(null, " called "),
        new Run(charStyleName, "DefaultStyledDocument"),
        new Run(null, " that is used as the default model for "),
        new Run(charStyleName, "JTextPane"),
        new Run(null, " and is also the base class from which " +
                "more specific models, such as the "),
        new Run(charStyleName, "HTMLDocument"),
        new Run(null, " class that handles input in HTML format, can be " +
                "created. In order to make use of "),
        new Run(charStyleName, "DefaultStyledDocument"),
        new Run(null, " and "),
        new Run(charStyleName, "JTextPane"),
        new Run(null, " you need to understand how Swing represents " +
                "and uses attributes.")
    new Paragraph(compParaName, new Run[] {
        new Run(componentStyleName, " ")


Related examples in the same category

1.TextPane SampleTextPane Sample
2.Brower based on JEditorPaneBrower based on JEditorPane
3.JTextPane demo with various format and html loading and renderingJTextPane demo with various format and html loading and rendering
4.Styled TextStyled Text
5.Appending TextPaneAppending TextPane
6.Text Component DisplayText Component Display
7.JTextPane Styles Example 1JTextPane Styles Example 1
8.JTextPane Styles Example 2JTextPane Styles Example 2
9.JTextPane Styles Example 3JTextPane Styles Example 3
10.JTextPane Styles Example 4JTextPane Styles Example 4
11.JTextPane Styles Example 5JTextPane Styles Example 5
12.JTextPane Styles Example 6JTextPane Styles Example 6
13.JTextPane Styles Example 7JTextPane Styles Example 7
14.JTextPane Styles Example 8JTextPane Styles Example 8
15.JTextPane Highlight ExampleJTextPane Highlight Example
16.JTextPane Extended Paragraph Example
17.TextPane Views 2TextPane Views 2
18.List HTML ValuesList HTML Values
19.Show HTML Document
20.Show HTML Views
21.JEditorPane Replace ReaderJEditorPane Replace Reader
22.Bi-Directional TextBi-Directional Text
23.TextPane: DocumentEvent TextPane: DocumentEvent
24.Show how Icons, Components, and text can be added to a JTextPaneShow how Icons, Components, and text can be added to a JTextPane
25.Parentheses matcherParentheses matcher
26.A TabSet in a JTextPaneA TabSet in a JTextPane
27.Extension of JTextPane that allows the user to easily append colored text to the documentExtension of JTextPane that allows the user to easily append colored text to the document
28.An implementation of HighlightPainter that underlines text with a thick lineAn implementation of HighlightPainter that underlines text with a thick line
29.An example of highlighting multiple, discontiguous regions of a text component.An example of highlighting multiple, discontiguous regions of a text component.
30.A custom caret classA custom caret class
31.Enumerating the Paragraphs of a JTextPane Component
32.Inserting an Image into a JTextPane Component
33.Inserting a Component into a JTextPane Component
34.Customizing Tab Stops in a JTextPane Component
35.Sharing Styles Between JTextPanes
36.Listing the Styles Associated with a JTextPane
37.Listing the Attributes in a Style
38.Replace style
39.Set logical style; replaces paragraph style's parent
40.Get logical style and restore it after new paragraph style
41.Determining If a Style Attribute Applies to a Character or the Paragraph
42.Determine if the attribute is a color or a font-related attribute.
43.Create a tab set from the tab stops
44.Foreground color
45.Background color
46.Change the Font size of JTextPane
47.Font family
48.Bold style
49.An example of several text components including password fields and formatted fields.An example of several text components including password fields and formatted fields.
50.A style can have multiple attributes; this one makes text bold and italic
51.Duplicate style
52.Italicize the entire paragraph containing the position 12
53.Inserting Styled Text in a JTextPane Component
54.A separation of a data from the visual representation. In a JTextPane component, we have a StyledDocument for setting the style of the text data.
55.Tests two attributed strings for equality.
56.Get Leading White Space
57.Get Leading White Space Width
58.Get Max Fitting FontSize
59.Reads a AttributedString object that has been serialised by the SerialUtilities.writeAttributedString(AttributedString, ObjectOutputStream)} method.