Java Doc for LegendItem.java in  » Chart » jfreechart » org » jfree » chart » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Chart » jfreechart » org.jfree.chart 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.jfree.chart.LegendItem

LegendItem
public class LegendItem implements Serializable(Code)
A temporary storage object for recording the properties of a legend item, without any consideration for layout issues.



Constructor Summary
public  LegendItem(String label, String description, String toolTipText, String urlText, Shape shape, Paint fillPaint)
     Creates a legend item with a filled shape.
public  LegendItem(String label, String description, String toolTipText, String urlText, Shape shape, Paint fillPaint, Stroke outlineStroke, Paint outlinePaint)
     Creates a legend item with a filled and outlined shape.
public  LegendItem(String label, String description, String toolTipText, String urlText, Shape line, Stroke lineStroke, Paint linePaint)
     Creates a legend item using a line.
public  LegendItem(String label, String description, String toolTipText, String urlText, boolean shapeVisible, Shape shape, boolean shapeFilled, Paint fillPaint, boolean shapeOutlineVisible, Paint outlinePaint, Stroke outlineStroke, boolean lineVisible, Shape line, Stroke lineStroke, Paint linePaint)
     Creates a new legend item.
public  LegendItem(AttributedString label, String description, String toolTipText, String urlText, Shape shape, Paint fillPaint)
     Creates a legend item with a filled shape.
public  LegendItem(AttributedString label, String description, String toolTipText, String urlText, Shape shape, Paint fillPaint, Stroke outlineStroke, Paint outlinePaint)
     Creates a legend item with a filled and outlined shape.
public  LegendItem(AttributedString label, String description, String toolTipText, String urlText, Shape line, Stroke lineStroke, Paint linePaint)
     Creates a legend item using a line.
public  LegendItem(AttributedString label, String description, String toolTipText, String urlText, boolean shapeVisible, Shape shape, boolean shapeFilled, Paint fillPaint, boolean shapeOutlineVisible, Paint outlinePaint, Stroke outlineStroke, boolean lineVisible, Shape line, Stroke lineStroke, Paint linePaint)
     Creates a new legend item.

Method Summary
public  booleanequals(Object obj)
     Tests this item for equality with an arbitrary object.
Parameters:
  obj - the object (null permitted).
public  AttributedStringgetAttributedLabel()
     Returns the attributed label.
public  DatasetgetDataset()
     Returns the dataset.
public  intgetDatasetIndex()
     Returns the dataset index for this legend item.
public  StringgetDescription()
     Returns the description for the legend item.
public  PaintgetFillPaint()
     Returns the fill paint.
public  GradientPaintTransformergetFillPaintTransformer()
     Returns the transformer used when the fill paint is an instance of GradientPaint.
public  StringgetLabel()
     Returns the label.
public  ShapegetLine()
     Returns the line.
public  PaintgetLinePaint()
     Returns the paint used for lines.
public  StrokegetLineStroke()
     Returns the line stroke for the series.
public  PaintgetOutlinePaint()
     Returns the outline paint.
public  StrokegetOutlineStroke()
     Returns the outline stroke.
public  intgetSeriesIndex()
     Returns the series index for this legend item.
public  ComparablegetSeriesKey()
     Returns the series key.
public  ShapegetShape()
     Returns the shape used to label the series represented by this legend item.
public  StringgetToolTipText()
     Returns the tool tip text.
public  StringgetURLText()
     Returns the URL text.
public  booleanisLineVisible()
     Returns a flag that indicates whether or not the line is visible.
public  booleanisShapeFilled()
     Returns a flag that controls whether or not the shape is filled.
public  booleanisShapeOutlineVisible()
     Returns the flag that controls whether or not the shape outline is visible.
public  booleanisShapeVisible()
     Returns a flag that indicates whether or not the shape is visible.
public  voidsetDataset(Dataset dataset)
     Sets the dataset.
public  voidsetDatasetIndex(int index)
     Sets the dataset index for this legend item.
public  voidsetFillPaintTransformer(GradientPaintTransformer transformer)
     Sets the transformer used when the fill paint is an instance of GradientPaint.
public  voidsetSeriesIndex(int index)
     Sets the series index for this legend item.
public  voidsetSeriesKey(Comparable key)
     Sets the series key.


Constructor Detail
LegendItem
public LegendItem(String label, String description, String toolTipText, String urlText, Shape shape, Paint fillPaint)(Code)
Creates a legend item with a filled shape. The shape is not outlined, and no line is visible.
Parameters:
  label - the label (null not permitted).
Parameters:
  description - the description (null permitted).
Parameters:
  toolTipText - the tool tip text (null permitted).
Parameters:
  urlText - the URL text (null permitted).
Parameters:
  shape - the shape (null not permitted).
Parameters:
  fillPaint - the paint used to fill the shape (nullnot permitted).



