com.aptana.ide.editor.html
Class HTMLFileLanguageService

java.lang.Object
  com.aptana.ide.editors.unified.BaseFileLanguageService
      com.aptana.ide.editor.html.HTMLFileLanguageService

All Implemented Interfaces:

IFileLanguageService

public class HTMLFileLanguageService
extends BaseFileLanguageService

Author:

Robin Debreuil

Field Summary

Fields inherited from class com.aptana.ide.editors.unified.BaseFileLanguageService

fileService

Constructor Summary

HTMLFileLanguageService(FileService fileService, IParseState parseState, IParser parser, IParentOffsetMapper mapper)
HTMLFileLanguageService

Method Summary

void	connectSourceProvider(IFileSourceProvider sourceProvider) Perhaps rename to onFileOpen?
void	createOffsetMapper(IParentOffsetMapper parent) This will return a default offset mapper if not overridden.
void	disconnectSourceProvider(IFileSourceProvider sourceProvider) Perhaps rename to onFileClose.
java.lang.String	getDefaultLanguage()
java.lang.String	getDocumentationFromLexeme(Lexeme lexeme) Given a lexeme, returns the documentation for that lexeme based upon the current "environment"
HelpResource[]	getDocumentationResourcesFromLexeme(Lexeme lexeme) Reurns a list of documentation links pertinent to the particular lexeme
java.lang.String	getDocumentationTitleFromLexeme(Lexeme lexeme) Given a lexeme, returns the documentation title for that lexeme based upon the current "environment"
static HTMLFileLanguageService	getHTMLFileLanguageService(IFileService fileContext) getHTMLFileLanguageService
IOffsetMapper	getOffsetMapper() Return the mapper from offsets to lexemes
Lexeme	getValidDocumentationLexeme(Lexeme lexeme) Given a lexeme, returns the "valid" neighboring lexeme that is useful for documentation.
boolean	isProfileMember() isProfileMember
void	reset(boolean resetFileIndex) reset
void	setProfileMember(boolean isProfileMember) setProfileMember

Methods inherited from class com.aptana.ide.editors.unified.BaseFileLanguageService

activateForEditing, deactivateForEditing, getFileContext, getParser, getParseState, getParseState, reconnectToEnvironment

Methods inherited from class java.lang.Object

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

Constructor Detail

HTMLFileLanguageService

public HTMLFileLanguageService(FileService fileService,
                               IParseState parseState,
                               IParser parser,
                               IParentOffsetMapper mapper)

HTMLFileLanguageService

Parameters:

fileService -

parseState -

parser -

mapper -

Method Detail

getDocumentationTitleFromLexeme

public java.lang.String getDocumentationTitleFromLexeme(Lexeme lexeme)

Description copied from interface: IFileLanguageService

Given a lexeme, returns the documentation title for that lexeme based upon the current "environment"

Specified by:

getDocumentationTitleFromLexeme in interface IFileLanguageService

Overrides:

getDocumentationTitleFromLexeme in class BaseFileLanguageService

Parameters:

lexeme - The lexeme to search documentation for

Returns:

A string representing the code assist documentation

See Also:

IFileLanguageService.getDocumentationTitleFromLexeme(com.aptana.ide.lexer.Lexeme)

getDocumentationResourcesFromLexeme

public HelpResource[] getDocumentationResourcesFromLexeme(Lexeme lexeme)

Description copied from interface: IFileLanguageService

Reurns a list of documentation links pertinent to the particular lexeme

Specified by:

getDocumentationResourcesFromLexeme in interface IFileLanguageService

Overrides:

getDocumentationResourcesFromLexeme in class BaseFileLanguageService

Parameters:

lexeme - The lexeme to search documentation for

Returns:

A list of help resources

See Also:

IFileLanguageService.getDocumentationResourcesFromLexeme(com.aptana.ide.lexer.Lexeme)

getDocumentationFromLexeme

public java.lang.String getDocumentationFromLexeme(Lexeme lexeme)

Given a lexeme, returns the documentation for that lexeme based upon the current "environment"

Specified by:

getDocumentationFromLexeme in interface IFileLanguageService

Overrides:

getDocumentationFromLexeme in class BaseFileLanguageService

Parameters:

lexeme - The lexeme to search documentation for

Returns:

A string representing the code assist documentation

See Also:

IFileLanguageService.getDocumentationFromLexeme(com.aptana.ide.lexer.Lexeme)

getValidDocumentationLexeme

public Lexeme getValidDocumentationLexeme(Lexeme lexeme)

Description copied from interface: IFileLanguageService

Given a lexeme, returns the "valid" neighboring lexeme that is useful for documentation. As an example, if doing document.getElementById(, it will return "getElementById", not "("

Specified by:

getValidDocumentationLexeme in interface IFileLanguageService

Overrides:

getValidDocumentationLexeme in class BaseFileLanguageService

Parameters:

lexeme - The lexeme to search documentation for

Returns:

A string representing the valid lexeme

See Also:

IFileLanguageService.getValidDocumentationLexeme(com.aptana.ide.lexer.Lexeme)

getDefaultLanguage

public java.lang.String getDefaultLanguage()

Returns:

DefaultLanguage

getOffsetMapper

public IOffsetMapper getOffsetMapper()

Return the mapper from offsets to lexemes

Specified by:

getOffsetMapper in interface IFileLanguageService

Overrides:

getOffsetMapper in class BaseFileLanguageService

Returns:

OffsetMapper

See Also:

IFileLanguageService.getOffsetMapper()

createOffsetMapper

public void createOffsetMapper(IParentOffsetMapper parent)

Description copied from class: BaseFileLanguageService

This will return a default offset mapper if not overridden. overrides shouldn't call the base class.

Overrides:

createOffsetMapper in class BaseFileLanguageService

See Also:

BaseFileLanguageService.createOffsetMapper(com.aptana.ide.editors.unified.IParentOffsetMapper)

getHTMLFileLanguageService

public static HTMLFileLanguageService getHTMLFileLanguageService(IFileService fileContext)

getHTMLFileLanguageService

Parameters:

fileContext -

Returns:

HTMLFileLanguageService

connectSourceProvider

public void connectSourceProvider(IFileSourceProvider sourceProvider)

Description copied from class: BaseFileLanguageService

Perhaps rename to onFileOpen?

Specified by:

connectSourceProvider in interface IFileLanguageService

Overrides:

connectSourceProvider in class BaseFileLanguageService

See Also:

IFileLanguageService.connectSourceProvider(com.aptana.ide.editors.unified.IFileSourceProvider)

disconnectSourceProvider

public void disconnectSourceProvider(IFileSourceProvider sourceProvider)

Description copied from class: BaseFileLanguageService

Perhaps rename to onFileClose. Languages should clean out their environement, delete the given file, and rebuild here

Specified by:

disconnectSourceProvider in interface IFileLanguageService

Overrides:

disconnectSourceProvider in class BaseFileLanguageService

See Also:

IFileLanguageService.disconnectSourceProvider(com.aptana.ide.editors.unified.IFileSourceProvider)

isProfileMember

public boolean isProfileMember()

isProfileMember

Returns:

boolean

setProfileMember

public void setProfileMember(boolean isProfileMember)

setProfileMember

Parameters:

isProfileMember -

reset

public void reset(boolean resetFileIndex)

Description copied from interface: IFileLanguageService

reset

Specified by:

reset in interface IFileLanguageService

Overrides:

reset in class BaseFileLanguageService

See Also:

IFileLanguageService.reset(boolean)