# Class JEditorPane

java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.text.JTextComponent
javax.swing.JEditorPane

All Implemented Interfaces:
  `ImageObserver, MenuContainer, Serializable, Accessible, Scrollable`

Direct Known Subclasses:
  `JTextPane`

@JavaBean(defaultProperty="UIClassID", description="A text component to edit various types of content.") public class JEditorPane extends JTextComponent
A text component to edit various kinds of content. You can find how-to information and examples of using editor panes in Using Text Components, a section in The Java Tutorial.

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:

text/plain
  Plain text, which is the default the type given isn't recognized. The kit used in this case is an extension of `DefaultEditorKit` that produces a wrapped plain text view.
text/html
  HTML text. The kit used in this case is the class `javax.swing.text.html.HTMLEditorKit` which provides HTML 3.2 support.
text/rtf
  RTF text. The kit used in this case is the class `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.

1. The `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.
2. The `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.
3. The `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`.

1. One way is to specify the character set as a parameter of the MIME type. This will be established by a call to the `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.
2. Another way the character set can be specified is in the document itself. This requires reading the document prior to determining the character set that is desired. To handle this, it is expected that the `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`).

Newlines
  For a discussion on how newlines are handled, see DefaultEditorKit.

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`.

Since:
  1.2

## Nested Class Summary

Nested Classes
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`.

### Nested classes/interfaces declared in class JTextComponent

`JTextComponent.AccessibleJTextComponent, JTextComponent.DropLocation, JTextComponent.KeyBinding`
Modifier and Type
Class
Description
`class`
`JTextComponent.AccessibleJTextComponent`
This class implements accessibility support for the `JTextComponent` class.
`static final class`
`JTextComponent.DropLocation`
Represents a drop location for `JTextComponent`s.
`static class`
`JTextComponent.KeyBinding`
Binding record for creating key bindings.

### Nested classes/interfaces declared in class JComponent

`JComponent.AccessibleJComponent`
Modifier and Type
Class
Description
`class`
`JComponent.AccessibleJComponent`
Inner class of JComponent used to provide default support for accessibility.

### Nested classes/interfaces declared in class Container

`Container.AccessibleAWTContainer`
Modifier and Type
Class
Description
`protected class`
`Container.AccessibleAWTContainer`
Inner class of Container used to provide default support for accessibility.

### Nested classes/interfaces declared in class Component

`Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy`
Modifier and Type
Class
Description
`protected class`
`Component.AccessibleAWTComponent`
Inner class of Component used to provide default support for accessibility.
`static enum`
`Component.BaselineResizeBehavior`
Enumeration of the common ways the baseline of a component can change as the size changes.
`protected class`
`Component.BltBufferStrategy`
Inner class for blitting offscreen surfaces to a component.
`protected class`
`Component.FlipBufferStrategy`
Inner class for flipping buffers on a component.

## Field Summary

Fields
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.

### Fields declared in class JTextComponent

`DEFAULT_KEYMAP, FOCUS_ACCELERATOR_KEY`
Modifier and Type
Field
Description
`static final String`
`DEFAULT_KEYMAP`
The default keymap that will be shared by all `JTextComponent` instances unless they have had a different keymap set.
`static final String`
`FOCUS_ACCELERATOR_KEY`
The bound property name for the focus accelerator.

### Fields declared in class JComponent

`listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW`
Modifier and Type
Field
Description
`protected EventListenerList`
`listenerList`
A list of event listeners for this component.
`static final String`
`TOOL_TIP_TEXT_KEY`
The comment to display when the cursor is over the component, also known as a "value tip", "flyover help", or "flyover label".
`protected ComponentUI`
`ui`
The look and feel delegate for this component.
`static final int`
`UNDEFINED_CONDITION`
Constant used by some of the APIs to mean that no condition is defined.
`static final int`
`WHEN_ANCESTOR_OF_FOCUSED_COMPONENT`
Constant used for `registerKeyboardAction` that means that the command should be invoked when the receiving component is an ancestor of the focused component or is itself the focused component.
`static final int`
`WHEN_FOCUSED`
Constant used for `registerKeyboardAction` that means that the command should be invoked when the component has the focus.
`static final int`
`WHEN_IN_FOCUSED_WINDOW`
Constant used for `registerKeyboardAction` that means that the command should be invoked when the receiving component is in the window that has the focus or is itself the focused component.

### Fields declared in class Component

`accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT`
Modifier and Type
Field
Description
`protected AccessibleContext`
`accessibleContext`
The `AccessibleContext` associated with this `Component`.
`static final float`
`BOTTOM_ALIGNMENT`
Ease-of-use constant for `getAlignmentY`.
`static final float`
`CENTER_ALIGNMENT`
Ease-of-use constant for `getAlignmentY` and `getAlignmentX`.
`static final float`
`LEFT_ALIGNMENT`
Ease-of-use constant for `getAlignmentX`.
`static final float`
`RIGHT_ALIGNMENT`
Ease-of-use constant for `getAlignmentX`.
`static final float`
`TOP_ALIGNMENT`
Ease-of-use constant for `getAlignmentY()`.

### Fields declared in interface ImageObserver

`ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH`
Modifier and Type
Field
Description
`static final int`
`ABORT`
This flag in the infoflags argument to imageUpdate indicates that an image which was being tracked asynchronously was aborted before production was complete.
`static final int`
`ALLBITS`
This flag in the infoflags argument to imageUpdate indicates that a static image which was previously drawn is now complete and can be drawn again in its final form.
`static final int`
`ERROR`
This flag in the infoflags argument to imageUpdate indicates that an image which was being tracked asynchronously has encountered an error.
`static final int`
`FRAMEBITS`
This flag in the infoflags argument to imageUpdate indicates that another complete frame of a multi-frame image which was previously drawn is now available to be drawn again.
`static final int`
`HEIGHT`
This flag in the infoflags argument to imageUpdate indicates that the height of the base image is now available and can be taken from the height argument to the imageUpdate callback method.
`static final int`
`PROPERTIES`
This flag in the infoflags argument to imageUpdate indicates that the properties of the image are now available.
`static final int`
`SOMEBITS`
This flag in the infoflags argument to imageUpdate indicates that more pixels needed for drawing a scaled variation of the image are available.
`static final int`
`WIDTH`
This flag in the infoflags argument to imageUpdate indicates that the width of the base image is now available and can be taken from the width argument to the imageUpdate callback method.

## Constructor Summary

Constructors
Constructor
Description
`JEditorPane()`
Creates a new `JEditorPane`.
`JEditorPane(String url)`
Creates a `JEditorPane` based on a string containing a URL specification.
`JEditorPane(String type, String text)`
Creates a `JEditorPane` that has been initialized to the given text.
`JEditorPane(URL initialPage)`
Creates a `JEditorPane` based on a specified URL for input.

## Method Summary

