javax.swing.text
Class StyledEditorKit.StyledTextAction
- java.lang.Object
-
- javax.swing.AbstractAction
-
- javax.swing.text.TextAction
-
- javax.swing.text.StyledEditorKit.StyledTextAction
-
- All Implemented Interfaces:
- ActionListener, Serializable, Cloneable, EventListener, Action
- Direct Known Subclasses:
- HTMLEditorKit.HTMLTextAction, StyledEditorKit.AlignmentAction, StyledEditorKit.BoldAction, StyledEditorKit.FontFamilyAction, StyledEditorKit.FontSizeAction, StyledEditorKit.ForegroundAction, StyledEditorKit.ItalicAction, StyledEditorKit.UnderlineAction
- Enclosing class:
- StyledEditorKit
public abstract static class StyledEditorKit.StyledTextAction extends TextAction
An action that assumes it's being fired on a JEditorPane with a StyledEditorKit (or subclass) installed. This has some convenience methods for causing character or paragraph level attribute changes. The convenience methods will throw an IllegalArgumentException if the assumption of a StyledDocument, a JEditorPane, or a StyledEditorKit fail to be true.The component that gets acted upon by the action will be the source of the ActionEvent if the source can be narrowed to a JEditorPane type. If the source can't be narrowed, the most recently focused text component is changed. If neither of these are the case, the action cannot be performed.
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 applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeans™ has been added to the
java.beanspackage. Please seeXMLEncoder.
-
-
Field Summary
-
Fields inherited from class javax.swing.AbstractAction
changeSupport, enabled
-
Fields inherited from interface javax.swing.Action
ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, DISPLAYED_MNEMONIC_INDEX_KEY, LARGE_ICON_KEY, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SELECTED_KEY, SHORT_DESCRIPTION, SMALL_ICON
-
-
Constructor Summary
Constructors Constructor and Description StyledTextAction(String nm)Creates a new StyledTextAction from a string action name.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description protected JEditorPanegetEditor(ActionEvent e)Gets the target editor for an action.protected StyledDocumentgetStyledDocument(JEditorPane e)Gets the document associated with an editor pane.protected StyledEditorKitgetStyledEditorKit(JEditorPane e)Gets the editor kit associated with an editor pane.protected voidsetCharacterAttributes(JEditorPane editor, AttributeSet attr, boolean replace)Applies the given attributes to character content.protected voidsetParagraphAttributes(JEditorPane editor, AttributeSet attr, boolean replace)Applies the given attributes to paragraphs.-
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
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.awt.event.ActionListener
actionPerformed
-
-
-
-
Constructor Detail
StyledTextAction
public StyledTextAction(String nm)
Creates a new StyledTextAction from a string action name.- Parameters:
-
nm- the name of the action
-
Method Detail
getEditor
protected final JEditorPane getEditor(ActionEvent e)
Gets the target editor for an action.- Parameters:
-
e- the action event - Returns:
- the editor
getStyledDocument
protected final StyledDocument getStyledDocument(JEditorPane e)
Gets the document associated with an editor pane.- Parameters:
-
e- the editor - Returns:
- the document
- Throws:
-
IllegalArgumentException- for the wrong document type
getStyledEditorKit
protected final StyledEditorKit getStyledEditorKit(JEditorPane e)
Gets the editor kit associated with an editor pane.- Parameters:
-
e- the editor pane - Returns:
- the kit
- Throws:
-
IllegalArgumentException- for the wrong document type
setCharacterAttributes
protected final void setCharacterAttributes(JEditorPane editor, AttributeSet attr, boolean replace)
Applies the given attributes to character content. If there is a selection, the attributes are applied to the selection range. If there is no selection, the attributes are applied to the input attribute set which defines the attributes for any new text that gets inserted.- Parameters:
-
editor- the editor -
attr- the attributes -
replace- if true, then replace the existing attributes first
setParagraphAttributes
protected final void setParagraphAttributes(JEditorPane editor, AttributeSet attr, boolean replace)
Applies the given attributes to paragraphs. If there is a selection, the attributes are applied to the paragraphs that intersect the selection. if there is no selection, the attributes are applied to the paragraph at the current caret position.- Parameters:
-
editor- the editor -
attr- the attributes -
replace- if true, replace the existing attributes first
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
