Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

javax.swing

Class JTextPane

Implemented Interfaces:
Accessible, ImageObserver, MenuContainer, Scrollable, Serializable
public class JTextPane
extends JEditorPane
A powerful text component that supports styled content as well as embedding images and components. It is entirely based on a StyledDocument content model and a StyledEditorKit.
See Also:
Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JEditorPane

JEditorPane.AccessibleJEditorPane, JEditorPane.AccessibleJEditorPaneHTML, JEditorPane.JEditorPaneAccessibleHypertextSupport

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

TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW, accessibleContext, listenerList, ui

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

JTextPane()
Creates a new JTextPane with a null document.
JTextPane(StyledDocument document)
Creates a new JTextPane and sets the specified document.

Method Summary

Style
addStyle(String nm, Style parent)
Adds a style into the style hierarchy.
protected EditorKit
createDefaultEditorKit()
Creates the default EditorKit that is used in JTextPanes.
AttributeSet
getCharacterAttributes()
Returns the text attributes for the character at the current caret position.
MutableAttributeSet
getInputAttributes()
Returns the attributes that are applied to newly inserted text.
Style
getLogicalStyle()
Returns the logical style of the paragraph at the current caret position.
AttributeSet
getParagraphAttributes()
Returns the text attributes of the paragraph at the current caret position.
Style
getStyle(String nm)
Looks up and returns a named Style.
StyledDocument
getStyledDocument()
Returns the StyledDocument that is the content model for this JTextPane.
protected StyledEditorKit
getStyledEditorKit()
Returns the StyledEditorKit that is currently used by this JTextPane.
String
getUIClassID()
Returns the UI class ID.
void
insertComponent(Component component)
Inserts an AWT or Swing component into the text at the current caret position.
void
insertIcon(Icon icon)
Inserts an Icon into the text at the current caret position.
protected String
paramString()
Returns a param string that can be used for debugging.
void
removeStyle(String nm)
Removes a named Style from the style hierarchy.
void
replaceSelection(String content)
Replaces the currently selected text with the specified content.
void
setCharacterAttributes(AttributeSet attribute, boolean replace)
Sets text attributes for the current selection.
void
setDocument(Document document)
Sets the content model for this JTextPane.
void
setEditorKit(EditorKit editor)
Sets the EditorKit to use for this JTextPane.
void
setLogicalStyle(Style style)
Sets the logical style for the paragraph at the current caret position.
void
setParagraphAttributes(AttributeSet attribute, boolean replace)
Sets text attributes for the paragraph at the current selection.
void
setStyledDocument(StyledDocument document)
Sets the content model for this JTextPane.

Methods inherited from class javax.swing.JEditorPane

addHyperlinkListener, createDefaultEditorKit, createEditorKitForContentType, fireHyperlinkUpdate, getAccessibleContext, getContentType, getEditorKit, getEditorKitClassNameForContentType, getEditorKitForContentType, getHyperlinkListeners, getPage, getPreferredSize, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getStream, getText, getUIClassID, isFocusCycleRoot, paramString, read, registerEditorKitForContentType, registerEditorKitForContentType, removeHyperlinkListener, replaceSelection, scrollToReference, setContentType, setEditorKit, setEditorKitForContentType, setPage, setPage, setText

Methods inherited from class javax.swing.text.JTextComponent

addCaretListener, addInputMethodListener, addKeymap, copy, cut, fireCaretUpdate, getAccessibleContext, getActions, getCaret, getCaretColor, getCaretListeners, getCaretPosition, getDisabledTextColor, getDocument, getDragEnabled, getFocusAccelerator, getHighlighter, getInputMethodListeners, getKeymap, getKeymap, getMargin, getNavigationFilter, getPreferredScrollableViewportSize, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getSelectedText, getSelectedTextColor, getSelectionColor, getSelectionEnd, getSelectionStart, getText, getText, getToolTipText, getUI, getUIClassID, isEditable, loadKeymap, modelToView, moveCaretPosition, paramString, paste, read, removeCaretListener, removeInputMethodListener, removeKeymap, replaceSelection, select, selectAll, setCaret, setCaretColor, setCaretPosition, setDisabledTextColor, setDocument, setDragEnabled, setEditable, setFocusAccelerator, setHighlighter, setKeymap, setMargin, setNavigationFilter, setSelectedTextColor, setSelectionColor, setSelectionEnd, setSelectionStart, setText, setUI, updateUI, viewToModel, write

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, extends EventListener> T[] getListeners, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, 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, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setNextFocusableComponent, setOpaque, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addNotify, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, extends EventListener> T[] getListeners, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponentZOrder, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, paramString, preferredSize, print, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, removeNotify, setComponentZOrder, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, setLayout, transferFocusDownCycle, update, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, enableInputMethods, extends EventListener> T[] getListeners, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, getAlignmentX, getAlignmentY, getBackground, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeys, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMinimumSize, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusCycleRoot, isFocusOwner, isFocusTraversable, isFocusable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, 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, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusTraversalKeys, setFocusTraversalKeysEnabled, setFocusable, setFont, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle, update, validate

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

JTextPane

public JTextPane()
Creates a new JTextPane with a null document.

JTextPane