Modifier and Type
Method
Description
`void`
`addHyperlinkListener(HyperlinkListener listener)`
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(String type)`
Creates a handler for the given type from the default registry of editor kits.
`void`
`fireHyperlinkUpdate(HyperlinkEvent e)`
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(String type)`
Returns the currently registered `EditorKit` class name for the type `type`.
`EditorKit`
`getEditorKitForContentType(String type)`
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(URL page)`
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(InputStream in, Object desc)`
This method initializes from a stream.
`static void`
`registerEditorKitForContentType(String type, String classname)`
Establishes the default bindings of `type` to `classname`.
`static void`
`registerEditorKitForContentType(String type, String classname, ClassLoader loader)`
Establishes the default bindings of `type` to `classname`.
`void`
`removeHyperlinkListener(HyperlinkListener listener)`
Removes a hyperlink listener.
`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 `URL.getRef` method for the URL being displayed).
`final void`
`setContentType(String type)`
Sets the type of content that this editor handles.
`void`
`setEditorKit(EditorKit kit)`
Sets the currently installed kit for handling content.
`void`
`setEditorKitForContentType(String type, EditorKit k)`
Directly sets the editor kit to use for the given 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 this `TextComponent` to the specified content, which is expected to be in the format of the content type of this editor.

### Methods declared in class JTextComponent

`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`
Modifier and Type
Method
Description
`void`
`addCaretListener(CaretListener listener)`
Adds a caret listener for notification of any changes to the caret.
`static Keymap`
`addKeymap(String nm, Keymap parent)`
Adds a new keymap into the keymap hierarchy.
`void`
`copy()`
Transfers the currently selected range in the associated text model to the system clipboard, leaving the contents in the text model.
`void`
`cut()`
Transfers the currently selected range in the associated text model to the system clipboard, removing the contents from the model.
`protected void`
`fireCaretUpdate(CaretEvent e)`
Notifies all listeners that have registered interest for notification on this event type.
`Action[]`
`getActions()`
Fetches the command list for the editor.
`Caret`
`getCaret()`
Fetches the caret that allows text-oriented navigation over the view.
`Color`
`getCaretColor()`
Fetches the current color used to render the caret.
`CaretListener[]`
`getCaretListeners()`
Returns an array of all the caret listeners registered on this text component.
`int`
`getCaretPosition()`
Returns the position of the text insertion caret for the text component.
`Color`
`getDisabledTextColor()`
Fetches the current color used to render the disabled text.
`Document`
`getDocument()`
Fetches the model associated with the editor.
`boolean`
`getDragEnabled()`
Returns whether or not automatic drag handling is enabled.
`final JTextComponent.DropLocation`
`getDropLocation()`
Returns the location that this component should visually indicate as the drop location during a DnD operation over the component, or `null` if no location is to currently be shown.
`final DropMode`
`getDropMode()`
Returns the drop mode for this component.
`char`
`getFocusAccelerator()`
Returns the key accelerator that will cause the receiving text component to get the focus.
`Highlighter`
`getHighlighter()`
Fetches the object responsible for making highlights.
`InputMethodRequests`
`getInputMethodRequests()`
Gets the input method request handler which supports requests from input methods for this component.
`Keymap`
`getKeymap()`
Fetches the keymap currently active in this text component.
`static Keymap`
`getKeymap(String nm)`
Fetches a named keymap previously added to the document.
`Insets`
`getMargin()`
Returns the margin between the text component's border and its text.
`NavigationFilter`
`getNavigationFilter()`
Returns the `NavigationFilter`.
`Dimension`
`getPreferredScrollableViewportSize()`
Returns the preferred size of the viewport for a view component.
`Printable`
`getPrintable(MessageFormat headerFormat, MessageFormat footerFormat)`
Returns a `Printable` to use for printing the content of this `JTextComponent`.
`int`
`getScrollableBlockIncrement(Rectangle visibleRect, int orientation, int direction)`
Components that display logical rows or columns should compute the scroll increment that will completely expose one block of rows or columns, depending on the value of orientation.
`int`
`getScrollableUnitIncrement(Rectangle visibleRect, int orientation, int direction)`
Components that display logical rows or columns should compute the scroll increment that will completely expose one new row or column, depending on the value of orientation.
`String`
`getSelectedText()`
Returns the selected text contained in this `TextComponent`.
`Color`
`getSelectedTextColor()`
Fetches the current color used to render the selected text.
`Color`
`getSelectionColor()`
Fetches the current color used to render the selection.
`int`
`getSelectionEnd()`
Returns the selected text's end position.
`int`
`getSelectionStart()`
Returns the selected text's start position.
`String`
`getText(int offs, int len)`
Fetches a portion of the text represented by the component.
`String`
`getToolTipText(MouseEvent event)`
Returns the string to be used as the tooltip for `event`.
`TextUI`
`getUI()`
Fetches the user-interface factory for this text-oriented editor.
`boolean`
`isEditable()`
Returns the boolean indicating whether this `TextComponent` is editable or not.
`static void`
`loadKeymap(Keymap map, JTextComponent.KeyBinding[] bindings, Action[] actions)`
Loads a keymap with a bunch of bindings.
`Rectangle`
`modelToView(int pos)`
Deprecated.
replaced by `JTextComponent.modelToView2D(int)`
`Rectangle2D`
`modelToView2D(int pos)`
Converts the given location in the model to a place in the view coordinate system.
`void`
`moveCaretPosition(int pos)`
Moves the caret to a new position, leaving behind a mark defined by the last time `setCaretPosition` was called.
`void`
`paste()`
Transfers the contents of the system clipboard into the associated text model.
`boolean`
`print()`
A convenience print method that displays a print dialog, and then prints this `JTextComponent` in interactive mode with no header or footer text.
`boolean`
`print(MessageFormat headerFormat, MessageFormat footerFormat)`
A convenience print method that displays a print dialog, and then prints this `JTextComponent` in interactive mode with the specified header and footer text.
`boolean`
`print(MessageFormat headerFormat, MessageFormat footerFormat, boolean showPrintDialog, PrintService service, PrintRequestAttributeSet attributes, boolean interactive)`
Prints the content of this `JTextComponent`.
`void`
`read(Reader in, Object desc)`
Initializes from a stream.
`void`
`removeCaretListener(CaretListener listener)`
Removes a caret listener.
`static Keymap`
`removeKeymap(String nm)`
Removes a named keymap previously added to the document.
`protected void`
`restoreComposedText()`
Restores composed text previously saved by `saveComposedText`.
`protected boolean`
`saveComposedText(int pos)`
Saves composed text around the specified position.
`void`
`select(int selectionStart, int selectionEnd)`
Selects the text between the specified start and end positions.
`void`
`selectAll()`
Selects all the text in the `TextComponent`.
`void`
`setCaret(Caret c)`
Sets the caret to be used.
`void`
`setCaretColor(Color c)`
Sets the current color used to render the caret.
`void`
`setCaretPosition(int position)`
Sets the position of the text insertion caret for the `TextComponent`.
`void`
`setDisabledTextColor(Color c)`
Sets the current color used to render the disabled text.
`void`
`setDocument(Document doc)`
Associates the editor with a text document.
`void`
`setDragEnabled(boolean b)`
Turns on or off automatic drag handling.
`final void`
`setDropMode(DropMode dropMode)`
Sets the drop mode for this component.
`void`
`setEditable(boolean b)`
Sets the specified boolean to indicate whether or not this `TextComponent` should be editable.
`void`
`setFocusAccelerator(char aKey)`
Sets the key accelerator that will cause the receiving text component to get the focus.
`void`
`setHighlighter(Highlighter h)`
Sets the highlighter to be used.
`void`
`setKeymap(Keymap map)`
Sets the keymap to use for binding events to actions.
`void`
`setMargin(Insets m)`
Sets margin space between the text component's border and its text.
`void`
`setNavigationFilter(NavigationFilter filter)`
Sets the `NavigationFilter`.
`void`
`setSelectedTextColor(Color c)`
Sets the current color used to render the selected text.
`void`
`setSelectionColor(Color c)`
Sets the current color used to render the selection.
`void`
`setSelectionEnd(int selectionEnd)`
Sets the selection end to the specified position.
`void`
`setSelectionStart(int selectionStart)`
Sets the selection start to the specified position.
`void`
`setUI(TextUI ui)`
Sets the user-interface factory for this text-oriented editor.
`void`
`updateUI()`
Reloads the pluggable UI.
`int`
`viewToModel(Point pt)`
Deprecated.
replaced by `JTextComponent.viewToModel2D(Point2D)`
`int`
`viewToModel2D(Point2D pt)`
Converts the given place in the view coordinate system to the nearest representative location in the model.
`void`
`write(Writer out)`
Stores the contents of the model into the given stream.

### Methods declared in class JComponent

`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`
Modifier and Type
Method
Description
`void`
`addAncestorListener(AncestorListener listener)`
Registers `listener` so that it will receive `AncestorEvents` when it or any of its ancestors move or are made visible or invisible.
`void`
`addNotify()`
Notifies this component that it now has a parent component.
`void`
`addVetoableChangeListener(VetoableChangeListener listener)`
Adds a `VetoableChangeListener` to the listener list.
`void`
`computeVisibleRect(Rectangle visibleRect)`
Returns the `Component`'s "visible rect rectangle" - the intersection of the visible rectangles for this component and all of its ancestors.
`boolean`
`contains(int x, int y)`
Gives the UI delegate an opportunity to define the precise shape of this component for the sake of mouse processing.
`JToolTip`
`createToolTip()`
Returns the instance of `JToolTip` that should be used to display the tooltip.
`void`
`disable()`
Deprecated.
As of JDK version 1.1, replaced by `java.awt.Component.setEnabled(boolean)`.
`void`
`enable()`
Deprecated.
As of JDK version 1.1, replaced by `java.awt.Component.setEnabled(boolean)`.
`void`
`firePropertyChange(String propertyName, boolean oldValue, boolean newValue)`
Support for reporting bound property changes for boolean properties.
`void`
`firePropertyChange(String propertyName, int oldValue, int newValue)`
Support for reporting bound property changes for integer properties.
`protected void`
`fireVetoableChange(String propertyName, Object oldValue, Object newValue)`
Supports reporting constrained property changes.
`ActionListener`
`getActionForKeyStroke(KeyStroke aKeyStroke)`
Returns the object that will perform the action registered for a given keystroke.
`final ActionMap`
`getActionMap()`
Returns the `ActionMap` used to determine what `Action` to fire for particular `KeyStroke` binding.
`float`
`getAlignmentX()`
Overrides `Container.getAlignmentX` to return the horizontal alignment.
`float`
`getAlignmentY()`
Overrides `Container.getAlignmentY` to return the vertical alignment.
`AncestorListener[]`
`getAncestorListeners()`
Returns an array of all the ancestor listeners registered on this component.
`boolean`
`getAutoscrolls()`
Gets the `autoscrolls` property.
`int`
`getBaseline(int width, int height)`
Returns the baseline.
`Component.BaselineResizeBehavior`
`getBaselineResizeBehavior()`
Returns an enum indicating how the baseline of the component changes as the size changes.
`Border`
`getBorder()`
Returns the border of this component or `null` if no border is currently set.
`Rectangle`
`getBounds(Rectangle rv)`
Stores the bounds of this component into "return value" `rv` and returns `rv`.
`final Object`
`getClientProperty(Object key)`
Returns the value of the property with the specified key.
`protected Graphics`
`getComponentGraphics(Graphics g)`
Returns the graphics object used to paint this component.
`JPopupMenu`
`getComponentPopupMenu()`
Returns `JPopupMenu` that assigned for this component.
`int`
`getConditionForKeyStroke(KeyStroke aKeyStroke)`
Returns the condition that determines whether a registered action occurs in response to the specified keystroke.
`int`
`getDebugGraphicsOptions()`
Returns the state of graphics debugging.
`static Locale`
`getDefaultLocale()`
Returns the default locale used to initialize each JComponent's locale property upon creation.
`FontMetrics`
`getFontMetrics(Font font)`
Gets the `FontMetrics` for the specified `Font`.
`Graphics`
`getGraphics()`
Returns this component's graphics context, which lets you draw on a component.
`int`
`getHeight()`
Returns the current height of this component.
`boolean`
`getInheritsPopupMenu()`
Returns true if the JPopupMenu should be inherited from the parent.
`final InputMap`
`getInputMap()`
Returns the `InputMap` that is used when the component has focus.
`final InputMap`
`getInputMap(int condition)`
Returns the `InputMap` that is used during `condition`.
`InputVerifier`
`getInputVerifier()`
Returns the input verifier for this component.
`Insets`
`getInsets()`
If a border has been set on this component, returns the border's insets; otherwise calls `super.getInsets`.
`Insets`
`getInsets(Insets insets)`
Returns an `Insets` object containing this component's inset values.
`<T extends EventListener>
T[]`
`getListeners(Class<T> listenerType)`
Returns an array of all the objects currently registered as `FooListener`s upon this `JComponent`.
`Point`
`getLocation(Point rv)`
Stores the x,y origin of this component into "return value" `rv` and returns `rv`.
`Dimension`
`getMaximumSize()`
If the maximum size has been set to a non-`null` value just returns it.
`Dimension`
`getMinimumSize()`
If the minimum size has been set to a non-`null` value just returns it.
`Component`
`getNextFocusableComponent()`
Deprecated.
As of 1.4, replaced by `FocusTraversalPolicy`.
`Point`
`getPopupLocation(MouseEvent event)`
Returns the preferred location to display the popup menu in this component's coordinate system.
`KeyStroke[]`
`getRegisteredKeyStrokes()`
Returns the `KeyStrokes` that will initiate registered actions.
`JRootPane`
`getRootPane()`
Returns the `JRootPane` ancestor for this component.
`Dimension`
`getSize(Dimension rv)`
Stores the width/height of this component into "return value" `rv` and returns `rv`.
`Point`
`getToolTipLocation(MouseEvent event)`
Returns the tooltip location in this component's coordinate system.
`String`
`getToolTipText()`
Returns the tooltip string that has been set with `setToolTipText`.
`Container`
`getTopLevelAncestor()`
Returns the top-level ancestor of this component (the containing `Window`) or `null` if this component has not been added to any container.
`TransferHandler`
`getTransferHandler()`
Gets the `transferHandler` property.
`boolean`
`getVerifyInputWhenFocusTarget()`
Returns the value that indicates whether the input verifier for the current focus owner will be called before this component requests focus.
`VetoableChangeListener[]`
`getVetoableChangeListeners()`
Returns an array of all the vetoable change listeners registered on this component.
`Rectangle`
`getVisibleRect()`
Returns the `Component`'s "visible rectangle" - the intersection of this component's visible rectangle, `new Rectangle(0, 0, getWidth(), getHeight())`, and all of its ancestors' visible rectangles.
`int`
`getWidth()`
Returns the current width of this component.
`int`
`getX()`
Returns the current x coordinate of the component's origin.
`int`
`getY()`
Returns the current y coordinate of the component's origin.
`void`
`grabFocus()`
Requests that this Component get the input focus, and that this Component's top-level ancestor become the focused Window.
`void`
`hide()`
Deprecated.
`boolean`
`isDoubleBuffered()`
Returns whether this component should use a buffer to paint.
`static boolean`
`isLightweightComponent(Component c)`
Returns true if this component is lightweight, that is, if it doesn't have a native window system peer.
`boolean`
`isManagingFocus()`
Deprecated.
As of 1.4, replaced by `Component.setFocusTraversalKeys(int, Set)` and `Container.setFocusCycleRoot(boolean)`.
`boolean`
`isOpaque()`
Returns true if this component is completely opaque.
`boolean`
`isOptimizedDrawingEnabled()`
Returns true if this component tiles its children -- that is, if it can guarantee that the children will not overlap.
`final boolean`
`isPaintingForPrint()`
Returns `true` if the current painting operation on this component is part of a `print` operation.
`protected boolean`
`isPaintingOrigin()`
Returns `true` if a paint triggered on a child component should cause painting to originate from this Component, or one of its ancestors.
`boolean`
`isPaintingTile()`
Returns true if the component is currently painting a tile.
`boolean`
`isRequestFocusEnabled()`
Returns `true` if this `JComponent` should get focus; otherwise returns `false`.
`boolean`
`isValidateRoot()`
If this method returns true, `revalidate` calls by descendants of this component will cause the entire tree beginning with this root to be validated.
`void`
`paint(Graphics g)`
Invoked by Swing to draw components.
`protected void`
`paintBorder(Graphics g)`
Paints the component's border.
`protected void`
`paintChildren(Graphics g)`
Paints this component's children.
`protected void`
`paintComponent(Graphics g)`
Calls the UI delegate's paint method, if the UI delegate is non-`null`.
`void`
`paintImmediately(int x, int y, int w, int h)`
Paints the specified region in this component and all of its descendants that overlap the region, immediately.
`void`
`paintImmediately(Rectangle r)`
Paints the specified region now.
`void`
`print(Graphics g)`
Invoke this method to print the component to the specified `Graphics`.
`void`
`printAll(Graphics g)`
Invoke this method to print the component.
`protected void`
`printBorder(Graphics g)`
Prints the component's border.
`protected void`
`printChildren(Graphics g)`
Prints this component's children.
`protected void`
`printComponent(Graphics g)`
This is invoked during a printing operation.
`protected void`
`processComponentKeyEvent(KeyEvent e)`
Processes any key events that the component itself recognizes.
`protected boolean`
`processKeyBinding(KeyStroke ks, KeyEvent e, int condition, boolean pressed)`
Invoked to process the key bindings for `ks` as the result of the `KeyEvent` `e`.
`protected void`
`processKeyEvent(KeyEvent e)`
Overrides `processKeyEvent` to process events.
`protected void`
`processMouseEvent(MouseEvent e)`
Processes mouse events occurring on this component by dispatching them to any registered `MouseListener` objects, refer to `Component.processMouseEvent(MouseEvent)` for a complete description of this method.
`protected void`
`processMouseMotionEvent(MouseEvent e)`
Processes mouse motion events, such as MouseEvent.MOUSE_DRAGGED.
`final void`
`putClientProperty(Object key, Object value)`
Adds an arbitrary key/value "client property" to this component.
`void`
`registerKeyboardAction(ActionListener anAction, String aCommand, KeyStroke aKeyStroke, int aCondition)`
This method is now obsolete, please use a combination of `getActionMap()` and `getInputMap()` for similar behavior.
`void`
`registerKeyboardAction(ActionListener anAction, KeyStroke aKeyStroke, int aCondition)`
This method is now obsolete, please use a combination of `getActionMap()` and `getInputMap()` for similar behavior.
`void`
`removeAncestorListener(AncestorListener listener)`
Unregisters `listener` so that it will no longer receive `AncestorEvents`.
`void`
`removeNotify()`
Notifies this component that it no longer has a parent component.
`void`
`removeVetoableChangeListener(VetoableChangeListener listener)`
Removes a `VetoableChangeListener` from the listener list.
`void`
`repaint(long tm, int x, int y, int width, int height)`
Adds the specified region to the dirty region list if the component is showing.
`void`
`repaint(Rectangle r)`
Adds the specified region to the dirty region list if the component is showing.
`boolean`
`requestDefaultFocus()`
Deprecated.
As of 1.4, replaced by `FocusTraversalPolicy.getDefaultComponent(Container).requestFocus()`
`void`
`requestFocus()`
Requests that this `Component` gets the input focus.
`boolean`
`requestFocus(boolean temporary)`
Requests that this `Component` gets the input focus.
`boolean`
`requestFocusInWindow()`
Requests that this `Component` gets the input focus.
`protected boolean`
`requestFocusInWindow(boolean temporary)`
Requests that this `Component` gets the input focus.
`void`
`resetKeyboardActions()`
Unregisters all the bindings in the first tier `InputMaps` and `ActionMap`.
`void`
`reshape(int x, int y, int w, int h)`
Deprecated.
As of JDK 5, replaced by `Component.setBounds(int, int, int, int)`.
`void`
`revalidate()`
Supports deferred automatic layout.
`void`
`scrollRectToVisible(Rectangle aRect)`
Forwards the `scrollRectToVisible()` message to the `JComponent`'s parent.
`final void`
`setActionMap(ActionMap am)`
Sets the `ActionMap` to `am`.
`void`
`setAlignmentX(float alignmentX)`
Sets the horizontal alignment.
`void`
`setAlignmentY(float alignmentY)`
Sets the vertical alignment.
`void`
`setAutoscrolls(boolean autoscrolls)`
Sets the `autoscrolls` property.
`void`
`setBackground(Color bg)`
Sets the background color of this component.
`void`
`setBorder(Border border)`
Sets the border of this component.
`void`
`setComponentPopupMenu(JPopupMenu popup)`
Sets the `JPopupMenu` for this `JComponent`.
`void`
`setDebugGraphicsOptions(int debugOptions)`
Enables or disables diagnostic information about every graphics operation performed within the component or one of its children.
`static void`
`setDefaultLocale(Locale l)`
Sets the default locale used to initialize each JComponent's locale property upon creation.
`void`
`setDoubleBuffered(boolean aFlag)`
Sets whether this component should use a buffer to paint.
`void`
`setEnabled(boolean enabled)`
Sets whether or not this component is enabled.
`void`
`setFocusTraversalKeys(int id, Set<? extends AWTKeyStroke> keystrokes)`
Sets the focus traversal keys for a given traversal operation for this Component.
`void`
`setFont(Font font)`
Sets the font for this component.
`void`
`setForeground(Color fg)`
Sets the foreground color of this component.
`void`
`setInheritsPopupMenu(boolean value)`
Sets whether or not `getComponentPopupMenu` should delegate to the parent if this component does not have a `JPopupMenu` assigned to it.
`final void`
`setInputMap(int condition, InputMap map)`
Sets the `InputMap` to use under the condition `condition` to `map`.
`void`
`setInputVerifier(InputVerifier inputVerifier)`
Sets the input verifier for this component.
`void`
`setMaximumSize(Dimension maximumSize)`
Sets the maximum size of this component to a constant value.
`void`
`setMinimumSize(Dimension minimumSize)`
Sets the minimum size of this component to a constant value.
`void`
`setNextFocusableComponent(Component aComponent)`
Deprecated.
As of 1.4, replaced by `FocusTraversalPolicy`
`void`
`setOpaque(boolean isOpaque)`
If true the component paints every pixel within its bounds.
`void`
`setPreferredSize(Dimension preferredSize)`
Sets the preferred size of this component.
`void`
`setRequestFocusEnabled(boolean requestFocusEnabled)`
Provides a hint as to whether or not this `JComponent` should get focus.
`void`
`setToolTipText(String text)`
Registers the text to display in a tool tip.
`void`
`setTransferHandler(TransferHandler newHandler)`
Sets the `TransferHandler`, which provides support for transfer of data into and out of this component via cut/copy/paste and drag and drop.
`protected void`
`setUI(ComponentUI newUI)`
Sets the look and feel delegate for this component.
`void`
`setVerifyInputWhenFocusTarget(boolean verifyInputWhenFocusTarget)`
Sets the value to indicate whether input verifier for the current focus owner will be called before this component requests focus.
`void`
`setVisible(boolean aFlag)`
Makes the component visible or invisible.
`void`
`unregisterKeyboardAction(KeyStroke aKeyStroke)`
This method is now obsolete.
`void`
`update(Graphics g)`
Calls `paint`.

### Methods declared in class 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, 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`
Modifier and Type
Method
Description
`Component`
`add(Component comp)`
Appends the specified component to the end of this container.
`Component`
`add(Component comp, int index)`
Adds the specified component to this container at the given position.
`void`
`add(Component comp, Object constraints)`
Adds the specified component to the end of this container.
`void`
`add(Component comp, Object constraints, int index)`
Adds the specified component to this container with the specified constraints at the specified index.
`Component`
`add(String name, Component comp)`
Adds the specified component to this container.
`void`
`addContainerListener(ContainerListener l)`
Adds the specified container listener to receive container events from this container.
`protected void`
`addImpl(Component comp, Object constraints, int index)`
Adds the specified component to this container at the specified index.
`void`
`addPropertyChangeListener(PropertyChangeListener listener)`
Adds a PropertyChangeListener to the listener list.
`void`
`addPropertyChangeListener(String propertyName, PropertyChangeListener listener)`
Adds a PropertyChangeListener to the listener list for a specific property.
`void`
`applyComponentOrientation(ComponentOrientation o)`
Sets the `ComponentOrientation` property of this container and all components contained within it.
`boolean`
`areFocusTraversalKeysSet(int id)`
Returns whether the Set of focus traversal keys for the given focus traversal operation has been explicitly defined for this Container.
`int`
`countComponents()`
Deprecated.
As of JDK version 1.1, replaced by getComponentCount().
`void`
`deliverEvent(Event e)`
Deprecated.
As of JDK version 1.1, replaced by `dispatchEvent(AWTEvent e)`
`void`
`doLayout()`
Causes this container to lay out its components.
`Component`
`findComponentAt(int x, int y)`
Locates the visible child component that contains the specified position.
`Component`
`findComponentAt(Point p)`
Locates the visible child component that contains the specified point.
`Component`
`getComponent(int n)`
Gets the nth component in this container.
`Component`
`getComponentAt(int x, int y)`
Locates the component that contains the x,y position.
`Component`
`getComponentAt(Point p)`
Gets the component that contains the specified point.
`int`
`getComponentCount()`
Gets the number of components in this panel.
`Component[]`
`getComponents()`
Gets all the components in this container.
`int`
`getComponentZOrder(Component comp)`
Returns the z-order index of the component inside the container.
`ContainerListener[]`
`getContainerListeners()`
Returns an array of all the container listeners registered on this container.
`Set<AWTKeyStroke>`
`getFocusTraversalKeys(int id)`
Returns the Set of focus traversal keys for a given traversal operation for this Container.
`FocusTraversalPolicy`
`getFocusTraversalPolicy()`
Returns the focus traversal policy that will manage keyboard traversal of this Container's children, or null if this Container is not a focus cycle root.
`LayoutManager`
`getLayout()`
Gets the layout manager for this container.
`Point`
`getMousePosition(boolean allowChildren)`
Returns the position of the mouse pointer in this `Container`'s coordinate space if the `Container` is under the mouse pointer, otherwise returns `null`.
`Insets`
`insets()`
Deprecated.
As of JDK version 1.1, replaced by `getInsets()`.
`void`
`invalidate()`
Invalidates the container.
`boolean`
`isAncestorOf(Component c)`
Checks if the component is contained in the component hierarchy of this container.
`boolean`
`isFocusCycleRoot()`
Returns whether this Container is the root of a focus traversal cycle.
`boolean`
`isFocusCycleRoot(Container container)`
Returns whether the specified Container is the focus cycle root of this Container's focus traversal cycle.
`final boolean`
`isFocusTraversalPolicyProvider()`
Returns whether this container provides focus traversal policy.
`boolean`
`isFocusTraversalPolicySet()`
Returns whether the focus traversal policy has been explicitly set for this Container.
`void`
`layout()`
Deprecated.
As of JDK version 1.1, replaced by `doLayout()`.
`void`
`list(PrintStream out, int indent)`
Prints a listing of this container to the specified output stream.
`void`
`list(PrintWriter out, int indent)`
Prints out a list, starting at the specified indentation, to the specified print writer.
`Component`
`locate(int x, int y)`
Deprecated.
As of JDK version 1.1, replaced by `getComponentAt(int, int)`.
`Dimension`
`minimumSize()`
Deprecated.
As of JDK version 1.1, replaced by `getMinimumSize()`.
`void`
`paintComponents(Graphics g)`
Paints each of the components in this container.
`Dimension`
`preferredSize()`
Deprecated.
As of JDK version 1.1, replaced by `getPreferredSize()`.
`void`
`printComponents(Graphics g)`
Prints each of the components in this container.
`protected void`
`processContainerEvent(ContainerEvent e)`
Processes container events occurring on this container by dispatching them to any registered ContainerListener objects.
`protected void`
`processEvent(AWTEvent e)`
Processes events on this container.
`void`
`remove(int index)`
Removes the component, specified by `index`, from this container.
`void`
`remove(Component comp)`
Removes the specified component from this container.
`void`
`removeAll()`
Removes all the components from this container.
`void`
`removeContainerListener(ContainerListener l)`
Removes the specified container listener so it no longer receives container events from this container.
`void`
`setComponentZOrder(Component comp, int index)`
Moves the specified component to the specified z-order index in the container.
`void`
`setFocusCycleRoot(boolean focusCycleRoot)`
Sets whether this Container is the root of a focus traversal cycle.
`void`
`setFocusTraversalPolicy(FocusTraversalPolicy policy)`
Sets the focus traversal policy that will manage keyboard traversal of this Container's children, if this Container is a focus cycle root.
`final void`
`setFocusTraversalPolicyProvider(boolean provider)`
Sets whether this container will be used to provide focus traversal policy.
`void`
`setLayout(LayoutManager mgr)`
Sets the layout manager for this container.
`void`
`transferFocusDownCycle()`
Transfers the focus down one focus traversal cycle.
`void`
`validate()`
Validates this container and all of its subcomponents.
`protected void`
`validateTree()`
Recursively descends the container tree and recomputes the layout for any subtrees marked as needing it (those marked as invalid).

