java.lang.Object javax.swing.text.EditorKit javax.swing.text.DefaultEditorKit javax.swing.text.StyledEditorKit javax.swing.text.html.HTMLEditorKit
The Swing JEditorPane text component supports different kinds of content via a plug-in mechanism called an EditorKit. Because HTML is a very popular format of content, some support is provided by default. The default support is provided by this class, which supports HTML version 3.2 (with some extensions), and is migrating toward version 4.0. The <applet> tag is not supported, but some support is provided for the <object> tag.
There are several goals of the HTML EditorKit provided, that have an effect upon the way that HTML is modeled. These have influenced its design in a substantial way.
The modeling of HTML is provided by the class HTMLDocument. Its documention describes the details of how the HTML is modeled. The editing support leverages heavily off of the text package.
The support for this is provided by the StyleSheet class. The presentation of the HTML can be heavily influenced by the setting of the StyleSheet property on the EditorKit.
Nested Class Summary | |
---|---|
static class |
HTMLEditorKit.HTMLFactory
A factory to build views for HTML. |
static class |
HTMLEditorKit.HTMLTextAction
An abstract Action providing some convenience methods that may be useful in inserting HTML into an existing document. |
static class |
HTMLEditorKit.InsertHTMLTextAction
InsertHTMLTextAction can be used to insert an arbitrary string of HTML into an existing HTML document. |
static class |
HTMLEditorKit.LinkController
Class to watch the associated component and fire hyperlink events on it when appropriate. |
static class |
HTMLEditorKit.Parser
Interface to be supported by the parser. |
static class |
HTMLEditorKit.ParserCallback
The result of parsing drives these callback methods. |
Nested classes inherited from class javax.swing.text. StyledEditorKit |
---|
StyledEditorKit.AlignmentAction , StyledEditorKit.BoldAction , StyledEditorKit.FontFamilyAction , StyledEditorKit.FontSizeAction , StyledEditorKit.ForegroundAction , StyledEditorKit.ItalicAction , StyledEditorKit.StyledTextAction , StyledEditorKit.UnderlineAction |
Nested classes inherited from class javax.swing.text. DefaultEditorKit |
---|
DefaultEditorKit.BeepAction , DefaultEditorKit.CopyAction , DefaultEditorKit.CutAction , DefaultEditorKit.DefaultKeyTypedAction , DefaultEditorKit.InsertBreakAction , DefaultEditorKit.InsertContentAction , DefaultEditorKit.InsertTabAction , DefaultEditorKit.PasteAction |
Field Summary | |
---|---|
static String |
BOLD_ACTION
The bold action identifier |
static String |
COLOR_ACTION
The Color choice action identifier The color is passed as an argument |
static String |
DEFAULT_CSS
Default Cascading Style Sheet file that sets up the tag views. |
static String |
FONT_CHANGE_BIGGER
The font size increase to next value action identifier |
static String |
FONT_CHANGE_SMALLER
The font size decrease to next value action identifier |
static String |
IMG_ALIGN_BOTTOM
Align images at the bottom. |
static String |
IMG_ALIGN_MIDDLE
Align images in the middle. |
static String |
IMG_ALIGN_TOP
Align images at the top. |
static String |
IMG_BORDER
Align images at the border. |
static String |
ITALIC_ACTION
The italic action identifier |
static String |
LOGICAL_STYLE_ACTION
The logical style choice action identifier The logical style is passed in as an argument |
static String |
PARA_INDENT_LEFT
The paragraph left indent action identifier |
static String |
PARA_INDENT_RIGHT
The paragraph right indent action identifier |
Fields inherited from class javax.swing.text. DefaultEditorKit |
---|
backwardAction , beepAction , beginAction , beginLineAction , beginParagraphAction , beginWordAction , copyAction , cutAction , defaultKeyTypedAction , deleteNextCharAction , deletePrevCharAction , downAction , endAction , endLineAction , EndOfLineStringProperty , endParagraphAction , endWordAction , forwardAction , insertBreakAction , insertContentAction , insertTabAction , nextWordAction , pageDownAction , pageUpAction , pasteAction , previousWordAction , readOnlyAction , selectAllAction , selectionBackwardAction , selectionBeginAction , selectionBeginLineAction , selectionBeginParagraphAction , selectionBeginWordAction , selectionDownAction , selectionEndAction , selectionEndLineAction , selectionEndParagraphAction , selectionEndWordAction , selectionForwardAction , selectionNextWordAction , selectionPreviousWordAction , selectionUpAction , selectLineAction , selectParagraphAction , selectWordAction , upAction , writableAction |
Constructor Summary | |
---|---|
HTMLEditorKit
() Constructs an HTMLEditorKit, creates a StyleContext, and loads the style sheet. |
Method Summary | |
---|---|
Object |
clone
() Creates a copy of the editor kit. |
Document |
createDefaultDocument
() Create an uninitialized text storage model that is appropriate for this type of editor. |
protected void |
createInputAttributes
(
Element
element,
MutableAttributeSet
set) Copies the key/values in elements AttributeSet into set. |
void |
deinstall
(
JEditorPane
c) Called when the kit is being removed from the JEditorPane. |
AccessibleContext |
getAccessibleContext
() returns the AccessibleContext associated with this editor kit |
Action [] |
getActions
() Fetches the command list for the editor. |
String |
getContentType
() Get the MIME type of the data that this kit represents support for. |
Cursor |
getDefaultCursor
() Returns the default cursor. |
MutableAttributeSet |
getInputAttributes
() Gets the input attributes used for the styled editing actions. |
Cursor |
getLinkCursor
() Returns the cursor to use over hyper links. |
protected HTMLEditorKit.Parser |
getParser
() Fetch the parser to use for reading HTML streams. |
StyleSheet |
getStyleSheet
() Get the set of styles currently being used to render the HTML elements. |
ViewFactory |
getViewFactory
() Fetch a factory that is suitable for producing views of any models that are produced by this kit. |
void |
insertHTML
(
HTMLDocument
doc, int offset,
String
html, int popDepth, int pushDepth,
HTML.Tag
insertTag) Inserts HTML into an existing document. |
void |
install
(
JEditorPane
c) Called when the kit is being installed into the a JEditorPane. |
boolean |
isAutoFormSubmission
()
Indicates whether an html form submission is processed automatically or only FormSubmitEvent is fired. |
void |
read
(
Reader
in,
Document
doc, int pos) Inserts content from the given stream. |
void |
setAutoFormSubmission
(boolean isAuto)
Specifies if an html form submission is processed automatically or only FormSubmitEvent is fired. |
void |
setDefaultCursor
(
Cursor
cursor) Sets the default cursor. |
void |
setLinkCursor
(
Cursor
cursor) Sets the cursor to use over links. |
void |
setStyleSheet
(
StyleSheet
s) Set the set of styles to be used to render the various HTML elements. |
void |
write
(
Writer
out,
Document
doc, int pos, int len) Write content from a document to the given stream in a format appropriate for this kind of content handler. |
Methods inherited from class javax.swing.text. StyledEditorKit |
---|
getCharacterAttributeRun |
Methods inherited from class javax.swing.text. DefaultEditorKit |
---|
createCaret , read , write |
Methods inherited from class java.lang. Object |
---|
equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait |
Field Detail |
---|
public static final String DEFAULT_CSS
public static final String BOLD_ACTION
public static final String ITALIC_ACTION
public static final String PARA_INDENT_LEFT
public static final String PARA_INDENT_RIGHT
public static final String FONT_CHANGE_BIGGER
public static final String FONT_CHANGE_SMALLER
public static final String COLOR_ACTION
public static final String LOGICAL_STYLE_ACTION
public static final String IMG_ALIGN_TOP
public static final String IMG_ALIGN_MIDDLE
public static final String IMG_ALIGN_BOTTOM
public static final String IMG_BORDER
Constructor Detail |
---|
public HTMLEditorKit()
Method Detail |
---|
public String getContentType()
public ViewFactory getViewFactory()
public Document createDefaultDocument()
public void read(Reader in, Document doc, int pos) throws IOException, BadLocationException
public void insertHTML(HTMLDocument doc, int offset, String html, int popDepth, int pushDepth, HTML.Tag insertTag) throws BadLocationException, IOException
public void write(Writer out, Document doc, int pos, int len) throws IOException, BadLocationException
public void install(JEditorPane c)
public void deinstall(JEditorPane c)
public void setStyleSheet(StyleSheet s)
public StyleSheet getStyleSheet()
public Action[] getActions()
protected void createInputAttributes(Element element, MutableAttributeSet set)
This is called anytime the caret moves over a different location.
public MutableAttributeSet getInputAttributes()
public void setDefaultCursor(Cursor cursor)
public Cursor getDefaultCursor()
public void setLinkCursor(Cursor cursor)
public Cursor getLinkCursor()
public boolean isAutoFormSubmission ()
public void setAutoFormSubmission (boolean isAuto)
public Object clone()
protected HTMLEditorKit.Parser getParser()
public AccessibleContext getAccessibleContext()