123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519 |
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
- <!-- NewPage -->
- <html lang="en">
- <head>
- <!-- Generated by javadoc (1.8.0_05) on Thu Jul 31 14:50:27 CEST 2014 -->
- <title>CompassFormat (JFreeChart Class Library (version 1.0.19-fx))</title>
- <meta name="date" content="2014-07-31">
- <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="CompassFormat (JFreeChart Class Library (version 1.0.19-fx))";
- }
- }
- catch(err) {
- }
- //-->
- var methods = {"i0":10,"i1":10,"i2":10,"i3":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/CompassFormat.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-files/index-1.html">Index</a></li>
- <li><a href="../../../../help-doc.html">Help</a></li>
- </ul>
- </div>
- <div class="subNav">
- <ul class="navList">
- <li><a href="../../../../org/jfree/chart/axis/ColorBar.html" title="class in org.jfree.chart.axis"><span class="typeNameLink">Prev Class</span></a></li>
- <li><a href="../../../../org/jfree/chart/axis/CyclicNumberAxis.html" title="class in org.jfree.chart.axis"><span class="typeNameLink">Next Class</span></a></li>
- </ul>
- <ul class="navList">
- <li><a href="../../../../index.html?org/jfree/chart/axis/CompassFormat.html" target="_top">Frames</a></li>
- <li><a href="CompassFormat.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><a href="#nested.classes.inherited.from.class.java.text.NumberFormat">Nested</a> | </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">org.jfree.chart.axis</div>
- <h2 title="Class CompassFormat" class="title">Class CompassFormat</h2>
- </div>
- <div class="contentContainer">
- <ul class="inheritance">
- <li>java.lang.Object</li>
- <li>
- <ul class="inheritance">
- <li>java.text.Format</li>
- <li>
- <ul class="inheritance">
- <li>java.text.NumberFormat</li>
- <li>
- <ul class="inheritance">
- <li>org.jfree.chart.axis.CompassFormat</li>
- </ul>
- </li>
- </ul>
- </li>
- </ul>
- </li>
- </ul>
- <div class="description">
- <ul class="blockList">
- <li class="blockList">
- <dl>
- <dt>All Implemented Interfaces:</dt>
- <dd>java.io.Serializable, java.lang.Cloneable</dd>
- </dl>
- <hr>
- <br>
- <pre>public class <a href="../../../../src-html/org/jfree/chart/axis/CompassFormat.html#line.53">CompassFormat</a>
- extends java.text.NumberFormat</pre>
- <div class="block">A formatter that displays numbers as directions.</div>
- <dl>
- <dt><span class="seeLabel">See Also:</span></dt>
- <dd><a href="../../../../serialized-form.html#org.jfree.chart.axis.CompassFormat">Serialized Form</a></dd>
- </dl>
- </li>
- </ul>
- </div>
- <div class="summary">
- <ul class="blockList">
- <li class="blockList">
- <!-- ======== NESTED CLASS SUMMARY ======== -->
- <ul class="blockList">
- <li class="blockList"><a name="nested.class.summary">
- <!-- -->
- </a>
- <h3>Nested Class Summary</h3>
- <ul class="blockList">
- <li class="blockList"><a name="nested.classes.inherited.from.class.java.text.NumberFormat">
- <!-- -->
- </a>
- <h3>Nested classes/interfaces inherited from class java.text.NumberFormat</h3>
- <code>java.text.NumberFormat.Field</code></li>
- </ul>
- </li>
- </ul>
- <!-- =========== 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>java.lang.String[]</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/CompassFormat.html#directions">directions</a></span></code>
- <div class="block">The directions.</div>
- </td>
- </tr>
- </table>
- <ul class="blockList">
- <li class="blockList"><a name="fields.inherited.from.class.java.text.NumberFormat">
- <!-- -->
- </a>
- <h3>Fields inherited from class java.text.NumberFormat</h3>
- <code>FRACTION_FIELD, INTEGER_FIELD</code></li>
- </ul>
- </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="../../../../org/jfree/chart/axis/CompassFormat.html#CompassFormat--">CompassFormat</a></span>()</code>
- <div class="block">Creates a new formatter using English identifiers.</div>
- </td>
- </tr>
- <tr class="rowColor">
- <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/CompassFormat.html#CompassFormat-java.lang.String:A-">CompassFormat</a></span>(java.lang.String[] directions)</code>
- <div class="block">Creates a new formatter using the specified identifiers.</div>
- </td>
- </tr>
- <tr class="altColor">
- <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/CompassFormat.html#CompassFormat-java.lang.String-java.lang.String-java.lang.String-java.lang.String-">CompassFormat</a></span>(java.lang.String n,
- java.lang.String e,
- java.lang.String s,
- java.lang.String w)</code>
- <div class="block">Creates a new formatter using the specified identifiers for
- the base wind directions.</div>
- </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>java.lang.StringBuffer</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/CompassFormat.html#format-double-java.lang.StringBuffer-java.text.FieldPosition-">format</a></span>(double number,
- java.lang.StringBuffer toAppendTo,
- java.text.FieldPosition pos)</code>
- <div class="block">Formats a number into the specified string buffer.</div>
- </td>
- </tr>
- <tr id="i1" class="rowColor">
- <td class="colFirst"><code>java.lang.StringBuffer</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/CompassFormat.html#format-long-java.lang.StringBuffer-java.text.FieldPosition-">format</a></span>(long number,
- java.lang.StringBuffer toAppendTo,
- java.text.FieldPosition pos)</code>
- <div class="block">Formats a number into the specified string buffer.</div>
- </td>
- </tr>
- <tr id="i2" class="altColor">
- <td class="colFirst"><code>java.lang.String</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/CompassFormat.html#getDirectionCode-double-">getDirectionCode</a></span>(double direction)</code>
- <div class="block">Returns a string representing the direction.</div>
- </td>
- </tr>
- <tr id="i3" class="rowColor">
- <td class="colFirst"><code>java.lang.Number</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/axis/CompassFormat.html#parse-java.lang.String-java.text.ParsePosition-">parse</a></span>(java.lang.String source,
- java.text.ParsePosition parsePosition)</code>
- <div class="block">This method returns <code>null</code> for all inputs.</div>
- </td>
- </tr>
- </table>
- <ul class="blockList">
- <li class="blockList"><a name="methods.inherited.from.class.java.text.NumberFormat">
- <!-- -->
- </a>
- <h3>Methods inherited from class java.text.NumberFormat</h3>
- <code>clone, equals, format, format, format, getAvailableLocales, getCurrency, getCurrencyInstance, getCurrencyInstance, getInstance, getInstance, getIntegerInstance, getIntegerInstance, getMaximumFractionDigits, getMaximumIntegerDigits, getMinimumFractionDigits, getMinimumIntegerDigits, getNumberInstance, getNumberInstance, getPercentInstance, getPercentInstance, getRoundingMode, hashCode, isGroupingUsed, isParseIntegerOnly, parse, parseObject, setCurrency, setGroupingUsed, setMaximumFractionDigits, setMaximumIntegerDigits, setMinimumFractionDigits, setMinimumIntegerDigits, setParseIntegerOnly, setRoundingMode</code></li>
- </ul>
- <ul class="blockList">
- <li class="blockList"><a name="methods.inherited.from.class.java.text.Format">
- <!-- -->
- </a>
- <h3>Methods inherited from class java.text.Format</h3>
- <code>format, formatToCharacterIterator, parseObject</code></li>
- </ul>
- <ul class="blockList">
- <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
- <!-- -->
- </a>
- <h3>Methods inherited from class java.lang.Object</h3>
- <code>finalize, getClass, notify, notifyAll, toString, wait, wait, wait</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="directions">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>directions</h4>
- <pre>public final java.lang.String[] <a href="../../../../src-html/org/jfree/chart/axis/CompassFormat.html#line.56">directions</a></pre>
- <div class="block">The directions.</div>
- </li>
- </ul>
- </li>
- </ul>
- <!-- ========= CONSTRUCTOR DETAIL ======== -->
- <ul class="blockList">
- <li class="blockList"><a name="constructor.detail">
- <!-- -->
- </a>
- <h3>Constructor Detail</h3>
- <a name="CompassFormat--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>CompassFormat</h4>
- <pre>public <a href="../../../../src-html/org/jfree/chart/axis/CompassFormat.html#line.61">CompassFormat</a>()</pre>
- <div class="block">Creates a new formatter using English identifiers.</div>
- </li>
- </ul>
- <a name="CompassFormat-java.lang.String-java.lang.String-java.lang.String-java.lang.String-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>CompassFormat</h4>
- <pre>public <a href="../../../../src-html/org/jfree/chart/axis/CompassFormat.html#line.76">CompassFormat</a>(java.lang.String n,
- java.lang.String e,
- java.lang.String s,
- java.lang.String w)</pre>
- <div class="block">Creates a new formatter using the specified identifiers for
- the base wind directions.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>n</code> - the code for NORTH.</dd>
- <dd><code>e</code> - the code for EAST.</dd>
- <dd><code>s</code> - the code for SOUTH.</dd>
- <dd><code>w</code> - the code for WEST.</dd>
- <dt><span class="simpleTagLabel">Since:</span></dt>
- <dd>1.0.18</dd>
- </dl>
- </li>
- </ul>
- <a name="CompassFormat-java.lang.String:A-">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>CompassFormat</h4>
- <pre>public <a href="../../../../src-html/org/jfree/chart/axis/CompassFormat.html#line.91">CompassFormat</a>(java.lang.String[] directions)</pre>
- <div class="block">Creates a new formatter using the specified identifiers.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>directions</code> - an array containing 16 strings representing
- the directions of a compass.</dd>
- <dt><span class="simpleTagLabel">Since:</span></dt>
- <dd>1.0.18</dd>
- </dl>
- </li>
- </ul>
- </li>
- </ul>
- <!-- ============ METHOD DETAIL ========== -->
- <ul class="blockList">
- <li class="blockList"><a name="method.detail">
- <!-- -->
- </a>
- <h3>Method Detail</h3>
- <a name="getDirectionCode-double-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getDirectionCode</h4>
- <pre>public java.lang.String <a href="../../../../src-html/org/jfree/chart/axis/CompassFormat.html#line.108">getDirectionCode</a>(double direction)</pre>
- <div class="block">Returns a string representing the direction.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>direction</code> - the direction.</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>A string.</dd>
- </dl>
- </li>
- </ul>
- <a name="format-double-java.lang.StringBuffer-java.text.FieldPosition-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>format</h4>
- <pre>public java.lang.StringBuffer <a href="../../../../src-html/org/jfree/chart/axis/CompassFormat.html#line.127">format</a>(double number,
- java.lang.StringBuffer toAppendTo,
- java.text.FieldPosition pos)</pre>
- <div class="block">Formats a number into the specified string buffer.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code>format</code> in class <code>java.text.NumberFormat</code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>number</code> - the number to format.</dd>
- <dd><code>toAppendTo</code> - the string buffer.</dd>
- <dd><code>pos</code> - the field position (ignored here).</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The string buffer.</dd>
- </dl>
- </li>
- </ul>
- <a name="format-long-java.lang.StringBuffer-java.text.FieldPosition-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>format</h4>
- <pre>public java.lang.StringBuffer <a href="../../../../src-html/org/jfree/chart/axis/CompassFormat.html#line.142">format</a>(long number,
- java.lang.StringBuffer toAppendTo,
- java.text.FieldPosition pos)</pre>
- <div class="block">Formats a number into the specified string buffer.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code>format</code> in class <code>java.text.NumberFormat</code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>number</code> - the number to format.</dd>
- <dd><code>toAppendTo</code> - the string buffer.</dd>
- <dd><code>pos</code> - the field position (ignored here).</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>The string buffer.</dd>
- </dl>
- </li>
- </ul>
- <a name="parse-java.lang.String-java.text.ParsePosition-">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>parse</h4>
- <pre>public java.lang.Number <a href="../../../../src-html/org/jfree/chart/axis/CompassFormat.html#line.157">parse</a>(java.lang.String source,
- java.text.ParsePosition parsePosition)</pre>
- <div class="block">This method returns <code>null</code> for all inputs. This class cannot
- be used for parsing.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code>parse</code> in class <code>java.text.NumberFormat</code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>source</code> - the source string.</dd>
- <dd><code>parsePosition</code> - the parse position.</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd><code>null</code>.</dd>
- </dl>
- </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/CompassFormat.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-files/index-1.html">Index</a></li>
- <li><a href="../../../../help-doc.html">Help</a></li>
- </ul>
- </div>
- <div class="subNav">
- <ul class="navList">
- <li><a href="../../../../org/jfree/chart/axis/ColorBar.html" title="class in org.jfree.chart.axis"><span class="typeNameLink">Prev Class</span></a></li>
- <li><a href="../../../../org/jfree/chart/axis/CyclicNumberAxis.html" title="class in org.jfree.chart.axis"><span class="typeNameLink">Next Class</span></a></li>
- </ul>
- <ul class="navList">
- <li><a href="../../../../index.html?org/jfree/chart/axis/CompassFormat.html" target="_top">Frames</a></li>
- <li><a href="CompassFormat.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><a href="#nested.classes.inherited.from.class.java.text.NumberFormat">Nested</a> | </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 ======= -->
- </body>
- </html>
|