### Methods declared in class Component

`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`
Modifier and Type
Method
Description
`boolean`
`action(Event evt, Object what)`
Deprecated.
As of JDK version 1.1, should register this component as ActionListener on component which fires action events.
`void`
`add(PopupMenu popup)`
Adds the specified popup menu to the component.
`void`
`addComponentListener(ComponentListener l)`
Adds the specified component listener to receive component events from this component.
`void`
`addFocusListener(FocusListener l)`
Adds the specified focus listener to receive focus events from this component when this component gains input focus.
`void`
`addHierarchyBoundsListener(HierarchyBoundsListener l)`
Adds the specified hierarchy bounds listener to receive hierarchy bounds events from this component when the hierarchy to which this container belongs changes.
`void`
`addHierarchyListener(HierarchyListener l)`
Adds the specified hierarchy listener to receive hierarchy changed events from this component when the hierarchy to which this container belongs changes.
`void`
`addInputMethodListener(InputMethodListener l)`
Adds the specified input method listener to receive input method events from this component.
`void`
`addKeyListener(KeyListener l)`
Adds the specified key listener to receive key events from this component.
`void`
`addMouseListener(MouseListener l)`
Adds the specified mouse listener to receive mouse events from this component.
`void`
`addMouseMotionListener(MouseMotionListener l)`
Adds the specified mouse motion listener to receive mouse motion events from this component.
`void`
`addMouseWheelListener(MouseWheelListener l)`
Adds the specified mouse wheel listener to receive mouse wheel events from this component.
`Rectangle`
`bounds()`
Deprecated.
As of JDK version 1.1, replaced by `getBounds()`.
`int`
`checkImage(Image image, int width, int height, ImageObserver observer)`
Returns the status of the construction of a screen representation of the specified image.
`int`
`checkImage(Image image, ImageObserver observer)`
Returns the status of the construction of a screen representation of the specified image.
`protected AWTEvent`
`coalesceEvents(AWTEvent existingEvent, AWTEvent newEvent)`
Potentially coalesce an event being posted with an existing event.
`boolean`
`contains(Point p)`
Checks whether this component "contains" the specified point, where the point's x and y coordinates are defined to be relative to the coordinate system of this component.
`Image`
`createImage(int width, int height)`
Creates an off-screen drawable image to be used for double buffering.
`Image`
`createImage(ImageProducer producer)`
Creates an image from the specified image producer.
`VolatileImage`
`createVolatileImage(int width, int height)`
Creates a volatile off-screen drawable image to be used for double buffering.
`VolatileImage`
`createVolatileImage(int width, int height, ImageCapabilities caps)`
Creates a volatile off-screen drawable image, with the given capabilities.
`protected final void`
`disableEvents(long eventsToDisable)`
Disables the events defined by the specified event mask parameter from being delivered to this component.
`final void`
`dispatchEvent(AWTEvent e)`
Dispatches an event to this component or one of its sub components.
`void`
`enable(boolean b)`
Deprecated.
As of JDK version 1.1, replaced by `setEnabled(boolean)`.
`protected final void`
`enableEvents(long eventsToEnable)`
Enables the events defined by the specified event mask parameter to be delivered to this component.
`void`
`enableInputMethods(boolean enable)`
Enables or disables input method support for this component.
`void`
`firePropertyChange(String propertyName, byte oldValue, byte newValue)`
Reports a bound property change.
`void`
`firePropertyChange(String propertyName, char oldValue, char newValue)`
Reports a bound property change.
`void`
`firePropertyChange(String propertyName, double oldValue, double newValue)`
Reports a bound property change.
`void`
`firePropertyChange(String propertyName, float oldValue, float newValue)`
Reports a bound property change.
`void`
`firePropertyChange(String propertyName, long oldValue, long newValue)`
Reports a bound property change.
`void`
`firePropertyChange(String propertyName, short oldValue, short newValue)`
Reports a bound property change.
`protected void`
`firePropertyChange(String propertyName, Object oldValue, Object newValue)`
Support for reporting bound property changes for Object properties.
`Color`
`getBackground()`
Gets the background color of this component.
`Rectangle`
`getBounds()`
Gets the bounds of this component in the form of a `Rectangle` object.
`ColorModel`
`getColorModel()`
Gets the instance of `ColorModel` used to display the component on the output device.
`ComponentListener[]`
`getComponentListeners()`
Returns an array of all the component listeners registered on this component.
`ComponentOrientation`
`getComponentOrientation()`
Retrieves the language-sensitive orientation that is to be used to order the elements or text within this component.
`Cursor`
`getCursor()`
Gets the cursor set in the component.
`DropTarget`
`getDropTarget()`
Gets the `DropTarget` associated with this `Component`.
`Container`
`getFocusCycleRootAncestor()`
Returns the Container which is the focus cycle root of this Component's focus traversal cycle.
`FocusListener[]`
`getFocusListeners()`
Returns an array of all the focus listeners registered on this component.
`boolean`
`getFocusTraversalKeysEnabled()`
Returns whether focus traversal keys are enabled for this Component.
`Font`
`getFont()`
Gets the font of this component.
`Color`
`getForeground()`
Gets the foreground color of this component.
`GraphicsConfiguration`
`getGraphicsConfiguration()`
Gets the `GraphicsConfiguration` associated with this `Component`.
`HierarchyBoundsListener[]`
`getHierarchyBoundsListeners()`
Returns an array of all the hierarchy bounds listeners registered on this component.
`HierarchyListener[]`
`getHierarchyListeners()`
Returns an array of all the hierarchy listeners registered on this component.
`boolean`
`getIgnoreRepaint()`
Returns whether or not paint messages received from the operating system should be ignored.
`InputContext`
`getInputContext()`
Gets the input context used by this component for handling the communication with input methods when text is entered in this component.
`InputMethodListener[]`
`getInputMethodListeners()`
Returns an array of all the input method listeners registered on this component.
`KeyListener[]`
`getKeyListeners()`
Returns an array of all the key listeners registered on this component.
`Locale`
`getLocale()`
Gets the locale of this component.
`Point`
`getLocation()`
Gets the location of this component in the form of a point specifying the component's top-left corner.
`Point`
`getLocationOnScreen()`
Gets the location of this component in the form of a point specifying the component's top-left corner in the screen's coordinate space.
`MouseListener[]`
`getMouseListeners()`
Returns an array of all the mouse listeners registered on this component.
`MouseMotionListener[]`
`getMouseMotionListeners()`
Returns an array of all the mouse motion listeners registered on this component.
`Point`
`getMousePosition()`
Returns the position of the mouse pointer in this `Component`'s coordinate space if the `Component` is directly under the mouse pointer, otherwise returns `null`.
`MouseWheelListener[]`
`getMouseWheelListeners()`
Returns an array of all the mouse wheel listeners registered on this component.
`String`
`getName()`
Gets the name of the component.
`Container`
`getParent()`
Gets the parent of this component.
`PropertyChangeListener[]`
`getPropertyChangeListeners()`
Returns an array of all the property change listeners registered on this component.
`PropertyChangeListener[]`
`getPropertyChangeListeners(String propertyName)`
Returns an array of all the listeners which have been associated with the named property.
`Dimension`
`getSize()`
Returns the size of this component in the form of a `Dimension` object.
`Toolkit`
`getToolkit()`
Gets the toolkit of this component.
`final Object`
`getTreeLock()`
Gets this component's locking object (the object that owns the thread synchronization monitor) for AWT component-tree and layout operations.
`boolean`
`gotFocus(Event evt, Object what)`
Deprecated.
As of JDK version 1.1, replaced by processFocusEvent(FocusEvent).
`boolean`
`handleEvent(Event evt)`
Deprecated.
As of JDK version 1.1 replaced by processEvent(AWTEvent).
`boolean`
`hasFocus()`
Returns `true` if this `Component` is the focus owner.
`boolean`
`imageUpdate(Image img, int infoflags, int x, int y, int w, int h)`
Repaints the component when the image has changed.
`boolean`
`inside(int x, int y)`
Deprecated.
As of JDK version 1.1, replaced by contains(int, int).
`boolean`
`isBackgroundSet()`
Returns whether the background color has been explicitly set for this Component.
`boolean`
`isCursorSet()`
Returns whether the cursor has been explicitly set for this Component.
`boolean`
`isDisplayable()`
Determines whether this component is displayable.
`boolean`
`isEnabled()`
Determines whether this component is enabled.
`boolean`
`isFocusable()`
Returns whether this Component can be focused.
`boolean`
`isFocusOwner()`
Returns `true` if this `Component` is the focus owner.
`boolean`
`isFocusTraversable()`
Deprecated.
As of 1.4, replaced by `isFocusable()`.
`boolean`
`isFontSet()`
Returns whether the font has been explicitly set for this Component.
`boolean`
`isForegroundSet()`
Returns whether the foreground color has been explicitly set for this Component.
`boolean`
`isLightweight()`
A lightweight component doesn't have a native toolkit peer.
`boolean`
`isMaximumSizeSet()`
Returns true if the maximum size has been set to a non-`null` value otherwise returns false.
`boolean`
`isMinimumSizeSet()`
Returns whether or not `setMinimumSize` has been invoked with a non-null value.
`boolean`
`isPreferredSizeSet()`
Returns true if the preferred size has been set to a non-`null` value otherwise returns false.
`boolean`
`isShowing()`
Determines whether this component is showing on screen.
`boolean`
`isValid()`
Determines whether this component is valid.
`boolean`
`isVisible()`
Determines whether this component should be visible when its parent is visible.
`boolean`
`keyDown(Event evt, int key)`
Deprecated.
As of JDK version 1.1, replaced by processKeyEvent(KeyEvent).
`boolean`
`keyUp(Event evt, int key)`
Deprecated.
As of JDK version 1.1, replaced by processKeyEvent(KeyEvent).
`void`
`list()`
Prints a listing of this component to the standard system output stream `System.out`.
`void`
`list(PrintStream out)`
Prints a listing of this component to the specified output stream.
`void`
`list(PrintWriter out)`
Prints a listing to the specified print writer.
`Point`
`location()`
Deprecated.
As of JDK version 1.1, replaced by `getLocation()`.
`boolean`
`lostFocus(Event evt, Object what)`
Deprecated.
As of JDK version 1.1, replaced by processFocusEvent(FocusEvent).
`boolean`
`mouseDown(Event evt, int x, int y)`
Deprecated.
As of JDK version 1.1, replaced by processMouseEvent(MouseEvent).
`boolean`
`mouseDrag(Event evt, int x, int y)`
Deprecated.
As of JDK version 1.1, replaced by processMouseMotionEvent(MouseEvent).
`boolean`
`mouseEnter(Event evt, int x, int y)`
Deprecated.
As of JDK version 1.1, replaced by processMouseEvent(MouseEvent).
`boolean`
`mouseExit(Event evt, int x, int y)`
Deprecated.
As of JDK version 1.1, replaced by processMouseEvent(MouseEvent).
`boolean`
`mouseMove(Event evt, int x, int y)`
Deprecated.
As of JDK version 1.1, replaced by processMouseMotionEvent(MouseEvent).
`boolean`
`mouseUp(Event evt, int x, int y)`
Deprecated.
As of JDK version 1.1, replaced by processMouseEvent(MouseEvent).
`void`
`move(int x, int y)`
Deprecated.
As of JDK version 1.1, replaced by `setLocation(int, int)`.
`void`
`nextFocus()`
Deprecated.
As of JDK version 1.1, replaced by transferFocus().
`void`
`paintAll(Graphics g)`
Paints this component and all of its subcomponents.
`boolean`
`postEvent(Event e)`
Deprecated.
As of JDK version 1.1, replaced by dispatchEvent(AWTEvent).
`boolean`
`prepareImage(Image image, int width, int height, ImageObserver observer)`
Prepares an image for rendering on this component at the specified width and height.
`boolean`
`prepareImage(Image image, ImageObserver observer)`
Prepares an image for rendering on this component.
`protected void`
`processComponentEvent(ComponentEvent e)`
Processes component events occurring on this component by dispatching them to any registered `ComponentListener` objects.
`protected void`
`processFocusEvent(FocusEvent e)`
Processes focus events occurring on this component by dispatching them to any registered `FocusListener` objects.
`protected void`
`processHierarchyBoundsEvent(HierarchyEvent e)`
Processes hierarchy bounds events occurring on this component by dispatching them to any registered `HierarchyBoundsListener` objects.
`protected void`
`processHierarchyEvent(HierarchyEvent e)`
Processes hierarchy events occurring on this component by dispatching them to any registered `HierarchyListener` objects.
`protected void`
`processInputMethodEvent(InputMethodEvent e)`
Processes input method events occurring on this component by dispatching them to any registered `InputMethodListener` objects.
`protected void`
`processMouseWheelEvent(MouseWheelEvent e)`
Processes mouse wheel events occurring on this component by dispatching them to any registered `MouseWheelListener` objects.
`void`
`remove(MenuComponent popup)`
Removes the specified popup menu from the component.
`void`
`removeComponentListener(ComponentListener l)`
Removes the specified component listener so that it no longer receives component events from this component.
`void`
`removeFocusListener(FocusListener l)`
Removes the specified focus listener so that it no longer receives focus events from this component.
`void`
`removeHierarchyBoundsListener(HierarchyBoundsListener l)`
Removes the specified hierarchy bounds listener so that it no longer receives hierarchy bounds events from this component.
`void`
`removeHierarchyListener(HierarchyListener l)`
Removes the specified hierarchy listener so that it no longer receives hierarchy changed events from this component.
`void`
`removeInputMethodListener(InputMethodListener l)`
Removes the specified input method listener so that it no longer receives input method events from this component.
`void`
`removeKeyListener(KeyListener l)`
Removes the specified key listener so that it no longer receives key events from this component.
`void`
`removeMouseListener(MouseListener l)`
Removes the specified mouse listener so that it no longer receives mouse events from this component.
`void`
`removeMouseMotionListener(MouseMotionListener l)`
Removes the specified mouse motion listener so that it no longer receives mouse motion events from this component.
`void`
`removeMouseWheelListener(MouseWheelListener l)`
Removes the specified mouse wheel listener so that it no longer receives mouse wheel events from this component.
`void`
`removePropertyChangeListener(PropertyChangeListener listener)`
Removes a PropertyChangeListener from the listener list.
`void`
`removePropertyChangeListener(String propertyName, PropertyChangeListener listener)`
Removes a `PropertyChangeListener` from the listener list for a specific property.
`void`
`repaint()`
Repaints this component.
`void`
`repaint(int x, int y, int width, int height)`
Repaints the specified rectangle of this component.
`void`
`repaint(long tm)`
Repaints the component.
`protected boolean`
`requestFocus(boolean temporary, FocusEvent.Cause cause)`
Requests by the reason of `cause` that this `Component` get the input focus, and that this `Component`'s top-level ancestor become the focused `Window`.
`void`
`requestFocus(FocusEvent.Cause cause)`
Requests by the reason of `cause` that this Component get the input focus, and that this Component's top-level ancestor become the focused Window.
`boolean`
`requestFocusInWindow(FocusEvent.Cause cause)`
Requests by the reason of `cause` that this Component get the input focus, if this Component's top-level ancestor is already the focused Window.
`void`
`resize(int width, int height)`
Deprecated.
As of JDK version 1.1, replaced by `setSize(int, int)`.
`void`
`resize(Dimension d)`
Deprecated.
As of JDK version 1.1, replaced by `setSize(Dimension)`.
`void`
`setBounds(int x, int y, int width, int height)`
Moves and resizes this component.
`void`
`setBounds(Rectangle r)`
Moves and resizes this component to conform to the new bounding rectangle `r`.
`void`
`setComponentOrientation(ComponentOrientation o)`
Sets the language-sensitive orientation that is to be used to order the elements or text within this component.
`void`
`setCursor(Cursor cursor)`
Sets the cursor image to the specified cursor.
`void`
`setDropTarget(DropTarget dt)`
Associate a `DropTarget` with this component.
`void`
`setFocusable(boolean focusable)`
Sets the focusable state of this Component to the specified value.
`void`
`setFocusTraversalKeysEnabled(boolean focusTraversalKeysEnabled)`
Sets whether focus traversal keys are enabled for this Component.
`void`
`setIgnoreRepaint(boolean ignoreRepaint)`
Sets whether or not paint messages received from the operating system should be ignored.
`void`
`setLocale(Locale l)`
Sets the locale of this component.
`void`
`setLocation(int x, int y)`
Moves this component to a new location.
`void`
`setLocation(Point p)`
Moves this component to a new location.
`void`
`setMixingCutoutShape(Shape shape)`
Sets a 'mixing-cutout' shape for this lightweight component.
`void`
`setName(String name)`
Sets the name of the component to the specified string.
`void`
`setSize(int width, int height)`
Resizes this component so that it has width `width` and height `height`.
`void`
`setSize(Dimension d)`
Resizes this component so that it has width `d.width` and height `d.height`.
`void`
`show()`
Deprecated.
As of JDK version 1.1, replaced by `setVisible(boolean)`.
`void`
`show(boolean b)`
Deprecated.
As of JDK version 1.1, replaced by `setVisible(boolean)`.
`Dimension`
`size()`
Deprecated.
As of JDK version 1.1, replaced by `getSize()`.
`String`
`toString()`
Returns a string representation of this component and its values.
`void`
`transferFocus()`
Transfers the focus to the next component, as though this Component were the focus owner.
`void`
`transferFocusBackward()`
Transfers the focus to the previous component, as though this Component were the focus owner.
`void`
`transferFocusUpCycle()`
Transfers the focus up one focus traversal cycle.

