Package com.altova.automation.XMLSpy

Class JSONSchemaDocumentationDlg

java.lang.Object

com.altova.automation.libs.COMIUnknownObject

com.altova.automation.libs.COMIDispatchObject

com.altova.automation.XMLSpy.JSONSchemaDocumentationDlg

public class JSONSchemaDocumentationDlg
extends COMIDispatchObject

Field Summary

Fields inherited from class com.altova.automation.libs.COMIDispatchObject

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF

Method Summary

Modifier and Type	Method	Description
void	allDetails(boolean i_bDetailsOn)	method AllDetails
COMIDispatchObject	getApplication()	property Application
boolean	getCreateDiagramsFolder()	Returnssets a value indicating whether to create a separate folder for diagrams or not.
Enums.SPYImageKind	getDiagramFormat()	Returnssets the image kind that is generated.
boolean	getEmbedCSSInHTML()	Returnssets a value indicating whether to embed the CSS in the HTML or not.
boolean	getEmbedDiagrams()	Returnssets a value indicating whether to embed the diagrams in the document or not.
boolean	getGenerateRelativeLinks()	Returnssets a value indicating whether links to local files are relative (true) or absolute (false).
boolean	getIncludeArrayItems()	property IncludeArrayItems
boolean	getIncludeDefinitions()	property IncludeDefinitions
boolean	getIncludeExternalSchemas()	property IncludeExternalSchemas
boolean	getIncludeOperatorSubschemas()	property IncludeOperatorSubschemas
boolean	getIncludeOverview()	property IncludeOverview
boolean	getIncludePatternProperties()	property IncludePatternProperties
boolean	getIncludeProperties()	property IncludeProperties
boolean	getIncludePropertyWildcards()	property IncludePropertyWildcards
boolean	getIncludeSchemaDependencies()	property IncludeSchemaDependencies
GUID	getInterfaceIID()
boolean	getMultipleOutputFiles()	Returnssets a value indicating whether the output document is split to multiple files.
Enums.SPYDialogAction	getOptionsDialogAction()	property OptionsDialogAction
java.lang.String	getOutputFile()	property OutputFile
Enums.SPYDialogAction	getOutputFileDialogAction()	property OutputFileDialogAction
Enums.SPYSchemaDocumentationFormat	getOutputFormat()	property OutputFormat
COMIDispatchObject	getParent()	property Parent
boolean	getShowArrayItems()	property ShowArrayItems
boolean	getShowDiagram()	property ShowDiagram
boolean	getShowEnumerations()	property ShowEnumerations
boolean	getShowLocation()	property ShowLocation
boolean	getShowOperators()	property ShowOperators
boolean	getShowProgressBar()	property ShowProgressBar
boolean	getShowProperties()	property ShowProperties
boolean	getShowPropertyDetails()	property ShowPropertyDetails
boolean	getShowResult()	property ShowResult
boolean	getShowSchemaDetails()	property ShowSchemaDetails
boolean	getShowSourceCode()	property ShowSourceCode
boolean	getShowSpecifying()	property ShowSpecifying
boolean	getShowType()	property ShowType
boolean	getShowTypeConstraints()	property ShowTypeConstraints
boolean	getShowUsedBy()	property ShowUsedBy
java.lang.String	getSPSFile()	Returnssets a value indicating the location of the SPS file.
boolean	getUseFixedDesign()	Returnssets a value indicating whether the documentation should be created with fixed design or with a design specified by a SPS.
void	includeAll(boolean i_bInclude)	method IncludeAll
void	setCreateDiagramsFolder(boolean newValue)	Returnssets a value indicating whether to create a separate folder for diagrams or not.
void	setDiagramFormat(Enums.SPYImageKind newValue)	Returnssets the image kind that is generated.
void	setEmbedCSSInHTML(boolean newValue)	Returnssets a value indicating whether to embed the CSS in the HTML or not.
void	setEmbedDiagrams(boolean newValue)	Returnssets a value indicating whether to embed the diagrams in the document or not.
void	setGenerateRelativeLinks(boolean newValue)	Returnssets a value indicating whether links to local files are relative (true) or absolute (false).
void	setIncludeArrayItems(boolean newValue)	property IncludeArrayItems
void	setIncludeDefinitions(boolean newValue)	property IncludeDefinitions
void	setIncludeExternalSchemas(boolean newValue)	property IncludeExternalSchemas
void	setIncludeOperatorSubschemas(boolean newValue)	property IncludeOperatorSubschemas
void	setIncludeOverview(boolean newValue)	property IncludeOverview
void	setIncludePatternProperties(boolean newValue)	property IncludePatternProperties
void	setIncludeProperties(boolean newValue)	property IncludeProperties
void	setIncludePropertyWildcards(boolean newValue)	property IncludePropertyWildcards
void	setIncludeSchemaDependencies(boolean newValue)	property IncludeSchemaDependencies
void	setMultipleOutputFiles(boolean newValue)	Returnssets a value indicating whether the output document is split to multiple files.
void	setOptionsDialogAction(Enums.SPYDialogAction newValue)	property OptionsDialogAction
void	setOutputFile(java.lang.String newValue)	property OutputFile
void	setOutputFileDialogAction(Enums.SPYDialogAction newValue)	property OutputFileDialogAction
void	setOutputFormat(Enums.SPYSchemaDocumentationFormat newValue)	property OutputFormat
void	setShowArrayItems(boolean newValue)	property ShowArrayItems
void	setShowDiagram(boolean newValue)	property ShowDiagram
void	setShowEnumerations(boolean newValue)	property ShowEnumerations
void	setShowLocation(boolean newValue)	property ShowLocation
void	setShowOperators(boolean newValue)	property ShowOperators
void	setShowProgressBar(boolean newValue)	property ShowProgressBar
void	setShowProperties(boolean newValue)	property ShowProperties
void	setShowPropertyDetails(boolean newValue)	property ShowPropertyDetails
void	setShowResult(boolean newValue)	property ShowResult
void	setShowSchemaDetails(boolean newValue)	property ShowSchemaDetails
void	setShowSourceCode(boolean newValue)	property ShowSourceCode
void	setShowSpecifying(boolean newValue)	property ShowSpecifying
void	setShowType(boolean newValue)	property ShowType
void	setShowTypeConstraints(boolean newValue)	property ShowTypeConstraints
void	setShowUsedBy(boolean newValue)	property ShowUsedBy
void	setSPSFile(java.lang.String newValue)	Returnssets a value indicating the location of the SPS file.
void	setUseFixedDesign(boolean newValue)	Returnssets a value indicating whether the documentation should be created with fixed design or with a design specified by a SPS.

