Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep
Overview  Package   Class  Use  Deprecated  Index 
Home >> All >> javax >> [ swing overview ]  PREV CLASS  NEXT CLASS
SUMMARY: JavaDoc of javax.swing.JEditorPane JAVADOC | Sourc code of javax.swing.JEditorPane SOURCE | Download javax.swing.JEditorPane DOWNLOAD | NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

javax.swing
Class JEditorPane  view JEditorPane download JEditorPane.java

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjavax.swing.JComponent
              extended byjavax.swing.text.JTextComponent
                  extended byjavax.swing.JEditorPane
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, Scrollable, java.io.Serializable
Direct Known Subclasses:
JTextPane
public class JEditorPane
extends javax.swing.text.JTextComponent

A powerful text editor component that can handle different types of content. The JEditorPane text component is driven by an instance of javax.swing.text.EditorKit. The editor kit is responsible for providing a default javax.swing.text.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:

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 javax.swing.text.html.HTMLEditorKit.
protected  class JEditorPane.JEditorPaneAccessibleHypertextSupport
          This is the accessible text that is returned by AccessibleJEditorPaneHTML#getAccessibleText().
private static class JEditorPane.PlainEditorKit
          An EditorKit used for plain text.
 
Nested classes inherited from class javax.swing.text.JTextComponent
javax.swing.text.JTextComponent.AccessibleJTextComponent, javax.swing.text.JTextComponent.KeyBinding
 
Nested classes inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
 
Nested classes inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Nested classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
private  javax.swing.text.EditorKit editorKit
           
(package private)  java.util.HashMap editorMap
           
(package private)  boolean focus_root
           
private  java.net.URL page
           
(package private) static java.util.HashMap registerMap
           
private static long serialVersionUID
           
 
Fields inherited from class javax.swing.text.JTextComponent
DEFAULT_KEYMAP, FOCUS_ACCELERATOR_KEY
 
Fields inherited from class javax.swing.JComponent
accessibleContext, alignmentX, alignmentY, autoscrolls, border, debugGraphicsOptions, doubleBuffered, isCompletelyDirty, isPaintingDoubleBuffered, listenerList, maximumSize, minimumSize, opaque, preferredSize, requestFocusEnabled, TOOL_TIP_TEXT_KEY, toolTipText, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
 
Fields inherited from class java.awt.Container
 
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(java.lang.String url)
           
JEditorPane(java.lang.String type, java.lang.String text)
           
JEditorPane(java.net.URL url)
           
 
Method Summary
 void addHyperlinkListener(javax.swing.event.HyperlinkListener listener)
          Add a HyperlinkListener object to this editor pane.
protected  javax.swing.text.EditorKit createDefaultEditorKit()
           
static javax.swing.text.EditorKit createEditorKitForContentType(java.lang.String type)
          Creates and returns an EditorKit that is appropriate for the given content type.
 void fireHyperlinkUpdate(javax.swing.event.HyperlinkEvent event)
          Sends a given HyperlinkEvent to all registered listeners.
 javax.accessibility.AccessibleContext getAccessibleContext()
          Returns the accessible context associated with this editor pane.
 java.lang.String getContentType()
           
 javax.swing.text.EditorKit getEditorKit()
          Returns the EditorKit.
static java.lang.String getEditorKitClassNameForContentType(java.lang.String type)
          Returns the class name of the EditorKit associated with the given content type.
 javax.swing.text.EditorKit getEditorKitForContentType(java.lang.String type)
          Returns the EditorKit to use for the given content type.
 javax.swing.event.HyperlinkListener[] getHyperlinkListeners()
          Returns all added HyperlinkListener objects.
 java.net.URL getPage()
           
 java.awt.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  java.io.InputStream getStream(java.net.URL page)
           
 java.lang.String getText()
          Retrieves the current text in this text document.
 java.lang.String getUIClassID()
          Returns a string that specifies the name of the Look and Feel class that renders this component.
(package private)  void init()
          Called by the constructors to set up the default bindings for content types and EditorKits.
 boolean isFocusCycleRoot()
          Check whether this Container is a focus cycle root.
