javax.swing

Class JEditorPane

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.text.JTextComponent

javax.swing.JEditorPane

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, Scrollable

Direct Known Subclasses:

JTextPane

public class JEditorPane
extends javax.swing.text.JTextComponent

A powerful text editor component that can handle different types of content. The JEditorPane text component is driven by an instance of EditorKit. The editor kit is responsible for providing a default Document implementation, a mechanism for loading and saving documents of its supported content type and providing a set of Actions for manipulating the content. By default the following content types are supported:

• text/plain: Plain text, handled by DefaultEditorKit.
• text/html: HTML 4.0 styled text, handled by HTMLEditorKit.
• text/rtf: RTF text, handled by javax.swing.text.rtf.RTFEditorKit.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	JEditorPane.AccessibleJEditorPane Provides accessibility support for JEditorPane.
protected class	JEditorPane.AccessibleJEditorPaneHTML Provides accessibility support for JEditorPanes, when the editor kit is an instance of HTMLEditorKit.
protected class	JEditorPane.JEditorPaneAccessibleHypertextSupport This is the accessible text that is returned by JEditorPane.AccessibleJEditorPaneHTML.getAccessibleText().

Nested classes/interfaces inherited from class javax.swing.text.JTextComponent

javax.swing.text.JTextComponent.AccessibleJTextComponent, javax.swing.text.JTextComponent.KeyBinding

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.text.JTextComponent

DEFAULT_KEYMAP, FOCUS_ACCELERATOR_KEY

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
JEditorPane()
JEditorPane(java.lang.String url)
JEditorPane(java.lang.String type, java.lang.String text)
JEditorPane(java.net.URL url)

Method Summary

Methods

Modifier and Type	Method and Description
void	addHyperlinkListener(javax.swing.event.HyperlinkListener listener) Add a HyperlinkListener object to this editor pane.
protected javax.swing.text.EditorKit	createDefaultEditorKit()
static javax.swing.text.EditorKit	createEditorKitForContentType(java.lang.String type) Creates and returns an EditorKit that is appropriate for the given content type.
void	fireHyperlinkUpdate(javax.swing.event.HyperlinkEvent event) Sends a given HyperlinkEvent to all registered listeners.
javax.accessibility.AccessibleContext	getAccessibleContext() Returns the accessible context associated with this editor pane.
java.lang.String	getContentType()
javax.swing.text.EditorKit	getEditorKit() Returns the EditorKit.
static java.lang.String	getEditorKitClassNameForContentType(java.lang.String type) Returns the class name of the EditorKit associated with the given content type.
javax.swing.text.EditorKit	getEditorKitForContentType(java.lang.String type) Returns the EditorKit to use for the given content type.
javax.swing.event.HyperlinkListener[]	getHyperlinkListeners() Returns all added HyperlinkListener objects.
java.net.URL	getPage()
java.awt.Dimension	getPreferredSize() Returns the preferred size for the JEditorPane.
boolean	getScrollableTracksViewportHeight() Returns true when a Viewport should force the height of this component to match the viewport height.
boolean	getScrollableTracksViewportWidth() Returns true when a Viewport should force the width of this component to match the viewport width.
protected java.io.InputStream	getStream(java.net.URL page)
java.lang.String	getText() Retrieves the current text in this text document.
java.lang.String	getUIClassID() Returns a string that specifies the name of the Look and Feel class that renders this component.
boolean	isFocusCycleRoot() Check whether this Container is a focus cycle root.
protected java.lang.String	paramString() Returns a string representation of this JTextComponent.
void	read(java.io.InputStream in, java.lang.Object desc) This method initializes from a stream.
static void	registerEditorKitForContentType(java.lang.String type, java.lang.String classname) Establishes a binding between type and classname.
static void	registerEditorKitForContentType(java.lang.String type, java.lang.String classname, java.lang.ClassLoader loader) Establishes the default bindings of type to classname.
void	removeHyperlinkListener(javax.swing.event.HyperlinkListener listener) Removes a HyperlinkListener object to this editor pane.
void	replaceSelection(java.lang.String content) Replaces the currently selected content with new content represented by the given string.
void	scrollToReference(java.lang.String reference) Scrolls the view to the given reference location (that is, the value returned by the UL.getRef method for the URL being displayed).
void	setContentType(java.lang.String type)
void	setEditorKit(javax.swing.text.EditorKit newValue)
void	setEditorKitForContentType(java.lang.String type, javax.swing.text.EditorKit k) Explicitly sets an EditorKit to be used for the given content type.
void	setPage(java.lang.String url) Sets the current URL being displayed.
void	setPage(java.net.URL page) Sets the current URL being displayed.
void	setText(java.lang.String t) Sets the text of the JEditorPane.

