public class ContextView extends java.lang.Object implements OptionProvider
As such, can be viewed as a simplified version of a View using a single ContextMatcher, but provides some extra configuration such as context highlighting and output path configuration (and it is specified in code rather than in javadoc comments).
Modifier and Type | Field and Description |
---|---|
private com.sun.javadoc.ClassDoc |
cd |
private Options |
centerOptions |
private Options |
globalOptions |
private static java.lang.String[] |
HIDE_OPTIONS |
private Options |
hideOptions |
private ContextMatcher |
matcher |
private Options |
myGlobalOptions |
private Options |
packageOptions |
Constructor and Description |
---|
ContextView(java.lang.String outputFolder,
com.sun.javadoc.ClassDoc cd,
com.sun.javadoc.RootDoc root,
Options parent) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getDisplayName()
Returns user displayable name for this option provider.
|
Options |
getGlobalOptions()
Returns the global options (the class independent definition)
|
Options |
getOptionsFor(com.sun.javadoc.ClassDoc cd)
Returns the options for the specified class.
|
Options |
getOptionsFor(java.lang.String name)
Returns the options for the specified class.
|
void |
overrideForClass(Options opt,
com.sun.javadoc.ClassDoc cd)
Gets a base Options and applies the overrides for the specified class
|
void |
overrideForClass(Options opt,
java.lang.String className)
Gets a base Options and applies the overrides for the specified class
|
void |
setContextCenter(com.sun.javadoc.ClassDoc contextCenter) |
private com.sun.javadoc.ClassDoc cd
private ContextMatcher matcher
private Options globalOptions
private Options myGlobalOptions
private Options hideOptions
private Options centerOptions
private Options packageOptions
private static final java.lang.String[] HIDE_OPTIONS
public ContextView(java.lang.String outputFolder, com.sun.javadoc.ClassDoc cd, com.sun.javadoc.RootDoc root, Options parent) throws java.io.IOException
java.io.IOException
public void setContextCenter(com.sun.javadoc.ClassDoc contextCenter)
public java.lang.String getDisplayName()
OptionProvider
Will be used to provide progress feedback on the console
getDisplayName
in interface OptionProvider
public Options getGlobalOptions()
OptionProvider
getGlobalOptions
in interface OptionProvider
public Options getOptionsFor(com.sun.javadoc.ClassDoc cd)
OptionProvider
getOptionsFor
in interface OptionProvider
public Options getOptionsFor(java.lang.String name)
OptionProvider
getOptionsFor
in interface OptionProvider
public void overrideForClass(Options opt, com.sun.javadoc.ClassDoc cd)
OptionProvider
overrideForClass
in interface OptionProvider
public void overrideForClass(Options opt, java.lang.String className)
OptionProvider
overrideForClass
in interface OptionProvider