protected  java.lang.String paramString()
          Returns a string representation of this JTextComponent.
 void read(java.io.InputStream in, java.lang.Object desc)
          This method initializes from a stream.
static void registerEditorKitForContentType(java.lang.String type, java.lang.String classname)
          Establishes a binding between type and classname.
static void registerEditorKitForContentType(java.lang.String type, java.lang.String classname, java.lang.ClassLoader loader)
          Establishes the default bindings of type to classname.
 void removeHyperlinkListener(javax.swing.event.HyperlinkListener listener)
          Removes a HyperlinkListener object to this editor pane.
 void replaceSelection(java.lang.String content)
          Replaces the currently selected content with new content represented by the given string.
 void scrollToReference(java.lang.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(java.lang.String type)
           
 void setEditorKit(javax.swing.text.EditorKit newValue)
           
 void setEditorKitForContentType(java.lang.String type, javax.swing.text.EditorKit k)
          Explicitly sets an EditorKit to be used for the given content type.
 void setPage(java.lang.String url)
          Sets the current URL being displayed.
 void setPage(java.net.URL page)
          Sets the current URL being displayed.
 void setText(java.lang.String t)
          Sets the text of the JEditorPane.
 
Methods inherited from class javax.swing.text.JTextComponent
addCaretListener, addInputMethodListener, addKeymap, copy, cut, fireCaretUpdate, getActions, getCaret, getCaretColor, getCaretListeners, getCaretPosition, getDisabledTextColor, getDocument, getDragEnabled, getFocusAccelerator, getHighlighter, getInputMethodListeners, getKeymap, getKeymap, getMargin, getNavigationFilter, getPreferredScrollableViewportSize, getScrollableBlockIncrement, getScrollableUnitIncrement, getSelectedText, getSelectedTextColor, getSelectionColor, getSelectionEnd, getSelectionStart, getText, getToolTipText, getUI, isEditable, loadKeymap, modelToView, moveCaretPosition, paste, read, removeCaretListener, removeInputMethodListener, removeKeymap, select, selectAll, setCaret, setCaretColor, setCaretPosition, setDisabledTextColor, setDocument, setDragEnabled, setEditable, setFocusAccelerator, setHighlighter, setKeymap, setMargin, setNavigationFilter, setSelectedTextColor, setSelectionColor, setSelectionEnd, setSelectionStart, setUI, updateUI, viewToModel, write
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, fireAncestorEvent, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paintImmediately2, paintSimple, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setUIProperty, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateComponentInputMap
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, transferFocusDownCycle, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

serialVersionUID

private static final long serialVersionUID
See Also:
Constant Field Values

page

private java.net.URL page

editorKit

private javax.swing.text.EditorKit editorKit

focus_root

boolean focus_root

registerMap

static java.util.HashMap registerMap

editorMap

java.util.HashMap editorMap
Constructor Detail

JEditorPane

public JEditorPane()

JEditorPane

public JEditorPane(java.lang.String url)
            throws java.io.IOException

JEditorPane

public JEditorPane(java.lang.String type,
                   java.lang.String text)

JEditorPane

public JEditorPane(java.net.URL url)
            throws java.io.IOException
Method Detail

init

void init()
Called by the constructors to set up the default bindings for content types and EditorKits.

createDefaultEditorKit

protected javax.swing.text.EditorKit createDefaultEditorKit()

createEditorKitForContentType

public static javax.swing.text.EditorKit createEditorKitForContentType(java.lang.String type)
Creates and returns an EditorKit that is appropriate for the given content type. This is created using the default recognized types plus any EditorKit types that have been registered.

fireHyperlinkUpdate

public void fireHyperlinkUpdate(javax.swing.event.HyperlinkEvent event)
Sends a given HyperlinkEvent to all registered listeners.

getAccessibleContext

public javax.accessibility.AccessibleContext getAccessibleContext()
Returns the accessible context associated with this editor pane.

getContentType

public final java.lang.String getContentType()

getEditorKit

public javax.swing.text.EditorKit getEditorKit()
Returns the EditorKit. If there is no EditorKit set this method calls createDefaultEditorKit() and setEditorKit() first.

getEditorKitClassNameForContentType

public static java.lang.String getEditorKitClassNameForContentType(java.lang.String type)
Returns the class name of the EditorKit associated with the given content type.

Since:
1.3

getEditorKitForContentType

public javax.swing.text.EditorKit getEditorKitForContentType(java.lang.String type)
Returns the EditorKit to use for the given content type. If an EditorKit has been explicitly set via 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.

getPreferredSize

public java.awt.Dimension getPreferredSize()
Returns the preferred size for the JEditorPane. This is implemented to return the super's preferred size, unless one of getScrollableTracksViewportHeight() 55 or getScrollableTracksViewportWidth() 55 returns true, in which case the preferred width and/or height is replaced by the UI's minimum size.

Overrides:
getPreferredSize in class JComponent

getScrollableTracksViewportHeight

public boolean getScrollableTracksViewportHeight()
Returns 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.

getScrollableTracksViewportWidth

public boolean getScrollableTracksViewportWidth()
Returns 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.

getPage

public java.net.URL getPage()

getStream

protected java.io.InputStream getStream(java.net.URL page)
                                 throws java.io.IOException

getText

public java.lang.String getText()
Description copied from class: javax.swing.text.JTextComponent
Retrieves the current text in this text document.

getUIClassID

public java.lang.String getUIClassID()
Description copied from class: javax.swing.text.JTextComponent
Returns a string that specifies the name of the Look and Feel class that renders this component.

isFocusCycleRoot

public boolean isFocusCycleRoot()
Description copied from class: java.awt.Container
Check whether this Container is a focus cycle root.

paramString

protected java.lang.String paramString()
Description copied from class: javax.swing.text.JTextComponent
Returns a string representation of this JTextComponent.

read

public void read(java.io.InputStream in,
                 java.lang.Object desc)
          throws java.io.IOException
This method initializes from a stream.

registerEditorKitForContentType

public static void registerEditorKitForContentType(java.lang.String type,
                                                   java.lang.String classname)
Establishes a binding between type and classname. This enables us to create an EditorKit later for the given content type.

registerEditorKitForContentType

public static void registerEditorKitForContentType(java.lang.String type,
                                                   java.lang.String classname,
                                                   java.lang.ClassLoader loader)
Establishes the default bindings of type to classname.

replaceSelection

public void replaceSelection(java.lang.String content)
Replaces the currently selected content with new content represented by the given string.

scrollToReference

public void scrollToReference(java.lang.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).

setContentType

public final void setContentType(java.lang.String type)

setEditorKit

public void setEditorKit(javax.swing.text.EditorKit newValue)

setEditorKitForContentType

public void setEditorKitForContentType(java.lang.String type,
                                       javax.swing.text.EditorKit k)
Explicitly sets an EditorKit to be used for the given content type.

setPage

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

setPage

public void setPage(java.net.URL page)
             throws java.io.IOException
Sets the current URL being displayed.

setText

public void setText(java.lang.String t)
Sets the text of the JEditorPane. The argument 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.

addHyperlinkListener

public void addHyperlinkListener(javax.swing.event.HyperlinkListener listener)
Add a HyperlinkListener object to this editor pane.

removeHyperlinkListener

public void removeHyperlinkListener(javax.swing.event.HyperlinkListener listener)
Removes a HyperlinkListener object to this editor pane.

getHyperlinkListeners

public javax.swing.event.HyperlinkListener[] getHyperlinkListeners()
Returns all added HyperlinkListener objects.

Since:
1.4
Overview  Package   Class  Use  Deprecated  Index 
Home >> All >> javax >> [ swing overview ]  PREV CLASS  NEXT CLASS
SUMMARY: JavaDoc of javax.swing.JEditorPane JAVADOC | Sourc code of javax.swing.JEditorPane SOURCE | Download javax.swing.JEditorPane DOWNLOAD | NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD