A B C D E F G H I J K L M N P R S T V W X

A

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

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

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

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

The Add button click action command

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

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

AbstractWordFinder - class com.swabunga.spell.event.AbstractWordFinder.

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

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

Creates a new AbstractWordFinder object.

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

AbstractWordTokenizer - class com.swabunga.spell.event.AbstractWordTokenizer.

This class tokenizes a input string.

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

Creates a new AbstractWordTokenizer object.

AbstractWordTokenizer(WordFinder) - 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

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

Register an action listener

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

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

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

Adds to the existing dictionary from a word list file.

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

Adds a SpellCheckListener

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 permanantly 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.SpellDictionaryDichoDisk

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

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

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

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

B

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

C

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

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 adjoinging 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)

Configuration - class com.swabunga.spell.engine.Configuration.

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

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

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

Set the action to terminate processing of the spellchecker.

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.

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

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

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

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

JMH Again, there is no need to have a global class matrix variable in this class.

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

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

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.

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

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

D

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

DefaultWordFinder - class com.swabunga.spell.event.DefaultWordFinder.

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

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

Creates a new DefaultWordFinder object.

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

DocumentWordTokenizer - class com.swabunga.spell.event.DocumentWordTokenizer.

This class tokenizes a swing document model.

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

DoubleMeta - class com.swabunga.spell.engine.DoubleMeta.

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

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

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

E

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

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

EditDistance - class com.swabunga.spell.engine.EditDistance.

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

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

F

FileWordTokenizer - class com.swabunga.spell.event.FileWordTokenizer.

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

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

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

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 com.swabunga.spell.engine.GenericSpellDictionary.

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 com.swabunga.spell.engine.GenericTransformator.

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

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

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

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

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

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

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(String) - Static method in class com.swabunga.spell.engine.Configuration

Returns a new instance of a Configuration class

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

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 current number of words that have been processed

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 the current end word position 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 curent word in the text

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

Returns the current character position in the text

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

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

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

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

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

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

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

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() - Method in interface com.swabunga.spell.event.SpellCheckEvent

Returns the list of suggested Word objects

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

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

Return the text being searched.

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

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

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

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

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

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

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

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

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

Returns true if there are more words left

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

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

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

I

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

Field indicating that the incorrect word should be ignored

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

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

The Ignore button click action command

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

Initial case for the action

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

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

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

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

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

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

Initializes this word finder

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

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

Called by the constructor to initialise the GUI

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

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

Returns true 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.

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

Returns true iff this word looks like 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

Returns true 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

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

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

J

JSpellApplet - class com.swabunga.spell.swing.JSpellApplet.

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

JSpellDialog - class com.swabunga.spell.swing.JSpellDialog.

Implementation of a spell check dialog.

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

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

JSpellForm - class com.swabunga.spell.swing.JSpellForm.

Implementation of a spell check form.

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

Panel constructor

JTextComponentSpellCheckExample - class com.swabunga.spell.examples.JTextComponentSpellCheckExample.

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

JTextComponentSpellChecker - class com.swabunga.spell.swing.JTextComponentSpellChecker.

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(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

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

JavaWordFinder - class com.swabunga.spell.event.JavaWordFinder.

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

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

Creates a new DefaultWordFinder object.

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

K

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

L

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

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

M

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

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

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

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

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

Returns the next word in the text

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

This returns the next word in the iteration.

P

PropertyConfiguration - class com.swabunga.spell.engine.PropertyConfiguration.

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

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

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

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

R

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

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

Field indicating that the incorrect word should be replaced

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

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

The Replace button click action command

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

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

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

Removes a SpellCheckListener

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.

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

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

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

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

When a word is replaced care should be taken that the WordTokenizer repositions itself such that the words that were added aren't rechecked.

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

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

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

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

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

SpellCheckEvent - interface com.swabunga.spell.event.SpellCheckEvent.

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

AFAIK we will only require one implementation of the SpellCheckEvent (BasicSpellCheckEvent) but I have defnied this interface just in case.

SpellCheckExample - class com.swabunga.spell.examples.SpellCheckExample.

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

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

SpellCheckExample2 - class com.swabunga.spell.examples.SpellCheckExample2.

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 com.swabunga.spell.event.SpellCheckListener.

This is the event based listener interface.

SpellCheckedDocument - class com.swabunga.spell.swing.SpellCheckedDocument.

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

SpellChecker - class com.swabunga.spell.event.SpellChecker.

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

SpellDictionary - interface com.swabunga.spell.engine.SpellDictionary.

An interface for all dictionary implementations.

SpellDictionaryASpell - class com.swabunga.spell.engine.SpellDictionaryASpell.

Container for various methods that any SpellDictionary will use.

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

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

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

SpellDictionaryDichoDisk - class com.swabunga.spell.engine.SpellDictionaryDichoDisk.

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

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

Dictionary Convienence Constructor.

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

Dictionary Convienence 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.

SpellDictionaryDisk - class com.swabunga.spell.engine.SpellDictionaryDisk.

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

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

NOTE: Do *not* create two instances of this class pointing to the same File unless you are sure that a new dictionary does not have to be created.

SpellDictionaryHashMap - class com.swabunga.spell.engine.SpellDictionaryHashMap.

The SpellDictionaryHashMap holds the dictionary

This class is thread safe.

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

Dictionary Constructor.

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

Dictionary Constructor.

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

Dictionary Convienence 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, Reader) - Constructor for class com.swabunga.spell.engine.SpellDictionaryHashMap

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

SpellEditorKit - class com.swabunga.spell.swing.SpellEditorKit.

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

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

SpellEditorKit.LinkController - class com.swabunga.spell.swing.SpellEditorKit.LinkController.

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

StringWordTokenizer - class com.swabunga.spell.event.StringWordTokenizer.

This class tokenizes a input string.

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

Creates a new StringWordTokenizer object.

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

Creates a new StringWordTokenizer object.

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

SwingFormExample - class com.swabunga.spell.examples.SwingFormExample.

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

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

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

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

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

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

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

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

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

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

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

Set user dictionary (used when a word is added)

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

Set user dictionary (used when a word is added)

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

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

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

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

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

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

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

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

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

T

TeXWordFinder - class com.swabunga.spell.event.TeXWordFinder.

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(String) - Constructor for class com.swabunga.spell.event.TeXWordFinder

Creates a new DefaultWordFinder object.

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

Transformator - interface com.swabunga.spell.engine.Transformator.

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

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

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

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

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

V

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

Fired when a value in the list is selected

W

Word - class com.swabunga.spell.engine.Word.

The Word object holds information for one suggested spelling.

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

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

Word - class com.swabunga.spell.event.Word.

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

Creates a new Word object.

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

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

WordFinder - interface com.swabunga.spell.event.WordFinder.

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

WordNotFoundException - exception com.swabunga.spell.event.WordNotFoundException.

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

Creates a new WordNotFoundException object.

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

Creates a new WordNotFoundException object.

WordTokenizer - interface com.swabunga.spell.event.WordTokenizer.

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

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

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

The cumulative word count that have been processed

X

XMLWordFinder - class com.swabunga.spell.event.XMLWordFinder.

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.

A B C D E F G H I J K L M N P R S T V W X