HelpConfig

All Known Implementing Classes:

DefaultHelpConfig
```
public interface HelpConfig
```

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`FILENAME_DOCS`
`static String`	`FILENAME_HELP_CONFIG`
`static String`	`FILENAME_HELPINDEX`
`static String`	`FILENAME_HELPMAPPING`
`static String`	`FILENAME_HELPSET`
`static String`	`FILENAME_HELPTOC`
`static String`	`FILENAME_INDEXER_CONFIG`
`static String`	`FILENAME_SEARCHDB`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`create(File folder, File docsFolder)`
`boolean`	`create(File folder, String name)`
`boolean`	`create(File folder, String name, File docsFolder)`
`HelpSet`	`createHelpSet()`
`boolean`	`exists(File folder)`
`File`	`getDocsFolder()`
`URL`	`getDocsUrl()`
`File`	`getFolder()`
`File`	`getHelpConfig()`
`File`	`getHelpIndex()`
`Writer`	`getHelpIndexWriter()`
`File`	`getHelpMapping()`
`Writer`	`getHelpMappingWriter()`
`File`	`getHelpSet()`
`Writer`	`getHelpSetWriter()`
`File`	`getIndexerConfig()`
`ClassLoader`	`getLoader()`
`String`	`getName()`
`File`	`getSearchdb()`
`File`	`getTOC()`
`Writer`	`getTOCWriter()`
`boolean`	`load(File folder)`

Field Detail
- FILENAME_DOCS
```
static final String FILENAME_DOCS
```
  See Also:
  Constant Field Values
- FILENAME_HELPINDEX
```
static final String FILENAME_HELPINDEX
```
  See Also:
  Constant Field Values
- FILENAME_HELPMAPPING
```
static final String FILENAME_HELPMAPPING
```
  See Also:
  Constant Field Values
- FILENAME_HELPSET
```
static final String FILENAME_HELPSET
```
  See Also:
  Constant Field Values
- FILENAME_HELPTOC
```
static final String FILENAME_HELPTOC
```
  See Also:
  Constant Field Values
- FILENAME_HELP_CONFIG
```
static final String FILENAME_HELP_CONFIG
```
  See Also:
  Constant Field Values
- FILENAME_INDEXER_CONFIG
```
static final String FILENAME_INDEXER_CONFIG
```
  See Also:
  Constant Field Values
- FILENAME_SEARCHDB
```
static final String FILENAME_SEARCHDB
```
  See Also:
  Constant Field Values

Method Detail

create

boolean create(File folder,
             String name)

create

boolean create(File folder,
             String name,
             File docsFolder)

create

boolean create(File folder,
             File docsFolder)

createHelpSet
```
HelpSet createHelpSet()
```

exists
```
boolean exists(File folder)
```

getDocsFolder
```
File getDocsFolder()
```

getDocsUrl
```
URL getDocsUrl()
```

getFolder
```
File getFolder()
```

getHelpConfig
```
File getHelpConfig()
```

getHelpIndex
```
File getHelpIndex()
```

getHelpIndexWriter
```
Writer getHelpIndexWriter()
```

getHelpMapping
```
File getHelpMapping()
```

getHelpMappingWriter
```
Writer getHelpMappingWriter()
```

getHelpSet
```
File getHelpSet()
```

getHelpSetWriter
```
Writer getHelpSetWriter()
```

getIndexerConfig
```
File getIndexerConfig()
```

getLoader
```
ClassLoader getLoader()
```

getName
```
String getName()
```

getSearchdb
```
File getSearchdb()
```

getTOC
```
File getTOC()
```

getTOCWriter
```
Writer getTOCWriter()
```

load
```
boolean load(File folder)
```

Interface HelpConfig

Field Summary

Method Summary

Field Detail

FILENAME_DOCS

FILENAME_HELPINDEX

FILENAME_HELPMAPPING

FILENAME_HELPSET

FILENAME_HELPTOC

FILENAME_HELP_CONFIG

FILENAME_INDEXER_CONFIG

FILENAME_SEARCHDB

Method Detail

create

create

create

createHelpSet

exists

getDocsFolder

getDocsUrl

getFolder

getHelpConfig

getHelpIndex

getHelpIndexWriter

getHelpMapping

getHelpMappingWriter

getHelpSet

getHelpSetWriter

getIndexerConfig

getLoader

getName

getSearchdb

getTOC

getTOCWriter

load