A C D E F G H I J N O S

A

AbstractJavafxdocMojo - Class in net.sf.jfxdplugin

Base class for the Javafxdoc mojo.

AbstractJavafxdocMojo() - Constructor for class net.sf.jfxdplugin.AbstractJavafxdocMojo

C

canGenerateReport(List<String>) - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Method that indicates whether the javafxdoc can be generated or not.

canGenerateReport() - Method in class net.sf.jfxdplugin.JavafxdocReport

D

DEBUG_JAVAFXDOC_SCRIPT_NAME - Static variable in class net.sf.jfxdplugin.AbstractJavafxdocMojo

The Javafxdoc script file name when the debug parameter is on, i.e.

DEFAULT_JAVA_API_LINKS - Static variable in class net.sf.jfxdplugin.AbstractJavafxdocMojo

The default Javafxdoc API URLs according to the Sun/Oracle API Specifications.

DEFAULT_JAVAFX_VERSION - Static variable in class net.sf.jfxdplugin.AbstractJavafxdocMojo

The default JavaFX version (1.0) to use if no other viable version can be found.

E

execute() - Method in class net.sf.jfxdplugin.HelpMojo

execute() - Method in class net.sf.jfxdplugin.JavafxdocJar

Entry point for the jar goal.

execute() - Method in class net.sf.jfxdplugin.JavafxdocReport

Entry point for the javafxdoc goal.

executeReport() - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Runs the report for the given parameters.

F

FILES_FILE_NAME - Static variable in class net.sf.jfxdplugin.AbstractJavafxdocMojo

The files file name in the output directory when calling javafxdoc.exe(or .sh) [@options] [packagenames] [sourcefiles] [@files].

formatMessage(String, Object...) - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Formats the messages from the resource bundle with the given arguments.

G

generate(Sink, Locale) - Method in class net.sf.jfxdplugin.JavafxdocReport

getAdditionalJOptions() - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Returns the additional -J option value.

getAdditionalXslOptions() - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Returns the additional Xsl options value.

getArchive() - Method in class net.sf.jfxdplugin.JavafxdocJar

Returns the Maven archive configuration.

getBootclasspath() - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Returns the boot class path.

getBundle(Locale) - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Gets the resource bundle for the specified locale.

getCategoryName() - Method in class net.sf.jfxdplugin.JavafxdocReport

getDefaultManifestFile() - Method in class net.sf.jfxdplugin.JavafxdocJar

Returns the default jar manifest file.

getDescription(Locale) - Method in class net.sf.jfxdplugin.JavafxdocReport

getDestDir() - Method in class net.sf.jfxdplugin.JavafxdocReport

Returns the destination directory for the HTML output.

getDoclet() - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Returns the doclet for HTML generation.

getDocletPath() - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Returns the path to the doclet for HTML generation.

getEncoding() - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Returns the output encoding.

getExcludePackageNames() - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Returns the list of package names to exclude.

getExtdirs() - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Returns the extension directories.

getExtracss() - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Returns the extra CSS file to use.

getExtrajs() - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Returns the extra JavaScript file to use.

getFiles(List<String>) - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Method to get the files on the specified source paths.

getFinalName() - Method in class net.sf.jfxdplugin.JavafxdocJar

Returns the final name for the generated jar file.

getInputFiles() - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Returns the XML input file.

getJarArchiver() - Method in class net.sf.jfxdplugin.JavafxdocJar

Returns the jar archiver for the plugin.

getJarOutputDirectory() - Method in class net.sf.jfxdplugin.JavafxdocJar

Returns the output directory for the generated jar file.

getJavafxdocExecutable() - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Returns the location of the Javafxdoc executable.

getJavafxdocVersion() - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Returns the javafxdoc tool version.

getLocale() - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Returns the documentation locale.

getLocaleObject() - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Constructs a Locale object from the specified locale.

getMastercss() - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Returns the location of the master CSS file.

getName(Locale) - Method in class net.sf.jfxdplugin.JavafxdocReport

getOutputDirectory() - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Returns the output directory for the plugin.

getOutputFile() - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Returns the XML output file.

getOutputName() - Method in class net.sf.jfxdplugin.JavafxdocReport

getProfile() - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Returns the JavaFX platform name.

getProject() - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Returns the Maven project object.

getProjectArtifacts(MavenProject) - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Returns the artifacts for the project.

getReportOutputDirectory() - Method in class net.sf.jfxdplugin.JavafxdocReport

getSession() - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Returns the Maven session object.

getShow() - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Returns the visibility level to show in the documentation.

getSource() - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Returns the version of the source code.

getSourcePath() - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Returns the path to the source code.

getSourcePaths() - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Method to get the source paths.

getSubpackages() - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Returns the sub packages to document.

getToolchainManager() - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Returns the toolchain manager.

getXsltfile() - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Returns the XSL transformation file.

H

HelpMojo - Class in net.sf.jfxdplugin

Display help information on maven-javafxdoc-plugin.
Call

HelpMojo() - Constructor for class net.sf.jfxdplugin.HelpMojo