### Methods declared in class Object

`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`
Modifier and Type
Method
Description
`protected Object`
`clone()`
Creates and returns a copy of this object.
`boolean`
`equals(Object obj)`
Indicates whether some other object is "equal to" this one.
`protected void`
`finalize()`
Deprecated, for removal: This API element is subject to removal in a future version.
Finalization is deprecated and subject to removal in a future release.
`final Class<?>`
`getClass()`
Returns the runtime class of this `Object`.
`int`
`hashCode()`
Returns a hash code value for this object.
`final void`
`notify()`
Wakes up a single thread that is waiting on this object's monitor.
`final void`
`notifyAll()`
Wakes up all threads that are waiting on this object's monitor.
`final void`
`wait()`
Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
`final void`
`wait(long timeoutMillis)`
Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`
`wait(long timeoutMillis, int nanos)`
Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

## Field Details

### W3C_LENGTH_UNITS

public static final String W3C_LENGTH_UNITS
Key for a client property used to indicate whether w3c compliant length units are used for html rendering.

By default this is not enabled; to enable it set the client `property` with this name to `Boolean.TRUE`.

Since:
  1.5
External Specifications
  - Cascading Style Sheets Level 2 Revision 2 (CSS 2.2) Specification
See Also:
  - Constant Field Values

### HONOR_DISPLAY_PROPERTIES

public 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.

The default varies based on the look and feel; to enable it set the client `property` with this name to `Boolean.TRUE`.

Since:
  1.5
See Also:
  - Constant Field Values

## Constructor Details

### JEditorPane

public JEditorPane()
Creates a new `JEditorPane`. The document model is set to `null`.

### JEditorPane

public JEditorPane(URL initialPage) throws IOException
Creates a `JEditorPane` based on a specified URL for input.

Parameters:
  `initialPage` - the URL
Throws:
  `IOException` - if the URL is `null` or cannot be accessed

### JEditorPane

public JEditorPane(String url) throws IOException
Creates a `JEditorPane` based on a string containing a URL specification.

Parameters:
  `url` - the URL
Throws:
  `IOException` - if the URL is `null` or cannot be accessed

### JEditorPane

public JEditorPane(String type, String text)
Creates a `JEditorPane` that has been initialized to the given text. This is a convenience constructor that calls the `setContentType` and `setText` methods.

Parameters:
  `type` - mime type of the given text
  `text` - the text to initialize with; may be `null`
Throws:
  `NullPointerException` - if the `type` parameter is `null`

## Method Details

### addHyperlinkListener

public void addHyperlinkListener(HyperlinkListener listener)
Adds a hyperlink listener for notification of any changes, for example when a link is selected and entered.

Parameters:
  `listener` - the listener

### removeHyperlinkListener

public void removeHyperlinkListener(HyperlinkListener listener)
Removes a hyperlink listener.

Parameters:
  `listener` - the listener

### getHyperlinkListeners

@BeanProperty(bound=false) public HyperlinkListener[] getHyperlinkListeners()
Returns an array of all the `HyperLinkListener`s added to this JEditorPane with addHyperlinkListener().

Returns:
  all of the `HyperLinkListener`s added or an empty array if no listeners have been added
Since:
  1.4

### fireHyperlinkUpdate

public void fireHyperlinkUpdate(HyperlinkEvent e)
Notifies all listeners that have registered interest for notification on this event type. This is normally called by the currently installed `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.

