de.sciss.syntaxpane

Class DefaultSyntaxKit

java.lang.Object

javax.swing.text.EditorKit

javax.swing.text.DefaultEditorKit

de.sciss.syntaxpane.DefaultSyntaxKit

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, javax.swing.text.ViewFactory

Direct Known Subclasses:

BashSyntaxKit, ClojureSyntaxKit, CSyntaxKit, DOSBatchSyntaxKit, JavaRegexKit, JavaScriptSyntaxKit, JavaSyntaxKit, LuaSyntaxKit, MarkdownSyntaxKit, PlainSyntaxKit, PropertiesSyntaxKit, PythonSyntaxKit, RubySyntaxKit, ScalaSyntaxKit, SqlSyntaxKit, TALSyntaxKit, XHTMLSyntaxKit, XmlSyntaxKit, XPathSyntaxKit

public class DefaultSyntaxKit
extends javax.swing.text.DefaultEditorKit
implements javax.swing.text.ViewFactory

The DefaultSyntaxKit is the main entry to SyntaxPane. To use the package, just set the EditorKit of the EditorPane to a new instance of this class. You need to pass a proper lexer to the class.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.text.DefaultEditorKit

javax.swing.text.DefaultEditorKit.BeepAction, javax.swing.text.DefaultEditorKit.CopyAction, javax.swing.text.DefaultEditorKit.CutAction, javax.swing.text.DefaultEditorKit.DefaultKeyTypedAction, javax.swing.text.DefaultEditorKit.InsertBreakAction, javax.swing.text.DefaultEditorKit.InsertContentAction, javax.swing.text.DefaultEditorKit.InsertTabAction, javax.swing.text.DefaultEditorKit.PasteAction

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONFIG_CARETCOLOR
static java.lang.String	CONFIG_COMPONENTS
static java.lang.String	CONFIG_MENU
static java.lang.String	CONFIG_SELECTION
static java.lang.String	CONFIG_TOOLBAR
static java.lang.String	CONFIG_TOOLBAR_BORDER
static java.lang.String	CONFIG_TOOLBAR_BORDER_SIZE
static java.lang.String	CONFIG_TOOLBAR_OPAQUE
static java.lang.String	CONFIG_TOOLBAR_ROLLOVER

Fields inherited from class javax.swing.text.DefaultEditorKit

backwardAction, beepAction, beginAction, beginLineAction, beginParagraphAction, beginWordAction, copyAction, cutAction, defaultKeyTypedAction, deleteNextCharAction, deleteNextWordAction, deletePrevCharAction, deletePrevWordAction, 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

Constructors

Constructor and Description
DefaultSyntaxKit(Lexer lexer) Creates a new Kit for the given language

Method Summary

Modifier and Type	Method and Description
static void	addAbbreviation(java.lang.String abbr, java.lang.String template) Adds an abbreviation to this kit's abbreviations.
void	addActions(javax.swing.JEditorPane editorPane) Adds keyboard actions to this control using the Configuration we have This is revised to properly use InputMap and ActionMap of the component instead of using the KeyMaps directly.
void	addComponents(javax.swing.JEditorPane editorPane) Adds UI components to the pane
void	addPopupMenu(javax.swing.JEditorPane editorPane) Adds a popup menu to the editorPane if needed.
void	addToolBarActions(javax.swing.JEditorPane editorPane, javax.swing.JToolBar toolbar) Adds all pop-up menu items to a Toolbar.
javax.swing.text.View	create(javax.swing.text.Element element)
javax.swing.text.Document	createDefaultDocument() This is called by Swing to create a Document for the JEditorPane document This may be called before you actually get a reference to the control.
void	deinstall(javax.swing.JEditorPane editorPane)
void	deinstallComponent(javax.swing.JEditorPane pane, java.lang.String className) Finds the SyntaxComponent with given class name that is installed on the given pane, then de-installs and removes it fom the editorComponents list
static java.lang.String	getAbbreviation(java.lang.String abbr) Gets the template for the given abbreviation
java.util.Map<java.lang.String,java.lang.String>	getAbbreviations()
Configuration	getConfig() Gets the configuration for this Object
static Configuration	getConfig(java.lang.Class<? extends DefaultSyntaxKit> kit) Returns the Configurations object for a Kit.
java.lang.String	getContentType()
static java.lang.String[]	getContentTypes() Return all the content types supported by this library.
java.lang.String	getProperty(java.lang.String key) Return the property with the given key.
javax.swing.text.ViewFactory	getViewFactory()
static void	initKit() This is called to initialize the list of Lexers we have.
void	install(javax.swing.JEditorPane editorPane) Installs the View on the given EditorPane.
void	installComponent(javax.swing.JEditorPane pane, java.lang.String className) Creates a SyntaxComponent of the the given class name and installs it on the pane
boolean	isComponentInstalled(javax.swing.JEditorPane pane, java.lang.String className) Checks if the component with given class-name is installed on the pane.
void	read(java.io.Reader in, javax.swing.text.Document doc, int pos)
static void	registerContentType(java.lang.String type, java.lang.String className) Registers the given content type to use the given class name as its kit When this is called, an entry is added into the private HashMap of the registered editors kits.
void	setConfig(java.util.Properties config) Merges the given properties with the configurations for this Object
void	setProperty(java.lang.String key, java.lang.String value) Sets the given property to the given value.
boolean	toggleComponent(javax.swing.JEditorPane pane, java.lang.String className) Toggles the component with given class-name.