I

isBreakiterator() - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Returns whether the sentence break iterator is used.

isDebug() - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Returns whether the plugin is in debug mode.

isExternalReport() - Method in class net.sf.jfxdplugin.JavafxdocReport

isFailOnError() - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Returns whether the plugin fails on errors.

isNohtml() - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Returns whether HTML files are generated.

isQuiet() - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Returns whether the plugin operates in quiet mode.

isUseDefaultManifestFile() - Method in class net.sf.jfxdplugin.JavafxdocJar

Returns whether the default manifest file is used.

isVerbose() - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Returns whether the plugin operates in verbose mode.

J

JavafxdocJar - Class in net.sf.jfxdplugin

Bundles the Javafxdoc documentation for the JavaFX code in a NON aggregator project into a jar using the standard Javafxdoc tool.

JavafxdocJar() - Constructor for class net.sf.jfxdplugin.JavafxdocJar

JavafxdocReport - Class in net.sf.jfxdplugin

Generates documentation for the JavaFX code in a NON aggregator project using the standard Javafxdoc Tool.

JavafxdocReport() - Constructor for class net.sf.jfxdplugin.JavafxdocReport

N

net.sf.jfxdplugin - package net.sf.jfxdplugin

Provides the classes necessary to execute the Javafxdoc tool on the supplied source files.

O

OPTIONS_FILE_NAME - Static variable in class net.sf.jfxdplugin.AbstractJavafxdocMojo

The options file name in the output directory when calling javafxdoc.exe(or .sh) [@options] [packagenames] [sourcefiles] [@files].

S

setAdditionalJOptions(String[]) - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Specifies the additional -J option value.

setAdditionalXslOptions(String[]) - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Specifies the additional Xsl option value.

setArchive(MavenArchiveConfiguration) - Method in class net.sf.jfxdplugin.JavafxdocJar

Sets the Maven archive configuration.

setBootclasspath(String) - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Specifies the boot class path.

setBreakiterator(boolean) - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Specifies whether the sentence break iterator is used.

setDebug(boolean) - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Specifies whether the plugin is in debug mode.

setDefaultManifestFile(File) - Method in class net.sf.jfxdplugin.JavafxdocJar

Sets the default jar manifest file.

setDestDir(String) - Method in class net.sf.jfxdplugin.JavafxdocReport

Sets the destination directory for the HTML output.

setDoclet(String) - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Specifies the doclet for HTML generation.

setDocletPath(String) - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Specifies the path to the doclet for HTML generation.

setEncoding(String) - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Specifies the output encoding.

setExcludePackageNames(String) - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Specifies the list of package names to exclude.

setExtdirs(String) - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Specifies the extension directories.

setExtracss(String) - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Specifies the extra CSS file to use.

setExtrajs(String) - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Specifies the extra JavaScript file to use.

setFailOnError(boolean) - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Specifies whether the plugin fails on errors.

setFinalName(String) - Method in class net.sf.jfxdplugin.JavafxdocJar

Sets the final name for the generated jar file.

setInputFiles(File[]) - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Specifies the XML input file.

setJarArchiver(JarArchiver) - Method in class net.sf.jfxdplugin.JavafxdocJar

Sets the jar archiver for the plugin.

setJarOutputDirectory(String) - Method in class net.sf.jfxdplugin.JavafxdocJar

Sets the output directory for the generated jar file.

setJavafxdocExecutable(String) - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Specifies the location of the Javafxdoc executable.

setLocale(String) - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Specifies the documentation locale.

setMastercss(String) - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Specifies the location of the master CSS file.

setNohtml(boolean) - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Specifies whether HTML files are generated.

setOutputDirectory(File) - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Specifies the output directory for the plugin.

setOutputFile(File) - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Specifies the XML output file.

setProfile(String) - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Specifies the JavaFX platform name (desktop, mobile, tv).

setProject(MavenProject) - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Specifies the Maven project object.

setQuiet(boolean) - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Specifies whether the plugin operates in quiet mode.

setReportOutputDirectory(File) - Method in class net.sf.jfxdplugin.JavafxdocReport

setShow(String) - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Specifies the visibility level to show in the documentation.

setSource(String) - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Specifies the version of the source code.

setSourcePath(String) - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Specifies the path to the source code.

setSubpackages(String) - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Specifies the sub packages to document.

setToolchainManager(ToolchainManager) - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Specifies the toolchain manager.

setUseDefaultManifestFile(boolean) - Method in class net.sf.jfxdplugin.JavafxdocJar

Sets whether the default manifest file is used.

setVerbose(boolean) - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Specifies whether the plugin operates in verbose mode.

setXsltfile(File) - Method in class net.sf.jfxdplugin.AbstractJavafxdocMojo

Specifies the XSL transformation file.

SINCE_JAVAFXDOC_1_3 - Static variable in class net.sf.jfxdplugin.AbstractJavafxdocMojo

For Javafxdoc options that appear since JavaFX 1.3.

A C D E F G H I J N O S