JEditorPane and Html Document

Table of Contents

1. Introduction to JEditorPane

The JEditorPane extends from Java Swing’s JTextComponent. So it supports various document types. One can use it to display Plain document (txt), Rich Text Document (rtf) and html document. In this example, we will create a JEditorPane and load a html document into it.

2. About The Example

Below screenshot shows the JEditorPane example we create here:

The example is a simple JFrame, which houses a JEditorPane in it. The editor pane is displaying a html table above and the user can scroll the document using the scrollbars. These scrolls are useful when the document is bigger than the editor pane. Now, we will proceed with the example.

3. Html Document for the Example

In this example, we are going to load a html document in the Editor Pane. The html document is a table with heading text. We no need to go into much detail about this html content. Name this a Test.html and place it along with the java files (Found in Code Reference Section).

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
<head>
    <title>Untitled Page</title>
</head>
<body>
    <H1 style="font-family: Verdana">
        <span style="color: red">This is a sample Html Page</span></H1>
    <p>
        <table border="1" cellpadding="4" cellspacing="4" style="width: 430px; height: 265px">
            <tr>
                <td style="width: 100px; background-color: seashell">
                    <span style="font-size: 14pt; font-family: Tahoma">&nbsp;Cell 1</span></td>
                <td style="width: 100px; background-color: seashell">
                    <span style="font-size: 14pt; font-family: Tahoma">&nbsp;Cell 2</span></td>
                <td style="width: 100px; background-color: seashell">
                    <span style="font-size: 14pt; font-family: Tahoma">&nbsp;Cell 3</span></td>
            </tr>
            <tr>
                <td style="width: 100px; background-color: seashell">
                    <span style="font-size: 14pt; font-family: Tahoma">&nbsp;Cell 4</span></td>
                <td style="width: 100px; background-color: seashell">
                    <span style="font-size: 14pt; font-family: Tahoma">&nbsp;Cell 5</span></td>
                <td style="width: 100px; background-color: seashell">
                    <span style="font-size: 14pt; font-family: Tahoma">&nbsp;Cell 6</span></td>
            </tr>
            <tr>
                <td style="width: 100px; background-color: seashell">
                    <span style="font-size: 14pt; font-family: Tahoma">&nbsp;Cell 7</span></td>
                <td style="width: 100px; background-color: seashell">
                    <span style="font-size: 14pt; font-family: Tahoma">&nbsp;Cell 8</span></td>
                <td style="width: 100px; background-color: seashell">
                    <span style="font-size: 14pt; font-family: Tahoma">&nbsp;Cell 9</span></td>
            </tr>
        </table>
        <span style="color: red"></span>
    </p>
</body>
</html>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<head>

<title>Untitled Page</title>

</head>

<body>

This is a sample Html Page</H1>

<tr>

Cell 1</td>

Cell 2</td>

Cell 3</td>

</tr>

<tr>

Cell 4</td>

Cell 5</td>

Cell 6</td>

</tr>

<tr>

Cell 7</td>

Cell 8</td>

Cell 9</td>

</tr>

</table>

</body>

</html>

4. Create JEditorPane

In the below code snippet, at line 7, we create a JEditorPane via an empty constructor. By default, Java Swing keeps editor pane in the disabled state. So we make a call to setEnable to override the default state.

//Sample 01: Set Size and Position
setBounds(100, 100, 600, 500);
Container ControlHost = getContentPane();
ControlHost.setLayout(new FlowLayout());

//Sample 02: Create Editor Pane
JEditorPane jep = new JEditorPane();
jep.setEnabled(true);

//Sample 01: Set Size and Position

setBounds(100, 100, 600, 500);

Container ControlHost = getContentPane();

ControlHost.setLayout(new FlowLayout());

//Sample 02: Create Editor Pane

JEditorPane jep = new JEditorPane();

jep.setEnabled(true);

5. Scrolling Support

When the html document is big, the JEditorPane will not show the entire html content in it. We need to provide scrolling support for the editor pane. At line 2, we create a JScrollPane instance and set a preferred size for it. This helps in providing more container space (JFrame) for other controls. The call, setVerticalScrollBarPolicy tells we always need the vertical scrollbar. So even if the html document is small, Java Swing will display a vertical scrollbar without scroll thumb.

//Sample 03: Create Scroll Pane for the Editor
JScrollPane scroll = new JScrollPane(jep);
Dimension ScrollSize = new Dimension(570, 450);
scroll.setPreferredSize(ScrollSize);
scroll.setVerticalScrollBarPolicy(
    JScrollPane.VERTICAL_SCROLLBAR_ALWAYS);
ControlHost.add(scroll);

//Sample 03: Create Scroll Pane for the Editor

JScrollPane scroll = new JScrollPane(jep);

Dimension ScrollSize = new Dimension(570, 450);

scroll.setPreferredSize(ScrollSize);

scroll.setVerticalScrollBarPolicy(

JScrollPane.VERTICAL_SCROLLBAR_ALWAYS);

ControlHost.add(scroll);

6. JEditorPane – Set Html Document

At line 3, we make a call to getResource method to load out html document. The URL reference refers this html document and we name it HtmlPage. Next, at line 6, the setPage method of the JEditorPane takes this html document as a parameter and displays it as the pane content. Since it is an IO action, we must handle the IOException. Note, the Scrolling support provided in the past section enables scrolling of the html page inside the editor pane.

//Sample 04: Get URL of the HTML
//Run 02 Check how JScrollPane Displays
URL HtmlPage = JEditorPaneExample.class.getResource("Test.html");
try 
{
  jep.setPage(HtmlPage);
} 
catch (IOException e) 
{
  e.printStackTrace();
}

//Sample 04: Get URL of the HTML

