org.gvsig.scripting

Interface HelpConfig

All Known Implementing Classes:

DefaultHelpConfig

public interface HelpConfig

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FILENAME_DOCS
static java.lang.String	FILENAME_HELP_CONFIG
static java.lang.String	FILENAME_HELPINDEX
static java.lang.String	FILENAME_HELPMAPPING
static java.lang.String	FILENAME_HELPSET
static java.lang.String	FILENAME_HELPTOC
static java.lang.String	FILENAME_INDEXER_CONFIG
static java.lang.String	FILENAME_SEARCHDB

Method Summary

Methods

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

Field Detail

FILENAME_DOCS

static final java.lang.String FILENAME_DOCS

See Also:

Constant Field Values

FILENAME_HELPINDEX

static final java.lang.String FILENAME_HELPINDEX

See Also:

Constant Field Values

FILENAME_HELPMAPPING

static final java.lang.String FILENAME_HELPMAPPING

See Also:

Constant Field Values

FILENAME_HELPSET

static final java.lang.String FILENAME_HELPSET

See Also:

Constant Field Values

FILENAME_HELPTOC

static final java.lang.String FILENAME_HELPTOC

See Also:

Constant Field Values

FILENAME_HELP_CONFIG

static final java.lang.String FILENAME_HELP_CONFIG

See Also:

Constant Field Values

FILENAME_INDEXER_CONFIG

static final java.lang.String FILENAME_INDEXER_CONFIG

See Also:

Constant Field Values

FILENAME_SEARCHDB

static final java.lang.String FILENAME_SEARCHDB

See Also:

Constant Field Values

Method Detail

create

boolean create(java.io.File folder,
             java.lang.String name)

create

boolean create(java.io.File folder,
             java.lang.String name,
             java.io.File docsFolder)

create

boolean create(java.io.File folder,
             java.io.File docsFolder)

createHelpSet

HelpSet createHelpSet()

exists

boolean exists(java.io.File folder)

getDocsFolder

java.io.File getDocsFolder()

getDocsUrl

java.net.URL getDocsUrl()

getFolder

java.io.File getFolder()

getHelpConfig

java.io.File getHelpConfig()

getHelpIndex

java.io.File getHelpIndex()

getHelpIndexWriter

java.io.Writer getHelpIndexWriter()

getHelpMapping

java.io.File getHelpMapping()

getHelpMappingWriter

java.io.Writer getHelpMappingWriter()

getHelpSet

java.io.File getHelpSet()

getHelpSetWriter

java.io.Writer getHelpSetWriter()

getIndexerConfig

java.io.File getIndexerConfig()

getLoader

java.lang.ClassLoader getLoader()

getName

java.lang.String getName()

getSearchdb

java.io.File getSearchdb()

getTOC

java.io.File getTOC()

getTOCWriter

java.io.Writer getTOCWriter()

load

boolean load(java.io.File folder)