| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="it"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_171) on Thu Jun 14 10:06:14 CEST 2018 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>HTMLTokenRenderer (OpenJPA Parent POM 3.0.0 API)</title> |
| <meta name="date" content="2018-06-14"> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="HTMLTokenRenderer (OpenJPA Parent POM 3.0.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/HTMLTokenRenderer.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../index-all.html">Index</a></li> |
| <li><a href="../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Class</li> |
| <li><a href="../../../openbook/tools/converter/Java2HTMLConverter.html" title="class in openbook.tools.converter"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?openbook/tools/converter/HTMLTokenRenderer.html" target="_top">Frames</a></li> |
| <li><a href="HTMLTokenRenderer.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">openbook.tools.converter</div> |
| <h2 title="Class HTMLTokenRenderer" class="title">Class HTMLTokenRenderer</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>openbook.tools.converter.HTMLTokenRenderer</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../openbook/tools/converter/TokenRenderer.html" title="interface in openbook.tools.converter">TokenRenderer</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">HTMLTokenRenderer</span> |
| extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> |
| implements <a href="../../../openbook/tools/converter/TokenRenderer.html" title="interface in openbook.tools.converter">TokenRenderer</a></pre> |
| <div class="block">Renders Java source tokens as HTML tags. |
| This renderer renders the parsed Java tokens with HTML styles. |
| The styles of the tokens are determined by their types such as Java keywords, identifiers, |
| comments etc. Moreover, an identifier can be a <em>custom</em> type if it matched a given |
| list of identifiers. The actual HTML text is enclosed in <span id="style">token<\span> |
| to apply the style. The styles are defined in a Cascaded Style Sheet (CSS). |
| The cascaded style sheet by default is named <code>java.css</code>. |
| <br> |
| The rendering takes care of line breaks and white space in the following way to work |
| around some limitations of Swing based HTML editor kit's usage of CSS attributes. |
| <LI> Line Breaks: Swing Editor seems to require an explicit carriage return-line feed |
| character to render in separate line. While a normal browser works with <br> |
| tag alone. |
| <LI> White space: The CSS property <code>white-space</code> is sufficient for browsers |
| to preserve white space within <span> tags. But Swing Editor seems to require |
| explicit <code>nbsp;</code> for white spaces within <span> tags. |
| <br> |
| Two boolean properties are provided to control these two properties. |
| <br> |
| <LI>Line Numbering: A boolean property controls whether line numbers will be printed. |
| Line numbers are printed in 4 digits with leading zeros, by default. |
| <LI>Line Number Anchoring: An anchor can be specified at every line. The anchor |
| is <code>line.nnn</code> where <code>nnn</code> is the actual line number without |
| any leading zero. |
| <LI> JavaDoc comment : The JavaDoc comments can use characters that if reproduced |
| exactly in HTML output can confuse the rendering process. On the other hand, the |
| JavaDoc tags that define an anchor in the source code or creates a hyperlink should |
| be preserved in the HTML output. The capacity and limitation of processing HTML tages |
| inside JavaDoc comments are described in <a href="../../../openbook/tools/util/TextProcessingUtility.html" title="class in openbook.tools.util">here</a>.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd>Pinaki Poddar</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../openbook/tools/converter/HTMLTokenRenderer.html#CSS_ANNOTATION">CSS_ANNOTATION</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../openbook/tools/converter/HTMLTokenRenderer.html#CSS_COMMENT">CSS_COMMENT</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../openbook/tools/converter/HTMLTokenRenderer.html#CSS_CUSTOM">CSS_CUSTOM</a></span></code> |
| <div class="block">The CSS named styles.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../openbook/tools/converter/HTMLTokenRenderer.html#CSS_DECIMAL">CSS_DECIMAL</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../openbook/tools/converter/HTMLTokenRenderer.html#CSS_ENUM">CSS_ENUM</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../openbook/tools/converter/HTMLTokenRenderer.html#CSS_KEYWORD">CSS_KEYWORD</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../openbook/tools/converter/HTMLTokenRenderer.html#CSS_LINE_NO">CSS_LINE_NO</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../openbook/tools/converter/HTMLTokenRenderer.html#CSS_LITERAL">CSS_LITERAL</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../openbook/tools/converter/HTMLTokenRenderer.html#HTML_BR_TAG">HTML_BR_TAG</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../openbook/tools/converter/HTMLTokenRenderer.html#HTML_SPACE">HTML_SPACE</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../openbook/tools/converter/HTMLTokenRenderer.html#NEW_LINE">NEW_LINE</a></span></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../openbook/tools/converter/HTMLTokenRenderer.html#HTMLTokenRenderer--">HTMLTokenRenderer</a></span>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../openbook/tools/converter/HTMLTokenRenderer.html#endLine-int-">endLine</a></span>(int line)</code> |
| <div class="block">Gets a end-of-line string: a HTML <br> tag followed by carriage return and line feed.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../openbook/tools/converter/HTMLTokenRenderer.html#getAddExplicitSpace--">getAddExplicitSpace</a></span>()</code> |
| <div class="block">Affirms if explicit <code> </code> will be added at the HTML output.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../openbook/tools/converter/HTMLTokenRenderer.html#getAddLineBreak--">getAddLineBreak</a></span>()</code> |
| <div class="block">Affirms if explicit line break (carriage return and line feed) will be added |
| at the HTML output.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../openbook/tools/converter/HTMLTokenRenderer.html#getAnchorLineNumber--">getAnchorLineNumber</a></span>()</code> |
| <div class="block">Affirms if an anchor will be created on every line.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../openbook/tools/converter/HTMLTokenRenderer.html#getEpilogue--">getEpilogue</a></span>()</code> |
| <div class="block">Gets the closing <BODY> and <HTML> tags</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../openbook/tools/converter/HTMLTokenRenderer.html#getLineNumberFormat--">getLineNumberFormat</a></span>()</code> |
| <div class="block">Gets the format string to format line number such as <code>"%%0%4d"</code> |
| for a 4-digit number with leading zeros.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../openbook/tools/converter/HTMLTokenRenderer.html#getPrologue--">getPrologue</a></span>()</code> |
| <div class="block">Gets the opening <BODY> and <HTML> tags and the <link type="stylesheet"> clause.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../openbook/tools/converter/HTMLTokenRenderer.html#getShowLineNumber--">getShowLineNumber</a></span>()</code> |
| <div class="block">Affirms if a line number will be added in HTML output.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../openbook/tools/converter/HTMLTokenRenderer.html#getStylesheet--">getStylesheet</a></span>()</code> |
| <div class="block">Gets the stylesheet to be linked at HTML output.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../openbook/tools/converter/HTMLTokenRenderer.html#newLine-int-">newLine</a></span>(int line)</code> |
| <div class="block">Gets a string for beginning of a new line.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../openbook/tools/converter/HTMLTokenRenderer.html#render-int-org.antlr.runtime.Token-">render</a></span>(int decision, |
| org.antlr.runtime.Token token)</code> |
| <div class="block">Produce a string representation of the given token.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../openbook/tools/converter/HTMLTokenRenderer.html#setAddExplicitSpace-boolean-">setAddExplicitSpace</a></span>(boolean addSpace)</code> |
| <div class="block">Sets if explicit <code> </code> will be added at the HTML output.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../openbook/tools/converter/HTMLTokenRenderer.html#setAddLineBreak-boolean-">setAddLineBreak</a></span>(boolean addLineBreak)</code> |
| <div class="block">Sets if explicit line break (carriage return and line feed) will be added |
| at the HTML output.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../openbook/tools/converter/HTMLTokenRenderer.html#setAnchorLineNumber-boolean-">setAnchorLineNumber</a></span>(boolean anchorLineNumber)</code> |
| <div class="block">Sets if an anchor will be created on every line.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../openbook/tools/converter/HTMLTokenRenderer.html#setLineNumberFormat-java.lang.String-">setLineNumberFormat</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> lineNumberFormat)</code> |
| <div class="block">Sets the format string to format line number such as <code>"%%0%4d"</code> |
| for a 4-digit number with leading zeros.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../openbook/tools/converter/HTMLTokenRenderer.html#setShowLineNumber-boolean-">setShowLineNumber</a></span>(boolean showLineNumber)</code> |
| <div class="block">Sets if a line number will be added in HTML output.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../openbook/tools/converter/HTMLTokenRenderer.html#setStylesheet-java.lang.String-">setStylesheet</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> stylesheet)</code> |
| <div class="block">Sets the stylesheet to be linked at the HTML output.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="CSS_CUSTOM"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CSS_CUSTOM</h4> |
| <pre>public static final <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> CSS_CUSTOM</pre> |
| <div class="block">The CSS named styles.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../constant-values.html#openbook.tools.converter.HTMLTokenRenderer.CSS_CUSTOM">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="CSS_KEYWORD"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CSS_KEYWORD</h4> |
| <pre>public static final <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> CSS_KEYWORD</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../constant-values.html#openbook.tools.converter.HTMLTokenRenderer.CSS_KEYWORD">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="CSS_ANNOTATION"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CSS_ANNOTATION</h4> |
| <pre>public static final <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> CSS_ANNOTATION</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../constant-values.html#openbook.tools.converter.HTMLTokenRenderer.CSS_ANNOTATION">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="CSS_ENUM"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CSS_ENUM</h4> |
| <pre>public static final <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> CSS_ENUM</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../constant-values.html#openbook.tools.converter.HTMLTokenRenderer.CSS_ENUM">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="CSS_COMMENT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CSS_COMMENT</h4> |
| <pre>public static final <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> CSS_COMMENT</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../constant-values.html#openbook.tools.converter.HTMLTokenRenderer.CSS_COMMENT">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="CSS_LITERAL"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CSS_LITERAL</h4> |
| <pre>public static final <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> CSS_LITERAL</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../constant-values.html#openbook.tools.converter.HTMLTokenRenderer.CSS_LITERAL">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="CSS_DECIMAL"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CSS_DECIMAL</h4> |
| <pre>public static final <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> CSS_DECIMAL</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../constant-values.html#openbook.tools.converter.HTMLTokenRenderer.CSS_DECIMAL">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="CSS_LINE_NO"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CSS_LINE_NO</h4> |
| <pre>public static final <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> CSS_LINE_NO</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../constant-values.html#openbook.tools.converter.HTMLTokenRenderer.CSS_LINE_NO">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="NEW_LINE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>NEW_LINE</h4> |
| <pre>public static final <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> NEW_LINE</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../constant-values.html#openbook.tools.converter.HTMLTokenRenderer.NEW_LINE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="HTML_BR_TAG"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HTML_BR_TAG</h4> |
| <pre>public static final <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> HTML_BR_TAG</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../constant-values.html#openbook.tools.converter.HTMLTokenRenderer.HTML_BR_TAG">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="HTML_SPACE"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>HTML_SPACE</h4> |
| <pre>public static final <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> HTML_SPACE</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../constant-values.html#openbook.tools.converter.HTMLTokenRenderer.HTML_SPACE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="HTMLTokenRenderer--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>HTMLTokenRenderer</h4> |
| <pre>public HTMLTokenRenderer()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="endLine-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>endLine</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> endLine(int line)</pre> |
| <div class="block">Gets a end-of-line string: a HTML <br> tag followed by carriage return and line feed.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../openbook/tools/converter/TokenRenderer.html#endLine-int-">endLine</a></code> in interface <code><a href="../../../openbook/tools/converter/TokenRenderer.html" title="interface in openbook.tools.converter">TokenRenderer</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>line</code> - the line being ended</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a String can be a blank</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="newLine-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newLine</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> newLine(int line)</pre> |
| <div class="block">Gets a string for beginning of a new line.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../openbook/tools/converter/TokenRenderer.html#newLine-int-">newLine</a></code> in interface <code><a href="../../../openbook/tools/converter/TokenRenderer.html" title="interface in openbook.tools.converter">TokenRenderer</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>line</code> - the current line number</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a String can be a blank</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="render-int-org.antlr.runtime.Token-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>render</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> render(int decision, |
| org.antlr.runtime.Token token)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../openbook/tools/converter/TokenRenderer.html#render-int-org.antlr.runtime.Token-">TokenRenderer</a></code></span></div> |
| <div class="block">Produce a string representation of the given token.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../openbook/tools/converter/TokenRenderer.html#render-int-org.antlr.runtime.Token-">render</a></code> in interface <code><a href="../../../openbook/tools/converter/TokenRenderer.html" title="interface in openbook.tools.converter">TokenRenderer</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>decision</code> - the index of the decision (or the context) in which |
| the current token is being processed. The index refers to ANTLR |
| <code>DebugEventListener.enterDecision(int)</code>.</dd> |
| <dd><code>token</code> - the token to be rendered. Can be a hidden token as well.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a string representation of the given token.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPrologue--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPrologue</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getPrologue()</pre> |
| <div class="block">Gets the opening <BODY> and <HTML> tags and the <link type="stylesheet"> clause.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../openbook/tools/converter/TokenRenderer.html#getPrologue--">getPrologue</a></code> in interface <code><a href="../../../openbook/tools/converter/TokenRenderer.html" title="interface in openbook.tools.converter">TokenRenderer</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEpilogue--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEpilogue</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getEpilogue()</pre> |
| <div class="block">Gets the closing <BODY> and <HTML> tags</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../openbook/tools/converter/TokenRenderer.html#getEpilogue--">getEpilogue</a></code> in interface <code><a href="../../../openbook/tools/converter/TokenRenderer.html" title="interface in openbook.tools.converter">TokenRenderer</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getStylesheet--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStylesheet</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getStylesheet()</pre> |
| <div class="block">Gets the stylesheet to be linked at HTML output.</div> |
| </li> |
| </ul> |
| <a name="setStylesheet-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setStylesheet</h4> |
| <pre>public void setStylesheet(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> stylesheet)</pre> |
| <div class="block">Sets the stylesheet to be linked at the HTML output.</div> |
| </li> |
| </ul> |
| <a name="getShowLineNumber--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getShowLineNumber</h4> |
| <pre>public boolean getShowLineNumber()</pre> |
| <div class="block">Affirms if a line number will be added in HTML output.</div> |
| </li> |
| </ul> |
| <a name="setShowLineNumber-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setShowLineNumber</h4> |
| <pre>public void setShowLineNumber(boolean showLineNumber)</pre> |
| <div class="block">Sets if a line number will be added in HTML output.</div> |
| </li> |
| </ul> |
| <a name="getAnchorLineNumber--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAnchorLineNumber</h4> |
| <pre>public boolean getAnchorLineNumber()</pre> |
| <div class="block">Affirms if an anchor will be created on every line.</div> |
| </li> |
| </ul> |
| <a name="setAnchorLineNumber-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAnchorLineNumber</h4> |
| <pre>public void setAnchorLineNumber(boolean anchorLineNumber)</pre> |
| <div class="block">Sets if an anchor will be created on every line.</div> |
| </li> |
| </ul> |
| <a name="getAddLineBreak--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAddLineBreak</h4> |
| <pre>public boolean getAddLineBreak()</pre> |
| <div class="block">Affirms if explicit line break (carriage return and line feed) will be added |
| at the HTML output.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../openbook/tools/converter/HTMLTokenRenderer.html#endLine-int-"><code>endLine(int)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setAddLineBreak-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAddLineBreak</h4> |
| <pre>public void setAddLineBreak(boolean addLineBreak)</pre> |
| <div class="block">Sets if explicit line break (carriage return and line feed) will be added |
| at the HTML output.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../openbook/tools/converter/HTMLTokenRenderer.html#endLine-int-"><code>endLine(int)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAddExplicitSpace--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAddExplicitSpace</h4> |
| <pre>public boolean getAddExplicitSpace()</pre> |
| <div class="block">Affirms if explicit <code> </code> will be added at the HTML output.</div> |
| </li> |
| </ul> |
| <a name="setAddExplicitSpace-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAddExplicitSpace</h4> |
| <pre>public void setAddExplicitSpace(boolean addSpace)</pre> |
| <div class="block">Sets if explicit <code> </code> will be added at the HTML output.</div> |
| </li> |
| </ul> |
| <a name="getLineNumberFormat--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLineNumberFormat</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getLineNumberFormat()</pre> |
| <div class="block">Gets the format string to format line number such as <code>"%%0%4d"</code> |
| for a 4-digit number with leading zeros.</div> |
| </li> |
| </ul> |
| <a name="setLineNumberFormat-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setLineNumberFormat</h4> |
| <pre>public void setLineNumberFormat(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> lineNumberFormat)</pre> |
| <div class="block">Sets the format string to format line number such as <code>"%%0%4d"</code> |
| for a 4-digit number with leading zeros.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/HTMLTokenRenderer.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../index-all.html">Index</a></li> |
| <li><a href="../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Class</li> |
| <li><a href="../../../openbook/tools/converter/Java2HTMLConverter.html" title="class in openbook.tools.converter"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?openbook/tools/converter/HTMLTokenRenderer.html" target="_top">Frames</a></li> |
| <li><a href="HTMLTokenRenderer.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2006–2018 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |