StyledEditorKit.StyledTextAction (Java 2 Platform SE 5.0) (original) (raw)

javax.swing.text

Class StyledEditorKit.StyledTextAction

java.lang.Object extended by 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 JavaBeansTM has been added to the java.beans package. Please see XMLEncoder.

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
StyledEditorKit.StyledTextAction(String nm) Creates a new StyledTextAction from a string action name.

Method Summary
protected JEditorPane	getEditor(ActionEvent e) Gets the target editor for an action.
protected StyledDocument	getStyledDocument(JEditorPane e) Gets the document associated with an editor pane.
protected StyledEditorKit	getStyledEditorKit(JEditorPane e) Gets the editor kit associated with an editor pane.
protected void	[setCharacterAttributes](../../../javax/swing/text/StyledEditorKit.StyledTextAction.html#setCharacterAttributes%28javax.swing.JEditorPane, javax.swing.text.AttributeSet, boolean%29)(JEditorPane editor,AttributeSet attr, boolean replace) Applies the given attributes to character content.
protected void	[setParagraphAttributes](../../../javax/swing/text/StyledEditorKit.StyledTextAction.html#setParagraphAttributes%28javax.swing.JEditorPane, javax.swing.text.AttributeSet, boolean%29)(JEditorPane editor,AttributeSet attr, boolean replace) Applies the given attributes to paragraphs.

Methods inherited from class javax.swing.text.TextAction
[augmentList](../../../javax/swing/text/TextAction.html#augmentList%28javax.swing.Action[], javax.swing.Action[]%29), getFocusedComponent, getTextComponent

Methods inherited from class javax.swing.AbstractAction
addPropertyChangeListener, clone, [firePropertyChange](../../../javax/swing/AbstractAction.html#firePropertyChange%28java.lang.String, java.lang.Object, java.lang.Object%29), getKeys, getPropertyChangeListeners, getValue, isEnabled, [putValue](../../../javax/swing/AbstractAction.html#putValue%28java.lang.String, java.lang.Object%29), removePropertyChangeListener, setEnabled

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, [wait](../../../java/lang/Object.html#wait%28long, int%29)

Methods inherited from interface java.awt.event.ActionListener
actionPerformed

Constructor Detail

StyledEditorKit.StyledTextAction

public StyledEditorKit.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](../../../java/lang/IllegalArgumentException.html "class in java.lang") - 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](../../../java/lang/IllegalArgumentException.html "class in java.lang") - 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 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.