|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.io.Writer
java.io.PrintWriter
com.sun.tools.doclets.formats.html.markup.HtmlWriter
public class HtmlWriter
Class for the Html format code generation. Initilizes PrintWriter with FileWriter, to enable print related methods to generate the code to the named File through FileWriter.
Field Summary | |
---|---|
protected Configuration |
configuration
The configuration |
static java.lang.String |
fileseparator
URL file separator string("/"). |
protected java.lang.String |
htmlFilename
Name of the file, to which this writer is writing to. |
protected java.lang.String |
winTitle
The window title of this file |
Fields inherited from class java.io.PrintWriter |
---|
out |
Fields inherited from class java.io.Writer |
---|
lock |
Constructor Summary | |
---|---|
HtmlWriter(Configuration configuration,
java.lang.String path,
java.lang.String filename,
java.lang.String docencoding)
Constructor. |
Method Summary | |
---|---|
void |
address()
Print <ADDRESS> tag. |
void |
addressEnd()
Print </ADDRESS> tag. |
void |
aEnd()
Print </A> tag. |
void |
aName(java.lang.String name)
Print anchor <A NAME="name"> tag. |
void |
anchor(java.lang.String name)
Print anchor <A NAME="name"> and </A>tags. |
void |
anchor(java.lang.String name,
java.lang.String content)
Print contents within anchor <A NAME="name"> tags. |
void |
blockquote()
Print <BLOCKQUOTE> tag. |
void |
blockquoteEnd()
Print </BLOCKQUOTE> tag. |
void |
body(java.lang.String bgcolor,
boolean includeScript)
Print <BODY BGCOLOR="bgcolor">, including JavaScript "onload" call to load windowtitle script. |
void |
bodyEnd()
Print </BODY> tag. |
void |
br()
Print newline and then print <BR> tag. |
void |
center()
Print <CENTER> tag. |
void |
centerEnd()
Print </CENTER> tag. |
void |
code()
Print <CODE> tag. |
void |
codeEnd()
Print </CODE> tag. |
java.lang.String |
codeText(java.lang.String text)
|
void |
commentEnd()
Print "-->" comment end string. |
void |
commentStart()
Print "<!-- " comment start string. |
void |
dd()
Print <DT> tag. |
void |
ddEnd()
Print </DD> tag. |
void |
dl()
Print <DL> tag. |
void |
dlEnd()
Print </DL> tag. |
void |
dt()
Print <DT> tag. |
void |
em()
Print <EM> tag. |
void |
emEnd()
Print </EM> tag. |
void |
font(java.lang.String size)
Print <FONT SIZE="size"> tag. |
void |
fontEnd()
Print </FONT> tag. |
void |
fontNoNewLine(java.lang.String size)
Print <FONT SIZE="size"> tag. |
void |
fontSizeStyle(java.lang.String size,
java.lang.String stylename)
Print <FONT SIZE="size" CLASS="stylename"> tag. |
void |
fontStyle(java.lang.String stylename)
Print <FONT CLASS="stylename"> tag. |
java.lang.String |
getCode()
Get the "<CODE>" string. |
java.lang.String |
getCodeEnd()
Get the "</CODE>" string. |
java.lang.String |
getFontColor(java.lang.String color)
Get the "<FONT COLOR="color">" string. |
java.lang.String |
getFontEnd()
Get the "</FONT>" string. |
java.lang.String |
getStrong()
Get the "<STRONG>" string. |
java.lang.String |
getStrongEnd()
Get the "</STRONG>" string. |
protected java.lang.String |
getWindowTitleOnload()
Return the Javascript call to be embedded in the <BODY> tag. |
void |
h1()
Print <H1> tag. |
void |
h1(java.lang.String text)
Print text with <H1> tag. |
void |
h1End()
Print </H1> tag. |
void |
h2()
Print <H2> tag. |
void |
h2(java.lang.String text)
Print text with <H2> tag. |
void |
h2End()
Print </H2> tag. |
void |
h3()
Print <H3> tag. |
void |
h3(java.lang.String text)
Print text with <H3> tag. |
void |
h3End()
Print </H3> tag. |
void |
h4()
Print <H4> tag. |
void |
h4(java.lang.String text)
Print text with <H4> tag. |
void |
h4End()
Print </H4> tag. |
void |
h5()
Print <H5> tag. |
void |
h5End()
Print </H5> tag. |
void |
head()
Print <HEAD> tag. |
void |
headEnd()
Print </HEAD> tag. |
void |
hr()
Print <HR> tag. |
void |
hr(int size,
int widthPercent)
Print <HR SIZE="size" WIDTH="widthpercent%"> tag. |
void |
hr(int size,
java.lang.String noshade)
Print <HR SIZE="size" NOSHADE> tag. |
void |
html()
Print <HTML> tag. |
void |
htmlEnd()
Print </HTML> tag. |
void |
img(java.lang.String imggif,
java.lang.String imgname,
int width,
int height)
Print HTML <IMG SRC="imggif" WIDTH="width" HEIGHT="height" ALT="imgname> tag. |
void |
italic()
Print <I> tag. |
void |
italicEnd()
Print </I> tag. |
void |
italics(java.lang.String text)
Print text passed, in Italics using <I> and </I> tags. |
java.lang.String |
italicsText(java.lang.String text)
Return, text passed, with Italics <I> and </I> tags, surrounding it. |
void |
li()
Print <LI> tag. |
void |
li(java.lang.String type)
Print <LI TYPE="type"> tag. |
void |
link(java.lang.String str)
Print <LINK str> tag. |
void |
menu()
Print <MENU> tag. |
void |
menuEnd()
Print </MENU> tag. |
void |
noFrames()
Print <NOFRAMES> tag. |
void |
noFramesEnd()
Print </NOFRAMES> tag. |
void |
noScript()
Print the Javascript <NOSCRIPT> start tag. |
void |
noScriptEnd()
Print the Javascript </NOSCRIPT> end tag. |
void |
p()
Print newline and then print <P> tag. |
void |
pEnd()
Print newline and then print </P> tag. |
void |
pre()
Print <PRE> tag. |
void |
preEnd()
Print </PRE> tag. |
void |
preNoNewLine()
Print <PRE> tag without adding new line character at th eend. |
protected void |
printWinTitleScript(java.lang.String winTitle)
Print the script code to be embeded before the </HEAD> tag. |
void |
script()
Print the Javascript <SCRIPT> start tag with its type attribute. |
void |
scriptEnd()
Print the Javascript </SCRIPT> end tag. |
void |
space()
Print " ", non-breaking space. |
void |
strong()
Print <STRONG> tag. |
void |
strong(java.lang.String text)
Print text passed, in strong format using <STRONG> and </STRONG> tags. |
void |
strongEnd()
Print </STRONG> tag. |
void |
sup()
Print <SUP> tag. |
void |
supEnd()
Print </SUP> tag. |
void |
table()
Print the HTML table tag with border size 0 and width 100%. |
void |
table(int border,
int cellpadding,
int cellspacing)
Print HTML <TABLE BORDER="border" CELLPADDING="cellpadding" CELLSPACING="cellspacing"> tag. |
void |
table(int border,
java.lang.String width)
Print HTML <TABLE BORDER="border" WIDTH="width"> |
void |
table(int border,
java.lang.String width,
int cellpadding,
int cellspacing)
Print HTML <TABLE BORDER="border" WIDTH="width" CELLPADDING="cellpadding" CELLSPACING="cellspacing"> tag. |
void |
tableEnd()
Print </TABLE> tag. |
void |
td()
Print <TD> tag. |
void |
tdAlign(java.lang.String align)
Print <TD ALIGN="align"> tag. |
void |
tdAlignRowspan(java.lang.String align,
int rowspan)
Print <TD ALIGN="align" ROWSPAN=rowspan> tag. |
void |
tdAlignVAlign(java.lang.String align,
java.lang.String valign)
Print <TD ALIGN="align" VALIGN="valign"> tag. |
void |
tdAlignVAlignRowspan(java.lang.String align,
java.lang.String valign,
int rowspan)
Print <TD ALIGN="align" VALIGN="valign" ROWSPAN=rowspan> tag. |
void |
tdBgcolorStyle(java.lang.String color,
java.lang.String stylename)
Print <TD BGCOLOR="color" CLASS="stylename"> tag. |
void |
tdColspan(int i)
Print <TD COLSPAN=i> tag. |
void |
tdColspanBgcolorStyle(int i,
java.lang.String color,
java.lang.String stylename)
Print <TD COLSPAN=i BGCOLOR="color" CLASS="stylename"> tag. |
void |
tdEnd()
Print </TD> tag. |
void |
tdNowrap()
Print <TD NOWRAP> tag. |
void |
tdVAlign(java.lang.String valign)
Print <TD VALIGN="valign"> tag. |
void |
tdVAlignClass(java.lang.String align,
java.lang.String stylename)
Print <TD ALIGN="align" CLASS="stylename"> tag. |
void |
tdWidth(java.lang.String width)
Print <TD WIDTH="width"> tag. |
void |
thAlign(java.lang.String align)
Print <TH ALIGN="align"> tag. |
void |
thAlignColspan(java.lang.String align,
int i)
Print <TH align="align" COLSPAN=i> tag. |
void |
thAlignNowrap(java.lang.String align)
Print <TH align="align" NOWRAP> tag. |
void |
thEnd()
Print </TH> tag. |
void |
title()
Print <TITLE> tag. |
void |
title(java.lang.String winTitle)
Print <TITLE> tag. |
void |
titleEnd()
Print </TITLE> tag. |
void |
tr()
Print <TR> tag. |
void |
trAlignVAlign(java.lang.String align,
java.lang.String valign)
Print <TR ALIGN="align" VALIGN="valign"> tag. |
void |
trBgcolor(java.lang.String color)
Print <TR BGCOLOR="color"> tag. |
void |
trBgcolorStyle(java.lang.String color,
java.lang.String stylename)
Print <TR BGCOLOR="color" CLASS="stylename"> tag. |
void |
trEnd()
Print </TR> tag. |
void |
ul()
Print <UL> tag. |
void |
ulEnd()
Print </UL> tag. |
Methods inherited from class java.io.PrintWriter |
---|
append, append, append, checkError, close, flush, format, format, print, print, print, print, print, print, print, print, print, printf, printf, println, println, println, println, println, println, println, println, println, println, setError, write, write, write, write, write |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected final java.lang.String htmlFilename
protected java.lang.String winTitle
public static final java.lang.String fileseparator
protected Configuration configuration
Constructor Detail |
---|
public HtmlWriter(Configuration configuration, java.lang.String path, java.lang.String filename, java.lang.String docencoding) throws java.io.IOException, java.io.UnsupportedEncodingException
path
- The directory path to be created for this file
or null if none to be created.filename
- File Name to which the PrintWriter will
do the Output.docencoding
- Encoding to be used for this file.
java.io.IOException
- Exception raised by the FileWriter is passed on
to next level.
UnSupportedEncodingException
- Exception raised by the
OutputStreamWriter is passed on to next level.
java.io.UnsupportedEncodingException
Method Detail |
---|
public void html()
public void htmlEnd()
protected void printWinTitleScript(java.lang.String winTitle)
public void script()
public void scriptEnd()
public void noScript()
public void noScriptEnd()
protected java.lang.String getWindowTitleOnload()
public void body(java.lang.String bgcolor, boolean includeScript)
bgcolor
- Background color.includeScript
- boolean set true if printing windowtitle scriptpublic void bodyEnd()
public void title()
public void title(java.lang.String winTitle)
winTitle
- The title of this document.public void titleEnd()
public void ul()
public void ulEnd()
public void li()
public void li(java.lang.String type)
type
- Type string.public void h1()
public void h1End()
public void h1(java.lang.String text)
text
- Text to be printed with <H1> format.public void h2()
public void h2(java.lang.String text)
text
- Text to be printed with <H2> format.public void h2End()
public void h3()
public void h3(java.lang.String text)
text
- Text to be printed with <H3> format.public void h3End()
public void h4()
public void h4End()
public void h4(java.lang.String text)
text
- Text to be printed with <H4> format.public void h5()
public void h5End()
public void img(java.lang.String imggif, java.lang.String imgname, int width, int height)
imggif
- Image GIF file.imgname
- Image name.width
- Width of the image.height
- Height of the image.public void menu()
public void menuEnd()
public void pre()
public void preNoNewLine()
public void preEnd()
public void hr()
public void hr(int size, int widthPercent)
size
- Size of the ruler.widthPercent
- Percentage Width of the rulerpublic void hr(int size, java.lang.String noshade)
size
- Size of the ruler.noshade
- noshade string.public java.lang.String getStrong()
public java.lang.String getStrongEnd()
public void strong()
public void strongEnd()
public void strong(java.lang.String text)
text
- String to be printed in between <STRONG> and </STRONG> tags.public void italics(java.lang.String text)
text
- String to be printed in between <I> and </I> tags.public java.lang.String italicsText(java.lang.String text)
text
- String to be printed in between <I> and </I> tags.public java.lang.String codeText(java.lang.String text)
public void space()
public void dl()
public void dlEnd()
public void dt()
public void dd()
public void ddEnd()
public void sup()
public void supEnd()
public void font(java.lang.String size)
size
- String size.public void fontNoNewLine(java.lang.String size)
size
- String size.public void fontStyle(java.lang.String stylename)
stylename
- String stylename.public void fontSizeStyle(java.lang.String size, java.lang.String stylename)
size
- String size.stylename
- String stylename.public void fontEnd()
public java.lang.String getFontColor(java.lang.String color)
color
- String color.
public java.lang.String getFontEnd()
public void center()
public void centerEnd()
public void aName(java.lang.String name)
name
- Name String.public void aEnd()
public void italic()
public void italicEnd()
public void anchor(java.lang.String name, java.lang.String content)
name
- String name.content
- String contents.public void anchor(java.lang.String name)
name
- String name.public void p()
public void pEnd()
public void br()
public void address()
public void addressEnd()
public void head()
public void headEnd()
public void code()
public void codeEnd()
public void em()
public void emEnd()
public void table(int border, java.lang.String width, int cellpadding, int cellspacing)
border
- Border size.width
- Width of the table.cellpadding
- Cellpadding for the table cells.cellspacing
- Cellspacing for the table cells.public void table(int border, int cellpadding, int cellspacing)
border
- Border size.cellpadding
- Cellpadding for the table cells.cellspacing
- Cellspacing for the table cells.public void table(int border, java.lang.String width)
border
- Border size.width
- Width of the table.public void table()
public void tableEnd()
public void tr()
public void trEnd()
public void td()
public void tdNowrap()
public void tdWidth(java.lang.String width)
width
- String width.public void tdEnd()
public void link(java.lang.String str)
str
- String.public void commentStart()
public void commentEnd()
public void trBgcolorStyle(java.lang.String color, java.lang.String stylename)
color
- String color.stylename
- String stylename.public void trBgcolor(java.lang.String color)
color
- String color.public void trAlignVAlign(java.lang.String align, java.lang.String valign)
align
- String align.valign
- String valign.public void thAlign(java.lang.String align)
align
- the align attribute.public void thAlignColspan(java.lang.String align, int i)
align
- the align attribute.i
- integer.public void thAlignNowrap(java.lang.String align)
align
- the align attribute.public void thEnd()
public void tdColspan(int i)
i
- integer.public void tdBgcolorStyle(java.lang.String color, java.lang.String stylename)
color
- String color.stylename
- String stylename.public void tdColspanBgcolorStyle(int i, java.lang.String color, java.lang.String stylename)
i
- integer.color
- String color.stylename
- String stylename.public void tdAlign(java.lang.String align)
align
- String align.public void tdVAlignClass(java.lang.String align, java.lang.String stylename)
align
- String align.stylename
- String stylename.public void tdVAlign(java.lang.String valign)
valign
- String valign.public void tdAlignVAlign(java.lang.String align, java.lang.String valign)
align
- String align.valign
- String valign.public void tdAlignRowspan(java.lang.String align, int rowspan)
align
- String align.rowspan
- integer rowspan.public void tdAlignVAlignRowspan(java.lang.String align, java.lang.String valign, int rowspan)
align
- String align.valign
- String valign.rowspan
- integer rowspan.public void blockquote()
public void blockquoteEnd()
public java.lang.String getCode()
public java.lang.String getCodeEnd()
public void noFrames()
public void noFramesEnd()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |