public class

StyledEditorKit

extends DefaultEditorKit

java.lang.Object
↳	javax.swing.text.EditorKit
	↳	javax.swing.text.DefaultEditorKit
		↳	javax.swing.text.StyledEditorKit

Known Direct Subclasses

HTMLEditorKit, RTFEditorKit

Class Overview

This is the set of things needed by a text component to be a reasonably functioning editor for some type of text document. This implementation provides a default implementation which treats text as styled text and provides a minimal set of actions for editing styled text.

Summary

Nested Classes
class	StyledEditorKit.AlignmentAction	An action to set paragraph alignment.
class	StyledEditorKit.BoldAction	An action to toggle the bold attribute.
class	StyledEditorKit.FontFamilyAction	An action to set the font family in the associated JEditorPane.
class	StyledEditorKit.FontSizeAction	An action to set the font size in the associated JEditorPane.
class	StyledEditorKit.ForegroundAction	An action to set foreground color.
class	StyledEditorKit.ItalicAction	An action to toggle the italic attribute.
class	StyledEditorKit.StyledTextAction	An action that assumes it's being fired on a JEditorPane with a StyledEditorKit (or subclass) installed.
class	StyledEditorKit.UnderlineAction	An action to toggle the underline attribute.

[Expand]

Inherited Constants

From class javax.swing.text.DefaultEditorKit

String	EndOfLineStringProperty	When reading a document if a CRLF is encountered a property with this name is added and the value will be "\r\n".
String	backwardAction	Name of the Action for moving the caret logically backward one position.
String	beepAction	Name of the action to create a beep.
String	beginAction	Name of the `Action` for moving the caret to the beginning of the document.
String	beginLineAction	Name of the `Action` for moving the caret to the beginning of a line.
String	beginParagraphAction	Name of the `Action` for moving the caret to the beginning of a paragraph.
String	beginWordAction	Name of the `Action` for moving the caret to the beginning of a word.
String	copyAction	Name of the action to copy the selected region and place the contents into the system clipboard.
String	cutAction	Name of the action to cut the selected region and place the contents into the system clipboard.
String	defaultKeyTypedAction	Name of the action that is executed by default if a key typed event is received and there is no keymap entry.
String	deleteNextCharAction	Name of the action to delete the character of content that follows the current caret position.
String	deleteNextWordAction	Name of the action to delete the word that follows the beginning of the selection.
String	deletePrevCharAction	Name of the action to delete the character of content that precedes the current caret position.
String	deletePrevWordAction	Name of the action to delete the word that precedes the beginning of the selection.
String	downAction	Name of the Action for moving the caret logically downward one position.
String	endAction	Name of the `Action` for moving the caret to the end of the document.
String	endLineAction	Name of the `Action` for moving the caret to the end of a line.
String	endParagraphAction	Name of the `Action` for moving the caret to the end of a paragraph.
String	endWordAction	Name of the Action for moving the caret to the end of a word.
String	forwardAction	Name of the Action for moving the caret logically forward one position.
String	insertBreakAction	Name of the action to place a line/paragraph break into the document.
String	insertContentAction	Name of the action to place content into the associated document.
String	insertTabAction	Name of the action to place a tab character into the document.
String	nextWordAction	Name of the `Action` for moving the caret to the beginning of the next word.
String	pageDownAction	Name of the action to page down vertically.
String	pageUpAction	Name of the action to page up vertically.
String	pasteAction	Name of the action to paste the contents of the system clipboard into the selected region, or before the caret if nothing is selected.
String	previousWordAction	Name of the `Action` for moving the caret to the beginning of the previous word.
String	readOnlyAction	Name of the action to set the editor into read-only mode.
String	selectAllAction	Name of the Action for selecting the entire document
String	selectLineAction	Name of the Action for selecting a line around the caret.
String	selectParagraphAction	Name of the Action for selecting a paragraph around the caret.
String	selectWordAction	Name of the Action for selecting a word around the caret.
String	selectionBackwardAction	Name of the Action for extending the selection by moving the caret logically backward one position.
String	selectionBeginAction	Name of the `Action` for moving the caret to the beginning of the document.
String	selectionBeginLineAction	Name of the `Action` for moving the caret to the beginning of a line, extending the selection.
String	selectionBeginParagraphAction	Name of the `Action` for moving the caret to the beginning of a paragraph, extending the selection.
String	selectionBeginWordAction	Name of the `Action` for moving the caret to the beginning of a word, extending the selection.
String	selectionDownAction	Name of the Action for moving the caret logically downward one position, extending the selection.
String	selectionEndAction	Name of the Action for moving the caret to the end of the document.
String	selectionEndLineAction	Name of the `Action` for moving the caret to the end of a line, extending the selection.
String	selectionEndParagraphAction	Name of the `Action` for moving the caret to the end of a paragraph, extending the selection.
String	selectionEndWordAction	Name of the Action for moving the caret to the end of a word, extending the selection.
String	selectionForwardAction	Name of the Action for extending the selection by moving the caret logically forward one position.
String	selectionNextWordAction	Name of the `Action` for moving the selection to the beginning of the next word, extending the selection.
String	selectionPreviousWordAction	Name of the `Action` for moving the selection to the beginning of the previous word, extending the selection.
String	selectionUpAction	Name of the Action for moving the caret logically upward one position, extending the selection.
String	upAction	Name of the Action for moving the caret logically upward one position.
String	writableAction	Name of the action to set the editor into writeable mode.

