com.vp.plugin

Interface DocumentationManager

public interface DocumentationManager

Method Summary

Modifier and Type	Method and Description
IUseCaseDescriptionReader	createUseCaseDescriptionReader(IProject project, IUseCaseDescriptionItemContainer useCaseDescription)
void	generateDocComposerWord(IReportDiagramUIModel aReportDiagram, java.io.File aOutputFile, javax.swing.JComponent aInvoker)
void	generateHTMLDoc(java.awt.Component invoker, java.io.File output)
void	generateHTMLDoc(java.io.File output)
void	generatePDFDoc(java.awt.Component invoker, java.io.File output)
void	generatePDFDoc(java.io.File output)
void	generateWordDoc(java.awt.Component invoker, java.io.File output)
void	generateWordDoc(java.awt.Component invoker, java.io.File output, java.lang.String templateName)
void	generateWordDoc(java.io.File output)
void	generateWordDoc(java.io.File output, java.lang.String templateName)
void	importDocTemplate(java.lang.String templateFilePath)
void	initDefaultRDNumberingSetting(IRDNumberingSetting aNumberingSetting)
void	initDefaultRDStyleRepository(IRDStyleRepository aStyleRepository)
void	initDefaultRDTableOfContentsTemplate(IRDTableOfContentsTemplate aTableOfContentsTemplate)
void	publishProject(java.awt.Component invoker, java.io.File output)
void	publishProject(java.io.File output)
int	showGenerateHTMLDocDialog()
int	showGenerateHTMLDocDialog(java.awt.Component invoker)
int	showGenerateHTMLDocDialog(java.awt.Component invoker, java.io.File output)
int	showGenerateHTMLDocDialog(java.io.File output)
int	showGeneratePDFDocDialog()
int	showGeneratePDFDocDialog(java.awt.Component invoker)
int	showGeneratePDFDocDialog(java.awt.Component invoker, java.io.File output)
int	showGeneratePDFDocDialog(java.io.File output)
int	showGenerateWordDocDialog()
int	showGenerateWordDocDialog(java.awt.Component invoker)
int	showGenerateWordDocDialog(java.awt.Component invoker, java.io.File output)
int	showGenerateWordDocDialog(java.awt.Component invoker, java.io.File output, java.lang.String templateName)
int	showGenerateWordDocDialog(java.awt.Component invoker, java.lang.String templateName)
int	showGenerateWordDocDialog(java.io.File output)
int	showGenerateWordDocDialog(java.io.File output, java.lang.String templateName)
int	showGenerateWordDocDialog(java.lang.String templateName)
int	showProjectPublisherDialog()
int	showProjectPublisherDialog(java.awt.Component invoker)
int	showProjectPublisherDialog(java.awt.Component invoker, java.io.File output)
int	showProjectPublisherDialog(java.io.File output)
void	updateRDHtmlTemplateStyles(IReportDiagramUIModel aReportDiagram) Synchronize RDStyleRepository's styles into all existing IRDHTMLTemplates, to ensure those HTML can be applied with current styles.
void	updateRDTableOfContentsTemplates(IReportDiagramUIModel aReportDiagram)

Method Detail

showGenerateHTMLDocDialog

int showGenerateHTMLDocDialog(java.awt.Component invoker,
                              java.io.File output)

showGenerateHTMLDocDialog

int showGenerateHTMLDocDialog(java.awt.Component invoker)

showGenerateHTMLDocDialog

int showGenerateHTMLDocDialog(java.io.File output)

showGenerateHTMLDocDialog

int showGenerateHTMLDocDialog()

generateHTMLDoc

void generateHTMLDoc(java.awt.Component invoker,
                     java.io.File output)

generateHTMLDoc

void generateHTMLDoc(java.io.File output)

showGeneratePDFDocDialog

int showGeneratePDFDocDialog(java.awt.Component invoker,
                             java.io.File output)

showGeneratePDFDocDialog

int showGeneratePDFDocDialog(java.awt.Component invoker)

showGeneratePDFDocDialog

int showGeneratePDFDocDialog(java.io.File output)

showGeneratePDFDocDialog

int showGeneratePDFDocDialog()

generatePDFDoc

void generatePDFDoc(java.awt.Component invoker,
                    java.io.File output)

generatePDFDoc

void generatePDFDoc(java.io.File output)

showGenerateWordDocDialog

int showGenerateWordDocDialog(java.awt.Component invoker,
                              java.io.File output,
                              java.lang.String templateName)

showGenerateWordDocDialog

int showGenerateWordDocDialog(java.awt.Component invoker,
                              java.lang.String templateName)

showGenerateWordDocDialog

int showGenerateWordDocDialog(java.io.File output,
                              java.lang.String templateName)

showGenerateWordDocDialog

int showGenerateWordDocDialog(java.awt.Component invoker,
                              java.io.File output)

showGenerateWordDocDialog

int showGenerateWordDocDialog(java.awt.Component invoker)

showGenerateWordDocDialog

int showGenerateWordDocDialog(java.io.File output)

showGenerateWordDocDialog

int showGenerateWordDocDialog(java.lang.String templateName)

showGenerateWordDocDialog

int showGenerateWordDocDialog()

generateWordDoc

void generateWordDoc(java.awt.Component invoker,
                     java.io.File output,
                     java.lang.String templateName)

generateWordDoc

void generateWordDoc(java.awt.Component invoker,
                     java.io.File output)

generateWordDoc

void generateWordDoc(java.io.File output,
                     java.lang.String templateName)

generateWordDoc

void generateWordDoc(java.io.File output)

importDocTemplate

void importDocTemplate(java.lang.String templateFilePath)

showProjectPublisherDialog

int showProjectPublisherDialog(java.awt.Component invoker)

showProjectPublisherDialog

int showProjectPublisherDialog()

showProjectPublisherDialog

int showProjectPublisherDialog(java.awt.Component invoker,
                               java.io.File output)

showProjectPublisherDialog

int showProjectPublisherDialog(java.io.File output)

publishProject

void publishProject(java.awt.Component invoker,
                    java.io.File output)

publishProject

void publishProject(java.io.File output)

createUseCaseDescriptionReader

IUseCaseDescriptionReader createUseCaseDescriptionReader(IProject project,
                                                         IUseCaseDescriptionItemContainer useCaseDescription)

generateDocComposerWord

void generateDocComposerWord(IReportDiagramUIModel aReportDiagram,
                             java.io.File aOutputFile,
                             javax.swing.JComponent aInvoker)

initDefaultRDTableOfContentsTemplate

void initDefaultRDTableOfContentsTemplate(IRDTableOfContentsTemplate aTableOfContentsTemplate)

initDefaultRDStyleRepository

void initDefaultRDStyleRepository(IRDStyleRepository aStyleRepository)

initDefaultRDNumberingSetting

void initDefaultRDNumberingSetting(IRDNumberingSetting aNumberingSetting)

updateRDTableOfContentsTemplates

void updateRDTableOfContentsTemplates(IReportDiagramUIModel aReportDiagram)

updateRDHtmlTemplateStyles

void updateRDHtmlTemplateStyles(IReportDiagramUIModel aReportDiagram)

Synchronize RDStyleRepository's styles into all existing IRDHTMLTemplates, to ensure those HTML can be applied with current styles. If the IRDStyleRepository is not yet created in this IReportDiagramUIModel, the default IRDStyleRepository will be created.