Methods inherited from class javax.swing.text.JTextComponent

addCaretListener, addInputMethodListener, addKeymap, copy, cut, fireCaretUpdate, getActions, getCaret, getCaretColor, getCaretListeners, getCaretPosition, getDisabledTextColor, getDocument, getDragEnabled, getFocusAccelerator, getHighlighter, getInputMethodListeners, getKeymap, getKeymap, getMargin, getNavigationFilter, getPreferredScrollableViewportSize, getScrollableBlockIncrement, getScrollableUnitIncrement, getSelectedText, getSelectedTextColor, getSelectionColor, getSelectionEnd, getSelectionStart, getText, getToolTipText, getUI, isEditable, loadKeymap, modelToView, moveCaretPosition, paste, read, removeCaretListener, removeInputMethodListener, removeKeymap, select, selectAll, setCaret, setCaretColor, setCaretPosition, setDisabledTextColor, setDocument, setDragEnabled, setEditable, setFocusAccelerator, setHighlighter, setKeymap, setMargin, setNavigationFilter, setSelectedTextColor, setSelectionColor, setSelectionEnd, setSelectionStart, setUI, updateUI, viewToModel, write

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setNextFocusableComponent, setOpaque, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

JEditorPane

public JEditorPane()

JEditorPane

public JEditorPane(java.lang.String url)
            throws java.io.IOException

Throws:

java.io.IOException

JEditorPane

public JEditorPane(java.lang.String type,
           java.lang.String text)

JEditorPane

public JEditorPane(java.net.URL url)
            throws java.io.IOException

Throws:

java.io.IOException

Method Detail

createDefaultEditorKit

protected javax.swing.text.EditorKit createDefaultEditorKit()

createEditorKitForContentType

public static javax.swing.text.EditorKit createEditorKitForContentType(java.lang.String type)

Creates and returns an EditorKit that is appropriate for the given content type. This is created using the default recognized types plus any EditorKit types that have been registered.

Parameters:

type - the content type

Returns:

an EditorKit for use with the given content type

See Also:

registerEditorKitForContentType(String, String), registerEditorKitForContentType(String, String, ClassLoader)

fireHyperlinkUpdate

public void fireHyperlinkUpdate(javax.swing.event.HyperlinkEvent event)

Sends a given HyperlinkEvent to all registered listeners.

Parameters:

event - the event to send

getAccessibleContext

public javax.accessibility.AccessibleContext getAccessibleContext()

Returns the accessible context associated with this editor pane.

Specified by:

getAccessibleContext in interface javax.accessibility.Accessible

Overrides:

getAccessibleContext in class javax.swing.text.JTextComponent

Returns:

the accessible context associated with this editor pane

getContentType

public final java.lang.String getContentType()

getEditorKit

public javax.swing.text.EditorKit getEditorKit()

Returns the EditorKit. If there is no EditorKit set this method calls createDefaultEditorKit() and setEditorKit() first.

getEditorKitClassNameForContentType

public static java.lang.String getEditorKitClassNameForContentType(java.lang.String type)

Returns the class name of the EditorKit associated with the given content type.

Parameters:

type - the content type

Returns:

the class name of the EditorKit associated with this content type

Since:

1.3

getEditorKitForContentType

public javax.swing.text.EditorKit getEditorKitForContentType(java.lang.String type)

Returns the EditorKit to use for the given content type. If an EditorKit has been explicitly set via setEditorKitForContentType then it will be returned. Otherwise an attempt will be made to create an EditorKit from the default recognzied content types or any EditorKits that have been registered. If none can be created, a PlainEditorKit is created.

Parameters:

type - the content type

Returns:

an appropriate EditorKit for the given content type

See Also:

registerEditorKitForContentType(String, String), registerEditorKitForContentType(String, String, ClassLoader)

getPreferredSize

public java.awt.Dimension getPreferredSize()

Returns the preferred size for the JEditorPane. This is implemented to return the super's preferred size, unless one of getScrollableTracksViewportHeight() or getScrollableTracksViewportWidth() returns true, in which case the preferred width and/or height is replaced by the UI's minimum size.

Overrides:

getPreferredSize in class JComponent

Returns:

the preferred size for the JEditorPane

See Also:

Component.setPreferredSize(java.awt.Dimension), Component.getPreferredSize(), Component.isPreferredSizeSet(), ComponentUI.getPreferredSize(JComponent)

getScrollableTracksViewportHeight

public boolean getScrollableTracksViewportHeight()

Returns true when a Viewport should force the height of this component to match the viewport height. This is implemented to return true when the parent is an instance of JViewport and the viewport height > the UI's minimum height.

