org.fife.rsta.ac.html

Class HtmlCompletionProvider

java.lang.Object

org.fife.ui.autocomplete.CompletionProviderBase

org.fife.ui.autocomplete.AbstractCompletionProvider

org.fife.ui.autocomplete.DefaultCompletionProvider

org.fife.rsta.ac.html.HtmlCompletionProvider

All Implemented Interfaces:

org.fife.ui.autocomplete.CompletionProvider

Direct Known Subclasses:

JspCompletionProvider, PhpCompletionProvider

public class HtmlCompletionProvider
extends org.fife.ui.autocomplete.DefaultCompletionProvider

Completion provider for HTML documents.

Nested Class Summary

Nested classes/interfaces inherited from class org.fife.ui.autocomplete.AbstractCompletionProvider

org.fife.ui.autocomplete.AbstractCompletionProvider.CaseInsensitiveComparator

Field Summary

Fields inherited from class org.fife.ui.autocomplete.DefaultCompletionProvider

seg

Fields inherited from class org.fife.ui.autocomplete.AbstractCompletionProvider

comparator, completions

Fields inherited from class org.fife.ui.autocomplete.CompletionProviderBase

EMPTY_STRING

Constructor Summary

Constructors

Constructor and Description
HtmlCompletionProvider() Constructor.

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	defaultGetAlreadyEnteredText(javax.swing.text.JTextComponent comp) This nasty hack is just a hook for subclasses (e.g.
java.lang.String	getAlreadyEnteredText(javax.swing.text.JTextComponent comp)
protected java.util.List<AttributeCompletion>	getAttributeCompletionsForTag(java.lang.String tagName) Returns the attributes that can be code-completed for the specified tag.
protected java.util.List<org.fife.ui.autocomplete.Completion>	getCompletionsImpl(javax.swing.text.JTextComponent comp)
protected java.util.List<org.fife.ui.autocomplete.Completion>	getTagCompletions() Returns the completions for the basic tag set.
protected void	initCompletions() Calls DefaultCompletionProvider.loadFromXML(String) to load all standard HTML completions.
boolean	isAutoActivateOkay(javax.swing.text.JTextComponent tc) Overridden to ensure auto-activation only occurs in a markup tag.
protected boolean	isAutoActivateOkayOutsideOfMarkup(javax.swing.text.JTextComponent tc) Returns the base implementation - basically checking that the caret comes immediately after letters.

Methods inherited from class org.fife.ui.autocomplete.DefaultCompletionProvider

getCompletionsAt, getParameterizedCompletions, init, isValidChar, loadFromXML, loadFromXML, loadFromXML, loadFromXML

Methods inherited from class org.fife.ui.autocomplete.AbstractCompletionProvider

addCompletion, addCompletions, addWordCompletions, checkProviderAndAdd, clear, getCompletionByInputText, removeCompletion

Methods inherited from class org.fife.ui.autocomplete.CompletionProviderBase

clearParameterizedCompletionParams, getCompletions, getListCellRenderer, getParameterChoicesProvider, getParameterListEnd, getParameterListSeparator, getParameterListStart, getParent, setAutoActivationRules, setListCellRenderer, setParameterChoicesProvider, setParameterizedCompletionParams, setParent

Methods inherited from class java.lang.Object

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

Constructor Detail

HtmlCompletionProvider

public HtmlCompletionProvider()

Constructor.

Method Detail

defaultGetAlreadyEnteredText

protected java.lang.String defaultGetAlreadyEnteredText(javax.swing.text.JTextComponent comp)

This nasty hack is just a hook for subclasses (e.g. PhpCompletionProvider) to be able to get at the DefaultCompletionProvider implementation.

Parameters:

comp - The text component.

Returns:

The text, or null if none.

getAlreadyEnteredText

public java.lang.String getAlreadyEnteredText(javax.swing.text.JTextComponent comp)

Specified by:

getAlreadyEnteredText in interface org.fife.ui.autocomplete.CompletionProvider

Overrides:

getAlreadyEnteredText in class org.fife.ui.autocomplete.DefaultCompletionProvider

getAttributeCompletionsForTag

protected java.util.List<AttributeCompletion> getAttributeCompletionsForTag(java.lang.String tagName)

Returns the attributes that can be code-completed for the specified tag. Subclasses can override this method to handle more than the standard set of HTML 5 tags and their attributes.

Parameters:

tagName - The tag whose attributes are being code-completed.

Returns:

A list of attributes, or null if the tag is not recognized.

getCompletionsImpl

protected java.util.List<org.fife.ui.autocomplete.Completion> getCompletionsImpl(javax.swing.text.JTextComponent comp)

Overrides:

getCompletionsImpl in class org.fife.ui.autocomplete.AbstractCompletionProvider

getTagCompletions

protected java.util.List<org.fife.ui.autocomplete.Completion> getTagCompletions()

Returns the completions for the basic tag set. This method is here so subclasses can add to it if they provide additional tags (i.e. JSP).

Returns:

The completions for the standard tag set.

initCompletions

protected void initCompletions()

Calls DefaultCompletionProvider.loadFromXML(String) to load all standard HTML completions. Subclasses can override to also load additional standard tags (i.e. JSP's jsp:* tags).

isAutoActivateOkayOutsideOfMarkup

protected boolean isAutoActivateOkayOutsideOfMarkup(javax.swing.text.JTextComponent tc)

Returns the base implementation - basically checking that the caret comes immediately after letters. This is here for subclasses that sometimes auto-activate in markup, other times auto-activate in some other language, such as PHP.

Parameters:

tc - The text component.

Returns:

Whether auto-activation is okay outside of markup.

See Also:

isAutoActivateOkay(JTextComponent)

isAutoActivateOkay

public boolean isAutoActivateOkay(javax.swing.text.JTextComponent tc)

Overridden to ensure auto-activation only occurs in a markup tag.

Specified by:

isAutoActivateOkay in interface org.fife.ui.autocomplete.CompletionProvider

Overrides:

isAutoActivateOkay in class org.fife.ui.autocomplete.CompletionProviderBase

See Also:

isAutoActivateOkayOutsideOfMarkup(JTextComponent)