javax.swing.text
Class StyledEditorKit.StyledTextAction

java.lang.Object
  extended by javax.swing.AbstractAction
      extended by javax.swing.text.TextAction
          extended by 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

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
StyledEditorKit.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
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface java.awt.event.ActionListener
actionPerformed
 

Constructor Detail

StyledEditorKit.StyledTextAction

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

Parameters:
nm - the name of the StyledTextAction
Method Detail

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

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

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

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