org.fife.rsta.ac.sh
Class ShellLanguageSupport

java.lang.Object
  org.fife.rsta.ac.AbstractLanguageSupport
      org.fife.rsta.ac.sh.ShellLanguageSupport

All Implemented Interfaces:

LanguageSupport

public class ShellLanguageSupport
extends AbstractLanguageSupport

Language support for Unix shell scripts.

Version:

1.0

Author:

Robert Futrell

Field Summary

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

PROPERTY_LANGUAGE_PARSER

Constructor Summary

ShellLanguageSupport()
Constructor.

Method Summary

protected ListCellRenderer	createDefaultCompletionCellRenderer() Creates the default cell renderer to use when none is specified.
boolean	getUseLocalManPages() Returns whether the local system's man pages should be used for descriptions of functions.
void	install(RSyntaxTextArea textArea) Installs this support.
void	setUseLocalManPages(boolean use) Sets whether the local system's man pages should be used for descriptions of functions.
void	uninstall(RSyntaxTextArea textArea) Uninstalls this support.

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

ShellLanguageSupport

public ShellLanguageSupport()

Constructor.

Method Detail

createDefaultCompletionCellRenderer

protected 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.

getUseLocalManPages

public boolean getUseLocalManPages()

Returns whether the local system's man pages should be used for descriptions of functions. If this returns false, or man cannot be found (e.g. if this is Windows), a shorter description will be used instead.

Returns:

Whether to use the local man pages in function descriptions.

See Also:

setUseLocalManPages(boolean)

install

public void install(RSyntaxTextArea textArea)

Installs this support.

Parameters:

textArea - The text area to install onto.

See Also:

LanguageSupport.uninstall(RSyntaxTextArea)

setUseLocalManPages

public void setUseLocalManPages(boolean use)

Sets whether the local system's man pages should be used for descriptions of functions. If this is set to false, or man cannot be found (e.g. if this is Windows), a shorter description will be used instead.

Parameters:

use - Whether to use the local man pages in function descriptions.

See Also:

getUseLocalManPages()

uninstall

public void uninstall(RSyntaxTextArea textArea)

Uninstalls this support.

Parameters:

textArea - The text area to uninstall from.

See Also:

LanguageSupport.install(RSyntaxTextArea)