Serializable
, Cloneable
, Accessible
public class HTMLEditorKit extends StyledEditorKit implements Accessible
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 documentation describes the details of how the HTML is modeled. The editing support leverages heavily off of the text package.
HTMLFactory
class. This can be easily changed by subclassing or replacing the HTMLFactory and reimplementing the getViewFactory method to return the alternative factory. JEditorPane.setPage
. This is controlled by a property on the document. The method createDefaultDocument
can be overridden to change this. The batching of work is done by the HTMLDocument.HTMLReader
class. The actual work is done by the DefaultStyledDocument
and AbstractDocument
classes in 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.
Modifier and Type | Class | Description |
---|---|---|
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. |
StyledEditorKit.AlignmentAction, StyledEditorKit.BoldAction, StyledEditorKit.FontFamilyAction, StyledEditorKit.FontSizeAction, StyledEditorKit.ForegroundAction, StyledEditorKit.ItalicAction, StyledEditorKit.StyledTextAction, StyledEditorKit.UnderlineAction
DefaultEditorKit.BeepAction, DefaultEditorKit.CopyAction, DefaultEditorKit.CutAction, DefaultEditorKit.DefaultKeyTypedAction, DefaultEditorKit.InsertBreakAction, DefaultEditorKit.InsertContentAction, DefaultEditorKit.InsertTabAction, DefaultEditorKit.PasteAction
Modifier and Type | Field | Description |
---|---|---|
static final String |
BOLD_ACTION |
The bold action identifier |
static final String |
COLOR_ACTION |
The Color choice action identifier The color is passed as an argument |
static final String |
DEFAULT_CSS |
Default Cascading Style Sheet file that sets up the tag views. |
static final String |
FONT_CHANGE_BIGGER |
The font size increase to next value action identifier |
static final String |
FONT_CHANGE_SMALLER |
The font size decrease to next value action identifier |
static final String |
IMG_ALIGN_BOTTOM |
Align images at the bottom. |
static final String |
IMG_ALIGN_MIDDLE |
Align images in the middle. |
static final String |
IMG_ALIGN_TOP |
Align images at the top. |
static final String |
IMG_BORDER |
Align images at the border. |
static final String |
ITALIC_ACTION |
The italic action identifier |
static final String |
LOGICAL_STYLE_ACTION |
The logical style choice action identifier The logical style is passed in as an argument |
static final String |
PARA_INDENT_LEFT |
The paragraph left indent action identifier |
static final String |
PARA_INDENT_RIGHT |
The paragraph right indent action identifier |
backwardAction, beepAction, beginAction, beginLineAction, beginLineUpAction, beginParagraphAction, beginWordAction, copyAction, cutAction, defaultKeyTypedAction, deleteNextCharAction, deleteNextWordAction, deletePrevCharAction, deletePrevWordAction, downAction, endAction, endLineAction, endLineDownAction, 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 | Description |
---|---|
HTMLEditorKit() |
Constructs an HTMLEditorKit, creates a StyleContext, and loads the style sheet. |
Modifier and Type | Method | Description |
---|---|---|
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 |
Copies the key/values in element s AttributeSet into set . |
void |
deinstall |
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 |
Inserts HTML into an existing document. |
void |
install |
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 |
Inserts content from the given stream. |
void |
setAutoFormSubmission |
Specifies if an html form submission is processed automatically or only FormSubmitEvent is fired. |
void |
setDefaultCursor |
Sets the default cursor. |
void |
setLinkCursor |
Sets the cursor to use over links. |
void |
setStyleSheet |
Set the set of styles to be used to render the various HTML elements. |
void |
write |
Write content from a document to the given stream in a format appropriate for this kind of content handler. |
getCharacterAttributeRun
createCaret, read, write
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
public HTMLEditorKit()
public String getContentType()
text/html
.getContentType
in class DefaultEditorKit
public ViewFactory getViewFactory()
getViewFactory
in class StyledEditorKit
public Document createDefaultDocument()
createDefaultDocument
in class StyledEditorKit
public void read(Reader in, Document doc, int pos) throws IOException, BadLocationException
doc
is an instance of HTMLDocument, this will read HTML 3.2 text. Inserting HTML into a non-empty document must be inside the body Element, if you do not insert into the body an exception will be thrown. When inserting into a non-empty document all tags outside of the body (head, title) will be dropped.read
in class DefaultEditorKit
in
- the stream to read fromdoc
- the destination for the insertionpos
- the location in the document to place the contentIOException
- on any I/O errorBadLocationException
- if pos represents an invalid location within the documentRuntimeException
- (will eventually be a BadLocationException) if pos is invalidpublic void insertHTML(HTMLDocument doc, int offset, String html, int popDepth, int pushDepth, HTML.Tag insertTag) throws BadLocationException, IOException
doc
- the document to insert intooffset
- the offset to insert HTML athtml
- the HTML stringpopDepth
- the number of ElementSpec.EndTagTypes to generate before insertingpushDepth
- the number of ElementSpec.StartTagTypes with a direction of ElementSpec.JoinNextDirection that should be generated before inserting, but after the end tags have been generatedinsertTag
- the first tag to start inserting into documentBadLocationException
- if offset
is invalidIOException
- on I/O errorRuntimeException
- (will eventually be a BadLocationException) if pos is invalidpublic void write(Writer out, Document doc, int pos, int len) throws IOException, BadLocationException
write
in class DefaultEditorKit
out
- the stream to write todoc
- the source for the writepos
- the location in the document to fetch the contentlen
- the amount to write outIOException
- on any I/O errorBadLocationException
- if pos
represents an invalid location within the documentpublic void install(JEditorPane c)
install
in class StyledEditorKit
c
- the JEditorPanepublic void deinstall(JEditorPane c)
deinstall
in class StyledEditorKit
c
- the JEditorPanepublic void setStyleSheet(StyleSheet s)
s
- a StyleSheetpublic StyleSheet getStyleSheet()
public Action[] getActions()
getActions
in class StyledEditorKit
protected void createInputAttributes(Element element, MutableAttributeSet set)
element
s 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.
createInputAttributes
in class StyledEditorKit
element
- the elementset
- the attributespublic MutableAttributeSet getInputAttributes()
getInputAttributes
in class StyledEditorKit
public void setDefaultCursor(Cursor cursor)
cursor
- a cursorpublic Cursor getDefaultCursor()
public void setLinkCursor(Cursor cursor)
cursor
- a cursorpublic Cursor getLinkCursor()
public boolean isAutoFormSubmission()
FormSubmitEvent
is fired.public void setAutoFormSubmission(boolean isAuto)
FormSubmitEvent
is fired. By default it is set to true.isAuto
- if true
, html form submission is processed automatically.public Object clone()
clone
in class StyledEditorKit
protected HTMLEditorKit.Parser getParser()
public AccessibleContext getAccessibleContext()
getAccessibleContext
in interface Accessible
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/javax/swing/text/html/HTMLEditorKit.html