Class PhpCompletionProvider

java.lang.Object

org.fife.ui.autocomplete.CompletionProviderBase

org.fife.ui.autocomplete.AbstractCompletionProvider

org.fife.ui.autocomplete.DefaultCompletionProvider

org.fife.rsta.ac.html.HtmlCompletionProvider

org.fife.rsta.ac.php.PhpCompletionProvider

All Implemented Interfaces:

org.fife.ui.autocomplete.CompletionProvider

public class PhpCompletionProvider
extends HtmlCompletionProvider

Completion provider for PHP.

Version:

1.0

Nested Class Summary

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

org.fife.ui.autocomplete.AbstractCompletionProvider.CaseInsensitiveComparator

Field Summary

Fields

Modifier and Type	Field	Description
private static final int	EVERYTHING_HERE_AND_BELOW_IS_PHP
private boolean	phpCompletion	Whether getAlreadyEnteredText(JTextComponent) determined the caret to be in a location where PHP completions were required (as opposed to HTML completions).
private List<org.fife.ui.autocomplete.Completion>	phpCompletions	PHP function completions.

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	Description
PhpCompletionProvider()

Method Summary

Modifier and Type	Method	Description
String	getAlreadyEnteredText(JTextComponent comp)
protected List<org.fife.ui.autocomplete.Completion>	getCompletionsImpl(JTextComponent comp)
private boolean	inPhpBlock(JTextComponent comp)	Returns whether the caret is inside a PHP block in this text component.
boolean	isAutoActivateOkay(JTextComponent tc)	Overridden to properly handle both HTML markup and PHP code.
void	loadPhpCompletionsFromXML(InputStream in)	Loads completions from an XML input stream.

Methods inherited from class HtmlCompletionProvider

defaultGetAlreadyEnteredText, getAttributeCompletionsForTag, getTagCompletions, initCompletions, isAutoActivateOkayOutsideOfMarkup

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 Object

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

Field Details

phpCompletion

private boolean phpCompletion

Whether getAlreadyEnteredText(JTextComponent) determined the caret to be in a location where PHP completions were required (as opposed to HTML completions).

phpCompletions

private List<org.fife.ui.autocomplete.Completion> phpCompletions

PHP function completions.

EVERYTHING_HERE_AND_BELOW_IS_PHP

private static final int EVERYTHING_HERE_AND_BELOW_IS_PHP

See Also:

• Constant Field Values

Constructor Details

PhpCompletionProvider

public PhpCompletionProvider()

Method Details

loadPhpCompletionsFromXML

public void loadPhpCompletionsFromXML(InputStream in)
                               throws IOException

Loads completions from an XML input stream. The XML should validate against the completion DTD found in the AutoComplete library.

Parameters:

in - The input stream to read from.

Throws:

IOException - If an IO error occurs.

getAlreadyEnteredText

public String getAlreadyEnteredText(JTextComponent comp)

Specified by:

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

Overrides:

getAlreadyEnteredText in class HtmlCompletionProvider

getCompletionsImpl

protected List<org.fife.ui.autocomplete.Completion> getCompletionsImpl(JTextComponent comp)

Overrides:

getCompletionsImpl in class HtmlCompletionProvider

inPhpBlock

private boolean inPhpBlock(JTextComponent comp)

Returns whether the caret is inside a PHP block in this text component.

Parameters:

comp - The RSyntaxTextAera.

Returns:

Whether the caret is inside a PHP block.

isAutoActivateOkay

public boolean isAutoActivateOkay(JTextComponent tc)

Overridden to properly handle both HTML markup and PHP code.

Specified by:

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

Overrides:

isAutoActivateOkay in class HtmlCompletionProvider

See Also:

• HtmlCompletionProvider.isAutoActivateOkayOutsideOfMarkup(JTextComponent)