javax.swing.text

Class StyledEditorKit.StyledTextAction

Enclosing Class:
StyledEditorKit
Implemented Interfaces:
Action, ActionListener, Cloneable, EventListener, Serializable
Known Direct Subclasses:
HTMLEditorKit.HTMLTextAction, StyledEditorKit.AlignmentAction, StyledEditorKit.BoldAction, StyledEditorKit.FontFamilyAction, StyledEditorKit.FontSizeAction, StyledEditorKit.ForegroundAction, StyledEditorKit.ItalicAction, StyledEditorKit.UnderlineAction

public static abstract class StyledEditorKit.StyledTextAction
extends TextAction

The abstract superclass of all styled TextActions. This class provides some useful methods to manipulate the text attributes.
See Also:
Serialized Form

Field Summary

Fields inherited from class javax.swing.AbstractAction

changeSupport, enabled

Fields inherited from interface javax.swing.Action

ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SHORT_DESCRIPTION, SMALL_ICON

Constructor Summary

StyledTextAction(String nm)
Creates a new instance of StyledTextAction.

Method Summary

protected JEditorPane
getEditor(ActionEvent event)
Returns the JEditorPane component from which the ActionEvent originated.
protected StyledDocument
getStyledDocument(JEditorPane editor)
Returns the StyledDocument that is used by editor.
protected StyledEditorKit
getStyledEditorKit(JEditorPane editor)
Returns the StyledEditorKit that is used by editor.
protected void
setCharacterAttributes(JEditorPane editor, AttributeSet atts, boolean replace)
Sets the specified character attributes on the currently selected text of editor.
protected void
setParagraphAttributes(JEditorPane editor, AttributeSet atts, boolean replace)
Sets the specified character attributes on the paragraph that contains the currently selected text of editor.

Methods inherited from class javax.swing.text.TextAction

augmentList, getFocusedComponent, getTextComponent

Methods inherited from class javax.swing.AbstractAction

addPropertyChangeListener, clone, firePropertyChange, getKeys, getPropertyChangeListeners, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled

Methods inherited from class java.lang.Object

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

Constructor Details

StyledTextAction

public StyledTextAction(String nm)
Creates a new instance of StyledTextAction.
Parameters:
nm - the name of the StyledTextAction

Method Details

getEditor

protected final JEditorPane getEditor(ActionEvent event)
Returns the JEditorPane component from which the ActionEvent originated.
Parameters:
event - the ActionEvent
Returns:
the JEditorPane component from which the ActionEvent originated

getStyledDocument

protected final StyledDocument getStyledDocument(JEditorPane editor)
Returns the StyledDocument that is used by editor.
Parameters:
editor - the JEditorPane from which to get the StyledDocument
Returns:
the StyledDocument that is used by editor

getStyledEditorKit

protected final StyledEditorKit getStyledEditorKit(JEditorPane editor)
Returns the StyledEditorKit that is used by editor.
Parameters:
editor - the JEditorPane from which to get the StyledEditorKit
Returns:
the StyledEditorKit that is used by editor

setCharacterAttributes

protected final void setCharacterAttributes(JEditorPane editor,
                                            AttributeSet atts,
                                            boolean replace)
Sets the specified character attributes on the currently selected text of editor. If editor does not have a selection, then the attributes are used as input attributes for newly inserted content.
Parameters:
editor - the JEditorPane component
atts - the text attributes to set
replace - if true the current attributes of the selection are replaces, otherwise they are merged

setParagraphAttributes

protected final void setParagraphAttributes(JEditorPane editor,
                                            AttributeSet atts,
                                            boolean replace)
Sets the specified character attributes on the paragraph that contains the currently selected text of editor. If editor does not have a selection, then the attributes are set on the paragraph that contains the current caret position.
Parameters:
editor - the JEditorPane component
atts - the text attributes to set
replace - if true the current attributes of the selection are replaces, otherwise they are merged

StyledEditorKit.java -- Copyright (C) 2002, 2004 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.