Public Constructors
	StyledEditorKit() Creates a new EditorKit used for styled documents.

Public Methods
Object	clone() Creates a copy of the editor kit.
Document	createDefaultDocument() Creates an uninitialized text storage model that is appropriate for this type of editor.
void	deinstall(JEditorPane c) Called when the kit is being removed from the JEditorPane.
Action[]	getActions() Fetches the command list for the editor.
Element	getCharacterAttributeRun() Fetches the element representing the current run of character attributes for the caret.
MutableAttributeSet	getInputAttributes() Gets the input attributes for the pane.
ViewFactory	getViewFactory() Fetches a factory that is suitable for producing views of any models that are produced by this kit.
void	install(JEditorPane c) Called when the kit is being installed into a JEditorPane.

Protected Methods
void	createInputAttributes(Element element, MutableAttributeSet set) Copies the key/values in `element`s AttributeSet into `set`.

[Expand]

Inherited Methods

From class javax.swing.text.DefaultEditorKit

Caret	createCaret() Fetches a caret that can navigate through views produced by the associated ViewFactory.
Document	createDefaultDocument() Creates an uninitialized text storage model (PlainDocument) that is appropriate for this type of editor.
Action[]	getActions() Fetches the set of commands that can be used on a text component that is using a model and view produced by this kit.
String	getContentType() Gets the MIME type of the data that this kit represents support for.
ViewFactory	getViewFactory() Fetches a factory that is suitable for producing views of any models that are produced by this kit.
void	read(InputStream in, Document doc, int pos) Inserts content from the given stream which is expected to be in a format appropriate for this kind of content handler.
void	read(Reader in, Document doc, int pos) Inserts content from the given stream, which will be treated as plain text.
void	write(Writer out, Document doc, int pos, int len) Writes content from a document to the given stream as plain text.
void	write(OutputStream out, Document doc, int pos, int len) Writes content from a document to the given stream in a format appropriate for this kind of content handler.

From class javax.swing.text.EditorKit

