java.lang.Object java.awt.Component java.awt.Container javax.swing.JComponent javax.swing.text.JTextComponent javax.swing.JEditorPanepublic class JEditorPane extends JTextComponent 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
RTFEditorKit.protected class JEditorPane.AccessibleJEditorPane JEditorPane.
protected class JEditorPane.AccessibleJEditorPaneHTML JEditorPanes, when the
editor kit is an instance of HTMLEditorKit.
protected class JEditorPane.JEditorPaneAccessibleHypertextSupport JEditorPane.AccessibleJEditorPaneHTML.getAccessibleText().
JEditorPane(String url)JEditorPane(String type, String text)JEditorPane(URL url) void addHyperlinkListener(HyperlinkListener listener)HyperlinkListener object to this editor pane.
protected EditorKit static EditorKit createEditorKitForContentType(String type) void fireHyperlinkUpdate(HyperlinkEvent event)HyperlinkEvent to all registered listeners.
AccessibleContext getAccessibleContext() EditorKit getEditorKit()static String getEditorKitClassNameForContentType(String type) EditorKit getEditorKitForContentType(String type) HyperlinkListener[] getHyperlinkListeners()HyperlinkListener objects.
Dimension getPreferredSize() boolean getScrollableTracksViewportHeight()true when a Viewport should force the height of
this component to match the viewport height. boolean getScrollableTracksViewportWidth()true when a Viewport should force the width of
this component to match the viewport width. protected InputStream boolean protected String void read(InputStream in, Object desc)static void registerEditorKitForContentType(String type, String classname)static void registerEditorKitForContentType(String type, String classname, ClassLoader loader) void removeHyperlinkListener(HyperlinkListener listener)HyperlinkListener object to this editor pane.
void replaceSelection(String content) void scrollToReference(String reference) void setContentType(String type) void setEditorKit(EditorKit newValue) void setEditorKitForContentType(String type, EditorKit k)addCaretListener, addInputMethodListener, addKeymap, copy, cut, fireCaretUpdate, getAccessibleContext, getActions, getCaret, getCaretColor, getCaretListeners, getCaretPosition, getDisabledTextColor, getDocument, getDragEnabled, getFocusAccelerator, getHighlighter, getInputMethodListeners, getKeymap, getKeymap, getMargin, getNavigationFilter, getPreferredScrollableViewportSize, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getSelectedText, getSelectedTextColor, getSelectionColor, getSelectionEnd, getSelectionStart, getText, getText, getToolTipText, getUI, getUIClassID, isEditable, loadKeymap, modelToView, moveCaretPosition, paramString, paste, read, removeCaretListener, removeInputMethodListener, removeKeymap, replaceSelection, select, selectAll, setCaret, setCaretColor, setCaretPosition, setDisabledTextColor, setDocument, setDragEnabled, setEditable, setFocusAccelerator, setHighlighter, setKeymap, setMargin, setNavigationFilter, setSelectedTextColor, setSelectionColor, setSelectionEnd, setSelectionStart, setText, setUI, updateUI, viewToModel, write addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, extends EventListener> T[] getListeners, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, 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, updateUI add, add, add, add, add, addContainerListener, addImpl, addNotify, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, extends EventListener> T[] getListeners, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponentZOrder, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, paramString, preferredSize, print, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, removeNotify, setComponentZOrder, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, setLayout, transferFocusDownCycle, update, validate, validateTree action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, enableInputMethods, extends EventListener> T[] getListeners, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, getAlignmentX, getAlignmentY, getBackground, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeys, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMinimumSize, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusCycleRoot, isFocusOwner, isFocusTraversable, isFocusable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paint, paintAll, paramString, postEvent, preferredSize, prepareImage, prepareImage, print, printAll, processComponentEvent, processEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusTraversalKeys, setFocusTraversalKeysEnabled, setFocusable, setFont, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle, update, validate public JEditorPane()
public JEditorPane(String url) throws IOException
public JEditorPane(String type, String text)
public JEditorPane(URL url) throws IOException
public void addHyperlinkListener(HyperlinkListener listener)
Add aHyperlinkListenerobject to this editor pane.
- Parameters:
listener- the listener to add
protected EditorKit createDefaultEditorKit()
public static EditorKit createEditorKitForContentType(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
public void fireHyperlinkUpdate(HyperlinkEvent event)
Sends a givenHyperlinkEventto all registered listeners.
- Parameters:
event- the event to send
public AccessibleContext getAccessibleContext()
Returns the accessible context associated with this editor pane.
- Specified by:
- getAccessibleContext in interface Accessible
- Overrides:
- getAccessibleContext in interface JTextComponent
- Returns:
- the accessible context associated with this editor pane
public final String getContentType()
public EditorKit getEditorKit()
Returns the EditorKit. If there is no EditorKit set this method calls createDefaultEditorKit() and setEditorKit() first.
public static String getEditorKitClassNameForContentType(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
public EditorKit getEditorKitForContentType(String type)
Returns the EditorKit to use for the given content type. If an EditorKit has been explicitly set viasetEditorKitForContentTypethen 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
public HyperlinkListener[] getHyperlinkListeners()
Returns all addedHyperlinkListenerobjects.
- Returns:
- array of listeners
- Since:
- 1.4
public Dimension getPreferredSize()
Returns the preferred size for the JEditorPane. This is implemented to return the super's preferred size, unless one ofgetScrollableTracksViewportHeight()orgetScrollableTracksViewportWidth()returnstrue, in which case the preferred width and/or height is replaced by the UI's minimum size.
- Overrides:
- getPreferredSize in interface JComponent
- Returns:
- the preferred size for the JEditorPane
public boolean getScrollableTracksViewportHeight()
Returnstruewhen a Viewport should force the height of this component to match the viewport height. This is implemented to returntruewhen 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 interface JTextComponent
- Returns:
truewhen a Viewport should force the height of this component to match the viewport height
public boolean getScrollableTracksViewportWidth()
Returnstruewhen a Viewport should force the width of this component to match the viewport width. This is implemented to returntruewhen 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 interface JTextComponent
- Returns:
truewhen a Viewport should force the width of this component to match the viewport width
protected InputStream getStream(URL page) throws IOException
public void read(InputStream in, Object desc) throws IOException
This method initializes from a stream.
public static void registerEditorKitForContentType(String type, 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 typeclassname- the name of the class that is associated with this content type
public static void registerEditorKitForContentType(String type, String classname, ClassLoader loader)
Establishes the default bindings of type to classname.
public void removeHyperlinkListener(HyperlinkListener listener)
Removes aHyperlinkListenerobject to this editor pane.
- Parameters:
listener- the listener to remove
public void replaceSelection(String content)
Replaces the currently selected content with new content represented by the given string.
- Overrides:
- replaceSelection in interface JTextComponent
public void scrollToReference(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).
public final void setContentType(String type)
public void setEditorKit(EditorKit newValue)
public void setEditorKitForContentType(String type, EditorKit k)
Explicitly sets an EditorKit to be used for the given content type.
- Parameters:
type- the content typek- the EditorKit to use for the given content type
public void setText(String t)
Sets the text of the JEditorPane. The argumenttis 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 interface JTextComponent
- Parameters:
t- the text to display in this JEditorPane