org.fife.rsta.ac.xml

Class XmlLanguageSupport

java.lang.Object

org.fife.rsta.ac.AbstractLanguageSupport

org.fife.rsta.ac.AbstractMarkupLanguageSupport

org.fife.rsta.ac.xml.XmlLanguageSupport

All Implemented Interfaces:

LanguageSupport

public class XmlLanguageSupport
extends AbstractMarkupLanguageSupport

Language support for XML. Currently supported features include:

• Squiggle underlining of basic XML structure errors.
• Usage of XmlOutlineTree, a tree view modeling the XML in the RSyntaxTextArea.

Possible future features include:

• DTD/Schema validation.
• Code completion based off of other tags in the XML.
• Code completion based off of the relevant DTD or schema.

See Also:

XmlOutlineTree

Field Summary

Fields inherited from class org.fife.rsta.ac.AbstractMarkupLanguageSupport

INSERT_CLOSING_TAG_ACTION

Fields inherited from interface org.fife.rsta.ac.LanguageSupport

PROPERTY_LANGUAGE_PARSER

Constructor Summary

Constructors

Constructor and Description
XmlLanguageSupport() Constructor.

Method Summary

Modifier and Type	Method and Description
protected javax.swing.ListCellRenderer	createDefaultCompletionCellRenderer() Creates the default cell renderer to use when none is specified.
XmlParser	getParser(RSyntaxTextArea textArea) Returns the XML parser running on a text area with this XML language support installed.
boolean	getShowSyntaxErrors() Returns whether syntax errors are squiggle-underlined in the editor.
void	install(RSyntaxTextArea textArea) Installs this support.
protected void	installKeyboardShortcuts(RSyntaxTextArea textArea) Installs extra keyboard shortcuts supported by this language support.
void	setShowSyntaxErrors(boolean show) Sets whether syntax errors are squiggle-underlined in the editor.
protected boolean	shouldAutoCloseTag(java.lang.String tag) Subclasses should override this method to return whether a specified tag should have its closing tag auto-inserted.
void	uninstall(RSyntaxTextArea textArea) Uninstalls this support.
protected void	uninstallKeyboardShortcuts(RSyntaxTextArea textArea) Uninstalls any keyboard shortcuts specific to this language support.

Methods inherited from class org.fife.rsta.ac.AbstractMarkupLanguageSupport

getAutoAddClosingTags, setAutoAddClosingTags

Methods inherited from class org.fife.rsta.ac.AbstractLanguageSupport

createAutoCompletion, getAutoActivationDelay, getAutoCompletionFor, getDefaultCompletionCellRenderer, getShowDescWindow, getTextAreas, installImpl, isAutoActivationEnabled, isAutoCompleteEnabled, isParameterAssistanceEnabled, setAutoActivationDelay, setAutoActivationEnabled, setAutoCompleteEnabled, setDefaultCompletionCellRenderer, setParameterAssistanceEnabled, setShowDescWindow, uninstallImpl

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlLanguageSupport

public XmlLanguageSupport()

Constructor.

Method Detail

createDefaultCompletionCellRenderer

protected javax.swing.ListCellRenderer createDefaultCompletionCellRenderer()

Creates the default cell renderer to use when none is specified. Subclasses can override this method if there is a "better" default renderer for a specific language.

Overrides:

createDefaultCompletionCellRenderer in class AbstractLanguageSupport

Returns:

The default renderer for the completion list.

getParser

public XmlParser getParser(RSyntaxTextArea textArea)

Returns the XML parser running on a text area with this XML language support installed.

Parameters:

textArea - The text area.

Returns:

The XML parser. This will be null if the text area does not have this XmlLanguageSupport installed.

getShowSyntaxErrors

public boolean getShowSyntaxErrors()

Returns whether syntax errors are squiggle-underlined in the editor.

Returns:

Whether errors are squiggle-underlined.

See Also:

setShowSyntaxErrors(boolean)

install

public void install(RSyntaxTextArea textArea)

Installs this support.

Parameters:

textArea - The text area to install onto.

See Also:

LanguageSupport.uninstall(RSyntaxTextArea)

installKeyboardShortcuts

protected void installKeyboardShortcuts(RSyntaxTextArea textArea)

Installs extra keyboard shortcuts supported by this language support. The default implementation maps an action to automatically add closing tags when '>' is pressed; subclasses can override and add additional shortcuts if desired.

Subclasses should call this method in their LanguageSupport.install(RSyntaxTextArea) methods.

Overrides:

installKeyboardShortcuts in class AbstractMarkupLanguageSupport

Parameters:

textArea - The text area to install the shortcuts into.

See Also:

AbstractMarkupLanguageSupport.uninstallKeyboardShortcuts(RSyntaxTextArea)

setShowSyntaxErrors

public void setShowSyntaxErrors(boolean show)

Sets whether syntax errors are squiggle-underlined in the editor.

Parameters:

show - Whether syntax errors are squiggle-underlined.

See Also:

getShowSyntaxErrors()

shouldAutoCloseTag

protected boolean shouldAutoCloseTag(java.lang.String tag)

Subclasses should override this method to return whether a specified tag should have its closing tag auto-inserted.

Specified by:

shouldAutoCloseTag in class AbstractMarkupLanguageSupport

Parameters:

tag - The name of the tag to check.

Returns:

Whether the tag should have its closing tag auto-inserted.

uninstall

public void uninstall(RSyntaxTextArea textArea)

Uninstalls this support.

Parameters:

textArea - The text area to uninstall from.

See Also:

LanguageSupport.install(RSyntaxTextArea)

uninstallKeyboardShortcuts

protected void uninstallKeyboardShortcuts(RSyntaxTextArea textArea)

Uninstalls any keyboard shortcuts specific to this language support.

Subclasses should call this method in their LanguageSupport.uninstall(RSyntaxTextArea) methods.

Overrides:

uninstallKeyboardShortcuts in class AbstractMarkupLanguageSupport

Parameters:

textArea - The text area to uninstall the actions from.

See Also:

AbstractMarkupLanguageSupport.installKeyboardShortcuts(RSyntaxTextArea)