Contents | Package | Class | Tree | Deprecated | Index | Help Java 1.2 Beta 3
PREV | NEXT SHOW LISTS | HIDE LISTS

Class java.awt.swing.JEditorPane

java.lang.Object
    |
    +----java.awt.Component
            |
            +----java.awt.Container
                    |
                    +----java.awt.swing.JComponent
                            |
                            +----java.awt.swing.text.JTextComponent
                                    |
                                    +----java.awt.swing.JEditorPane
Subclasses:
JTextPane

public class JEditorPane
extends JTextComponent

A text pane to edit various kinds of content, such as html and rtf. This uses implementations of the EditorKit to accomplish it's behavior. This component 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, it's type is used to determine the EditorKit that should be used to load the content.

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 Swing1.0 applications. It will not be possible to load serialized Swing1.0 objects with future releases of Swing. The JDK1.2 release of Swing will be the compatibility baseline for the serialized form of Swing objects.


Inner Class Summary
 JEditorPane.AccessibleJEditorPane
The class used to obtain the accessible role for this object.
 
Inner classes inherited from class java.awt.swing.text.JTextComponent
 JTextComponent.AccessibleJTextComponent, JTextComponent.KeyBinding
 
Inner classes inherited from class java.awt.swing.JComponent
 JComponent.AccessibleJComponent
 

Fields inherited from class java.awt.swing.text.JTextComponent
 DEFAULT_KEYMAP, FOCUS_ACCELERATOR_KEY
 
Fields inherited from class java.awt.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
 

Constructor Summary
 JEditorPane()
Constructs a new JEditorPane.
 JEditorPane(URL initialPage)
Creates a JEditorPane based on a specified URL for input.
 JEditorPane(String url)
Creates a JEditorPane based on a string containing a URL specification.
 

Method Summary
void  addHyperlinkListener(HyperlinkListener listener)
Adds a hyperlink listener for notification of any changes.
EditorKit  createDefaultEditorKit()
Creates the default editor kit for when the component is first created.
static EditorKit  createEditorKitForContentType(String type)
Create 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()
Get the AccessibleContext associated with this JEditorPane
String  getContentType()
Gets the type of content that this editor handles.
EditorKit  getEditorKit()
Fetches the currently installed kit for handling content.
EditorKit  getEditorKitForContentType(String type)
Fetches the editor kit to use for the given type of content.
URL  getPage()
Gets the current url being displayed.
boolean  getScrollableTracksViewportWidth()
Returns true if a viewport should always force the width of this Scrollable to match the width of the viewport.
String  getUIClassID()
Gets the class ID for the UI.
boolean  isManagingFocus()
Turns off tab traversal once focus gained.
static void  registerEditorKitForContentType(String type, String classname)
Establishes the default bindings of type to name.
void  removeHyperlinkListener(HyperlinkListener listener)
Removes a hyperlink listener.
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 set the editor kit to use for the given type.
void  setPage(URL page)
Sets the current url being displayed.
void  setPage(String url)
Sets the current url being displayed.
 
Methods inherited from class java.awt.swing.text.JTextComponent
 addCaretListener, addKeymap, copy, cut, fireCaretUpdate, getAccessibleContext, getActions, getCaret, getCaretColor, getCaretPosition, getDisabledTextColor, getDocument, getFocusAccelerator, getHighlighter, getKeymap, getKeymap, getMargin, getPreferredScrollableViewportSize, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getSelectedText, getSelectedTextColor, getSelectionColor, getSelectionEnd, getSelectionStart, getText, getText, getUI, isEditable, isFocusTraversable, isOpaque, loadKeymap, modelToView, moveCaretPosition, paste, processComponentKeyEvent, read, removeCaretListener, removeKeymap, replaceSelection, select, selectAll, setCaret, setCaretColor, setCaretPosition, setDisabledTextColor, setDocument, setEditable, setFocusAccelerator, setHighlighter, setKeymap, setMargin, setOpaque, setSelectedTextColor, setSelectionColor, setSelectionEnd, setSelectionStart, setText, setUI, updateUI, viewToModel, write
 
Methods inherited from class java.awt.swing.JComponent
 addAncestorListener, addNotify, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, getActionForKeyStroke, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInsets, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getUIClassID, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, isDoubleBuffered, isFocusCycleRoot, isFocusTraversable, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, processComponentKeyEvent, processFocusEvent, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setAlignmentX, setAlignmentY, setAutoscrolls, setBorder, setBounds, setDebugGraphicsOptions, setDoubleBuffered, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setUI, setVisible, unregisterKeyboardAction, update, updateUI
 
