Index

A

AbstractWordFinder - Class in com.swabunga.spell.event

Defines common methods and behaviour for the various word finding subclasses.

AbstractWordFinder() - Constructor for class com.swabunga.spell.event.AbstractWordFinder

Creates a new default AbstractWordFinder object.

AbstractWordFinder(String) - Constructor for class com.swabunga.spell.event.AbstractWordFinder

Creates a new AbstractWordFinder object.

AbstractWordTokenizer - Class in com.swabunga.spell.event

This class tokenizes a input string.

AbstractWordTokenizer(WordFinder) - Constructor for class com.swabunga.spell.event.AbstractWordTokenizer

Creates a new AbstractWordTokenizer object.

AbstractWordTokenizer(String) - Constructor for class com.swabunga.spell.event.AbstractWordTokenizer

Creates a new AbstractWordTokenizer object.

actionPerformed(ActionEvent) - Method in class com.swabunga.spell.swing.JSpellDialog

 

actionPerformed(ActionEvent) - Method in class com.swabunga.spell.swing.JSpellForm

Fired when a button is selected

ADD_CMD - Static variable in class com.swabunga.spell.swing.JSpellForm

The Add button click action command

addActionListener(ActionListener) - Method in class com.swabunga.spell.swing.JSpellForm

Register an action listener

addDictionary(SpellDictionary) - Method in class com.swabunga.spell.event.SpellChecker

Accumulates a dictionary at the end of the dictionaries list used for looking up words.

addDictionary(File) - Method in class com.swabunga.spell.engine.SpellDictionaryHashMap

Add words from a file to existing dictionary hashmap.

addDictionary(Reader) - Method in class com.swabunga.spell.engine.SpellDictionaryHashMap

Add words from a Reader to existing dictionary hashmap.

addDictionaryHelper(BufferedReader) - Method in class com.swabunga.spell.engine.SpellDictionaryHashMap

Adds to the existing dictionary from a word list file.

addJEditorPane(JEditorPane) - Method in class com.swabunga.spell.swing.autospell.AutoSpellCheckHandler

 

addSpellCheckListener(SpellCheckListener) - Method in class com.swabunga.spell.event.SpellChecker

Adds a SpellCheckListener to the listeners list.

ADDTODICT - Static variable in interface com.swabunga.spell.event.SpellCheckEvent

Field indicating that the incorrect word should be added to the dictionary

addToDictionary(String) - Method in class com.swabunga.spell.event.SpellChecker

Adds a word to the user dictionary

addToDictionary(String) - Method in interface com.swabunga.spell.event.SpellCheckEvent

Set the action to add a new word into the dictionary.

addUserDefinedIgnores(Collection, int) - Method in class com.swabunga.spell.event.TeXWordFinder

This method is used to import a user defined set of either strings or regular expressions to ignore.

addWord(String) - Method in class com.swabunga.spell.engine.GenericSpellDictionary

Add a word permanently to the dictionary (and the dictionary file).

addWord(String) - Method in interface com.swabunga.spell.engine.SpellDictionary

Add a word permanently to the dictionary.

addWord(String) - Method in class com.swabunga.spell.engine.SpellDictionaryCachedDichoDisk

Add a word permanantly to the dictionary (and the dictionary file).

addWord(String) - Method in class com.swabunga.spell.engine.SpellDictionaryDichoDisk

Add a word permanently to the dictionary (and the dictionary file).

addWord(String) - Method in class com.swabunga.spell.engine.SpellDictionaryDisk

Adds another word to the dictionary.

addWord(String) - Method in class com.swabunga.spell.engine.SpellDictionaryHashMap

Add a word permanently to the dictionary (and the dictionary file).

ADDWORD_1 - Static variable in class com.swabunga.spell.swing.JSpellForm

Add word confirm

ADDWORD_2 - Static variable in class com.swabunga.spell.swing.JSpellForm

 

ADDWORD_3 - Static variable in class com.swabunga.spell.swing.JSpellForm

 

ALPHABET_END - Static variable in class com.swabunga.spell.engine.GenericTransformator

The alphabet end marker.

ALPHABET_START - Static variable in class com.swabunga.spell.engine.GenericTransformator

The alphabet start marker.

append(View) - Method in class com.swabunga.spell.swing.autospell.AutoSpellView

 

AutoSpellCheckHandler - Class in com.swabunga.spell.swing.autospell

This class handles the actual autospelling by implementing some listeners on the spellchecked JEditorPane and Document.

AutoSpellCheckHandler(SpellChecker) - Constructor for class com.swabunga.spell.swing.autospell.AutoSpellCheckHandler

 

AutoSpellCheckHandler(SpellChecker, ResourceBundle) - Constructor for class com.swabunga.spell.swing.autospell.AutoSpellCheckHandler

 

AutoSpellConstants - Interface in com.swabunga.spell.swing.autospell

Just some constants used by autospell.

AutoSpellEditorKit - Class in com.swabunga.spell.swing.autospell

This editorkit just forwards all method calls to the original EditorKit for all method but getAction where it also adds a "MarkAsMisspelled" action and getViewFactory where we return our own ViewFactory (Based on the original).

AutoSpellEditorKit(StyledEditorKit) - Constructor for class com.swabunga.spell.swing.autospell.AutoSpellEditorKit

 

AutoSpellView - Class in com.swabunga.spell.swing.autospell

This View just forward all calls to the original view but also paints the waved line if the Elements is marked as misspelled.

AutoSpellView(View) - Constructor for class com.swabunga.spell.swing.autospell.AutoSpellView

 

AutoSpellViewFactory - Class in com.swabunga.spell.swing.autospell

Gets the views from the original ViewFactory and but all of them in a AutoSpellView to support the waved line style.

AutoSpellViewFactory(ViewFactory) - Constructor for class com.swabunga.spell.swing.autospell.AutoSpellViewFactory

 

B

breakView(int, int, float, float) - Method in class com.swabunga.spell.swing.autospell.AutoSpellView

 

buildNewDictionaryDatabase() - Method in class com.swabunga.spell.engine.SpellDictionaryDisk

Builds the file words database file and the contents file for the on disk dictionary.

C

cancel() - Method in interface com.swabunga.spell.event.SpellCheckEvent

Set the action to terminate processing of the spell checker.

CANCEL - Static variable in interface com.swabunga.spell.event.SpellCheckEvent

Field indicating that the spell checking should be terminated

CANCEL_CMD - Static variable in class com.swabunga.spell.swing.JSpellForm

The Cancel button click action command

changedUpdate(DocumentEvent) - Method in class com.swabunga.spell.swing.autospell.AutoSpellCheckHandler

 

changedUpdate(DocumentEvent, Shape, ViewFactory) - Method in class com.swabunga.spell.swing.autospell.AutoSpellView

 

checkSpelling() - Method in class com.swabunga.spell.swing.SpellCheckedDocument

 

checkSpelling(WordTokenizer) - Method in class com.swabunga.spell.event.SpellChecker

This method is called to check the spelling of the words that are returned by the WordTokenizer.

checkSplittedWords(String, String) - Method in class com.swabunga.spell.swing.SpellCheckedDocument

 

checkString(String) - Method in class com.swabunga.spell.event.SpellChecker

Deprecated.

use checkSpelling(WordTokenizer)

checkText - Variable in class com.swabunga.spell.swing.JSpellForm

 

clean(String) - Method in class com.swabunga.spell.swing.SpellCheckedDocument

 

clearCache() - Method in class com.swabunga.spell.engine.SpellDictionaryCachedDichoDisk

Clears the cache.

clone() - Method in class com.swabunga.spell.swing.autospell.AutoSpellEditorKit

 

codes - Static variable in class com.swabunga.spell.engine.SpellDictionaryCachedDichoDisk

 

com.swabunga.spell.engine - package com.swabunga.spell.engine

 

com.swabunga.spell.event - package com.swabunga.spell.event

 

com.swabunga.spell.examples - package com.swabunga.spell.examples

 

com.swabunga.spell.swing - package com.swabunga.spell.swing

 

com.swabunga.spell.swing.autospell - package com.swabunga.spell.swing.autospell

 

compare(Object, Object) - Method in class com.swabunga.spell.engine.Word

Compares two words, mostly for the purpose of sorting words.

config - Static variable in class com.swabunga.spell.engine.EditDistance

Fetches the spell engine configuration properties.

Configuration - Class in com.swabunga.spell.engine

The various settings used to control how a spell checker works are read from here.

Configuration() - Constructor for class com.swabunga.spell.engine.Configuration

 

copy(Word) - Method in class com.swabunga.spell.event.Word

Sets the value of this Word to be a copy of another.

COST_CHANGE_CASE - Static variable in class com.swabunga.spell.engine.Configuration

used by EditDistance: the cost of having to change case, for example, from i to I.

COST_INSERT_CHAR - Static variable in class com.swabunga.spell.engine.Configuration

used by EditDistance: the cost of having to insert a character
(integer greater than 0)

COST_REMOVE_CHAR - Static variable in class com.swabunga.spell.engine.Configuration

used by EditDistance: the cost of having to remove a character
(integer greater than 0)

COST_SUBST_CHARS - Static variable in class com.swabunga.spell.engine.Configuration

used by EditDistance: the cost of having to substitute one character for another for the sub value to ever be used, it should be smaller than the COST_REMOVE_CHAR or COST_INSERT_CHAR values
(integer greater than 0)

COST_SWAP_CHARS - Static variable in class com.swabunga.spell.engine.Configuration

used by EditDistance: the cost of having to swap two adjoining characters for the swap value to ever be used, it should be smaller than the COST_REMOVE_CHAR or COST_INSERT_CHAR values
(integer greater than 0)

create(Element) - Method in class com.swabunga.spell.swing.autospell.AutoSpellViewFactory

 

createCaret() - Method in class com.swabunga.spell.swing.autospell.AutoSpellEditorKit

 

createDefaultDocument() - Method in class com.swabunga.spell.swing.autospell.AutoSpellEditorKit

 

createDefaultDocument() - Method in class com.swabunga.spell.swing.SpellEditorKit

 

createDictionary(BufferedReader) - Method in class com.swabunga.spell.engine.GenericSpellDictionary

Constructs the dictionary from a word list file.

createDictionary(BufferedReader) - Method in class com.swabunga.spell.engine.SpellDictionaryHashMap

Constructs the dictionary from a word list file.

createFragment(int, int) - Method in class com.swabunga.spell.swing.autospell.AutoSpellView

 

current() - Method in class com.swabunga.spell.event.AbstractWordFinder

Returns the current word in the iteration .

current() - Method in interface com.swabunga.spell.event.WordFinder

This method should return the Word object representing the current word in the iteration.

currentWord - Variable in class com.swabunga.spell.event.AbstractWordFinder

The word being analyzed

currentWord - Variable in class com.swabunga.spell.event.AbstractWordTokenizer

The word being analyzed

D

defaultCursor - Variable in class com.swabunga.spell.swing.SpellEditorKit

 

DefaultWordFinder - Class in com.swabunga.spell.event

A basic word finder, which searches text for sequences of letters.

DefaultWordFinder() - Constructor for class com.swabunga.spell.event.DefaultWordFinder

Creates a new DefaultWordFinder object.

DefaultWordFinder(String) - Constructor for class com.swabunga.spell.event.DefaultWordFinder

Creates a new DefaultWordFinder object.

deinstall(JEditorPane) - Method in class com.swabunga.spell.swing.autospell.AutoSpellEditorKit

 

dictionary - Variable in class com.swabunga.spell.examples.JTextComponentSpellCheckExample

 

dictionary - Variable in class com.swabunga.spell.examples.TextPaneMarkingExample

 

DIGITCODE - Static variable in class com.swabunga.spell.engine.GenericTransformator

During phonetic transformation of a word each numeric character is replaced by this DIGITCODE.

DocumentWordTokenizer - Class in com.swabunga.spell.event

This class tokenizes a swing document model.

DocumentWordTokenizer(Document) - Constructor for class com.swabunga.spell.event.DocumentWordTokenizer

Creates a new DocumentWordTokenizer to work on a document

DoubleMeta - Class in com.swabunga.spell.engine

A phonetic encoding algorithm that takes an English word and computes a phonetic version of it.

DoubleMeta() - Constructor for class com.swabunga.spell.engine.DoubleMeta

 

E

EditDistance - Class in com.swabunga.spell.engine

This class is based on Levenshtein Distance algorithms, and it calculates how similar two words are.

EditDistance() - Constructor for class com.swabunga.spell.engine.EditDistance

 

ENDMULTI - Static variable in class com.swabunga.spell.engine.GenericTransformator

End a group of characters which can be appended to the match expression of the phonetic file.

equals(Object) - Method in class com.swabunga.spell.engine.Word

Indicates if this word is equal to another one.

equals(Object) - Method in class com.swabunga.spell.swing.autospell.AutoSpellView

 

ERROR_STYLE - Static variable in class com.swabunga.spell.swing.SpellCheckedDocument

 

F

filename - Variable in class com.swabunga.spell.engine.PropertyConfiguration

The name of the file containing spell engine properties

FileWordTokenizer - Class in com.swabunga.spell.event

This class tokenizes a input file.

FileWordTokenizer(File) - Constructor for class com.swabunga.spell.event.FileWordTokenizer

Creates a new FileWordTokenizer object.

FileWordTokenizer(File, WordFinder) - Constructor for class com.swabunga.spell.event.FileWordTokenizer

Creates a new FileWordTokenizer object and associate a WordFinder to it's processing.

finder - Variable in class com.swabunga.spell.event.AbstractWordTokenizer

The word finder used to filter out words which are non pertinent to spell checking

fireActionEvent(ActionEvent) - Method in class com.swabunga.spell.swing.JSpellForm

 

fireAndHandleEvent(WordTokenizer, SpellCheckEvent) - Method in class com.swabunga.spell.event.SpellChecker

This method will fire the spell check event and then handle the event action that has been selected by the user.

fireSpellCheckEvent(SpellCheckEvent) - Method in class com.swabunga.spell.event.SpellChecker

Fires off a spell check event to the listeners.

G

GenericSpellDictionary - Class in com.swabunga.spell.engine

The SpellDictionary class holds the instance of the dictionary.

GenericSpellDictionary(File) - Constructor for class com.swabunga.spell.engine.GenericSpellDictionary

Dictionary constructor that uses the DoubleMeta class with the English alphabet.

GenericSpellDictionary(File, File) - Constructor for class com.swabunga.spell.engine.GenericSpellDictionary

Dictionary constructor that uses an aspell phonetic file to build the transformation table.

GenericTransformator - Class in com.swabunga.spell.engine

