Class HtmlWriter
java.lang.Object
gw.gosudoc.com.sun.tools.doclets.formats.html.markup.HtmlWriter
- Direct Known Subclasses:
HtmlDocWriter
Deprecated.
Class for the Html format code generation.
Initializes PrintWriter with FileWriter, to enable print
related methods to generate the code to the named File through FileWriter.
This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.
- Since:
- 1.2
-
Field Summary
FieldsModifier and TypeFieldDescriptionfinal Content
Deprecated.final Content
Deprecated.final Content
Deprecated.final Content
Deprecated.protected Configuration
Deprecated.The configurationfinal Content
Deprecated.final Content
Deprecated.final Content
Deprecated.final Content
Deprecated.final Content
Deprecated.final Content
Deprecated.final Content
Deprecated.final Content
Deprecated.final Content
Deprecated.final Content
Deprecated.private final DocFile
Deprecated.final Content
Deprecated.final Content
Deprecated.final Content
Deprecated.protected boolean
Deprecated.The flag to indicate whether a member details list is printed or not.final Content
Deprecated.protected final String
Deprecated.Column header for class docs displaying Modifier and Type header.final Content
Deprecated.final Content
Deprecated.final Content
Deprecated.final Content
Deprecated.final Content
Deprecated.final Content
Deprecated.final Content
Deprecated.final Content
Deprecated.protected final String[]
Deprecated.Header for tables displaying packages and description..final Content
Deprecated.final Content
Deprecated.final Content
Deprecated.final Content
Deprecated.protected Content
Deprecated.final Content
Deprecated.final Content
Deprecated.final Content
Deprecated.final Content
Deprecated.final Content
Deprecated.protected final String
Deprecated.Summary for use tables displaying class and package use.protected String
Deprecated.The window title of this fileprivate Writer
Deprecated. -
Constructor Summary
ConstructorsConstructorDescriptionHtmlWriter
(Configuration configuration, DocPath path) Deprecated.Constructor. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addStyles
(HtmlStyle style, StringBuilder vars) Deprecated.Adds javascript style variables to the document.void
close()
Deprecated.Deprecated.private static String
Deprecated.Returns a String with escaped special JavaScript characters.void
generateMethodTypesScript
(Map<String, Integer> typeMap, Set<MethodTypes> methodTypes) Deprecated.Generated javascript variables for the document.Deprecated.Returns an HtmlTree for the BODY tag.protected Content
Deprecated.Returns a content tree for the SCRIPT tag for the main page(index.html).Deprecated.Deprecated.Get the configuration string as a content, replacing spaces with non-breaking spaces.getResource
(String key) Deprecated.Get the configuration string as a content.getResource
(String key, Object o) Deprecated.Get the configuration string as a content.getResource
(String key, Object o0, Object o1) Deprecated.Get the configuration string as a content.getSpace()
Deprecated.Return " ", non-breaking space.getTitle()
Deprecated.Returns an HtmlTree for the TITLE tag.protected HtmlTree
Deprecated.Returns an HtmlTree for the SCRIPT tag.void
Deprecated.
-
Field Details
-
winTitle
Deprecated.The window title of this file -
configuration
Deprecated.The configuration -
memberDetailsListPrinted
protected boolean memberDetailsListPrintedDeprecated.The flag to indicate whether a member details list is printed or not. -
packageTableHeader
Deprecated.Header for tables displaying packages and description.. -
useTableSummary
Deprecated.Summary for use tables displaying class and package use. -
modifierTypeHeader
Deprecated.Column header for class docs displaying Modifier and Type header. -
overviewLabel
Deprecated. -
defaultPackageLabel
Deprecated. -
packageLabel
Deprecated. -
useLabel
Deprecated. -
prevLabel
Deprecated. -
nextLabel
Deprecated. -
prevclassLabel
Deprecated. -
nextclassLabel
Deprecated. -
summaryLabel
Deprecated. -
detailLabel
Deprecated. -
framesLabel
Deprecated. -
noframesLabel
Deprecated. -
treeLabel
Deprecated. -
classLabel
Deprecated. -
deprecatedLabel
Deprecated. -
deprecatedPhrase
Deprecated. -
allclassesLabel
Deprecated. -
allpackagesLabel
Deprecated. -
indexLabel
Deprecated. -
helpLabel
Deprecated. -
seeLabel
Deprecated. -
descriptionLabel
Deprecated. -
prevpackageLabel
Deprecated. -
nextpackageLabel
Deprecated. -
packagesLabel
Deprecated. -
methodDetailsLabel
Deprecated. -
annotationTypeDetailsLabel
Deprecated. -
fieldDetailsLabel
Deprecated. -
propertyDetailsLabel
Deprecated. -
constructorDetailsLabel
Deprecated. -
enumConstantsDetailsLabel
Deprecated. -
specifiedByLabel
Deprecated. -
overridesLabel
Deprecated. -
descfrmClassLabel
Deprecated. -
descfrmInterfaceLabel
Deprecated. -
file
Deprecated. -
writer
Deprecated. -
script
Deprecated.
-
-
Constructor Details
-
HtmlWriter
public HtmlWriter(Configuration configuration, DocPath path) throws IOException, UnsupportedEncodingException Deprecated.Constructor.- Parameters:
path
- The directory path to be created for this file or null if none to be created.- Throws:
IOException
- Exception raised by the FileWriter is passed on to next level.UnsupportedEncodingException
- Exception raised by the OutputStreamWriter is passed on to next level.
-
-
Method Details
-
write
Deprecated.- Throws:
IOException
-
close
Deprecated.- Throws:
IOException
-
getResource
Deprecated.Get the configuration string as a content.- Parameters:
key
- the key to look for in the configuration file- Returns:
- a content tree for the text
-
getNonBreakResource
Deprecated.Get the configuration string as a content, replacing spaces with non-breaking spaces.- Parameters:
key
- the key to look for in the configuration file- Returns:
- a content tree for the text
-
getResource
Deprecated.Get the configuration string as a content.- Parameters:
key
- the key to look for in the configuration fileo
- string or content argument added to configuration text- Returns:
- a content tree for the text
-
getResource
Deprecated.Get the configuration string as a content.- Parameters:
key
- the key to look for in the configuration fileo1
- string or content argument added to configuration texto2
- string or content argument added to configuration text- Returns:
- a content tree for the text
-
getWinTitleScript
Deprecated.Returns an HtmlTree for the SCRIPT tag.- Returns:
- an HtmlTree for the SCRIPT tag
-
escapeJavaScriptChars
Deprecated.Returns a String with escaped special JavaScript characters.- Parameters:
s
- String that needs to be escaped- Returns:
- a valid escaped JavaScript string
-
getFramesJavaScript
Deprecated.Returns a content tree for the SCRIPT tag for the main page(index.html).- Returns:
- a content for the SCRIPT tag
-
getBody
Deprecated.Returns an HtmlTree for the BODY tag.- Parameters:
includeScript
- set true if printing windowtitle scripttitle
- title for the window- Returns:
- an HtmlTree for the BODY tag
-
generateMethodTypesScript
Deprecated.Generated javascript variables for the document.- Parameters:
typeMap
- map comprising of method and type relationshipmethodTypes
- set comprising of all methods types for this class
-
addStyles
Deprecated.Adds javascript style variables to the document.- Parameters:
style
- style to be added as a javascript variablevars
- variable string to which the style variable will be added
-
getTitle
Deprecated.Returns an HtmlTree for the TITLE tag.- Returns:
- an HtmlTree for the TITLE tag
-
codeText
Deprecated. -
getSpace
Deprecated.Return " ", non-breaking space. -
getModifierTypeHeader
Deprecated.
-