Methods inherited from class java.awt.Container
 add, add, add, add, add, addContainerListener, addImpl, addNotify, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paint, paintComponents, paramString, preferredSize, print, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, removeNotify, setLayout, update, validate, validateTree
 
Methods inherited from class java.awt.Component
 action, add, addComponentListener, addFocusListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, enableInputMethods, firePropertyChange, getAlignmentX, getAlignmentY, getBackground, getBounds, getColorModel, getComponentAt, getComponentAt, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocationOnScreen, getMaximumSize, getMinimumSize, getName, getParent, getPeer, getPreferredSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isDisplayable, isEnabled, isFocusTraversable, isLightweight, isOpaque, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paint, paintAll, paramString, postEvent, preferredSize, prepareImage, prepareImage, print, printAll, processComponentEvent, processEvent, processFocusEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, remove, removeComponentListener, removeFocusListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, reshape, resize, resize, setBackground, setBounds, setBounds, setCursor, setDropTarget, setEnabled, setFont, setForeground, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, show, size, toString, transferFocus, update, validate
 
Methods inherited from class java.lang.Object
 clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JEditorPane

public JEditorPane()
Constructs a new JEditorPane.

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 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 cannot be accessed
Method Detail

addHyperlinkListener

public void addHyperlinkListener(HyperlinkListener listener)
Adds a hyperlink listener for notification of any changes.
Parameters:
listener - the listener

removeHyperlinkListener

public void removeHyperlinkListener(HyperlinkListener listener)
Removes a hyperlink listener.
Parameters:
listener - the listener

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.
Parameters:
e - the event
See Also:
EventListenerList

setPage

public void setPage(URL page) throws IOException
Sets the current url being displayed.
Parameters:
page - the URL of the page
Throws:
IOException - for an invalid page specification

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

setPage

public void setPage(String url) throws IOException
Sets the current url being displayed.
Parameters:
url - the URL for display
Throws:
IOException - for an invalid URL specification

getUIClassID

public String getUIClassID()
Gets the class ID for the UI.
Returns:
the ID
Overrides:
getUIClassID in class JComponent
See Also:
getUIClassID, getUI

createDefaultEditorKit

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

getEditorKit

public final EditorKit getEditorKit()
Fetches the currently installed kit for handling content.
Returns:
the editor kit

getContentType

public final String getContentType()
Gets the type of content that this editor handles.
Returns:
the content type

setContentType

public final void setContentType(String type)
Sets the type of content that this editor handles. This calls getEditorKitForContentType and setEditorKit if and editor kit can be successfully located. This is a convenience method that can be used as an alternative to calling setEditorKit directly.
Parameters:
type - the mime type for the content editing support.
See Also:
getContentType

setEditorKit

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.
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 DefaultEditorKit 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 content type
Returns:
the editor kit

setEditorKitForContentType

public void setEditorKitForContentType(String type,
                                       EditorKit k)
Directly set 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.

createEditorKitForContentType

public static EditorKit createEditorKitForContentType(String type)
Create a handler for the given type from the default registry of editor kits.

registerEditorKitForContentType

public static void registerEditorKitForContentType(String type,
                                                   String classname)
Establishes the default bindings of type to name. The class will be dynamically loaded later when actually needed, and can be safely changed before attempted uses to avoid loading unwanted classes.
Parameters:
type - the content type
classname - the class to load later

isManagingFocus

public boolean isManagingFocus()
Turns off tab traversal once focus gained.
Returns:
true, to indicate that the focus is being managed
Overrides:
isManagingFocus in class JComponent

getScrollableTracksViewportWidth

public boolean getScrollableTracksViewportWidth()
Returns true if a viewport should always force the width of this Scrollable to match the width of the viewport.
Returns:
True if a viewport should force the Scrollables width to match its own.
Overrides:
getScrollableTracksViewportWidth in class JTextComponent

getAccessibleContext

public AccessibleContext getAccessibleContext()
Get the AccessibleContext associated with this JEditorPane
Returns:
the AccessibleContext of this JEditorPane
Overrides:
getAccessibleContext in class JTextComponent

Contents | Package | Class | Tree | Deprecated | Index | Help Java 1.2 Beta 3
PREV | NEXT SHOW LISTS | HIDE LISTS

Submit a bug or feature
Submit comments/suggestions about new javadoc look.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-1998 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A. All Rights Reserved.