Methods inherited from class com.altova.automation.libs.COMIDispatchObject

addListener, getProperty, getProperty, invoke, removeListener, setProperty, setProperty

Methods inherited from class com.altova.automation.libs.COMIUnknownObject

dispose, equals, getCOMInterfacePointer, isNull

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getInterfaceIID

public GUID getInterfaceIID()

getApplication

public COMIDispatchObject getApplication() throws AutomationException

property Application

Throws:

AutomationException

getParent

public COMIDispatchObject getParent() throws AutomationException

property Parent

Throws:

AutomationException

getOptionsDialogAction

public Enums.SPYDialogAction getOptionsDialogAction() throws AutomationException

property OptionsDialogAction

Throws:

AutomationException

setOptionsDialogAction

public void setOptionsDialogAction(Enums.SPYDialogAction newValue) throws AutomationException

property OptionsDialogAction

Throws:

AutomationException

getOutputFileDialogAction

public Enums.SPYDialogAction getOutputFileDialogAction() throws AutomationException

property OutputFileDialogAction

Throws:

AutomationException

setOutputFileDialogAction

public void setOutputFileDialogAction(Enums.SPYDialogAction newValue) throws AutomationException

property OutputFileDialogAction

Throws:

AutomationException

getOutputFile

public java.lang.String getOutputFile() throws AutomationException

property OutputFile

Throws:

AutomationException

setOutputFile

public void setOutputFile(java.lang.String newValue) throws AutomationException

property OutputFile

Throws:

AutomationException

getShowProgressBar

public boolean getShowProgressBar() throws AutomationException

property ShowProgressBar

Throws:

AutomationException

setShowProgressBar

public void setShowProgressBar(boolean newValue) throws AutomationException

property ShowProgressBar

Throws:

AutomationException

getUseFixedDesign

public boolean getUseFixedDesign() throws AutomationException

Returnssets a value indicating whether the documentation should be created with fixed design or with a design specified by a SPS.

Throws:

AutomationException

setUseFixedDesign

public void setUseFixedDesign(boolean newValue) throws AutomationException

Returnssets a value indicating whether the documentation should be created with fixed design or with a design specified by a SPS.

Throws:

AutomationException

getSPSFile

public java.lang.String getSPSFile() throws AutomationException

Returnssets a value indicating the location of the SPS file.

Throws:

AutomationException

setSPSFile

public void setSPSFile(java.lang.String newValue) throws AutomationException

Returnssets a value indicating the location of the SPS file.

Throws:

AutomationException

getOutputFormat