Object	clone() Creates a copy of the editor kit.
abstract Caret	createCaret() Fetches a caret that can navigate through views produced by the associated ViewFactory.
abstract Document	createDefaultDocument() Creates an uninitialized text storage model that is appropriate for this type of editor.
void	deinstall(JEditorPane c) Called when the kit is being removed from the JEditorPane.
abstract Action[]	getActions() Fetches the set of commands that can be used on a text component that is using a model and view produced by this kit.
abstract String	getContentType() Gets the MIME type of the data that this kit represents support for.
abstract ViewFactory	getViewFactory() Fetches a factory that is suitable for producing views of any models that are produced by this kit.
void	install(JEditorPane c) Called when the kit is being installed into the a JEditorPane.
abstract void	read(InputStream in, Document doc, int pos) Inserts content from the given stream which is expected to be in a format appropriate for this kind of content handler.
abstract void	read(Reader in, Document doc, int pos) Inserts content from the given stream which is expected to be in a format appropriate for this kind of content handler.
abstract void	write(Writer out, Document doc, int pos, int len) Writes content from a document to the given stream in a format appropriate for this kind of content handler.
abstract void	write(OutputStream out, Document doc, int pos, int len) Writes content from a document to the given stream in a format appropriate for this kind of content handler.

From class java.lang.Object

Object	clone() Creates and returns a copy of this object.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
void	finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
final Class<?>	getClass() Returns the runtime class of this `Object`.
int	hashCode() Returns a hash code value for the object.
final void	notify() Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll() Wakes up all threads that are waiting on this object's monitor.
String	toString() Returns a string representation of the object.
final void	wait() Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.
final void	wait(long timeout, int nanos) Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
final void	wait(long timeout) Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.

Public Constructors

public StyledEditorKit ()

Creates a new EditorKit used for styled documents.

Public Methods

public Object clone ()

Creates a copy of the editor kit.

Returns

the copy

public Document createDefaultDocument ()

Creates an uninitialized text storage model that is appropriate for this type of editor.

Returns

the model

public void deinstall (JEditorPane c)

Called when the kit is being removed from the JEditorPane. This is used to unregister any listeners that were attached.

Parameters

c	the JEditorPane

public Action[] getActions ()

Fetches the command list for the editor. This is the list of commands supported by the superclass augmented by the collection of commands defined locally for style operations.

Returns

the command list

public Element getCharacterAttributeRun ()

Fetches the element representing the current run of character attributes for the caret.

Returns

the element

public MutableAttributeSet getInputAttributes ()

Gets the input attributes for the pane. When the caret moves and there is no selection, the input attributes are automatically mutated to reflect the character attributes of the current caret location. The styled editing actions use the input attributes to carry out their actions.

Returns

the attribute set

public ViewFactory getViewFactory ()

Fetches a factory that is suitable for producing views of any models that are produced by this kit. This is implemented to return View implementations for the following kinds of elements:

AbstractDocument.ContentElementName
AbstractDocument.ParagraphElementName
AbstractDocument.SectionElementName
StyleConstants.ComponentElementName
StyleConstants.IconElementName

Returns

the factory

public void install (JEditorPane c)

Called when the kit is being installed into a JEditorPane.

Parameters

c	the JEditorPane

Protected Methods

protected void createInputAttributes (Element element, MutableAttributeSet set)

Copies the key/values in elements AttributeSet into set. This does not copy component, icon, or element names attributes. Subclasses may wish to refine what is and what isn't copied here. But be sure to first remove all the attributes that are in set.

This is called anytime the caret moves over a different location.

Interfaces

Classes

Exceptions

StyledEditorKit

Class Overview

Summary

Public Constructors

public StyledEditorKit ()

Public Methods

public Object clone ()

Returns

public Document createDefaultDocument ()

Returns

public void deinstall (JEditorPane c)

Parameters

public Action[] getActions ()

Returns

public Element getCharacterAttributeRun ()

Returns

public MutableAttributeSet getInputAttributes ()

Returns

public ViewFactory getViewFactory ()

Returns

public void install (JEditorPane c)

Parameters

Protected Methods

protected void createInputAttributes (Element element, MutableAttributeSet set)