public JTextPane(StyledDocument document)
Creates a new JTextPane and sets the specified document.
Parameters:
document - the content model to use

Method Details

addStyle

public Style addStyle(String nm,
                      Style parent)
Adds a style into the style hierarchy. Unspecified style attributes can be resolved in the parent style, if one is specified. While it is legal to add nameless styles (nm == null
Parameters:
nm - the name of the style or null if the style should be unnamed
parent - the parent in which unspecified style attributes are resolved, or null if that is not necessary
Returns:
the newly created Style

createDefaultEditorKit

protected EditorKit createDefaultEditorKit()
Creates the default EditorKit that is used in JTextPanes. This is an instance of StyledEditorKit.
Overrides:
createDefaultEditorKit in interface JEditorPane
Returns:
the default EditorKit that is used in JTextPanes

getCharacterAttributes

public AttributeSet getCharacterAttributes()
Returns the text attributes for the character at the current caret position.
Returns:
the text attributes for the character at the current caret position

getInputAttributes

public MutableAttributeSet getInputAttributes()
Returns the attributes that are applied to newly inserted text. This is a MutableAttributeSet, so you can easily modify these attributes.
Returns:
the attributes that are applied to newly inserted text

getLogicalStyle

public Style getLogicalStyle()
Returns the logical style of the paragraph at the current caret position.
Returns:
the logical style of the paragraph at the current caret position

getParagraphAttributes

public AttributeSet getParagraphAttributes()
Returns the text attributes of the paragraph at the current caret position.
Returns:
the attributes of the paragraph at the current caret position

getStyle

public Style getStyle(String nm)
Looks up and returns a named Style.
Parameters:
nm - the name of the Style
Returns:
the found Style of null if no such Style exists

getStyledDocument

public StyledDocument getStyledDocument()
Returns the StyledDocument that is the content model for this JTextPane. This is a typed wrapper for getDocument().
Returns:
the content model of this JTextPane

getStyledEditorKit

protected final StyledEditorKit getStyledEditorKit()
Returns the StyledEditorKit that is currently used by this JTextPane.
Returns:
the current StyledEditorKit of this JTextPane

getUIClassID

public String getUIClassID()
Returns the UI class ID. This is TextPaneUI.
Overrides:
getUIClassID in interface JEditorPane
Returns:
TextPaneUI

insertComponent

public void insertComponent(Component component)
Inserts an AWT or Swing component into the text at the current caret position.
Parameters:
component - the component to be inserted

insertIcon

public void insertIcon(Icon icon)
Inserts an Icon into the text at the current caret position.
Parameters:
icon - the Icon to be inserted

paramString

protected String paramString()
Returns a param string that can be used for debugging.
Overrides:
paramString in interface JEditorPane
Returns:
a param string that can be used for debugging.

removeStyle

public void removeStyle(String nm)
Removes a named Style from the style hierarchy.
Parameters:
nm - the name of the Style to be removed

replaceSelection

public void replaceSelection(String content)
Replaces the currently selected text with the specified content. If there is no selected text, this results in a simple insertion at the current caret position. If there is no content specified, this results in the selection beeing deleted.
Overrides:
replaceSelection in interface JEditorPane
Parameters:
content - the text with which the selection is replaced

setCharacterAttributes

public void setCharacterAttributes(AttributeSet attribute,
                                   boolean replace)
Sets text attributes for the current selection. If there is no selection the text attributes are applied to newly inserted text
Parameters:
attribute - the text attributes to set
replace - if true, the attributes of the current selection are overridden, otherwise they are merged
See Also:
getInputAttributes()

setDocument

public void setDocument(Document document)
Sets the content model for this JTextPane. JTextPane can only be used with StyledDocuments, if you try to set a different type of Document, an IllegalArgumentException is thrown.
Overrides:
setDocument in interface JTextComponent
Parameters:
document - the content model to set
Throws:
IllegalArgumentException - if document is not an instance of StyledDocument
See Also:
setStyledDocument(StyledDocument)

setEditorKit

public final void setEditorKit(EditorKit editor)
Sets the EditorKit to use for this JTextPane. JTextPanes can only handle StyledEditorKits, if client programs try to set a different type of EditorKit then an IllegalArgumentException is thrown
Overrides:
setEditorKit in interface JEditorPane
Parameters:
editor - the EditorKit to set
Throws:
IllegalArgumentException - if editor is no StyledEditorKit

setLogicalStyle

public void setLogicalStyle(Style style)
Sets the logical style for the paragraph at the current caret position.
Parameters:
style - the style to set for the current paragraph

setParagraphAttributes

public void setParagraphAttributes(AttributeSet attribute,
                                   boolean replace)
Sets text attributes for the paragraph at the current selection. If there is no selection the text attributes are applied to the paragraph at the current caret position.
Parameters:
attribute - the text attributes to set
replace - if true, the attributes of the current selection are overridden, otherwise they are merged

setStyledDocument

public void setStyledDocument(StyledDocument document)
Sets the content model for this JTextPane.
Parameters:
document - the content model to set
JTextPane.java -- A powerful text widget supporting styled text Copyright (C) 2002, 2004, 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.

Overview Package Class Use Source Tree Index Deprecated About