public Enums.SPYSchemaDocumentationFormat getOutputFormat() throws AutomationException

property OutputFormat

Throws:

AutomationException

setOutputFormat

public void setOutputFormat(Enums.SPYSchemaDocumentationFormat newValue) throws AutomationException

property OutputFormat

Throws:

AutomationException

getDiagramFormat

public Enums.SPYImageKind getDiagramFormat() throws AutomationException

Returnssets the image kind that is generated.

Throws:

AutomationException

setDiagramFormat

public void setDiagramFormat(Enums.SPYImageKind newValue) throws AutomationException

Returnssets the image kind that is generated.

Throws:

AutomationException

getEmbedDiagrams

public boolean getEmbedDiagrams() throws AutomationException

Returnssets a value indicating whether to embed the diagrams in the document or not.

Throws:

AutomationException

setEmbedDiagrams

public void setEmbedDiagrams(boolean newValue) throws AutomationException

Returnssets a value indicating whether to embed the diagrams in the document or not.

Throws:

AutomationException

getCreateDiagramsFolder

public boolean getCreateDiagramsFolder() throws AutomationException

Returnssets a value indicating whether to create a separate folder for diagrams or not.

Throws:

AutomationException

setCreateDiagramsFolder

public void setCreateDiagramsFolder(boolean newValue) throws AutomationException

Returnssets a value indicating whether to create a separate folder for diagrams or not.

Throws:

AutomationException

getMultipleOutputFiles

public boolean getMultipleOutputFiles() throws AutomationException

Returnssets a value indicating whether the output document is split to multiple files.

Throws:

AutomationException

setMultipleOutputFiles

public void setMultipleOutputFiles(boolean newValue) throws AutomationException

Returnssets a value indicating whether the output document is split to multiple files.

Throws:

AutomationException

getEmbedCSSInHTML

public boolean getEmbedCSSInHTML() throws AutomationException

Returnssets a value indicating whether to embed the CSS in the HTML or not.

Throws:

AutomationException

setEmbedCSSInHTML

public void setEmbedCSSInHTML(boolean newValue) throws AutomationException

Returnssets a value indicating whether to embed the CSS in the HTML or not.

Throws:

AutomationException

getShowResult

public boolean getShowResult() throws AutomationException

property ShowResult

Throws:

AutomationException

setShowResult

public void setShowResult(boolean newValue) throws AutomationException

property ShowResult

Throws:

AutomationException

getGenerateRelativeLinks

public boolean getGenerateRelativeLinks() throws AutomationException

Returnssets a value indicating whether links to local files are relative (true) or absolute (false).

Throws:

AutomationException

setGenerateRelativeLinks

public void setGenerateRelativeLinks(boolean newValue) throws AutomationException

Returnssets a value indicating whether links to local files are relative (true) or absolute (false).

Throws:

AutomationException

includeAll

public void includeAll(boolean i_bInclude) throws AutomationException

method IncludeAll

Throws:

AutomationException

allDetails

public void allDetails(boolean i_bDetailsOn) throws AutomationException

method AllDetails

Throws:

AutomationException

getIncludeOverview

public boolean getIncludeOverview() throws AutomationException

property IncludeOverview

Throws:

AutomationException

setIncludeOverview

public void setIncludeOverview(boolean newValue) throws AutomationException

property IncludeOverview

Throws:

AutomationException

getIncludeDefinitions

public boolean getIncludeDefinitions() throws AutomationException

property IncludeDefinitions

Throws:

AutomationException

setIncludeDefinitions

public void setIncludeDefinitions(boolean newValue) throws AutomationException

property IncludeDefinitions

Throws:

AutomationException

getIncludeProperties

public boolean getIncludeProperties() throws AutomationException

property IncludeProperties

Throws:

AutomationException

setIncludeProperties

public void setIncludeProperties(boolean newValue) throws AutomationException

property IncludeProperties

Throws:

AutomationException

getIncludePatternProperties

public boolean getIncludePatternProperties() throws AutomationException

property IncludePatternProperties

Throws:

AutomationException

setIncludePatternProperties

public void setIncludePatternProperties(boolean newValue) throws AutomationException

property IncludePatternProperties

Throws:

AutomationException

getIncludePropertyWildcards

public boolean getIncludePropertyWildcards() throws AutomationException

property IncludePropertyWildcards

Throws:

AutomationException

setIncludePropertyWildcards

public void setIncludePropertyWildcards(boolean newValue) throws AutomationException

property IncludePropertyWildcards

Throws:

AutomationException

getIncludeArrayItems

public boolean getIncludeArrayItems() throws AutomationException

property IncludeArrayItems

Throws:

