Liking cljdoc? Tell your friends :D

javax.swing.text.EditorKit

Establishes the set of things needed by a text component to be a reasonably functioning editor for some type of text content. The EditorKit acts as a factory for some kind of policy. For example, an implementation of html and rtf can be provided that is replaceable with other implementations.

A kit can safely store editing state as an instance of the kit will be dedicated to a text component. New kits will normally be created by cloning a prototype kit. The kit will have it's setComponent method called to establish it's relationship with a JTextComponent.

Establishes the set of things needed by a text component
to be a reasonably functioning editor for some type
of text content.  The EditorKit acts as a factory for some
kind of policy.  For example, an implementation
of html and rtf can be provided that is replaceable
with other implementations.

A kit can safely store editing state as an instance
of the kit will be dedicated to a text component.
New kits will normally be created by cloning a
prototype kit.  The kit will have it's
setComponent method called to establish
it's relationship with a JTextComponent.
raw docstring

->editor-kitclj

(->editor-kit)

Constructor.

Construct an EditorKit.

Constructor.

Construct an EditorKit.
raw docstring

cloneclj

(clone this)

Creates a copy of the editor kit. This is implemented to use Object.clone(). If the kit cannot be cloned, null is returned.

returns: the copy - java.lang.Object

Creates a copy of the editor kit.  This is implemented
 to use Object.clone().  If the kit cannot be cloned,
 null is returned.

returns: the copy - `java.lang.Object`
raw docstring

create-caretclj

(create-caret this)

Fetches a caret that can navigate through views produced by the associated ViewFactory.

returns: the caret - javax.swing.text.Caret

Fetches a caret that can navigate through views
 produced by the associated ViewFactory.

returns: the caret - `javax.swing.text.Caret`
raw docstring

create-default-documentclj

(create-default-document this)

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

returns: the model - javax.swing.text.Document

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

returns: the model - `javax.swing.text.Document`
raw docstring

deinstallclj

(deinstall this c)

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

c - the JEditorPane - javax.swing.JEditorPane

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

c - the JEditorPane - `javax.swing.JEditorPane`
raw docstring

get-actionsclj

(get-actions this)

Fetches the set of commands that can be used on a text component that is using a model and view produced by this kit.

returns: the set of actions - javax.swing.Action[]

Fetches the set of commands that can be used
 on a text component that is using a model and
 view produced by this kit.

returns: the set of actions - `javax.swing.Action[]`
raw docstring

get-content-typeclj

(get-content-type this)

Gets the MIME type of the data that this kit represents support for.

returns: the type - java.lang.String

Gets the MIME type of the data that this
 kit represents support for.

returns: the type - `java.lang.String`
raw docstring

get-view-factoryclj

(get-view-factory this)

Fetches a factory that is suitable for producing views of any models that are produced by this kit.

returns: the factory - javax.swing.text.ViewFactory

Fetches a factory that is suitable for producing
 views of any models that are produced by this
 kit.

returns: the factory - `javax.swing.text.ViewFactory`
raw docstring

installclj

(install this c)

Called when the kit is being installed into the a JEditorPane.

c - the JEditorPane - javax.swing.JEditorPane

Called when the kit is being installed into the
 a JEditorPane.

c - the JEditorPane - `javax.swing.JEditorPane`
raw docstring

readclj

(read this in doc pos)

Inserts content from the given stream which is expected to be in a format appropriate for this kind of content handler.

in - The stream to read from - java.io.InputStream doc - The destination for the insertion. - javax.swing.text.Document pos - The location in the document to place the content >= 0. - int

throws: java.io.IOException - on any I/O error

Inserts content from the given stream which is expected
 to be in a format appropriate for this kind of content
 handler.

in - The stream to read from - `java.io.InputStream`
doc - The destination for the insertion. - `javax.swing.text.Document`
pos - The location in the document to place the content >= 0. - `int`

throws: java.io.IOException - on any I/O error
raw docstring

writeclj

(write this out doc pos len)

Writes content from a document to the given stream in a format appropriate for this kind of content handler.

out - The stream to write to - java.io.OutputStream doc - The source for the write. - javax.swing.text.Document pos - The location in the document to fetch the content from >= 0. - int len - The amount to write out >= 0. - int

throws: java.io.IOException - on any I/O error

Writes content from a document to the given stream
 in a format appropriate for this kind of content handler.

out - The stream to write to - `java.io.OutputStream`
doc - The source for the write. - `javax.swing.text.Document`
pos - The location in the document to fetch the content from >= 0. - `int`
len - The amount to write out >= 0. - `int`

throws: java.io.IOException - on any I/O error
raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close