Parameters:
  `e` - the event
See Also:
  - `EventListenerList`

### setPage

@BeanProperty(expert=true, description="the URL used to set content") public void setPage(URL page) throws IOException
Sets the current URL being displayed. The content type of the pane is set, and if the editor kit for the pane is non-`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.

Parameters:
  `page` - the URL of the page
Throws:
  `IOException` - for a `null` or invalid page specification, or exception from the stream being read
See Also:
  - `getPage()`

### read

public void read(InputStream in, Object desc) throws IOException
This method initializes from a stream. If the kit is set to be of type `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.

Parameters:
  `in` - the stream from which to read
  `desc` - an object describing the stream
Throws:
  `IOException` - as thrown by the stream being used to initialize
See Also:
  - `JTextComponent.read(Reader, Object)`
  - `JTextComponent.setDocument(Document)`

### getStream

protected InputStream getStream(URL page) throws IOException
Fetches a stream for the given URL, which is about to be loaded by the `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.

Parameters:
  `page` - the URL of the page
Returns:
  a stream for the URL which is about to be loaded
Throws:
  `IOException` - if an I/O problem occurs

### scrollToReference

public void scrollToReference(String reference)
Scrolls the view to the given reference location (that is, the value returned by the `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.

Parameters:
  `reference` - the named location to scroll to

