|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectjava.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.text.JTextComponent
javax.swing.JEditorPane
public class JEditorPane
A powerful text editor component that can handle different types of
content.
The JEditorPane text component is driven by an instance of
EditorKit. The editor kit is responsible for providing
a default Document implementation, a mechanism for loading
and saving documents of its supported content type and providing
a set of Actions for manipulating the content.
By default the following content types are supported:
text/plain: Plain text, handled by
DefaultEditorKit.text/html: HTML 4.0 styled text, handled by
HTMLEditorKit.text/rtf: RTF text, handled by
RTFEditorKit.
| Nested Class Summary | |
|---|---|
protected class |
JEditorPane.AccessibleJEditorPane
Provides accessibility support for JEditorPane. |
protected class |
JEditorPane.AccessibleJEditorPaneHTML
Provides accessibility support for JEditorPanes, when the
editor kit is an instance of HTMLEditorKit. |
protected class |
JEditorPane.JEditorPaneAccessibleHypertextSupport
This is the accessible text that is returned by JEditorPane.AccessibleJEditorPaneHTML.getAccessibleText(). |
| Nested classes/interfaces inherited from class javax.swing.text.JTextComponent |
|---|
JTextComponent.AccessibleJTextComponent, JTextComponent.KeyBinding |
| Nested classes/interfaces inherited from class javax.swing.JComponent |
|---|
JComponent.AccessibleJComponent |
| Nested classes/interfaces inherited from class java.awt.Container |
|---|
Container.AccessibleAWTContainer |
| Nested classes/interfaces inherited from class java.awt.Component |
|---|
Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy |
| Field Summary |
|---|
| Fields inherited from class javax.swing.text.JTextComponent |
|---|
DEFAULT_KEYMAP, FOCUS_ACCELERATOR_KEY |
| Fields inherited from class javax.swing.JComponent |
|---|
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW |
| Fields inherited from class java.awt.Component |
|---|
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT |
| Fields inherited from interface java.awt.image.ImageObserver |
|---|
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH |
| Constructor Summary | |
|---|---|
JEditorPane()
|
|
JEditorPane(String url)
|
|
JEditorPane(String type,
String text)
|
|
JEditorPane(URL url)
|
|
| Method Summary | |
|---|---|
void |
addHyperlinkListener(HyperlinkListener listener)
Add a HyperlinkListener object to this editor pane. |
protected EditorKit |
createDefaultEditorKit()
|
static EditorKit |
createEditorKitForContentType(String type)
Creates and returns an EditorKit that is appropriate for the given content type. |
void |
fireHyperlinkUpdate(HyperlinkEvent event)
Sends a given HyperlinkEvent to all registered listeners. |
AccessibleContext |
getAccessibleContext()
Returns the accessible context associated with this editor pane. |
String |
getContentType()
|
EditorKit |
getEditorKit()
Returns the EditorKit. |
static String |
getEditorKitClassNameForContentType(String type)
Returns the class name of the EditorKit associated with the given content type. |
EditorKit |
getEditorKitForContentType(String type)
Returns the EditorKit to use for the given content type. |
HyperlinkListener[] |
getHyperlinkListeners()
Returns all added HyperlinkListener objects. |
URL |
getPage()
|
Dimension |
getPreferredSize()
Returns the preferred size for the JEditorPane. |
boolean |
getScrollableTracksViewportHeight()
Returns true when a Viewport should force the height of
this component to match the viewport height. |
boolean |
getScrollableTracksViewportWidth()
Returns true when a Viewport should force the width of
this component to match the viewport width. |
protected InputStream |
getStream(URL page)
|
String |
getText()
Retrieves the current text in this text document. |
String |
getUIClassID()
Returns a string that specifies the name of the Look and Feel class that renders this component. |
boolean |
isFocusCycleRoot()
Check whether this Container is a focus cycle root. |
protected String |
paramString()
Returns a string representation of this JTextComponent. |
void |
read(InputStream in,
Object desc)
This method initializes from a stream. |
static void |
registerEditorKitForContentType(String type,
String classname)
Establishes a binding between type and classname. |
static void |
registerEditorKitForContentType(String type,
String classname,
ClassLoader loader)
Establishes the default bindings of type to classname. |
void |
removeHyperlinkListener(HyperlinkListener listener)
Removes a HyperlinkListener object to this editor pane. |
void |
replaceSelection(String content)
Replaces the currently selected content with new content represented by the given string. |
void |
scrollToReference(String reference)
Scrolls the view to the given reference location (that is, the value returned by the UL.getRef method for the URL being displayed). |
void |
setContentType(String type)
|
void |
setEditorKit(EditorKit newValue)
|
void |
setEditorKitForContentType(String type,
EditorKit k)
Explicitly sets an EditorKit to be used for the given content type. |
void |
setPage(String url)
Sets the current URL being displayed. |
void |
setPage(URL page)
Sets the current URL being displayed. |
void |
setText(String t)
Sets the text of the JEditorPane. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
public JEditorPane()
public JEditorPane(String url)
throws IOException
IOException
public JEditorPane(String type,
String text)
public JEditorPane(URL url)
throws IOException
IOException| Method Detail |
|---|
protected EditorKit createDefaultEditorKit()
public static EditorKit createEditorKitForContentType(String type)
type - the content type
registerEditorKitForContentType(String, String),
registerEditorKitForContentType(String, String, ClassLoader)public void fireHyperlinkUpdate(HyperlinkEvent event)
HyperlinkEvent to all registered listeners.
event - the event to sendpublic AccessibleContext getAccessibleContext()
getAccessibleContext in interface AccessiblegetAccessibleContext in class JTextComponentpublic final String getContentType()
public EditorKit getEditorKit()
public static String getEditorKitClassNameForContentType(String type)
type - the content type
public EditorKit getEditorKitForContentType(String type)
setEditorKitForContentType
then it will be returned. Otherwise an attempt will be made to create
an EditorKit from the default recognzied content types or any
EditorKits that have been registered. If none can be created, a
PlainEditorKit is created.
type - the content type
registerEditorKitForContentType(String, String),
registerEditorKitForContentType(String, String, ClassLoader)public Dimension getPreferredSize()
getScrollableTracksViewportHeight() or
getScrollableTracksViewportWidth() returns true,
in which case the preferred width and/or height is replaced by the UI's
minimum size.
getPreferredSize in class JComponentComponent.setPreferredSize(java.awt.Dimension),
Component.getPreferredSize(),
Component.isPreferredSizeSet(),
ComponentUI.getPreferredSize(JComponent)public boolean getScrollableTracksViewportHeight()
true when a Viewport should force the height of
this component to match the viewport height. This is implemented to return
true when the parent is an instance of JViewport and
the viewport height > the UI's minimum height.
getScrollableTracksViewportHeight in interface ScrollablegetScrollableTracksViewportHeight in class JTextComponenttrue when a Viewport should force the height of
this component to match the viewport heightpublic boolean getScrollableTracksViewportWidth()
true when a Viewport should force the width of
this component to match the viewport width. This is implemented to return
true when the parent is an instance of JViewport and
the viewport width > the UI's minimum width.
getScrollableTracksViewportWidth in interface ScrollablegetScrollableTracksViewportWidth in class JTextComponenttrue when a Viewport should force the width of
this component to match the viewport widthpublic URL getPage()
protected InputStream getStream(URL page)
throws IOException
IOExceptionpublic String getText()
JTextComponent
getText in class JTextComponentpublic String getUIClassID()
JTextComponent
getUIClassID in class JTextComponentJComponent.setUI(javax.swing.plaf.ComponentUI),
JComponent.updateUI()public boolean isFocusCycleRoot()
Container
isFocusCycleRoot in class Containerprotected String paramString()
JTextComponent
paramString in class JTextComponent
public void read(InputStream in,
Object desc)
throws IOException
IOException
public static void registerEditorKitForContentType(String type,
String classname)
type - the content typeclassname - the name of the class that is associated with this
content type
public static void registerEditorKitForContentType(String type,
String classname,
ClassLoader loader)
public void replaceSelection(String content)
replaceSelection in class JTextComponentpublic void scrollToReference(String reference)
public final void setContentType(String type)
public void setEditorKit(EditorKit newValue)
public void setEditorKitForContentType(String type,
EditorKit k)
type - the content typek - the EditorKit to use for the given content type
public void setPage(String url)
throws IOException
IOException
public void setPage(URL page)
throws IOException
IOExceptionpublic void setText(String t)
t
is expected to be in the format of the current EditorKit. This removes
the content of the current document and uses the EditorKit to read in the
new text. This allows the EditorKit to handle the String rather than just
inserting in plain text.
setText in class JTextComponentt - the text to display in this JEditorPanepublic void addHyperlinkListener(HyperlinkListener listener)
HyperlinkListener object to this editor pane.
listener - the listener to addpublic void removeHyperlinkListener(HyperlinkListener listener)
HyperlinkListener object to this editor pane.
listener - the listener to removepublic HyperlinkListener[] getHyperlinkListeners()
HyperlinkListener objects.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||