AutomationException

setIncludeArrayItems

public void setIncludeArrayItems(boolean newValue) throws AutomationException

property IncludeArrayItems

Throws:

AutomationException

getIncludeOperatorSubschemas

public boolean getIncludeOperatorSubschemas() throws AutomationException

property IncludeOperatorSubschemas

Throws:

AutomationException

setIncludeOperatorSubschemas

public void setIncludeOperatorSubschemas(boolean newValue) throws AutomationException

property IncludeOperatorSubschemas

Throws:

AutomationException

getIncludeSchemaDependencies

public boolean getIncludeSchemaDependencies() throws AutomationException

property IncludeSchemaDependencies

Throws:

AutomationException

setIncludeSchemaDependencies

public void setIncludeSchemaDependencies(boolean newValue) throws AutomationException

property IncludeSchemaDependencies

Throws:

AutomationException

getIncludeExternalSchemas

public boolean getIncludeExternalSchemas() throws AutomationException

property IncludeExternalSchemas

Throws:

AutomationException

setIncludeExternalSchemas

public void setIncludeExternalSchemas(boolean newValue) throws AutomationException

property IncludeExternalSchemas

Throws:

AutomationException

getShowDiagram

public boolean getShowDiagram() throws AutomationException

property ShowDiagram

Throws:

AutomationException

setShowDiagram

public void setShowDiagram(boolean newValue) throws AutomationException

property ShowDiagram

Throws:

AutomationException

getShowLocation

public boolean getShowLocation() throws AutomationException

property ShowLocation

Throws:

AutomationException

setShowLocation

public void setShowLocation(boolean newValue) throws AutomationException

property ShowLocation

Throws:

AutomationException

getShowSpecifying

public boolean getShowSpecifying() throws AutomationException

property ShowSpecifying

Throws:

AutomationException

setShowSpecifying

public void setShowSpecifying(boolean newValue) throws AutomationException

property ShowSpecifying

Throws:

AutomationException

getShowPropertyDetails

public boolean getShowPropertyDetails() throws AutomationException

property ShowPropertyDetails

Throws:

AutomationException

setShowPropertyDetails

public void setShowPropertyDetails(boolean newValue) throws AutomationException

property ShowPropertyDetails

Throws:

AutomationException

getShowSchemaDetails

public boolean getShowSchemaDetails() throws AutomationException

property ShowSchemaDetails

Throws:

AutomationException

setShowSchemaDetails

public void setShowSchemaDetails(boolean newValue) throws AutomationException

property ShowSchemaDetails

Throws:

AutomationException

getShowType

public boolean getShowType() throws AutomationException

property ShowType

Throws:

AutomationException

setShowType

public void setShowType(boolean newValue) throws AutomationException

property ShowType

Throws:

AutomationException

getShowTypeConstraints

public boolean getShowTypeConstraints() throws AutomationException

property ShowTypeConstraints

Throws:

AutomationException

setShowTypeConstraints

public void setShowTypeConstraints(boolean newValue) throws AutomationException

property ShowTypeConstraints

Throws:

AutomationException

getShowEnumerations

public boolean getShowEnumerations() throws AutomationException

property ShowEnumerations

Throws:

AutomationException

setShowEnumerations

public void setShowEnumerations(boolean newValue) throws AutomationException

property ShowEnumerations

Throws:

AutomationException

getShowProperties

public boolean getShowProperties() throws AutomationException

property ShowProperties

Throws:

AutomationException

setShowProperties

public void setShowProperties(boolean newValue) throws AutomationException

property ShowProperties

Throws:

AutomationException

getShowArrayItems

public boolean getShowArrayItems() throws AutomationException

property ShowArrayItems

Throws:

AutomationException

setShowArrayItems

public void setShowArrayItems(boolean newValue) throws AutomationException

property ShowArrayItems

Throws:

AutomationException

getShowOperators

public boolean getShowOperators() throws AutomationException

property ShowOperators

Throws:

AutomationException

setShowOperators

public void setShowOperators(boolean newValue) throws AutomationException

property ShowOperators

Throws:

AutomationException

getShowSourceCode

public boolean getShowSourceCode() throws AutomationException

property ShowSourceCode

Throws:

AutomationException

setShowSourceCode

public void setShowSourceCode(boolean newValue) throws AutomationException

property ShowSourceCode

Throws:

AutomationException

getShowUsedBy

public boolean getShowUsedBy() throws AutomationException

property ShowUsedBy

Throws:

AutomationException

setShowUsedBy

public void setShowUsedBy(boolean newValue) throws AutomationException

property ShowUsedBy

Throws:

AutomationException