ImageObserver
, MenuContainer
, Serializable
, Accessible
, Scrollable
JTextPane
@JavaBean(defaultProperty="UIClassID", description="A text component to edit various types of content.") public class JEditorPane extends JTextComponent
This component uses implementations of the EditorKit
to accomplish its behavior. It effectively morphs into the proper kind of text editor for the kind of content it is given. The content type that editor is bound to at any given time is determined by the EditorKit
currently installed. If the content is set to a new URL, its type is used to determine the EditorKit
that should be used to load the content.
By default, the following types of content are known:
DefaultEditorKit
that produces a wrapped plain text view. javax.swing.text.html.HTMLEditorKit
which provides HTML 3.2 support. javax.swing.text.rtf.RTFEditorKit
which provides a limited support of the Rich Text Format. There are several ways to load content into this component.
setText
method can be used to initialize the component from a string. In this case the current EditorKit
will be used, and the content type will be expected to be of this type. read
method can be used to initialize the component from a Reader
. Note that if the content type is HTML, relative references (e.g. for things like images) can't be resolved unless the <base> tag is used or the Base property on HTMLDocument
is set. In this case the current EditorKit
will be used, and the content type will be expected to be of this type. setPage
method can be used to initialize the component from a URL. In this case, the content type will be determined from the URL, and the registered EditorKit
for that content type will be set. Some kinds of content may provide hyperlink support by generating hyperlink events. The HTML EditorKit
will generate hyperlink events if the JEditorPane
is not editable (JEditorPane.setEditable(false);
has been called). If HTML frames are embedded in the document, the typical response would be to change a portion of the current document. The following code fragment is a possible hyperlink listener implementation, that treats HTML frame events specially, and simply displays any other activated hyperlinks.
class Hyperactive implements HyperlinkListener { public void hyperlinkUpdate(HyperlinkEvent e) { if (e.getEventType() == HyperlinkEvent.EventType.ACTIVATED) { JEditorPane pane = (JEditorPane) e.getSource(); if (e instanceof HTMLFrameHyperlinkEvent) { HTMLFrameHyperlinkEvent evt = (HTMLFrameHyperlinkEvent)e; HTMLDocument doc = (HTMLDocument)pane.getDocument(); doc.processHTMLFrameHyperlinkEvent(evt); } else { try { pane.setPage(e.getURL()); } catch (Throwable t) { t.printStackTrace(); } } } } }
For information on customizing how text/html is rendered please see W3C_LENGTH_UNITS
and HONOR_DISPLAY_PROPERTIES
Culturally dependent information in some documents is handled through a mechanism called character encoding. Character encoding is an unambiguous mapping of the members of a character set (letters, ideographs, digits, symbols, or control functions) to specific numeric code values. It represents the way the file is stored. Example character encodings are ISO-8859-1, ISO-8859-5, Shift-jis, Euc-jp, and UTF-8. When the file is passed to an user agent (JEditorPane
) it is converted to the document character set (ISO-10646 aka Unicode).
There are multiple ways to get a character set mapping to happen with JEditorPane
.
setContentType
method. If the content is loaded by the setPage
method the content type will have been set according to the specification of the URL. It the file is loaded directly, the content type would be expected to have been set prior to loading. EditorKit
.read operation throw a ChangedCharSetException
which will be caught. The read is then restarted with a new Reader that uses the character set specified in the ChangedCharSetException
(which is an IOException
). Warning: Swing is not thread safe. For more information see Swing's Threading Policy.
Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeans has been added to the java.beans
package. Please see XMLEncoder
.
Modifier and Type | Class | Description |
---|---|---|
protected class |
JEditorPane.AccessibleJEditorPane |
This class implements accessibility support for the JEditorPane class. |
protected class |
JEditorPane.AccessibleJEditorPaneHTML |
This class provides support for AccessibleHypertext , and is used in instances where the EditorKit installed in this JEditorPane is an instance of HTMLEditorKit . |
protected class |
JEditorPane.JEditorPaneAccessibleHypertextSupport |
What's returned by AccessibleJEditorPaneHTML.getAccessibleText . |
JTextComponent.AccessibleJTextComponent, JTextComponent.DropLocation, JTextComponent.KeyBinding
JComponent.AccessibleJComponent
Container.AccessibleAWTContainer
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
Modifier and Type | Field | Description |
---|---|---|
static final String |
HONOR_DISPLAY_PROPERTIES |
Key for a client property used to indicate whether the default font and foreground color from the component are used if a font or foreground color is not specified in the styled text. |
static final String |
W3C_LENGTH_UNITS |
Key for a client property used to indicate whether w3c compliant length units are used for html rendering. |
DEFAULT_KEYMAP, FOCUS_ACCELERATOR_KEY
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
Constructor | Description |
---|---|
JEditorPane() |
Creates a new JEditorPane . |
JEditorPane |
Creates a JEditorPane based on a string containing a URL specification. |
JEditorPane |
Creates a JEditorPane that has been initialized to the given text. |
JEditorPane |
Creates a JEditorPane based on a specified URL for input. |
Modifier and Type | Method | Description |
---|---|---|
void |
addHyperlinkListener |
Adds a hyperlink listener for notification of any changes, for example when a link is selected and entered. |
protected EditorKit |
createDefaultEditorKit() |
Creates the default editor kit ( PlainEditorKit ) for when the component is first created. |
static EditorKit |
createEditorKitForContentType |
Creates a handler for the given type from the default registry of editor kits. |
void |
fireHyperlinkUpdate |
Notifies all listeners that have registered interest for notification on this event type. |
AccessibleContext |
getAccessibleContext() |
Gets the AccessibleContext associated with this JEditorPane. |
final String |
getContentType() |
Gets the type of content that this editor is currently set to deal with. |
EditorKit |
getEditorKit() |
Fetches the currently installed kit for handling content. |
static String |
getEditorKitClassNameForContentType |
Returns the currently registered EditorKit class name for the type type . |
EditorKit |
getEditorKitForContentType |
Fetches the editor kit to use for the given type of content. |
HyperlinkListener[] |
getHyperlinkListeners() |
Returns an array of all the HyperLinkListener s added to this JEditorPane with addHyperlinkListener(). |
URL |
getPage() |
Gets the current URL being displayed. |
Dimension |
getPreferredSize() |
Returns the preferred size for the JEditorPane . |
boolean |
getScrollableTracksViewportHeight() |
Returns true if a viewport should always force the height of this Scrollable to match the height of the viewport. |
boolean |
getScrollableTracksViewportWidth() |
Returns true if a viewport should always force the width of this Scrollable to match the width of the viewport. |
protected InputStream |
getStream |
Fetches a stream for the given URL, which is about to be loaded by the setPage method. |
String |
getText() |
Returns the text contained in this TextComponent in terms of the content type of this editor. |
String |
getUIClassID() |
Gets the class ID for the UI. |
protected String |
paramString() |
Returns a string representation of this JEditorPane . |
void |
read |
This method initializes from a stream. |
static void |
registerEditorKitForContentType |
Establishes the default bindings of type to classname . |
static void |
registerEditorKitForContentType |
Establishes the default bindings of type to classname . |
void |
removeHyperlinkListener |
Removes a hyperlink listener. |
void |
replaceSelection |
Replaces the currently selected content with new content represented by the given string. |
void |
scrollToReference |
Scrolls the view to the given reference location (that is, the value returned by the URL.getRef method for the URL being displayed). |
final void |
setContentType |
Sets the type of content that this editor handles. |
void |
setEditorKit |
Sets the currently installed kit for handling content. |
void |
setEditorKitForContentType |
Directly sets the editor kit to use for the given type. |
void |
setPage |
Sets the current URL being displayed. |
void |
setPage |
Sets the current URL being displayed. |
void |
setText |
Sets the text of this TextComponent to the specified content, which is expected to be in the format of the content type of this editor. |
addCaretListener, addKeymap, copy, cut, fireCaretUpdate, getActions, getCaret, getCaretColor, getCaretListeners, getCaretPosition, getDisabledTextColor, getDocument, getDragEnabled, getDropLocation, getDropMode, getFocusAccelerator, getHighlighter, getInputMethodRequests, getKeymap, getKeymap, getMargin, getNavigationFilter, getPreferredScrollableViewportSize, getPrintable, getScrollableBlockIncrement, getScrollableUnitIncrement, getSelectedText, getSelectedTextColor, getSelectionColor, getSelectionEnd, getSelectionStart, getText, getToolTipText, getUI, isEditable, loadKeymap, modelToView, modelToView2D, moveCaretPosition, paste, print, print, print, read, removeCaretListener, removeKeymap, restoreComposedText, saveComposedText, select, selectAll, setCaret, setCaretColor, setCaretPosition, setDisabledTextColor, setDocument, setDragEnabled, setDropMode, setEditable, setFocusAccelerator, setHighlighter, setKeymap, setMargin, setNavigationFilter, setSelectedTextColor, setSelectionColor, setSelectionEnd, setSelectionStart, setUI, updateUI, viewToModel, viewToModel2D, write
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, 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, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, 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, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, 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, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, 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, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
public static final String W3C_LENGTH_UNITS
By default this is not enabled; to enable it set the client property
with this name to Boolean.TRUE
.
public static final String HONOR_DISPLAY_PROPERTIES
The default varies based on the look and feel; to enable it set the client property
with this name to Boolean.TRUE
.
public JEditorPane()
JEditorPane
. The document model is set to null
.public JEditorPane(URL initialPage) throws IOException
JEditorPane
based on a specified URL for input.initialPage
- the URLIOException
- if the URL is null
or cannot be accessedpublic JEditorPane(String url) throws IOException
JEditorPane
based on a string containing a URL specification.url
- the URLIOException
- if the URL is null
or cannot be accessedpublic JEditorPane(String type, String text)
JEditorPane
that has been initialized to the given text. This is a convenience constructor that calls the setContentType
and setText
methods.type
- mime type of the given texttext
- the text to initialize with; may be null
NullPointerException
- if the type
parameter is null
public void addHyperlinkListener(HyperlinkListener listener)
listener
- the listenerpublic void removeHyperlinkListener(HyperlinkListener listener)
listener
- the listener@BeanProperty(bound=false) public HyperlinkListener[] getHyperlinkListeners()
HyperLinkListener
s added to this JEditorPane with addHyperlinkListener().HyperLinkListener
s added or an empty array if no listeners have been addedpublic void fireHyperlinkUpdate(HyperlinkEvent e)
EditorKit
if a content type that supports hyperlinks is currently active and there was activity with a link. The listener list is processed last to first.e
- the event@BeanProperty(expert=true, description="the URL used to set content") public void setPage(URL page) throws IOException
null
, then a new default document is created and the URL is read into it. If the URL contains and reference location, the location will be scrolled to by calling the scrollToReference
method. If the desired URL is the one currently being displayed, the document will not be reloaded. To force a document reload it is necessary to clear the stream description property of the document. The following code shows how this can be done: Document doc = jEditorPane.getDocument(); doc.putProperty(Document.StreamDescriptionProperty, null);If the desired URL is not the one currently being displayed, the
getStream
method is called to give subclasses control over the stream provided. This may load either synchronously or asynchronously depending upon the document returned by the EditorKit
. If the Document
is of type AbstractDocument
and has a value returned by AbstractDocument.getAsynchronousLoadPriority
that is greater than or equal to zero, the page will be loaded on a separate thread using that priority.
If the document is loaded synchronously, it will be filled in with the stream prior to being installed into the editor with a call to setDocument
, which is bound and will fire a property change event. If an IOException
is thrown the partially loaded document will be discarded and neither the document or page property change events will be fired. If the document is successfully loaded and installed, a view will be built for it by the UI which will then be scrolled if necessary, and then the page property change event will be fired.
If the document is loaded asynchronously, the document will be installed into the editor immediately using a call to setDocument
which will fire a document property change event, then a thread will be created which will begin doing the actual loading. In this case, the page property change event will not be fired by the call to this method directly, but rather will be fired when the thread doing the loading has finished. It will also be fired on the event-dispatch thread. Since the calling thread can not throw an IOException
in the event of failure on the other thread, the page property change event will be fired when the other thread is done whether the load was successful or not.
page
- the URL of the pageIOException
- for a null
or invalid page specification, or exception from the stream being readpublic void read(InputStream in, Object desc) throws IOException
HTMLEditorKit
, and the desc
parameter is an HTMLDocument
, then it invokes the HTMLEditorKit
to initiate the read. Otherwise it calls the superclass method which loads the model as plain text.in
- the stream from which to readdesc
- an object describing the streamIOException
- as thrown by the stream being used to initializeprotected InputStream getStream(URL page) throws IOException
setPage
method. By default, this simply opens the URL and returns the stream. This can be reimplemented to do useful things like fetch the stream from a cache, monitor the progress of the stream, etc. This method is expected to have the side effect of establishing the content type, and therefore setting the appropriate EditorKit
to use for loading the stream.
If this the stream was an http connection, redirects will be followed and the resulting URL will be set as the Document.StreamDescriptionProperty
so that relative URL's can be properly resolved.
page
- the URL of the pageIOException
- if an I/O problem occurspublic void scrollToReference(String reference)
URL.getRef
method for the URL being displayed). By default, this method only knows how to locate a reference in an HTMLDocument. The implementation calls the scrollRectToVisible
method to accomplish the actual scrolling. If scrolling to a reference location is needed for document types other than HTML, this method should be reimplemented. This method will have no effect if the component is not visible.reference
- the named location to scroll topublic URL getPage()
null
, and relative URL's will not be resolved.null
if nonepublic void setPage(String url) throws IOException
url
- the URL for displayIOException
- for a null
or invalid URL specification@BeanProperty(bound=false) public String getUIClassID()
getUIClassID
in class JComponent
protected EditorKit createDefaultEditorKit()
PlainEditorKit
) for when the component is first created.public EditorKit getEditorKit()
createDefaultEditorKit
is called to set up a default if necessary.public final String getContentType()
EditorKit
.null
if no editor kit set@BeanProperty(bound=false, description="the type of content") public final void setContentType(String type)
getEditorKitForContentType
, and then setEditorKit
if an editor kit can be successfully located. This is mostly convenience method that can be used as an alternative to calling setEditorKit
directly. If there is a charset definition specified as a parameter of the content type specification, it will be used when loading input streams using the associated EditorKit
. For example if the type is specified as text/html; charset=EUC-JP
the content will be loaded using the EditorKit
registered for text/html
and the Reader provided to the EditorKit
to load unicode into the document will use the EUC-JP
charset for translating to unicode. If the type is not recognized, the content will be loaded using the EditorKit
registered for plain text, text/plain
.
type
- the non-null
mime type for the content editing supportNullPointerException
- if the type
parameter is null
@BeanProperty(expert=true, description="the currently installed kit for handling content") public void setEditorKit(EditorKit kit)
null
, the new kit is installed, and a default document created for it. A PropertyChange
event ("editorKit") is always fired when setEditorKit
is called. NOTE: This has the side effect of changing the model, because the EditorKit
is the source of how a particular type of content is modeled. This method will cause setDocument
to be called on behalf of the caller to ensure integrity of the internal state.
kit
- the desired editor behaviorpublic EditorKit getEditorKitForContentType(String type)
EditorKit
registered for the given type, it will try to create an EditorKit
from the default EditorKit
registry. If that fails, a PlainEditorKit
is used on the assumption that all text documents can be represented as plain text. This method can be reimplemented to use some other kind of type registry. This can be reimplemented to use the Java Activation Framework, for example.
type
- the non-null
content typepublic void setEditorKitForContentType(String type, EditorKit k)
createEditorKitForContentType
to install handlers for content types with a look-and-feel bias.type
- the non-null
content typek
- the editor kit to be setpublic void replaceSelection(String content)
null
) this amounts to a removal of the current selection. The replacement text will have the attributes currently defined for input. If the component is not editable, beep and return.replaceSelection
in class JTextComponent
content
- the content to replace the selection with. This value can be null
public static EditorKit createEditorKitForContentType(String type)
ClassLoader
, that ClassLoader
will be used to load the prototype. If there was no registered ClassLoader
, Class.forName
will be used to load the prototype. Once a prototype EditorKit
instance is successfully located, it is cloned and the clone is returned.
type
- the content typenull
if there is nothing registered for the given typepublic static void registerEditorKitForContentType(String type, String classname)
type
to classname
. The class will be dynamically loaded later when actually needed, and can be safely changed before attempted uses to avoid loading unwanted classes. The prototype EditorKit
will be loaded with Class.forName
when registered with this method.type
- the non-null
content typeclassname
- the class to load laterpublic static void registerEditorKitForContentType(String type, String classname, ClassLoader loader)
type
to classname
. The class will be dynamically loaded later when actually needed using the given ClassLoader
, and can be safely changed before attempted uses to avoid loading unwanted classes.type
- the non-null
content typeclassname
- the class to load laterloader
- the ClassLoader
to use to load the namepublic static String getEditorKitClassNameForContentType(String type)
EditorKit
class name for the type type
.type
- the non-null
content typeString
containing the EditorKit
class name for type
public Dimension getPreferredSize()
JEditorPane
. The preferred size for JEditorPane
is slightly altered from the preferred size of the superclass. If the size of the viewport has become smaller than the minimum size of the component, the scrollable definition for tracking width or height will turn to false. The default viewport layout will give the preferred size, and that is not desired in the case where the scrollable is tracking. In that case the normal preferred size is adjusted to the minimum size. This allows things like HTML tables to shrink down to their minimum size and then be laid out at their minimum size, refusing to shrink any further.getPreferredSize
in class JComponent
Dimension
containing the preferred size@BeanProperty(bound=false, description="the text of this component") public void setText(String t)
TextComponent
to the specified content, which is expected to be in the format of the content type of this editor. For example, if the type is set to text/html
the string should be specified in terms of HTML. This is implemented to remove the contents of the current document, and replace them by parsing the given string using the current EditorKit
. This gives the semantics of the superclass by not changing out the model, while supporting the content type currently set on this component. The assumption is that the previous content is relatively small, and that the previous content doesn't have side effects. Both of those assumptions can be violated and cause undesirable results. To avoid this, create a new document, getEditorKit().createDefaultDocument()
, and replace the existing Document
with the new one. You are then assured the previous Document
won't have any lingering state.
An alternative way to load this component with a string would be to create a StringReader and call the read method. In this case the model would be replaced after it was initialized with the contents of the string.
setText
in class JTextComponent
t
- the new text to be set; if null
the old text will be deletedpublic String getText()
TextComponent
in terms of the content type of this editor. If an exception is thrown while attempting to retrieve the text, null
will be returned. This is implemented to call JTextComponent.write
with a StringWriter
.getText
in class JTextComponent
@BeanProperty(bound=false) public boolean getScrollableTracksViewportWidth()
Scrollable
to match the width of the viewport.getScrollableTracksViewportWidth
in interface Scrollable
getScrollableTracksViewportWidth
in class JTextComponent
@BeanProperty(bound=false) public boolean getScrollableTracksViewportHeight()
Scrollable
to match the height of the viewport.getScrollableTracksViewportHeight
in interface Scrollable
getScrollableTracksViewportHeight
in class JTextComponent
Scrollable
's height to match its own, false otherwiseprotected String paramString()
JEditorPane
. This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations. The returned string may be empty but may not be null
.paramString
in class JTextComponent
JEditorPane
@BeanProperty(bound=false) public AccessibleContext getAccessibleContext()
getAccessibleContext
in interface Accessible
getAccessibleContext
in class JTextComponent
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/javax/swing/JEditorPane.html