Overview | Package | Class | Tree | Deprecated | Index | Help			Java Platform 1.1.7
PREV CLASS | NEXT CLASS	FRAMES | NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

Class com.sun.java.swing.text.
StyledEditorKit.StyledTextAction

java.lang.Object
  |
  +--com.sun.java.swing.AbstractAction
        |
        +--com.sun.java.swing.text.TextAction
              |
              +--com.sun.java.swing.text.StyledEditorKit.StyledTextAction

Subclasses:

StyledEditorKit.AlignmentAction, StyledEditorKit.BoldAction, StyledEditorKit.FontFamilyAction, StyledEditorKit.FontSizeAction, StyledEditorKit.ForegroundAction, StyledEditorKit.ItalicAction, StyledEditorKit.UnderlineAction

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 Swing1.0 applications. It will not be possible to load serialized Swing1.0 objects with future releases of Swing. The JDK1.2 release of Swing will be the compatibility baseline for the serialized form of Swing objects.

See Also:

Serialized Form

Fields inherited from class com.sun.java.swing.AbstractAction

changeSupport, enabled

Constructor Summary

StyledEditorKit.StyledTextAction(java.lang.String nm)
Creates a new StyledTextAction from a string action name.

Method Summary

JEditorPane	getEditor(java.awt.event.ActionEvent e) Gets the target editor for an action.
StyledDocument	getStyledDocument(JEditorPane e) Gets the document associated with an editor pane.
StyledEditorKit	getStyledEditorKit(JEditorPane e) Gets the editor kit associated with an editor pane.
void	setCharacterAttributes(JEditorPane editor, AttributeSet attr, boolean replace) Applies the given attributes to character content.
void	setParagraphAttributes(JEditorPane editor, AttributeSet attr, boolean replace) Applies the given attributes to paragraphs.

Methods inherited from class com.sun.java.swing.text.TextAction

augmentList, getFocusedComponent, getTextComponent

Methods inherited from class com.sun.java.swing.AbstractAction

addPropertyChangeListener, firePropertyChange, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notifyAll, notify, toString, wait, wait, wait

Constructor Detail

StyledEditorKit.StyledTextAction

public StyledEditorKit.StyledTextAction(java.lang.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(java.awt.event.ActionEvent e)

Gets the target editor for an action.

Parameters:

e - the action event

Returns:

the editor

Throws:

java.lang.IllegalArgumentException - for an invalid target

getStyledDocument

protected final StyledDocument getStyledDocument(JEditorPane e)

Gets the document associated with an editor pane.

Parameters:

e - the editor

Returns:

the document

Throws:

java.lang.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:

java.lang.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