//Run 02 Check how JScrollPane Displays

URL HtmlPage = JEditorPaneExample.class.getResource("Test.html");

try

{

jep.setPage(HtmlPage);

}

catch (IOException e)

{

e.printStackTrace();

}

7. Youtube Demo

8. Code Reference

8.1 MainEntry.java

package tube.coding.examples;
public class MainEntry {
  public static void main(String[] args) {
        //Sample 07: Create Instance of JFrameDemo
    JEditorPaneExample frame = 
        new JEditorPaneExample("JEditorPane and Html Example");
        frame.setVisible(true);    
  }
}

package tube.coding.examples;

public class MainEntry {

public static void main(String[] args) {

//Sample 07: Create Instance of JFrameDemo

JEditorPaneExample frame =

new JEditorPaneExample("JEditorPane and Html Example");

frame.setVisible(true);

}

8.2 JEditorPaneExample.java

package tube.coding.examples;

import java.awt.Container;
import java.awt.Dimension;
import java.awt.FlowLayout;
import java.awt.HeadlessException;
import java.awt.event.ItemEvent;
import java.awt.event.ItemListener;
import java.io.IOException;
import java.net.URL;

import javax.swing.ButtonGroup;
import javax.swing.JCheckBox;
import javax.swing.JEditorPane;
import javax.swing.JFrame;
import javax.swing.JOptionPane;
import javax.swing.JRadioButton;
import javax.swing.JScrollPane;
import javax.swing.JTextField;

public class JEditorPaneExample extends JFrame 
{
  public JEditorPaneExample(String title) throws HeadlessException 
  {
    super(title);
    //Sample 01: Set Size and Position
    setBounds(100, 100, 600, 500);
    Container ControlHost = getContentPane();
    ControlHost.setLayout(new FlowLayout());
    
    //Sample 02: Create Editor Pane
    JEditorPane jep = new JEditorPane();
    jep.setEnabled(true);
    
    //Sample 03: Create Scroll Pane for the Editor
    //Run 01 Check how JScrollPane Displays
    //Run 03 Change 500 to 100 & check Scrolling
    JScrollPane scroll = new JScrollPane(jep);
    Dimension ScrollSize = new Dimension(570, 450);
    scroll.setPreferredSize(ScrollSize);
    scroll.setVerticalScrollBarPolicy(
        JScrollPane.VERTICAL_SCROLLBAR_ALWAYS);
    ControlHost.add(scroll);
    
    //Sample 04: Get URL of the HTML
    //Run 02 Check how JScrollPane Displays
    URL HtmlPage = JEditorPaneExample.class.getResource("Test.html");
    try {
      jep.setPage(HtmlPage);
    } catch (IOException e) {
      e.printStackTrace();
    }
  }
}

package tube.coding.examples;

import java.awt.Container;

import java.awt.Dimension;

import java.awt.FlowLayout;

import java.awt.HeadlessException;

import java.awt.event.ItemEvent;

import java.awt.event.ItemListener;

import java.io.IOException;

import java.net.URL;

import javax.swing.ButtonGroup;

import javax.swing.JCheckBox;

import javax.swing.JEditorPane;

import javax.swing.JFrame;

import javax.swing.JOptionPane;

import javax.swing.JRadioButton;

import javax.swing.JScrollPane;

import javax.swing.JTextField;

public class JEditorPaneExample extends JFrame

{

public JEditorPaneExample(String title) throws HeadlessException

{

super(title);

//Sample 01: Set Size and Position

setBounds(100, 100, 600, 500);

Container ControlHost = getContentPane();

ControlHost.setLayout(new FlowLayout());

//Sample 02: Create Editor Pane

JEditorPane jep = new JEditorPane();

jep.setEnabled(true);

//Sample 03: Create Scroll Pane for the Editor

//Run 01 Check how JScrollPane Displays

//Run 03 Change 500 to 100 & check Scrolling

JScrollPane scroll = new JScrollPane(jep);

Dimension ScrollSize = new Dimension(570, 450);

scroll.setPreferredSize(ScrollSize);

scroll.setVerticalScrollBarPolicy(

JScrollPane.VERTICAL_SCROLLBAR_ALWAYS);

ControlHost.add(scroll);

//Sample 04: Get URL of the HTML

//Run 02 Check how JScrollPane Displays

URL HtmlPage = JEditorPaneExample.class.getResource("Test.html");

try {

jep.setPage(HtmlPage);

} catch (IOException e) {

e.printStackTrace();

}

Categories: Swing

Tags: getResource, JEditorPane, JScrollPane, setPage, URL

Do you like this Example? Please comment about it for others!! Cancel reply

This site uses Akismet to reduce spam. Learn how your comment data is processed.

Programming Examples

Are you a Programmer or Application Developer or a DBA? Take a cup of coffee, sit back and spend few minutes here :)

1. Introduction to JEditorPane

2. About The Example

3. Html Document for the Example

4. Create JEditorPane

5. Scrolling Support

6. JEditorPane – Set Html Document

7. Youtube Demo

8. Code Reference

8.1 MainEntry.java

8.2 JEditorPaneExample.java

Like this:

Related

Do you like this Example? Please comment about it for others!! Cancel reply

Programming Examples

Are you a Programmer or Application Developer or a DBA? Take a cup of coffee, sit back and spend few minutes here :)

JEditorPane and Html Document

1. Introduction to JEditorPane

2. About The Example

3. Html Document for the Example

4. Create JEditorPane

5. Scrolling Support

6. JEditorPane – Set Html Document

7. Youtube Demo

8. Code Reference

8.1 MainEntry.java

8.2 JEditorPaneExample.java

Share this:

Like this:

Related

Do you like this Example? Please comment about it for others!! Cancel reply