### getPage

public URL getPage()
Gets the current URL being displayed. If a URL was not specified in the creation of the document, this will return `null`, and relative URL's will not be resolved.

Returns:
  the URL, or `null` if none

### setPage

public void setPage(String url) throws IOException
Sets the current URL being displayed.

Parameters:
  `url` - the URL for display
Throws:
  `IOException` - for a `null` or invalid URL specification

### getUIClassID

@BeanProperty(bound=false) public String getUIClassID()
Gets the class ID for the UI.

Overrides:
  `getUIClassID` in class `JComponent`
Returns:
  the string "EditorPaneUI"
See Also:
  - `JComponent.getUIClassID()`
  - `UIDefaults.getUI(JComponent)`

### createDefaultEditorKit

protected EditorKit createDefaultEditorKit()
Creates the default editor kit (`PlainEditorKit`) for when the component is first created.

Returns:
  the editor kit

### getEditorKit

public EditorKit getEditorKit()
Fetches the currently installed kit for handling content. `createDefaultEditorKit` is called to set up a default if necessary.

Returns:
  the editor kit

### getContentType

public final String getContentType()
Gets the type of content that this editor is currently set to deal with. This is defined to be the type associated with the currently installed `EditorKit`.

Returns:
  the content type, `null` if no editor kit set