LegendItem
public LegendItem(String label, String description, String toolTipText, String urlText, Shape shape, Paint fillPaint, Stroke outlineStroke, Paint outlinePaint)(Code)
Creates a legend item with a filled and outlined shape.
Parameters:
  label - the label (null not permitted).
Parameters:
  description - the description (null permitted).
Parameters:
  toolTipText - the tool tip text (null permitted).
Parameters:
  urlText - the URL text (null permitted).
Parameters:
  shape - the shape (null not permitted).
Parameters:
  fillPaint - the paint used to fill the shape (nullnot permitted).
Parameters:
  outlineStroke - the outline stroke (null not permitted).
Parameters:
  outlinePaint - the outline paint (null not permitted).



LegendItem
public LegendItem(String label, String description, String toolTipText, String urlText, Shape line, Stroke lineStroke, Paint linePaint)(Code)
Creates a legend item using a line.
Parameters:
  label - the label (null not permitted).
Parameters:
  description - the description (null permitted).
Parameters:
  toolTipText - the tool tip text (null permitted).
Parameters:
  urlText - the URL text (null permitted).
Parameters:
  line - the line (null not permitted).
Parameters:
  lineStroke - the line stroke (null not permitted).
Parameters:
  linePaint - the line paint (null not permitted).



LegendItem
public LegendItem(String label, String description, String toolTipText, String urlText, boolean shapeVisible, Shape shape, boolean shapeFilled, Paint fillPaint, boolean shapeOutlineVisible, Paint outlinePaint, Stroke outlineStroke, boolean lineVisible, Shape line, Stroke lineStroke, Paint linePaint)(Code)
Creates a new legend item.
Parameters:
  label - the label (null not permitted).
Parameters:
  description - the description (not currently used, null permitted).
Parameters:
  toolTipText - the tool tip text (null permitted).
Parameters:
  urlText - the URL text (null permitted).
Parameters:
  shapeVisible - a flag that controls whether or not the shape is displayed.
Parameters:
  shape - the shape (null permitted).
Parameters:
  shapeFilled - a flag that controls whether or not the shape is filled.
Parameters:
  fillPaint - the fill paint (null not permitted).
Parameters:
  shapeOutlineVisible - a flag that controls whether or not the shape is outlined.
Parameters:
  outlinePaint - the outline paint (null not permitted).
Parameters:
  outlineStroke - the outline stroke (null not permitted).
Parameters:
  lineVisible - a flag that controls whether or not the line is visible.
Parameters:
  line - the line.
Parameters:
  lineStroke - the stroke (null not permitted).
Parameters:
  linePaint - the line paint (null not permitted).



LegendItem
public LegendItem(AttributedString label, String description, String toolTipText, String urlText, Shape shape, Paint fillPaint)(Code)
Creates a legend item with a filled shape. The shape is not outlined, and no line is visible.
Parameters:
  label - the label (null not permitted).
Parameters:
  description - the description (null permitted).
Parameters:
  toolTipText - the tool tip text (null permitted).
Parameters:
  urlText - the URL text (null permitted).
Parameters:
  shape - the shape (null not permitted).
Parameters:
  fillPaint - the paint used to fill the shape (nullnot permitted).



LegendItem
public LegendItem(AttributedString label, String description, String toolTipText, String urlText, Shape shape, Paint fillPaint, Stroke outlineStroke, Paint outlinePaint)(Code)
Creates a legend item with a filled and outlined shape.
Parameters:
  label - the label (null not permitted).
Parameters:
  description - the description (null permitted).
Parameters:
  toolTipText - the tool tip text (null permitted).
Parameters:
  urlText - the URL text (null permitted).
Parameters:
  shape - the shape (null not permitted).
Parameters:
  fillPaint - the paint used to fill the shape (nullnot permitted).
Parameters:
  outlineStroke - the outline stroke (null not permitted).
Parameters:
  outlinePaint - the outline paint (null not permitted).



LegendItem
public LegendItem(AttributedString label, String description, String toolTipText, String urlText, Shape line, Stroke lineStroke, Paint linePaint)(Code)
Creates a legend item using a line.
Parameters:
  label - the label (null not permitted).
Parameters:
  description - the description (null permitted).
Parameters:
  toolTipText - the tool tip text (null permitted).
Parameters:
  urlText - the URL text (null permitted).
Parameters:
  line - the line (null not permitted).
Parameters:
  lineStroke - the line stroke (null not permitted).
Parameters:
  linePaint - the line paint (null not permitted).



LegendItem
public LegendItem(AttributedString label, String description, String toolTipText, String urlText, boolean shapeVisible, Shape shape, boolean shapeFilled, Paint fillPaint, boolean shapeOutlineVisible, Paint outlinePaint, Stroke outlineStroke, boolean lineVisible, Shape line, Stroke lineStroke, Paint linePaint)(Code)
Creates a new legend item.
Parameters:
  label - the label (null not permitted).