Methods inherited from class javax.swing.text.DefaultEditorKit

createCaret, getActions, read, write, write

Methods inherited from class javax.swing.text.EditorKit

clone

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CONFIG_CARETCOLOR

public static final java.lang.String CONFIG_CARETCOLOR

See Also:

Constant Field Values

CONFIG_SELECTION

public static final java.lang.String CONFIG_SELECTION

See Also:

Constant Field Values

CONFIG_COMPONENTS

public static final java.lang.String CONFIG_COMPONENTS

See Also:

Constant Field Values

CONFIG_MENU

public static final java.lang.String CONFIG_MENU

See Also:

Constant Field Values

CONFIG_TOOLBAR

public static final java.lang.String CONFIG_TOOLBAR

See Also:

Constant Field Values

CONFIG_TOOLBAR_ROLLOVER

public static final java.lang.String CONFIG_TOOLBAR_ROLLOVER

See Also:

Constant Field Values

CONFIG_TOOLBAR_BORDER

public static final java.lang.String CONFIG_TOOLBAR_BORDER

See Also:

Constant Field Values

CONFIG_TOOLBAR_OPAQUE

public static final java.lang.String CONFIG_TOOLBAR_OPAQUE

See Also:

Constant Field Values

CONFIG_TOOLBAR_BORDER_SIZE

public static final java.lang.String CONFIG_TOOLBAR_BORDER_SIZE

See Also:

Constant Field Values

Constructor Detail

DefaultSyntaxKit

public DefaultSyntaxKit(Lexer lexer)

Creates a new Kit for the given language

Method Detail

addComponents

public void addComponents(javax.swing.JEditorPane editorPane)

Adds UI components to the pane

Parameters:

editorPane - a component to install this kit for

installComponent

public void installComponent(javax.swing.JEditorPane pane,
                             java.lang.String className)

Creates a SyntaxComponent of the the given class name and installs it on the pane

deinstallComponent

public void deinstallComponent(javax.swing.JEditorPane pane,
                               java.lang.String className)

Finds the SyntaxComponent with given class name that is installed on the given pane, then de-installs and removes it fom the editorComponents list

isComponentInstalled

public boolean isComponentInstalled(javax.swing.JEditorPane pane,
                                    java.lang.String className)

Checks if the component with given class-name is installed on the pane.

Returns:

true if component is installed, false otherwise

toggleComponent

public boolean toggleComponent(javax.swing.JEditorPane pane,
                               java.lang.String className)

Toggles the component with given class-name. If component is found and installed, then it is uninstalled. Otherwise a new one is installed

Returns:

true if component was installed, false if it was removed

read

public void read(java.io.Reader in,
                 javax.swing.text.Document doc,
                 int pos)
          throws java.io.IOException,
                 javax.swing.text.BadLocationException

Overrides:

read in class javax.swing.text.DefaultEditorKit

Throws:

java.io.IOException

javax.swing.text.BadLocationException

addPopupMenu

public void addPopupMenu(javax.swing.JEditorPane editorPane)

Adds a popup menu to the editorPane if needed.

addToolBarActions

public void addToolBarActions(javax.swing.JEditorPane editorPane,
                              javax.swing.JToolBar toolbar)

Adds all pop-up menu items to a Toolbar. You need to call the validate method on the toolbar after this is done to layout the buttons. Only Actions which have a SMALL_ICON property will be added to the toolbar There are three Configuration Keys that affect the appearance of the added buttons: CONFIG_TOOLBAR_ROLLOVER, CONFIG_TOOLBAR_BORDER, CONFIG_TOOLBAR_OPAQUE

getViewFactory

public javax.swing.text.ViewFactory getViewFactory()

Overrides:

getViewFactory in class javax.swing.text.DefaultEditorKit

create

public javax.swing.text.View create(javax.swing.text.Element element)

Specified by:

create in interface javax.swing.text.ViewFactory

install

public void install(javax.swing.JEditorPane editorPane)

Installs the View on the given EditorPane. This is called by Swing and can be used to do anything you need on the JEditorPane control. Here I set some default Actions.

Overrides:

install in class javax.swing.text.EditorKit

deinstall

public void deinstall(javax.swing.JEditorPane editorPane)

Overrides:

deinstall in class javax.swing.text.EditorKit

addActions

public void addActions(javax.swing.JEditorPane editorPane)

Adds keyboard actions to this control using the Configuration we have This is revised to properly use InputMap and ActionMap of the component instead of using the KeyMaps directly.

Parameters:

editorPane - the component to attach the actions to

createDefaultDocument

public javax.swing.text.Document createDefaultDocument()

This is called by Swing to create a Document for the JEditorPane document This may be called before you actually get a reference to the control. We use it here to create a proper lexer and pass it to the SyntaxDocument we return.

Overrides:

createDefaultDocument in class javax.swing.text.DefaultEditorKit

initKit

public static void initKit()

This is called to initialize the list of Lexers we have. You can call this at initialization, or it will be called when needed. The method will also add the appropriate EditorKit classes to the corresponding ContentType of the JEditorPane. After this is called, you can simply call the editor.setContentType("text/java") on the control and you will be done.

registerContentType

public static void registerContentType(java.lang.String type,
                                       java.lang.String className)

Registers the given content type to use the given class name as its kit When this is called, an entry is added into the private HashMap of the registered editors kits. This is needed so that the SyntaxPane library has it's own registration of all the EditorKits

getContentTypes

public static java.lang.String[] getContentTypes()

Return all the content types supported by this library. This will be the content types in the file WEB-INF/services/resources/de/sciss/syntaxpane/kitsfortypes

Returns:

sorted array of all registered content types

setConfig

public void setConfig(java.util.Properties config)

Merges the given properties with the configurations for this Object

setProperty

public void setProperty(java.lang.String key,
                        java.lang.String value)

Sets the given property to the given value. If the kit is not initialized, then calls initKit

getProperty

public java.lang.String getProperty(java.lang.String key)

Return the property with the given key. If the kit is not initialized, then calls initKit Be careful when changing property as the default property may be used

Returns:

value for given key

getConfig

public Configuration getConfig()

Gets the configuration for this Object

getConfig

public static Configuration getConfig(java.lang.Class<? extends DefaultSyntaxKit> kit)

Returns the Configurations object for a Kit. Perform lazy creation of a Configuration object if nothing is created.

getAbbreviations

public java.util.Map<java.lang.String,java.lang.String> getAbbreviations()

addAbbreviation

public static void addAbbreviation(java.lang.String abbr,
                                   java.lang.String template)

Adds an abbreviation to this kit's abbreviations.

getAbbreviation

public static java.lang.String getAbbreviation(java.lang.String abbr)

Gets the template for the given abbreviation

getContentType

public java.lang.String getContentType()

Overrides:

getContentType in class javax.swing.text.DefaultEditorKit