### setContentType

@BeanProperty(bound=false, description="the type of content") public final void setContentType(String type)
Sets the type of content that this editor handles. This calls `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`.

Parameters:
  `type` - the non-`null` mime type for the content editing support
Throws:
  `NullPointerException` - if the `type` parameter is `null`
See Also:
  - `getContentType()`

### setEditorKit

@BeanProperty(expert=true, description="the currently installed kit for handling content") public void setEditorKit(EditorKit kit)
Sets the currently installed kit for handling content. This is the bound property that establishes the content type of the editor. Any old kit is first deinstalled, then if kit is non-`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.

Parameters:
  `kit` - the desired editor behavior
See Also:
  - `getEditorKit()`

### getEditorKitForContentType

public EditorKit getEditorKitForContentType(String type)
Fetches the editor kit to use for the given type of content. This is called when a type is requested that doesn't match the currently installed type. If the component doesn't have an `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.

Parameters:
  `type` - the non-`null` content type
Returns:
  the editor kit

### setEditorKitForContentType

public void setEditorKitForContentType(String type, EditorKit k)
Directly sets the editor kit to use for the given type. A look-and-feel implementation might use this in conjunction with `createEditorKitForContentType` to install handlers for content types with a look-and-feel bias.

Parameters:
  `type` - the non-`null` content type
  `k` - the editor kit to be set

