Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> gjt >> sp >> jedit >> [ help overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.gjt.sp.jedit.help
Class HelpIndex  

java.lang.Object
  org.gjt.sp.jedit.help.HelpIndex

---

class HelpIndex

extends java.lang.Object

---

Nested Class Summary
(package private) static class	HelpIndex.HelpFile
(package private) static class	HelpIndex.Word

 

Field Summary
private static HelpIndex.Word.Occurrence[]	EMPTY_ARRAY
private  java.util.ArrayList	files
private static java.lang.Object	IGNORE
private  java.util.HashMap	words

 

Constructor Summary

HelpIndex()

 

Method Summary
private  void	addWord(java.lang.String word, int file, boolean title)
HelpIndex.HelpFile	getFile(int index)
private  void	ignoreWord(java.lang.String word)
void	indexDirectory(java.lang.String dir)           Indexes all HTML and text files in the specified directory.
void	indexEditorHelp()           Indexes all available help, including the jEdit user's guide, FAQ,] and plugin documentation.
void	indexJAR(java.util.zip.ZipFile jar)           Indexes all HTML and text files in the specified JAR file.
private  void	indexStream(java.io.InputStream _in, java.lang.String fileName)           Reads the specified HTML file and adds all words defined therein to the index.
void	indexURL(java.lang.String url)           Reads the specified HTML file and adds all words defined therein to the index.
HelpIndex.Word	lookupWord(java.lang.String word)

 

Methods inherited from class java.lang.Object

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

 

Field Detail

EMPTY_ARRAY

private static HelpIndex.Word.Occurrence[] EMPTY_ARRAY

---

IGNORE

private static java.lang.Object IGNORE

---

words

private java.util.HashMap words

---

files

private java.util.ArrayList files

Constructor Detail

HelpIndex

public HelpIndex()

Method Detail

indexEditorHelp

public void indexEditorHelp()

Indexes all available help, including the jEdit user's guide, FAQ,] and plugin documentation.

---

indexDirectory

public void indexDirectory(java.lang.String dir)
                    throws java.lang.Exception

Indexes all HTML and text files in the specified directory.

---

indexJAR

public void indexJAR(java.util.zip.ZipFile jar)
              throws java.lang.Exception

Indexes all HTML and text files in the specified JAR file.

---

indexURL

public void indexURL(java.lang.String url)
              throws java.lang.Exception

Reads the specified HTML file and adds all words defined therein to the index.

---

lookupWord

public HelpIndex.Word lookupWord(java.lang.String word)

---

getFile

public HelpIndex.HelpFile getFile(int index)

---

ignoreWord

private void ignoreWord(java.lang.String word)

---

indexStream

private void indexStream(java.io.InputStream _in,
                         java.lang.String fileName)
                  throws java.lang.Exception

Reads the specified HTML file and adds all words defined therein to the index.

---

addWord

private void addWord(java.lang.String word,
                     int file,
                     boolean title)

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> gjt >> sp >> jedit >> [ help overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---