public 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 Action
s 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
.Modifier and Type | Class and Description |
---|---|
protected class |
JEditorPane.AccessibleJEditorPane
Provides accessibility support for
JEditorPane . |
protected class |
JEditorPane.AccessibleJEditorPaneHTML
Provides accessibility support for
JEditorPane s, 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() . |
JTextComponent.AccessibleJTextComponent, JTextComponent.KeyBinding
JComponent.AccessibleJComponent
Container.AccessibleAWTContainer
Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy
DEFAULT_KEYMAP, FOCUS_ACCELERATOR_KEY
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
Constructor and Description |
---|
JEditorPane() |
JEditorPane(String url) |
JEditorPane(String type,
String text) |
JEditorPane(URL url) |
Modifier and Type | Method and Description |
---|---|
void |
addHyperlinkListener(HyperlinkListener listener)
Add a
HyperlinkListener object to this editor pane. |
protected EditorKit |
createDefaultEditorKit() |
static EditorKit |
createEditorKitForContentType(String type)
Creates and returns an EditorKit that is appropriate for the given
content type.
|
void |
fireHyperlinkUpdate(HyperlinkEvent event)
Sends a given
HyperlinkEvent to all registered listeners. |
AccessibleContext |
getAccessibleContext()
Returns the accessible context associated with this editor pane.
|
String |
getContentType() |
EditorKit |
getEditorKit()
Returns the EditorKit.
|
static String |
getEditorKitClassNameForContentType(String type)
Returns the class name of the EditorKit associated with the given
content type.
|
EditorKit |
getEditorKitForContentType(String type)
Returns the EditorKit to use for the given content type.
|
HyperlinkListener[] |
getHyperlinkListeners()
Returns all added
HyperlinkListener objects. |
URL |
getPage() |
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 InputStream |
getStream(URL page) |
String |
getText()
Retrieves the current text in this text document.
|
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 String |
paramString()
Returns a string representation of this JTextComponent.
|
void |
read(InputStream in,
Object desc)
This method initializes from a stream.
|
static void |
registerEditorKitForContentType(String type,
String classname)
Establishes a binding between type and classname.
|
static void |
registerEditorKitForContentType(String type,
String classname,
ClassLoader loader)
Establishes the default bindings of type to classname.
|
void |
removeHyperlinkListener(HyperlinkListener listener)
Removes a
HyperlinkListener object to this editor pane. |
void |
replaceSelection(String content)
Replaces the currently selected content with new content represented
by the given string.
|
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).
|
void |
setContentType(String type) |
void |
setEditorKit(EditorKit newValue) |
void |
setEditorKitForContentType(String type,
EditorKit k)
Explicitly sets an EditorKit to be used for the given content type.
|
void |
setPage(String url)
Sets the current URL being displayed.
|
void |
setPage(URL page)
Sets the current URL being displayed.
|
void |
setText(String t)
Sets the text of the JEditorPane.
|
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
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
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
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
public JEditorPane()
public JEditorPane(String url) throws IOException
IOException
public JEditorPane(String type, String text)
public JEditorPane(URL url) throws IOException
IOException
protected EditorKit createDefaultEditorKit()
public static EditorKit createEditorKitForContentType(String type)
type
- the content typeregisterEditorKitForContentType(String, String)
,
registerEditorKitForContentType(String, String, ClassLoader)
public void fireHyperlinkUpdate(HyperlinkEvent event)
HyperlinkEvent
to all registered listeners.event
- the event to sendpublic AccessibleContext getAccessibleContext()
getAccessibleContext
in interface Accessible
getAccessibleContext
in class JTextComponent
public final String getContentType()
public EditorKit getEditorKit()
public static String getEditorKitClassNameForContentType(String type)
type
- the content typepublic EditorKit getEditorKitForContentType(String type)
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.type
- the content typeregisterEditorKitForContentType(String, String)
,
registerEditorKitForContentType(String, String, ClassLoader)
public Dimension getPreferredSize()
getScrollableTracksViewportHeight()
or
getScrollableTracksViewportWidth()
returns true
,
in which case the preferred width and/or height is replaced by the UI's
minimum size.getPreferredSize
in class JComponent
Component.setPreferredSize(java.awt.Dimension)
,
Component.getPreferredSize()
,
Component.isPreferredSizeSet()
,
ComponentUI.getPreferredSize(JComponent)
public boolean getScrollableTracksViewportHeight()
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.getScrollableTracksViewportHeight
in interface Scrollable
getScrollableTracksViewportHeight
in class JTextComponent
true
when a Viewport should force the height of
this component to match the viewport heightpublic boolean getScrollableTracksViewportWidth()
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.getScrollableTracksViewportWidth
in interface Scrollable
getScrollableTracksViewportWidth
in class JTextComponent
true
when a Viewport should force the width of
this component to match the viewport widthprotected InputStream getStream(URL page) throws IOException
IOException
public String getText()
JTextComponent
getText
in class JTextComponent
public String getUIClassID()
JTextComponent
getUIClassID
in class JTextComponent
JComponent.setUI(javax.swing.plaf.ComponentUI)
,
JComponent.updateUI()
public boolean isFocusCycleRoot()
Container
isFocusCycleRoot
in class Container
protected String paramString()
JTextComponent
paramString
in class JTextComponent
public void read(InputStream in, Object desc) throws IOException
IOException
public static void registerEditorKitForContentType(String type, String classname)
type
- the content typeclassname
- the name of the class that is associated with this
content typepublic static void registerEditorKitForContentType(String type, String classname, ClassLoader loader)
public void replaceSelection(String content)
replaceSelection
in class JTextComponent
public void scrollToReference(String reference)
public final void setContentType(String type)
public void setEditorKit(EditorKit newValue)
public void setEditorKitForContentType(String type, EditorKit k)
type
- the content typek
- the EditorKit to use for the given content typepublic void setPage(String url) throws IOException
IOException
public void setPage(URL page) throws IOException
IOException
public void setText(String t)
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.setText
in class JTextComponent
t
- the text to display in this JEditorPanepublic void addHyperlinkListener(HyperlinkListener listener)
HyperlinkListener
object to this editor pane.listener
- the listener to addpublic void removeHyperlinkListener(HyperlinkListener listener)
HyperlinkListener
object to this editor pane.listener
- the listener to removepublic HyperlinkListener[] getHyperlinkListeners()
HyperlinkListener
objects.