A Generic implementation of a transformator takes an aspell phonetics file and constructs some sort of transformation table using the inner class TransformationRule.

GenericTransformator(File) - Constructor for class com.swabunga.spell.engine.GenericTransformator

Construct a transformation table from the phonetic file

GenericTransformator(File, String) - Constructor for class com.swabunga.spell.engine.GenericTransformator

Construct a transformation table from the phonetic file

GenericTransformator(Reader) - Constructor for class com.swabunga.spell.engine.GenericTransformator

Construct a transformation table from the phonetic file

getAction() - Method in interface com.swabunga.spell.event.SpellCheckEvent

Returns the action type the user has to handle

getActions() - Method in class com.swabunga.spell.swing.autospell.AutoSpellEditorKit

 

getAlignment(int) - Method in class com.swabunga.spell.swing.autospell.AutoSpellView

 

getAttributes() - Method in class com.swabunga.spell.swing.autospell.AutoSpellView

 

getBoolean(String) - Method in class com.swabunga.spell.engine.Configuration

Gets one of the boolean constants

getBoolean(String) - Method in class com.swabunga.spell.engine.PropertyConfiguration

 

getBreakWeight(int, float, float) - Method in class com.swabunga.spell.swing.autospell.AutoSpellView

 

getCharacterAttributeRun() - Method in class com.swabunga.spell.swing.autospell.AutoSpellEditorKit

 

getChildAllocation(int, Shape) - Method in class com.swabunga.spell.swing.autospell.AutoSpellView

 

getCode(String) - Method in class com.swabunga.spell.engine.SpellDictionaryASpell

Returns the phonetic code representing the word.

getCodeReplaceList() - Method in class com.swabunga.spell.engine.GenericTransformator

Takes out all single character replacements and put them in a char array.

getConfiguration() - Static method in class com.swabunga.spell.engine.Configuration

gets a new default Configuration

getConfiguration() - Method in class com.swabunga.spell.event.SpellChecker

Supply the instance of the configuration holding the spell checking engine parameters.

getConfiguration(String) - Static method in class com.swabunga.spell.engine.Configuration

Returns a new instance of a Configuration class

getContainer() - Method in class com.swabunga.spell.swing.autospell.AutoSpellView

 

getContentType() - Method in class com.swabunga.spell.swing.autospell.AutoSpellEditorKit

 

getContext() - Method in class com.swabunga.spell.event.AbstractWordTokenizer

Returns the current text that is being tokenized (includes any changes that have been made)

getContext() - Method in class com.swabunga.spell.event.DocumentWordTokenizer

Returns the current text that is being tokenized (includes any changes that have been made)

getContext() - Method in interface com.swabunga.spell.event.WordTokenizer

Returns the context text that is being tokenized (should include any changes that have been made).

getCost() - Method in class com.swabunga.spell.engine.Word

A cost measures how close a match this word was to the original word

getCurrentWordCount() - Method in class com.swabunga.spell.event.AbstractWordTokenizer

Returns the current number of words that have been processed

getCurrentWordCount() - Method in class com.swabunga.spell.event.DocumentWordTokenizer

Returns the number of word tokens that have been processed thus far

getCurrentWordCount() - Method in interface com.swabunga.spell.event.WordTokenizer

Returns the number of word tokens that have been processed thus far

getCurrentWordEnd() - Method in class com.swabunga.spell.event.AbstractWordTokenizer

Returns the end of the current word in the text

getCurrentWordEnd() - Method in class com.swabunga.spell.event.DocumentWordTokenizer

Returns an index representing the end location of the current word in the text.

getCurrentWordEnd() - Method in interface com.swabunga.spell.event.WordTokenizer

Returns an index representing the end location of the current word in the text.

getCurrentWordPosition() - Method in class com.swabunga.spell.event.AbstractWordTokenizer

Returns the index of the start of the current word in the text

getCurrentWordPosition() - Method in class com.swabunga.spell.event.DocumentWordTokenizer

Returns the number of word tokens that have been processed thus far

getCurrentWordPosition() - Method in interface com.swabunga.spell.event.WordTokenizer

Returns an index representing the start location of the current word in the text.

getDistance(String, String) - Static method in class com.swabunga.spell.engine.EditDistance

Evaluates the distance between two words.

getDistance(String, String, int[][]) - Static method in class com.swabunga.spell.engine.EditDistance

Evaluates the distance between two words.

getDocument() - Method in class com.swabunga.spell.swing.autospell.AutoSpellView

 

getElement() - Method in class com.swabunga.spell.swing.autospell.AutoSpellView

 

getEnd() - Method in class com.swabunga.spell.event.Word

Evaluate the end of word position.

getEndOffset() - Method in class com.swabunga.spell.swing.autospell.AutoSpellView

 

getFinalText() - Method in class com.swabunga.spell.event.StringWordTokenizer

Deprecated.

use getContext() instead as per the WordTokenizer interface specification.

getGraphics() - Method in class com.swabunga.spell.swing.autospell.AutoSpellView

 

getInputAttributes() - Method in class com.swabunga.spell.swing.autospell.AutoSpellEditorKit

 

getInteger(String) - Method in class com.swabunga.spell.engine.Configuration

Gets one of the integer constants

getInteger(String) - Method in class com.swabunga.spell.engine.PropertyConfiguration

 

getInvalidWord() - Method in interface com.swabunga.spell.event.SpellCheckEvent

Returns the currently misspelt word

getMaximumSpan(int) - Method in class com.swabunga.spell.swing.autospell.AutoSpellView

 

getMinimumSpan(int) - Method in class com.swabunga.spell.swing.autospell.AutoSpellView

 

getNextVisualPositionFrom(int, Position.Bias, Shape, int, Position.Bias[]) - Method in class com.swabunga.spell.swing.autospell.AutoSpellView

 

getParent() - Method in class com.swabunga.spell.swing.autospell.AutoSpellView

 

getPreferredSpan(int) - Method in class com.swabunga.spell.swing.autospell.AutoSpellView

 

getReplaceList() - Method in class com.swabunga.spell.engine.DoubleMeta

 

getReplaceList() - Method in class com.swabunga.spell.engine.GenericTransformator

Builds up an char array with the chars in the alphabet of the language as it was read from the alphabet tag in the phonetic file.

getReplaceList() - Method in interface com.swabunga.spell.engine.Transformator

gets the list of characters that should be swapped in to the misspelled word in order to try to find more suggestions.

getReplaceWord() - Method in interface com.swabunga.spell.event.SpellCheckEvent

Returns the text to replace

getResizeWeight(int) - Method in class com.swabunga.spell.swing.autospell.AutoSpellView

 

getStart() - Method in class com.swabunga.spell.event.Word

Evaluate the start of word position.

getStartOffset() - Method in class com.swabunga.spell.swing.autospell.AutoSpellView

 

getStyledEditorKit() - Method in class com.swabunga.spell.swing.autospell.AutoSpellEditorKit

 

getSuggestions() - Method in interface com.swabunga.spell.event.SpellCheckEvent

Returns the list of suggested Word objects

getSuggestions(String, int) - Method in interface com.swabunga.spell.engine.SpellDictionary

Returns a list of Word objects that are the suggestions to any word.

getSuggestions(String, int) - Method in class com.swabunga.spell.engine.SpellDictionaryASpell

Returns a list of Word objects that are the suggestions to an incorrect word.