Parameters:
  description - the description (not currently used, null permitted).
Parameters:
  toolTipText - the tool tip text (null permitted).
Parameters:
  urlText - the URL text (null permitted).
Parameters:
  shapeVisible - a flag that controls whether or not the shape is displayed.
Parameters:
  shape - the shape (null permitted).
Parameters:
  shapeFilled - a flag that controls whether or not the shape is filled.
Parameters:
  fillPaint - the fill paint (null not permitted).
Parameters:
  shapeOutlineVisible - a flag that controls whether or not the shape is outlined.
Parameters:
  outlinePaint - the outline paint (null not permitted).
Parameters:
  outlineStroke - the outline stroke (null not permitted).
Parameters:
  lineVisible - a flag that controls whether or not the line is visible.
Parameters:
  line - the line.
Parameters:
  lineStroke - the stroke (null not permitted).
Parameters:
  linePaint - the line paint (null not permitted).




Method Detail
equals
public boolean equals(Object obj)(Code)
Tests this item for equality with an arbitrary object.
Parameters:
  obj - the object (null permitted). A boolean.



getAttributedLabel
public AttributedString getAttributedLabel()(Code)
Returns the attributed label. The attributed label (possibly null).



getDataset
public Dataset getDataset()(Code)
Returns the dataset. The dataset.
since:
   1.0.6
See Also:   LegendItem.setDatasetIndex(int)



getDatasetIndex
public int getDatasetIndex()(Code)
Returns the dataset index for this legend item. The dataset index.
since:
   1.0.2
See Also:   LegendItem.setDatasetIndex(int)
See Also:   LegendItem.getDataset()



getDescription
public String getDescription()(Code)
Returns the description for the legend item. The description.



getFillPaint
public Paint getFillPaint()(Code)
Returns the fill paint. The fill paint (never null).



getFillPaintTransformer
public GradientPaintTransformer getFillPaintTransformer()(Code)
Returns the transformer used when the fill paint is an instance of GradientPaint. The transformer (never null).
since:
   1.0.4
See Also:   LegendItem.setFillPaintTransformer(GradientPaintTransformer)



getLabel
public String getLabel()(Code)
Returns the label. The label (never null).



getLine
public Shape getLine()(Code)
Returns the line. The line.



getLinePaint
public Paint getLinePaint()(Code)
Returns the paint used for lines. The paint.



getLineStroke
public Stroke getLineStroke()(Code)
Returns the line stroke for the series. The stroke (never null).



getOutlinePaint
public Paint getOutlinePaint()(Code)
Returns the outline paint. The outline paint (never null).



getOutlineStroke
public Stroke getOutlineStroke()(Code)
Returns the outline stroke. The outline stroke (never null).



getSeriesIndex
public int getSeriesIndex()(Code)
Returns the series index for this legend item. The series index.
since:
   1.0.2



getSeriesKey
public Comparable getSeriesKey()(Code)
Returns the series key. The series key.
since:
   1.0.6
See Also:   LegendItem.setSeriesKey(Comparable)



getShape
public Shape getShape()(Code)
Returns the shape used to label the series represented by this legend item. The shape (never null).



getToolTipText
public String getToolTipText()(Code)
Returns the tool tip text. The tool tip text (possibly null).



getURLText
public String getURLText()(Code)
Returns the URL text. The URL text (possibly null).



isLineVisible
public boolean isLineVisible()(Code)
Returns a flag that indicates whether or not the line is visible. A boolean.



isShapeFilled
public boolean isShapeFilled()(Code)
Returns a flag that controls whether or not the shape is filled. A boolean.



isShapeOutlineVisible
public boolean isShapeOutlineVisible()(Code)
Returns the flag that controls whether or not the shape outline is visible. A boolean.



isShapeVisible
public boolean isShapeVisible()(Code)
Returns a flag that indicates whether or not the shape is visible. A boolean.



setDataset
public void setDataset(Dataset dataset)(Code)
Sets the dataset.
Parameters:
  dataset - the dataset.
since:
   1.0.6



setDatasetIndex
public void setDatasetIndex(int index)(Code)
Sets the dataset index for this legend item.
Parameters:
  index - the index.
since:
   1.0.2
See Also:   LegendItem.getDatasetIndex()



setFillPaintTransformer
public void setFillPaintTransformer(GradientPaintTransformer transformer)(Code)
Sets the transformer used when the fill paint is an instance of GradientPaint.
Parameters:
  transformer - the transformer (null not permitted).
since:
   1.0.4
See Also:   LegendItem.getFillPaintTransformer()



setSeriesIndex
public void setSeriesIndex(int index)(Code)
Sets the series index for this legend item.
Parameters:
  index - the index.
since:
   1.0.2



setSeriesKey
public void setSeriesKey(Comparable key)(Code)
Sets the series key.
Parameters:
  key - the series key.
since:
   1.0.6



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.