### replaceSelection

public void replaceSelection(String content)
Replaces the currently selected content with new content represented by the given string. If there is no selection this amounts to an insert of the given text. If there is no replacement text (i.e. the content string is empty or `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.

Overrides:
  `replaceSelection` in class `JTextComponent`
Parameters:
  `content` - the content to replace the selection with. This value can be `null`

### createEditorKitForContentType

public static EditorKit createEditorKitForContentType(String type)
Creates a handler for the given type from the default registry of editor kits. The registry is created if necessary. If the registered class has not yet been loaded, an attempt is made to dynamically load the prototype of the kit for the given type. If the type was registered with a `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.

Parameters:
  `type` - the content type
Returns:
  the editor kit, or `null` if there is nothing registered for the given type

### registerEditorKitForContentType

public static void registerEditorKitForContentType(String type, String classname)
Establishes the default bindings of `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.

Parameters:
  `type` - the non-`null` content type
  `classname` - the class to load later

### registerEditorKitForContentType

public static void registerEditorKitForContentType(String type, String classname, ClassLoader loader)
Establishes the default bindings of `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.

Parameters:
  `type` - the non-`null` content type
  `classname` - the class to load later
  `loader` - the `ClassLoader` to use to load the name

### getEditorKitClassNameForContentType

public static String getEditorKitClassNameForContentType(String type)
Returns the currently registered `EditorKit` class name for the type `type`.

Parameters:
  `type` - the non-`null` content type
Returns:
  a `String` containing the `EditorKit` class name for `type`
Since:
  1.3

### getPreferredSize

public Dimension getPreferredSize()
Returns the preferred size for the `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.

Overrides:
  `getPreferredSize` in class `JComponent`
Returns:
  a `Dimension` containing the preferred size
See Also:
  - `JComponent.setPreferredSize(Dimension)`
  - `ComponentUI`

### setText

@BeanProperty(bound=false, description="the text of this component") public void setText(String t)
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. 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.

1. Leaving the existing model in place means that the old view will be torn down, and a new view created, where replacing the document would avoid the tear down of the old view.
2. Some formats (such as HTML) can install things into the document that can influence future contents. HTML can have style information embedded that would influence the next content installed unexpectedly.

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.

Overrides:
  `setText` in class `JTextComponent`
Parameters:
  `t` - the new text to be set; if `null` the old text will be deleted
See Also:
  - `getText()`

### getText

public String getText()
Returns the text contained in this `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`.

Overrides:
  `getText` in class `JTextComponent`
Returns:
  the text
See Also:
  - `setText(String)`

### getScrollableTracksViewportWidth

@BeanProperty(bound=false) public boolean getScrollableTracksViewportWidth()
Returns true if a viewport should always force the width of this `Scrollable` to match the width of the viewport.

Specified by:
  `getScrollableTracksViewportWidth` in interface `Scrollable`
Overrides:
  `getScrollableTracksViewportWidth` in class `JTextComponent`
Returns:
  true if a viewport should force the Scrollables width to match its own, false otherwise

### getScrollableTracksViewportHeight

@BeanProperty(bound=false) public boolean getScrollableTracksViewportHeight()
Returns true if a viewport should always force the height of this `Scrollable` to match the height of the viewport.

Specified by:
  `getScrollableTracksViewportHeight` in interface `Scrollable`
Overrides:
  `getScrollableTracksViewportHeight` in class `JTextComponent`
Returns:
  true if a viewport should force the `Scrollable`'s height to match its own, false otherwise

### paramString

protected String paramString()
Returns a string representation of this `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`.

Overrides:
  `paramString` in class `JTextComponent`
Returns:
  a string representation of this `JEditorPane`

### getAccessibleContext

@BeanProperty(bound=false) public AccessibleContext getAccessibleContext()
Gets the AccessibleContext associated with this JEditorPane. For editor panes, the AccessibleContext takes the form of an AccessibleJEditorPane. A new AccessibleJEditorPane instance is created if necessary.

Specified by:
  `getAccessibleContext` in interface `Accessible`
Overrides:
  `getAccessibleContext` in class `JTextComponent`
Returns:
  an AccessibleJEditorPane that serves as the AccessibleContext of this JEditorPane