getSuggestions(String, int) - Method in class com.swabunga.spell.event.SpellChecker

Produces a list of suggested word after looking for suggestions in various dictionaries.

getSuggestions(String, int, int[][]) - Method in interface com.swabunga.spell.engine.SpellDictionary

Returns a list of Word objects that are the suggestions to any word.

getSuggestions(String, int, int[][]) - Method in class com.swabunga.spell.engine.SpellDictionaryASpell

Returns a list of Word objects that are the suggestions to an incorrect word.

getText() - Method in class com.swabunga.spell.event.AbstractWordFinder

Return the text being searched.

getText() - Method in class com.swabunga.spell.event.Word

Supply the text string representing the word

getText() - Method in interface com.swabunga.spell.event.WordFinder

This method returns the text through which the WordFinder is iterating.

getToolTipText(float, float, Shape) - Method in class com.swabunga.spell.swing.autospell.AutoSpellView

 

getView(int) - Method in class com.swabunga.spell.swing.autospell.AutoSpellView

 

getViewCount() - Method in class com.swabunga.spell.swing.autospell.AutoSpellView

 

getViewFactory() - Method in class com.swabunga.spell.swing.autospell.AutoSpellEditorKit

 

getViewFactory() - Method in class com.swabunga.spell.swing.autospell.AutoSpellView

 

getViewIndex(float, float, Shape) - Method in class com.swabunga.spell.swing.autospell.AutoSpellView

 

getViewIndex(int, Position.Bias) - Method in class com.swabunga.spell.swing.autospell.AutoSpellView

 

getWord() - Method in class com.swabunga.spell.engine.Word

gets suggested spelling

getWordContext() - Method in interface com.swabunga.spell.event.SpellCheckEvent

Returns the context in which the misspelt word is used

getWordContextPosition() - Method in interface com.swabunga.spell.event.SpellCheckEvent

Returns the start position of the misspelt word in the context

getWords(String) - Method in class com.swabunga.spell.engine.GenericSpellDictionary

Returns a list of strings (words) for the code.

getWords(String) - Method in class com.swabunga.spell.engine.SpellDictionaryASpell

Returns a list of words that have the same phonetic code.

getWords(String) - Method in class com.swabunga.spell.engine.SpellDictionaryCachedDichoDisk

Returns a list of strings (words) for the code.

getWords(String) - Method in class com.swabunga.spell.engine.SpellDictionaryDichoDisk

Returns a list of strings (words) for the code.

getWords(String) - Method in class com.swabunga.spell.engine.SpellDictionaryDisk

Returns a list of words that have the same phonetic code.

getWords(String) - Method in class com.swabunga.spell.engine.SpellDictionaryHashMap

Returns a list of strings (words) for the code.

H

hasMoreWords() - Method in class com.swabunga.spell.event.AbstractWordTokenizer

Returns true if there are more words that can be processed in the string

hasMoreWords() - Method in class com.swabunga.spell.event.DocumentWordTokenizer

Indicates if there are more words left

hasMoreWords() - Method in interface com.swabunga.spell.event.WordTokenizer

Indicates if there are more words left

hasNext() - Method in class com.swabunga.spell.event.AbstractWordFinder

Indicates if there is some more word to analyze

hasNext() - Method in interface com.swabunga.spell.event.WordFinder

Tests the finder to see if any more words are available.

hits - Static variable in class com.swabunga.spell.engine.SpellDictionaryCachedDichoDisk

 

I

ignore(int, char) - Method in class com.swabunga.spell.event.AbstractWordFinder

Ignores or skip over text starting from the index position specified if it contains the startIgnore, and until the first non letter or digit character is encountered or end of text is detected.

ignore(int, char, char) - Method in class com.swabunga.spell.event.AbstractWordFinder

Ignores or skip over text starting from the index position specified if it contains the startIgnore, and until the endIgnore character is encountered or end of text is detected.

ignore(int, Character, Character) - Method in class com.swabunga.spell.event.AbstractWordFinder

Ignores or skip over text starting from the index position specified if it contains the startIgnore, and until the endIgnore character is encountered or end of text is detected.

ignore(int, String, String) - Method in class com.swabunga.spell.event.AbstractWordFinder

Ignores or skip over text starting from the index position specified if it contains the startIgnore string, and until the endIgnore string is encountered or end of text is detected.

IGNORE - Static variable in interface com.swabunga.spell.event.SpellCheckEvent

Field indicating that the incorrect word should be ignored

IGNORE_CMD - Static variable in class com.swabunga.spell.swing.JSpellForm

The Ignore button click action command

ignoreAll(String) - Method in class com.swabunga.spell.event.SpellChecker

Adds a word to the list of ignored words

IGNOREALL - Static variable in interface com.swabunga.spell.event.SpellCheckEvent

Field indicating that the incorrect word should be ignored forever

IGNOREALL_CMD - Static variable in class com.swabunga.spell.swing.JSpellForm

The Ignore All button click action command

IGNORED_KEYWORDS - Static variable in class com.swabunga.spell.engine.GenericTransformator

Phonetic file lines starting with the keywords are skipped.

ignoreWord(boolean) - Method in interface com.swabunga.spell.event.SpellCheckEvent

Set the action it ignore the currently misspelt word.

init() - Method in class com.swabunga.spell.event.AbstractWordFinder

Initializes the sentenseIterator

init() - Method in class com.swabunga.spell.event.JavaWordFinder

Initializes this word finder

init() - Method in class com.swabunga.spell.swing.JSpellApplet

 

INITIAL - Static variable in interface com.swabunga.spell.event.SpellCheckEvent

Initial case for the action

initialiseGUI() - Method in class com.swabunga.spell.swing.JSpellForm

Called by the constructor to initialise the GUI

insert(int, View) - Method in class com.swabunga.spell.swing.autospell.AutoSpellView

 

insertString(int, String, AttributeSet) - Method in class com.swabunga.spell.swing.SpellCheckedDocument

 

insertUpdate(DocumentEvent) - Method in class com.swabunga.spell.swing.autospell.AutoSpellCheckHandler

 

insertUpdate(DocumentEvent, Shape, ViewFactory) - Method in class com.swabunga.spell.swing.autospell.AutoSpellView

 

install(JEditorPane) - Method in class com.swabunga.spell.swing.autospell.AutoSpellEditorKit

 

install(JEditorPane) - Method in class com.swabunga.spell.swing.SpellEditorKit

 

isCorrect(String) - Method in class com.swabunga.spell.engine.GenericSpellDictionary

Returns true if the word is correctly spelled against the current word list.

isCorrect(String) - Method in interface com.swabunga.spell.engine.SpellDictionary

Evaluates if the word is correctly spelled against the dictionary.

isCorrect(String) - Method in class com.swabunga.spell.engine.SpellDictionaryASpell

Returns true if the word is correctly spelled against the current word list.

isCorrect(String) - Method in class com.swabunga.spell.engine.SpellDictionaryHashMap

Returns true if the word is correctly spelled against the current word list.

isCorrect(String) - Method in class com.swabunga.spell.event.SpellChecker

Verifies if the word to analyze is contained in dictionaries.

isIgnored(String) - Method in class com.swabunga.spell.event.SpellChecker

Indicates if a word is in the list of ignored words

isINETWord(String) - Static method in class com.swabunga.spell.event.SpellChecker

Verifies if the word that is being spell checked contains an Internet address.