Specified by:

getScrollableTracksViewportHeight in interface Scrollable

Overrides:

getScrollableTracksViewportHeight in class javax.swing.text.JTextComponent

Returns:

true when a Viewport should force the height of this component to match the viewport height

getScrollableTracksViewportWidth

public boolean getScrollableTracksViewportWidth()

Returns true when a Viewport should force the width of this component to match the viewport width. This is implemented to return true when the parent is an instance of JViewport and the viewport width > the UI's minimum width.

Specified by:

getScrollableTracksViewportWidth in interface Scrollable

Overrides:

getScrollableTracksViewportWidth in class javax.swing.text.JTextComponent

Returns:

true when a Viewport should force the width of this component to match the viewport width

getPage

public java.net.URL getPage()

getStream

protected java.io.InputStream getStream(java.net.URL page)
                                 throws java.io.IOException

Throws:

java.io.IOException

getText

public java.lang.String getText()

Description copied from class: javax.swing.text.JTextComponent

Retrieves the current text in this text document.

Overrides:

getText in class javax.swing.text.JTextComponent

Returns:

the text

getUIClassID

public java.lang.String getUIClassID()

Description copied from class: javax.swing.text.JTextComponent

Returns a string that specifies the name of the Look and Feel class that renders this component.

Overrides:

getUIClassID in class javax.swing.text.JTextComponent

Returns:

the string "TextComponentUI"

See Also:

JComponent.setUI(javax.swing.plaf.ComponentUI), JComponent.updateUI()

isFocusCycleRoot

public boolean isFocusCycleRoot()

Description copied from class: java.awt.Container

Check whether this Container is a focus cycle root.

Overrides:

isFocusCycleRoot in class java.awt.Container

Returns:

true if this is a focus cycle root, false otherwise

paramString

protected java.lang.String paramString()

Description copied from class: javax.swing.text.JTextComponent

Returns a string representation of this JTextComponent.

Overrides:

paramString in class javax.swing.text.JTextComponent

Returns:

A string describing this component.

read

public void read(java.io.InputStream in,
        java.lang.Object desc)
          throws java.io.IOException

This method initializes from a stream.

Throws:

java.io.IOException

registerEditorKitForContentType

public static void registerEditorKitForContentType(java.lang.String type,
                                   java.lang.String classname)

Establishes a binding between type and classname. This enables us to create an EditorKit later for the given content type.

Parameters:

type - the content type

classname - the name of the class that is associated with this content type

registerEditorKitForContentType

public static void registerEditorKitForContentType(java.lang.String type,
                                   java.lang.String classname,
                                   java.lang.ClassLoader loader)

Establishes the default bindings of type to classname.

replaceSelection

public void replaceSelection(java.lang.String content)

Replaces the currently selected content with new content represented by the given string.

Overrides:

replaceSelection in class javax.swing.text.JTextComponent

scrollToReference

public void scrollToReference(java.lang.String reference)

Scrolls the view to the given reference location (that is, the value returned by the UL.getRef method for the URL being displayed).

setContentType

public final void setContentType(java.lang.String type)

setEditorKit

public void setEditorKit(javax.swing.text.EditorKit newValue)

setEditorKitForContentType

public void setEditorKitForContentType(java.lang.String type,
                              javax.swing.text.EditorKit k)

Explicitly sets an EditorKit to be used for the given content type.

Parameters:

type - the content type

k - the EditorKit to use for the given content type

setPage

public void setPage(java.lang.String url)
             throws java.io.IOException

Sets the current URL being displayed.

Throws:

java.io.IOException

setPage

public void setPage(java.net.URL page)
             throws java.io.IOException

Sets the current URL being displayed.

Throws:

java.io.IOException

setText

public void setText(java.lang.String t)

Sets the text of the JEditorPane. The argument t is expected to be in the format of the current EditorKit. This removes the content of the current document and uses the EditorKit to read in the new text. This allows the EditorKit to handle the String rather than just inserting in plain text.

Overrides:

setText in class javax.swing.text.JTextComponent

Parameters:

t - the text to display in this JEditorPane

addHyperlinkListener

public void addHyperlinkListener(javax.swing.event.HyperlinkListener listener)

Add a HyperlinkListener object to this editor pane.

Parameters:

listener - the listener to add

removeHyperlinkListener

public void removeHyperlinkListener(javax.swing.event.HyperlinkListener listener)

Removes a HyperlinkListener object to this editor pane.

Parameters:

listener - the listener to remove

getHyperlinkListeners

public javax.swing.event.HyperlinkListener[] getHyperlinkListeners()

Returns all added HyperlinkListener objects.

Returns:

array of listeners

Since:

1.4