PageRenderTime 26ms CodeModel.GetById 18ms RepoModel.GetById 0ms app.codeStats 0ms

/graphLib/jfreechart-1.0.13/javadocs/src-html/org/jfree/chart/labels/PieSectionLabelGenerator.html

https://github.com/BryanLeow/SIMS
HTML | 175 lines | 115 code | 60 blank | 0 comment | 0 complexity | 1f09d080dc5530bcdc3bbe1854e288d9 MD5 | raw file
    

  1. <HTML>
    2. 

  2. <BODY BGCOLOR="white">
    3. 

  3. <PRE>
    4. 

  4. <FONT color="green">001</FONT>    /* ===========================================================<a name="line.1"></a>
    5. 

  5. <FONT color="green">002</FONT>     * JFreeChart : a free chart library for the Java(tm) platform<a name="line.2"></a>
    6. 

  6. <FONT color="green">003</FONT>     * ===========================================================<a name="line.3"></a>
    7. 

  7. <FONT color="green">004</FONT>     *<a name="line.4"></a>
    8. 

  8. <FONT color="green">005</FONT>     * (C) Copyright 2000-2008, by Object Refinery Limited and Contributors.<a name="line.5"></a>
    9. 

  9. <FONT color="green">006</FONT>     *<a name="line.6"></a>
    10. 

  10. <FONT color="green">007</FONT>     * Project Info:  http://www.jfree.org/jfreechart/index.html<a name="line.7"></a>
    11. 

  11. <FONT color="green">008</FONT>     *<a name="line.8"></a>
    12. 

  12. <FONT color="green">009</FONT>     * This library is free software; you can redistribute it and/or modify it<a name="line.9"></a>
    13. 

  13. <FONT color="green">010</FONT>     * under the terms of the GNU Lesser General Public License as published by<a name="line.10"></a>
    14. 

  14. <FONT color="green">011</FONT>     * the Free Software Foundation; either version 2.1 of the License, or<a name="line.11"></a>
    15. 

  15. <FONT color="green">012</FONT>     * (at your option) any later version.<a name="line.12"></a>
    16. 

  16. <FONT color="green">013</FONT>     *<a name="line.13"></a>
    17. 

  17. <FONT color="green">014</FONT>     * This library is distributed in the hope that it will be useful, but<a name="line.14"></a>
    18. 

  18. <FONT color="green">015</FONT>     * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY<a name="line.15"></a>
    19. 

  19. <FONT color="green">016</FONT>     * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public<a name="line.16"></a>
    20. 

  20. <FONT color="green">017</FONT>     * License for more details.<a name="line.17"></a>
    21. 

  21. <FONT color="green">018</FONT>     *<a name="line.18"></a>
    22. 

  22. <FONT color="green">019</FONT>     * You should have received a copy of the GNU Lesser General Public<a name="line.19"></a>
    23. 

  23. <FONT color="green">020</FONT>     * License along with this library; if not, write to the Free Software<a name="line.20"></a>
    24. 

  24. <FONT color="green">021</FONT>     * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,<a name="line.21"></a>
    25. 

  25. <FONT color="green">022</FONT>     * USA.<a name="line.22"></a>
    26. 

  26. <FONT color="green">023</FONT>     *<a name="line.23"></a>
    27. 

  27. <FONT color="green">024</FONT>     * [Java is a trademark or registered trademark of Sun Microsystems, Inc.<a name="line.24"></a>
    28. 

  28. <FONT color="green">025</FONT>     * in the United States and other countries.]<a name="line.25"></a>
    29. 

  29. <FONT color="green">026</FONT>     *<a name="line.26"></a>
    30. 

  30. <FONT color="green">027</FONT>     * -----------------------------<a name="line.27"></a>
    31. 

  31. <FONT color="green">028</FONT>     * PieSectionLabelGenerator.java<a name="line.28"></a>
    32. 

  32. <FONT color="green">029</FONT>     * -----------------------------<a name="line.29"></a>
    33. 

  33. <FONT color="green">030</FONT>     * (C) Copyright 2001-2008, by Object Refinery Limited.<a name="line.30"></a>
    34. 

  34. <FONT color="green">031</FONT>     *<a name="line.31"></a>
    35. 

  35. <FONT color="green">032</FONT>     * Original Author:  David Gilbert (for Object Refinery Limited);<a name="line.32"></a>
    36. 

  36. <FONT color="green">033</FONT>     * Contributor(s):   -;<a name="line.33"></a>
    37. 

  37. <FONT color="green">034</FONT>     *<a name="line.34"></a>
    38. 

  38. <FONT color="green">035</FONT>     * Changes<a name="line.35"></a>
    39. 

  39. <FONT color="green">036</FONT>     * -------<a name="line.36"></a>
    40. 

  40. <FONT color="green">037</FONT>     * 13-Dec-2001 : Version 1 (DG);<a name="line.37"></a>
    41. 

  41. <FONT color="green">038</FONT>     * 16-Jan-2002 : Completed Javadocs (DG);<a name="line.38"></a>
    42. 

  42. <FONT color="green">039</FONT>     * 26-Sep-2002 : Fixed errors reported by Checkstyle (DG);<a name="line.39"></a>
    43. 

  43. <FONT color="green">040</FONT>     * 30-Oct-2002 : Category is now a Comparable instance (DG);<a name="line.40"></a>
    44. 

  44. <FONT color="green">041</FONT>     * 07-Mar-2003 : Changed to KeyedValuesDataset and added pieIndex<a name="line.41"></a>
    45. 

  45. <FONT color="green">042</FONT>     *               parameter (DG);<a name="line.42"></a>
    46. 

  46. <FONT color="green">043</FONT>     * 21-Mar-2003 : Updated Javadocs (DG);<a name="line.43"></a>
    47. 

  47. <FONT color="green">044</FONT>     * 24-Apr-2003 : Switched around PieDataset and KeyedValuesDataset (DG);<a name="line.44"></a>
    48. 

  48. <FONT color="green">045</FONT>     * 13-Aug-2003 : Added clone() method (DG);<a name="line.45"></a>
    49. 

  49. <FONT color="green">046</FONT>     * 19-Aug-2003 : Renamed PieToolTipGenerator --&gt; PieItemLabelGenerator (DG);<a name="line.46"></a>
    50. 

  50. <FONT color="green">047</FONT>     * 11-Nov-2003 : Removed clone() method (DG);<a name="line.47"></a>
    51. 

  51. <FONT color="green">048</FONT>     * 30-Jan-2004 : Added generateSectionLabel() method (DG);<a name="line.48"></a>
    52. 

  52. <FONT color="green">049</FONT>     * 15-Apr-2004 : Moved generateToolTip() method into separate interface and<a name="line.49"></a>
    53. 

  53. <FONT color="green">050</FONT>     *               renamed this interface PieSectionLabelGenerator (DG);<a name="line.50"></a>
    54. 

  54. <FONT color="green">051</FONT>     *<a name="line.51"></a>
    55. 

  55. <FONT color="green">052</FONT>     */<a name="line.52"></a>
    56. 

  56. <FONT color="green">053</FONT>    <a name="line.53"></a>
    57. 

  57. <FONT color="green">054</FONT>    package org.jfree.chart.labels;<a name="line.54"></a>
    58. 

  58. <FONT color="green">055</FONT>    <a name="line.55"></a>
    59. 

  59. <FONT color="green">056</FONT>    import java.awt.Font;<a name="line.56"></a>
    60. 

  60. <FONT color="green">057</FONT>    import java.awt.Paint;<a name="line.57"></a>
    61. 

  61. <FONT color="green">058</FONT>    import java.awt.font.TextAttribute;<a name="line.58"></a>
    62. 

  62. <FONT color="green">059</FONT>    import java.text.AttributedString;<a name="line.59"></a>
    63. 

  63. <FONT color="green">060</FONT>    <a name="line.60"></a>
    64. 

  64. <FONT color="green">061</FONT>    import org.jfree.data.general.PieDataset;<a name="line.61"></a>
    65. 

  65. <FONT color="green">062</FONT>    <a name="line.62"></a>
    66. 

  66. <FONT color="green">063</FONT>    /**<a name="line.63"></a>
    67. 

  67. <FONT color="green">064</FONT>     * Interface for a label generator for plots that use data from<a name="line.64"></a>
    68. 

  68. <FONT color="green">065</FONT>     * a {@link PieDataset}.<a name="line.65"></a>
    69. 

  69. <FONT color="green">066</FONT>     */<a name="line.66"></a>
    70. 

  70. <FONT color="green">067</FONT>    public interface PieSectionLabelGenerator {<a name="line.67"></a>
    71. 

  71. <FONT color="green">068</FONT>    <a name="line.68"></a>
    72. 

  72. <FONT color="green">069</FONT>        /**<a name="line.69"></a>
    73. 

  73. <FONT color="green">070</FONT>         * Generates a label for a pie section.<a name="line.70"></a>
    74. 

  74. <FONT color="green">071</FONT>         *<a name="line.71"></a>
    75. 

  75. <FONT color="green">072</FONT>         * @param dataset  the dataset (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.72"></a>
    76. 

  76. <FONT color="green">073</FONT>         * @param key  the section key (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.73"></a>
    77. 

  77. <FONT color="green">074</FONT>         *<a name="line.74"></a>
    78. 

  78. <FONT color="green">075</FONT>         * @return The label (possibly &lt;code&gt;null&lt;/code&gt;).<a name="line.75"></a>
    79. 

  79. <FONT color="green">076</FONT>         */<a name="line.76"></a>
    80. 

  80. <FONT color="green">077</FONT>        public String generateSectionLabel(PieDataset dataset, Comparable key);<a name="line.77"></a>
    81. 

  81. <FONT color="green">078</FONT>    <a name="line.78"></a>
    82. 

  82. <FONT color="green">079</FONT>        /**<a name="line.79"></a>
    83. 

  83. <FONT color="green">080</FONT>         * Generates an attributed label for the specified series, or<a name="line.80"></a>
    84. 

  84. <FONT color="green">081</FONT>         * &lt;code&gt;null&lt;/code&gt; if no attributed label is available (in which case,<a name="line.81"></a>
    85. 

  85. <FONT color="green">082</FONT>         * the string returned by<a name="line.82"></a>
    86. 

  86. <FONT color="green">083</FONT>         * {@link #generateSectionLabel(PieDataset, Comparable)} will<a name="line.83"></a>
    87. 

  87. <FONT color="green">084</FONT>         * provide the fallback).  Only certain attributes are recognised by the<a name="line.84"></a>
    88. 

  88. <FONT color="green">085</FONT>         * code that ultimately displays the labels:<a name="line.85"></a>
    89. 

  89. <FONT color="green">086</FONT>         * &lt;ul&gt;<a name="line.86"></a>
    90. 

  90. <FONT color="green">087</FONT>         * &lt;li&gt;{@link TextAttribute#FONT}: will set the font;&lt;/li&gt;<a name="line.87"></a>
    91. 

  91. <FONT color="green">088</FONT>         * &lt;li&gt;{@link TextAttribute#POSTURE}: a value of<a name="line.88"></a>
    92. 

  92. <FONT color="green">089</FONT>         *     {@link TextAttribute#POSTURE_OBLIQUE} will add {@link Font#ITALIC} to<a name="line.89"></a>
    93. 

  93. <FONT color="green">090</FONT>         *     the current font;&lt;/li&gt;<a name="line.90"></a>
    94. 

  94. <FONT color="green">091</FONT>         * &lt;li&gt;{@link TextAttribute#WEIGHT}: a value of<a name="line.91"></a>
    95. 

  95. <FONT color="green">092</FONT>         *     {@link TextAttribute#WEIGHT_BOLD} will add {@link Font#BOLD} to the<a name="line.92"></a>
    96. 

  96. <FONT color="green">093</FONT>         *     current font;&lt;/li&gt;<a name="line.93"></a>
    97. 

  97. <FONT color="green">094</FONT>         * &lt;li&gt;{@link TextAttribute#FOREGROUND}: this will set the {@link Paint}<a name="line.94"></a>
    98. 

  98. <FONT color="green">095</FONT>         *     for the current&lt;/li&gt;<a name="line.95"></a>
    99. 

  99. <FONT color="green">096</FONT>         * &lt;li&gt;{@link TextAttribute#SUPERSCRIPT}: the values<a name="line.96"></a>
    100. 

  100. <FONT color="green">097</FONT>         *     {@link TextAttribute#SUPERSCRIPT_SUB} and<a name="line.97"></a>
    101. 

  101. <FONT color="green">098</FONT>         *     {@link TextAttribute#SUPERSCRIPT_SUPER} are recognised.&lt;/li&gt;<a name="line.98"></a>
    102. 

  102. <FONT color="green">099</FONT>         * &lt;/ul&gt;<a name="line.99"></a>
    103. 

  103. <FONT color="green">100</FONT>         *<a name="line.100"></a>
    104. 

  104. <FONT color="green">101</FONT>         * @param dataset  the dataset.<a name="line.101"></a>
    105. 

  105. <FONT color="green">102</FONT>         * @param key  the key.<a name="line.102"></a>
    106. 

  106. <FONT color="green">103</FONT>         *<a name="line.103"></a>
    107. 

  107. <FONT color="green">104</FONT>         * @return An attributed label (possibly &lt;code&gt;null&lt;/code&gt;).<a name="line.104"></a>
    108. 

  108. <FONT color="green">105</FONT>         */<a name="line.105"></a>
    109. 

  109. <FONT color="green">106</FONT>        public AttributedString generateAttributedSectionLabel(PieDataset dataset,<a name="line.106"></a>
    110. 

  110. <FONT color="green">107</FONT>                                                               Comparable key);<a name="line.107"></a>
    111. 

  111. <FONT color="green">108</FONT>    <a name="line.108"></a>
    112. 

  112. <FONT color="green">109</FONT>    }<a name="line.109"></a>
    113. 

  113. 

  114. 

  115. 

  116. 

  117. 

  118. 

  119. 

  120. 

  121. 

  122. 

  123. 

  124. 

  125. 

  126. 

  127. 

  128. 

  129. 

  130. 

  131. 

  132. 

  133. 

  134. 

  135. 

  136. 

  137. 

  138. 

  139. 

  140. 

  141. 

  142. 

  143. 

  144. 

  145. 

  146. 

  147. 

  148. 

  149. 

  150. 

  151. 

  152. 

  153. 

  154. 

  155. 

  156. 

  157. 

  158. 

  159. 

  160. 

  161. 

  162. 

  163. 

  164. 

  165. 

  166. 

  167. 

  168. 

  169. 

  170. 

  171. 

  172. 

  173. </PRE>
    174. 

  174. </BODY>
    175. 

  175. </HTML>
    176. 

  176.