isNewSentence() - Method in class com.swabunga.spell.event.AbstractWordTokenizer

returns true if the current word is at the start of a sentence

isNewSentence() - Method in class com.swabunga.spell.event.DocumentWordTokenizer

Indicates if the current word is at the start of a sentence

isNewSentence() - Method in interface com.swabunga.spell.event.WordTokenizer

Returns true if the current word is at the start of a sentence

isReady() - Method in class com.swabunga.spell.engine.SpellDictionaryDisk

Indicates if the initial preparation or loading of the on disk dictionary is complete.

isVisible() - Method in class com.swabunga.spell.swing.autospell.AutoSpellView

 

isWordChar(char) - Method in class com.swabunga.spell.event.AbstractWordFinder

Indicates if the character at the specified character is acceptable as part of a word.

isWordChar(int) - Method in class com.swabunga.spell.event.AbstractWordFinder

Indicates if the character at the specified position is acceptable as part of a word.

J

JavaWordFinder - Class in com.swabunga.spell.event

A word finder Java source files, which searches text for sequences of letters formated as Java comments.

JavaWordFinder() - Constructor for class com.swabunga.spell.event.JavaWordFinder

Creates a new JavaWordFinder object.

JavaWordFinder(String) - Constructor for class com.swabunga.spell.event.JavaWordFinder

Creates a new JavaWordFinder object.

JAZZY_DIR - Static variable in class com.swabunga.spell.engine.SpellDictionaryCachedDichoDisk

 

JSpellApplet - Class in com.swabunga.spell.swing

 

JSpellApplet() - Constructor for class com.swabunga.spell.swing.JSpellApplet

 

JSpellDialog - Class in com.swabunga.spell.swing

Implementation of a spell check dialog.

JSpellDialog(Dialog, String, boolean) - Constructor for class com.swabunga.spell.swing.JSpellDialog

 

JSpellDialog(Frame, String, boolean) - Constructor for class com.swabunga.spell.swing.JSpellDialog

 

JSpellForm - Class in com.swabunga.spell.swing

Implementation of a spell check form.

JSpellForm() - Constructor for class com.swabunga.spell.swing.JSpellForm

Panel constructor

JTextComponentSpellChecker - Class in com.swabunga.spell.swing

This class spellchecks a JTextComponent throwing up a Dialog everytime it encounters a misspelled word.

JTextComponentSpellChecker(SpellDictionary) - Constructor for class com.swabunga.spell.swing.JTextComponentSpellChecker

 

JTextComponentSpellChecker(SpellDictionary, SpellDictionary, String) - Constructor for class com.swabunga.spell.swing.JTextComponentSpellChecker

 

JTextComponentSpellChecker(String) - Constructor for class com.swabunga.spell.swing.JTextComponentSpellChecker

 

JTextComponentSpellChecker(String, String) - Constructor for class com.swabunga.spell.swing.JTextComponentSpellChecker

 

JTextComponentSpellChecker(String, String, String) - Constructor for class com.swabunga.spell.swing.JTextComponentSpellChecker

 

JTextComponentSpellCheckExample - Class in com.swabunga.spell.examples

This class shows an example of how to use the spell checking capability on a JTextComponent.

JTextComponentSpellCheckExample(String, String) - Constructor for class com.swabunga.spell.examples.JTextComponentSpellCheckExample

 

K

KEYWORD_ALPHBET - Static variable in class com.swabunga.spell.engine.GenericTransformator

Phonetic file keyword indicating that a different alphabet is used for this language.

L

length() - Method in class com.swabunga.spell.event.Word

Evaluate the length of the word.

LinkController() - Constructor for class com.swabunga.spell.swing.SpellEditorKit.LinkController

 

linkCursor - Static variable in class com.swabunga.spell.swing.SpellEditorKit

 

listenerList - Variable in class com.swabunga.spell.swing.JSpellForm

The listener list (holds actionlisteners)

loadIndex() - Method in class com.swabunga.spell.engine.SpellDictionaryDisk

Loads the index file from disk.

M

main(String[]) - Static method in class com.swabunga.spell.engine.EditDistance

For testing edit distances

main(String[]) - Static method in class com.swabunga.spell.examples.JTextComponentSpellCheckExample

 

main(String[]) - Static method in class com.swabunga.spell.examples.SpellCheckExample

 

main(String[]) - Static method in class com.swabunga.spell.examples.SpellCheckExample2

 

main(String[]) - Static method in class com.swabunga.spell.examples.SwingFormExample

 

main(String[]) - Static method in class com.swabunga.spell.examples.TextPaneMarkingExample

 

main(String[]) - Static method in class com.swabunga.spell.swing.JSpellForm

 

mainDictionary - Variable in class com.swabunga.spell.engine.GenericSpellDictionary

The hashmap that contains the word dictionary.

mainDictionary - Variable in class com.swabunga.spell.engine.SpellDictionaryHashMap

The hashmap that contains the word dictionary.

makeCentrePanel() - Method in class com.swabunga.spell.swing.JSpellForm

 

makeEastPanel() - Method in class com.swabunga.spell.swing.JSpellForm

Creates the buttons on the left hand side of the panel

messages - Variable in class com.swabunga.spell.swing.JSpellForm

 

modelToView(int, Shape, Position.Bias) - Method in class com.swabunga.spell.swing.autospell.AutoSpellView

 

modelToView(int, Position.Bias, int, Position.Bias, Shape) - Method in class com.swabunga.spell.swing.autospell.AutoSpellView

 

mouseClicked(MouseEvent) - Method in class com.swabunga.spell.swing.SpellEditorKit.LinkController

Called for a mouse click event.

mouseDragged(MouseEvent) - Method in class com.swabunga.spell.swing.SpellEditorKit.LinkController

 

mouseMoved(MouseEvent) - Method in class com.swabunga.spell.swing.SpellEditorKit.LinkController

 

mouseReleased(MouseEvent) - Method in class com.swabunga.spell.swing.autospell.AutoSpellCheckHandler

 

N

next() - Method in class com.swabunga.spell.event.AbstractWordFinder

This method scans the text from the end of the last word, and returns a new Word object corresponding to the next word.

next() - Method in class com.swabunga.spell.event.DefaultWordFinder

This method scans the text from the end of the last word, and returns a new Word object corresponding to the next word.

next() - Method in class com.swabunga.spell.event.JavaWordFinder

This method scans the text from the end of the last word, and returns a new Word object corresponding to the next word.

next() - Method in class com.swabunga.spell.event.TeXWordFinder

This method scans the text from the end of the last word, and returns a new Word object corresponding to the next word.

next() - Method in interface com.swabunga.spell.event.WordFinder

This method should return the Word object representing the next word in the iteration (the first word if next() has not yet been called.)

next() - Method in class com.swabunga.spell.event.XMLWordFinder

This method scans the text from the end of the last word, and returns a new Word object corresponding to the next word.

nextWord - Variable in class com.swabunga.spell.event.AbstractWordFinder

The word following the current one

nextWord() - Method in class com.swabunga.spell.event.AbstractWordTokenizer

Returns searches for the next word in the text, and returns that word.

nextWord() - Method in class com.swabunga.spell.event.DocumentWordTokenizer

This returns the next word in the iteration.

nextWord() - Method in interface com.swabunga.spell.event.WordTokenizer

This returns the next word in the iteration.

P

paint(Graphics) - Method in class com.swabunga.spell.swing.JSpellApplet

 

paint(Graphics, Shape) - Method in class com.swabunga.spell.swing.autospell.AutoSpellView

 

posStartFullWordFrom(int) - Method in class com.swabunga.spell.event.DocumentWordTokenizer

Sets the current word position at the start of the word containing the char at position pos.

PRE_CACHE_FILE_EXT - Static variable in class com.swabunga.spell.engine.SpellDictionaryCachedDichoDisk

 

preferenceChanged(View, boolean, boolean) - Method in class com.swabunga.spell.swing.autospell.AutoSpellView

 

prop - Variable in class com.swabunga.spell.engine.PropertyConfiguration

The persistent set of properties supported by the spell engine

PropertyConfiguration - Class in com.swabunga.spell.engine

Implementation class to read the properties controlling the spell engine.

PropertyConfiguration() - Constructor for class com.swabunga.spell.engine.PropertyConfiguration

Constructs and loads spell engine properties configuration.

putWord(String) - Method in class com.swabunga.spell.engine.GenericSpellDictionary

Allocates a word in the dictionary

putWord(String) - Method in class com.swabunga.spell.engine.SpellDictionaryHashMap

Allocates a word in the dictionary

putWordUnique(String) - Method in class com.swabunga.spell.engine.SpellDictionaryHashMap

Allocates a word, if it is not already present in the dictionary.

R

read(InputStream, Document, int) - Method in class com.swabunga.spell.swing.autospell.AutoSpellEditorKit

 

read(Reader, Document, int) - Method in class com.swabunga.spell.swing.autospell.AutoSpellEditorKit

 

ready - Variable in class com.swabunga.spell.engine.SpellDictionaryDisk

The flag indicating if the initial preparation or loading of the on disk dictionary is complete.

REG_EXPR - Static variable in class com.swabunga.spell.event.TeXWordFinder

A type where regular expressions are used to define expression to ignore

remove(int) - Method in class com.swabunga.spell.swing.autospell.AutoSpellView

 

remove(int, int) - Method in class com.swabunga.spell.swing.SpellCheckedDocument

 

removeActionListener(ActionListener) - Method in class com.swabunga.spell.swing.JSpellForm

Deregister an action listener

removeAll() - Method in class com.swabunga.spell.swing.autospell.AutoSpellView

 

removeJEditorPane(JEditorPane) - Method in class com.swabunga.spell.swing.autospell.AutoSpellCheckHandler

 

removeSpellCheckListener(SpellCheckListener) - Method in class com.swabunga.spell.event.SpellChecker

Removes a SpellCheckListener from the listeners list.

removeUpdate(DocumentEvent) - Method in class com.swabunga.spell.swing.autospell.AutoSpellCheckHandler

 

removeUpdate(DocumentEvent, Shape, ViewFactory) - Method in class com.swabunga.spell.swing.autospell.AutoSpellView

 

replace(int, int, View[]) - Method in class com.swabunga.spell.swing.autospell.AutoSpellView

 

replace(String) - Method in class com.swabunga.spell.event.AbstractWordFinder

Replace the current word in the search with a replacement string.

replace(String) - Method in interface com.swabunga.spell.event.WordFinder

This method should replace the current Word object with a Word object representing the String newWord.

REPLACE - Static variable in interface com.swabunga.spell.event.SpellCheckEvent

Field indicating that the incorrect word should be replaced

REPLACE_CMD - Static variable in class com.swabunga.spell.swing.JSpellForm

The Replace button click action command

REPLACEALL - Static variable in interface com.swabunga.spell.event.SpellCheckEvent

Field indicating that the incorrect word should be replaced always

REPLACEALL_CMD - Static variable in class com.swabunga.spell.swing.JSpellForm

The Replace All button click action command

REPLACEVOID - Static variable in class com.swabunga.spell.engine.GenericTransformator

Phonetic file character code indicating that the replace expression is empty.

replaceWord(String) - Method in class com.swabunga.spell.event.AbstractWordTokenizer

Replaces the current word token

replaceWord(String) - Method in class com.swabunga.spell.event.DocumentWordTokenizer

Replaces the current word token

replaceWord(String) - Method in class com.swabunga.spell.event.FileWordTokenizer

Replaces the current word token

replaceWord(String) - Method in class com.swabunga.spell.event.StringWordTokenizer

Replace the current word in the iteration with the String s.

replaceWord(String) - Method in interface com.swabunga.spell.event.WordTokenizer

Replaces the current word token

replaceWord(String, boolean) - Method in interface com.swabunga.spell.event.SpellCheckEvent

Set the action to replace the currently misspelt word with the new word

reset() - Method in class com.swabunga.spell.event.SpellChecker

This method clears the words that are currently being remembered as Ignore All words and Replace All words.

S

save() - Method in class com.swabunga.spell.engine.PropertyConfiguration

Writes the property list (key and element pairs) in the PropertyConfiguration file.

saveCache() - Method in class com.swabunga.spell.engine.SpellDictionaryCachedDichoDisk

Saves the current cache to file.

sentenceIterator - Variable in class com.swabunga.spell.event.AbstractWordFinder

An iterator to work through the sentence

sentenceIterator - Variable in class com.swabunga.spell.event.AbstractWordTokenizer

An iterator to work through the sentence

setBoolean(String, boolean) - Method in class com.swabunga.spell.engine.Configuration

Sets one of the boolean constants

setBoolean(String, boolean) - Method in class com.swabunga.spell.engine.PropertyConfiguration

 

setCache() - Method in class com.swabunga.spell.event.SpellChecker

Activates a cache with the maximum number of entries set to 300

setCache(int) - Method in class com.swabunga.spell.event.SpellChecker

Activates a cache with specified size

setCheckSpelling(boolean) - Method in class com.swabunga.spell.swing.SpellCheckedDocument

 

setIgnoreComments(boolean) - Method in class com.swabunga.spell.event.TeXWordFinder

Define if comments contents are ignored during spell checking

setInteger(String, int) - Method in class com.swabunga.spell.engine.Configuration

Sets one of the integer constants

setInteger(String, int) - Method in class com.swabunga.spell.engine.PropertyConfiguration

 

setParent(View) - Method in class com.swabunga.spell.swing.autospell.AutoSpellView

 

setSentenceIterator(Word) - Method in class com.swabunga.spell.event.AbstractWordFinder

Adjusts the sentence iterator and the startSentence flag according to the currentWord.

setSize(float, float) - Method in class com.swabunga.spell.swing.autospell.AutoSpellView

 

setSpellEvent(SpellCheckEvent) - Method in class com.swabunga.spell.swing.JSpellForm

Sets the current spell check event that is being shown to the user

setStart(int) - Method in class com.swabunga.spell.event.Word

Set the start index of the word.

setText(String) - Method in class com.swabunga.spell.event.AbstractWordFinder

Defines the text to search.

setText(String) - Method in class com.swabunga.spell.event.Word

Set the text to a new string value.

setText(String) - Method in interface com.swabunga.spell.event.WordFinder

This method resets the text through which the WordFinder iterates.

setUserDictionary(SpellDictionary) - Method in class com.swabunga.spell.event.SpellChecker

Registers the user dictionary to which words are added.

setUserDictionary(SpellDictionary) - Method in class com.swabunga.spell.swing.JTextComponentSpellChecker

Set user dictionary (used when a word is added)

setWord(String) - Method in class com.swabunga.spell.engine.Word

sets suggested spelling

show(SpellCheckEvent) - Method in class com.swabunga.spell.swing.JSpellDialog

 

SPELL_IGNOREDIGITWORDS - Static variable in class com.swabunga.spell.engine.Configuration

words that have digits in them are not spell checked, example: "mach5"
(boolean)

SPELL_IGNOREINTERNETADDRESSES - Static variable in class com.swabunga.spell.engine.Configuration

words that look like an Internet address are not spell checked, example: "http://www.google.com"
(boolean)

SPELL_IGNOREMIXEDCASE - Static variable in class com.swabunga.spell.engine.Configuration

words that have mixed case are not spell checked, example: "SpellChecker"
(boolean)

SPELL_IGNOREMULTIPLEWORDS - Static variable in class com.swabunga.spell.engine.Configuration

I don't know what this does.

SPELL_IGNORESENTENCECAPITALIZATION - Static variable in class com.swabunga.spell.engine.Configuration

the first word of a sentence is expected to start with an upper case letter
(boolean)

SPELL_IGNOREUPPERCASE - Static variable in class com.swabunga.spell.engine.Configuration

words that are all upper case are not spell checked, example: "CIA"
(boolean)

SPELL_THRESHOLD - Static variable in class com.swabunga.spell.engine.Configuration

the maximum cost of suggested spelling.

spellCheck(JTextComponent) - Method in class com.swabunga.spell.swing.JTextComponentSpellChecker

This method is called to check the spelling of a JTextComponent.

SPELLCHECK_CANCEL - Static variable in class com.swabunga.spell.event.SpellChecker

Flag indicating that the Spell Check completed due to user cancellation

SPELLCHECK_OK - Static variable in class com.swabunga.spell.event.SpellChecker

Flag indicating that the Spell Check completed without any errors present

SpellCheckedDocument - Class in com.swabunga.spell.swing

 

SpellCheckedDocument(SpellDictionary) - Constructor for class com.swabunga.spell.swing.SpellCheckedDocument

 

SpellChecker - Class in com.swabunga.spell.event

This is the main class for spell checking (using the new event based spell checking).

SpellChecker() - Constructor for class com.swabunga.spell.event.SpellChecker

Constructs the SpellChecker.

SpellChecker(SpellDictionary) - Constructor for class com.swabunga.spell.event.SpellChecker

Constructs the SpellChecker.

SpellChecker(SpellDictionary, int) - Constructor for class com.swabunga.spell.event.SpellChecker

Constructs the SpellChecker with a threshold

SpellCheckEvent - Interface in com.swabunga.spell.event

This event is fired off by the SpellChecker and is passed to the registered SpellCheckListeners

SpellCheckExample - Class in com.swabunga.spell.examples

This class shows an example of how to use the spell checking capability.

SpellCheckExample() - Constructor for class com.swabunga.spell.examples.SpellCheckExample

 

SpellCheckExample2 - Class in com.swabunga.spell.examples

This class shows an example of how to use the spell checking capability.

SpellCheckExample2(String) - Constructor for class com.swabunga.spell.examples.SpellCheckExample2

 

SpellCheckListener - Interface in com.swabunga.spell.event

This is the event based listener interface.

SpellDictionary - Interface in com.swabunga.spell.engine

An interface for all dictionary implementations.

SpellDictionaryASpell - Class in com.swabunga.spell.engine

Container for various methods that any SpellDictionary will use.

SpellDictionaryASpell(File) - Constructor for class com.swabunga.spell.engine.SpellDictionaryASpell

Constructs a new SpellDictionaryASpell

SpellDictionaryASpell(File, String) - Constructor for class com.swabunga.spell.engine.SpellDictionaryASpell

Constructs a new SpellDictionaryASpell

SpellDictionaryASpell(Reader) - Constructor for class com.swabunga.spell.engine.SpellDictionaryASpell

Constructs a new SpellDictionaryASpell

SpellDictionaryCachedDichoDisk - Class in com.swabunga.spell.engine

Yet another SpellDictionary this one is based on Damien Guillaume's Diskbased dictionary but adds a cache to try to improve abit on performance.

SpellDictionaryCachedDichoDisk(File) - Constructor for class com.swabunga.spell.engine.SpellDictionaryCachedDichoDisk

Dictionary Convienence Constructor.

SpellDictionaryCachedDichoDisk(File, File) - Constructor for class com.swabunga.spell.engine.SpellDictionaryCachedDichoDisk

Dictionary constructor that uses an aspell phonetic file to build the transformation table.

SpellDictionaryCachedDichoDisk(File, File, String) - Constructor for class com.swabunga.spell.engine.SpellDictionaryCachedDichoDisk

Dictionary constructor that uses an aspell phonetic file to build the transformation table.

SpellDictionaryCachedDichoDisk(File, String) - Constructor for class com.swabunga.spell.engine.SpellDictionaryCachedDichoDisk

Dictionary Convienence Constructor.

SpellDictionaryDichoDisk - Class in com.swabunga.spell.engine

Another implementation of SpellDictionary that doesn't cache any words in memory.

SpellDictionaryDichoDisk(File) - Constructor for class com.swabunga.spell.engine.SpellDictionaryDichoDisk

Dictionary convenience Constructor.

SpellDictionaryDichoDisk(File, File) - Constructor for class com.swabunga.spell.engine.SpellDictionaryDichoDisk

Dictionary constructor that uses an aspell phonetic file to build the transformation table.

SpellDictionaryDichoDisk(File, File, String) - Constructor for class com.swabunga.spell.engine.SpellDictionaryDichoDisk

Dictionary constructor that uses an aspell phonetic file to build the transformation table.

SpellDictionaryDichoDisk(File, String) - Constructor for class com.swabunga.spell.engine.SpellDictionaryDichoDisk

Dictionary convenience Constructor.

SpellDictionaryDisk - Class in com.swabunga.spell.engine

An implementation of SpellDictionary that doesn't cache any words in memory.

SpellDictionaryDisk(File, File, boolean) - Constructor for class com.swabunga.spell.engine.SpellDictionaryDisk

Construct a spell dictionary on disk.

SpellDictionaryHashMap - Class in com.swabunga.spell.engine

The SpellDictionaryHashMap holds the dictionary

SpellDictionaryHashMap() - Constructor for class com.swabunga.spell.engine.SpellDictionaryHashMap

Dictionary Constructor.

SpellDictionaryHashMap(File) - Constructor for class com.swabunga.spell.engine.SpellDictionaryHashMap

Dictionary convenience Constructor.

SpellDictionaryHashMap(File, File) - Constructor for class com.swabunga.spell.engine.SpellDictionaryHashMap

Dictionary constructor that uses an aspell phonetic file to build the transformation table.

SpellDictionaryHashMap(File, File, String) - Constructor for class com.swabunga.spell.engine.SpellDictionaryHashMap

Dictionary constructor that uses an aspell phonetic file to build the transformation table.

SpellDictionaryHashMap(Reader) - Constructor for class com.swabunga.spell.engine.SpellDictionaryHashMap

Dictionary Constructor.

SpellDictionaryHashMap(Reader, Reader) - Constructor for class com.swabunga.spell.engine.SpellDictionaryHashMap

Dictionary constructor that uses an aspell phonetic file to build the transformation table.

SpellEditorKit - Class in com.swabunga.spell.swing

use: JTextPane pane = new JTextPane(); pane.setEditorKit(new SpellEditorKit());

SpellEditorKit(File) - Constructor for class com.swabunga.spell.swing.SpellEditorKit

 

SpellEditorKit.LinkController - Class in com.swabunga.spell.swing

 

spellEvent - Variable in class com.swabunga.spell.swing.JSpellForm

 

spellingError(SpellCheckEvent) - Method in interface com.swabunga.spell.event.SpellCheckListener

Propagates the spelling errors to listeners.

spellingError(SpellCheckEvent) - Method in class com.swabunga.spell.examples.SpellCheckExample

 

spellingError(SpellCheckEvent) - Method in class com.swabunga.spell.examples.SpellCheckExample2

 

spellingError(SpellCheckEvent) - Method in class com.swabunga.spell.swing.JTextComponentSpellChecker

 

startAutoSpellCheck(JEditorPane) - Method in class com.swabunga.spell.swing.JTextComponentSpellChecker

 

STARTMULTI - Static variable in class com.swabunga.spell.engine.GenericTransformator

Start a group of characters which can be appended to the match expression of the phonetic file.

startsSentence - Variable in class com.swabunga.spell.event.AbstractWordFinder

Indicate if the current word starts a new sentence

startsSentence() - Method in class com.swabunga.spell.event.AbstractWordFinder

 

startsSentence() - Method in interface com.swabunga.spell.event.WordFinder

Indicates if the current word starts a new sentence.

stopAutoSpellCheck(JEditorPane) - Method in class com.swabunga.spell.swing.JTextComponentSpellChecker

 

STRING_EXPR - Static variable in class com.swabunga.spell.event.TeXWordFinder

A type where string expressions are used to define expression to ignore

StringWordTokenizer - Class in com.swabunga.spell.event

This class tokenizes a input string.

StringWordTokenizer(WordFinder) - Constructor for class com.swabunga.spell.event.StringWordTokenizer

Creates a new StringWordTokenizer object.

StringWordTokenizer(String) - Constructor for class com.swabunga.spell.event.StringWordTokenizer

Creates a new StringWordTokenizer object.

StringWordTokenizer(String, WordFinder) - Constructor for class com.swabunga.spell.event.StringWordTokenizer

Creates a new StringWordTokenizer object.

suggestList - Variable in class com.swabunga.spell.swing.JSpellForm

 

SwingFormExample - Class in com.swabunga.spell.examples

This class shows an example of how to use the spell checking capability for a text area on a swing form.

SwingFormExample() - Constructor for class com.swabunga.spell.examples.SwingFormExample

 

T

text - Variable in class com.swabunga.spell.event.AbstractWordFinder

Holds the text to analyze

TextPaneMarkingExample - Class in com.swabunga.spell.examples

This class shows an example of how to use the spell checking capability on a JTextComponent.

TextPaneMarkingExample(String, String) - Constructor for class com.swabunga.spell.examples.TextPaneMarkingExample

 

TeXWordFinder - Class in com.swabunga.spell.event

A word finder for TeX and LaTeX documents, which searches text for sequences of letters, but ignores any commands and environments as well as Math environments.

TeXWordFinder() - Constructor for class com.swabunga.spell.event.TeXWordFinder

Creates a new DefaultWordFinder object.

TeXWordFinder(String) - Constructor for class com.swabunga.spell.event.TeXWordFinder

Creates a new DefaultWordFinder object.

tf - Variable in class com.swabunga.spell.engine.SpellDictionaryASpell

The reference to a Transformator, used to transform a word into it's phonetic code.

toString() - Method in class com.swabunga.spell.engine.Word

returns the suggested spelling

toString() - Method in class com.swabunga.spell.event.AbstractWordFinder

Return the text being searched.

toString() - Method in class com.swabunga.spell.event.Word

Supply the text representing the word.

transform(String) - Method in class com.swabunga.spell.engine.DoubleMeta

Take the given word, and return the best phonetic hash for it.

transform(String) - Method in class com.swabunga.spell.engine.GenericTransformator

Builds the phonetic code of the word.

transform(String) - Method in interface com.swabunga.spell.engine.Transformator

Take the given word, and return the best phonetic hash for it.

Transformator - Interface in com.swabunga.spell.engine

An interface for all Transformators - which take a dictionary word and converts into its phonetic hash.

V

valueChanged(ListSelectionEvent) - Method in class com.swabunga.spell.swing.JSpellForm

Fired when a value in the list is selected

viewToModel(float, float, Shape, Position.Bias[]) - Method in class com.swabunga.spell.swing.autospell.AutoSpellView

 

W

windowActivated(WindowEvent) - Method in class com.swabunga.spell.swing.JSpellDialog

 

windowClosed(WindowEvent) - Method in class com.swabunga.spell.swing.JSpellDialog

 

windowClosing(WindowEvent) - Method in class com.swabunga.spell.swing.JSpellDialog

Cancel the event if the Dialog Close button is pressed

windowDeactivated(WindowEvent) - Method in class com.swabunga.spell.swing.JSpellDialog

 

windowDeiconified(WindowEvent) - Method in class com.swabunga.spell.swing.JSpellDialog

 

windowIconified(WindowEvent) - Method in class com.swabunga.spell.swing.JSpellDialog

 

windowOpened(WindowEvent) - Method in class com.swabunga.spell.swing.JSpellDialog

 

Word - Class in com.swabunga.spell.engine

The Word object holds information for one suggested spelling.

Word - Class in com.swabunga.spell.event

Offers basic methods to manipulate a text string representing a word.

Word() - Constructor for class com.swabunga.spell.engine.Word

Constructs a new Word.

Word(Word) - Constructor for class com.swabunga.spell.event.Word

Creates a new Word object by cloning an existing Word object.

Word(String, int) - Constructor for class com.swabunga.spell.engine.Word

Constructs a new Word.

Word(String, int) - Constructor for class com.swabunga.spell.event.Word

Creates a new Word object.

wordCount - Variable in class com.swabunga.spell.event.AbstractWordTokenizer

The cumulative word count that have been processed

WordFinder - Interface in com.swabunga.spell.event

An interface for objects which take a String as input, and iterates through the words in the string.

wordMisspelled - Static variable in interface com.swabunga.spell.swing.autospell.AutoSpellConstants

 

wordMisspelledTrue - Static variable in interface com.swabunga.spell.swing.autospell.AutoSpellConstants

 

WordNotFoundException - Exception Class in com.swabunga.spell.event

An exception to indicate that there not enough words as expected.

WordNotFoundException() - Constructor for exception class com.swabunga.spell.event.WordNotFoundException

Creates a new WordNotFoundException object.

WordNotFoundException(String) - Constructor for exception class com.swabunga.spell.event.WordNotFoundException

Creates a new WordNotFoundException object.

WordTokenizer - Interface in com.swabunga.spell.event

An interface for objects which take a text-based media as input, and iterate through the words in the text stored in that media.

write(OutputStream, Document, int, int) - Method in class com.swabunga.spell.swing.autospell.AutoSpellEditorKit

 

write(Writer, Document, int, int) - Method in class com.swabunga.spell.swing.autospell.AutoSpellEditorKit

 

X

XMLWordFinder - Class in com.swabunga.spell.event

A word finder for XML or HTML documents, which searches text for sequences of letters, but ignores the text inside any tags.

XMLWordFinder(String) - Constructor for class com.swabunga.spell.event.XMLWordFinder

Creates a new DefaultWordFinder object.