Java Doc for ElementTrafficLightFunction.java in  » Report » pentaho-report » org » jfree » report » function » 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 » Report » pentaho report » org.jfree.report.function 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.jfree.report.function.AbstractExpression
      org.jfree.report.function.AbstractFunction
         org.jfree.report.function.AbstractElementFormatFunction
            org.jfree.report.function.ElementTrafficLightFunction

ElementTrafficLightFunction
public class ElementTrafficLightFunction extends AbstractElementFormatFunction (Code)
A function that performs basic traffic lighting based on a range of values and a given set of colors to use. The default colors are for red for values smaller than 50, yellow for values smaller than 75 and green for all values greater than 75. The default behaviour will be applied if no other limits and colors are defined. This function respects absolute values when flagged.

By default the given limits specify the lower boundary of an range. That means a value lower than the first given limit will return the default color, a value lower than the second value will return the first color and so on.

That logic can be inversed using the 'useOppositeLogic' flag. In that case the limits specify an upper boundary. If the value read from the datarow is greater than the last limit specified, the default is returned. If the value is greater than the second last limit, the last color is used, and so on.
author:
   Michael D'Amour




Constructor Summary
public  ElementTrafficLightFunction()
     Default constructor.

Method Summary
public  ColorgetColor(int index)
     Returns the color at the given index in the list of LightDefinition entries.
Parameters:
  index - the position of the entry that should be queried.
public  Color[]getColor()
     Returns all colors defined in this function mapped to their respective position.
public  intgetColorCount()
     Returns the number of LightDefinitions defined in this function.
public  ColorgetDefaultColor()
     Returns the default color that is used if none of the limits applies.
public  StringgetField()
     Returns the field used by the function.
public  ExpressiongetInstance()
     Return a completly separated copy of this function.
public  NumbergetLimit(int index)
     Returns the numerical limit at the given index in the list of LightDefinition entries.
Parameters:
  index - the position of the entry that should be queried.
public  Number[]getLimit()
     Returns all numerical limits defined in this function mapped to their respective position.
public  intgetLimitCount()
     Returns the number of LightDefinitions defined in this function.
public  booleanisDefineBackground()
     Returns whether the computed color is applied to the foreground or background of the element.
public  booleanisUseAbsoluteValue()
     Defines, whether all negative limits should be made positive, by calling 'Math.abs'.
public  booleanisUseOppositeLogic()
     Returns whether limits specify the lower or the upper boundary of a range.
protected  voidprocessRootBand(Band b)
     Process the given band and color the named element of that band if it exists.
public  voidsetColor(int index, Color color)
     Updates the color at the given index in the list of LightDefinition entries.
public  voidsetColor(Color[] colors)
     Updates all colors defined in this function mapped to their respective position.
public  voidsetDefaultColor(Color defaultColor)
     Defines the default color that is used if none of the limits applies.
public  voidsetDefineBackground(boolean defineBackground)
     Defines whether the computed color is applied to the foreground or background of the element.
public  voidsetField(String field)
     Sets the field name for the function.
public  voidsetLimit(int index, Number value)
     Updates the numerical limit at the given index in the list of LightDefinition entries.
public  voidsetLimit(Number[] limits)
     Updates all numerical limits defined in this function mapped to their respective position.
public  voidsetUseAbsoluteValue(boolean useAbsoluteValue)
     Defines, whether all negative limits should be made positive, by calling 'Math.abs'.
public  voidsetUseOppositeLogic(boolean useOppositeLogic)
     Defines whether limits specify the lower or the upper boundary of a range.


Constructor Detail
ElementTrafficLightFunction
public ElementTrafficLightFunction()(Code)
Default constructor.




Method Detail
getColor
public Color getColor(int index)(Code)
Returns the color at the given index in the list of LightDefinition entries.
Parameters:
  index - the position of the entry that should be queried. the color at the given position.



getColor
public Color[] getColor()(Code)
Returns all colors defined in this function mapped to their respective position. the colors as array.



getColorCount
public int getColorCount()(Code)
Returns the number of LightDefinitions defined in this function. the number of entries.



getDefaultColor
public Color getDefaultColor()(Code)
Returns the default color that is used if none of the limits applies. the default color.



getField
public String getField()(Code)
Returns the field used by the function.

The field name corresponds to a column name in the data-row. The field name.




getInstance
public Expression getInstance()(Code)
Return a completly separated copy of this function. The copy does no longer share any changeable objects with the original function. a copy of this function.



getLimit
public Number getLimit(int index)(Code)
Returns the numerical limit at the given index in the list of LightDefinition entries.
Parameters:
  index - the position of the entry that should be queried. the numerical limit at the given position.



getLimit
public Number[] getLimit()(Code)
Returns all numerical limits defined in this function mapped to their respective position. the numerical limits as array.



getLimitCount
public int getLimitCount()(Code)
Returns the number of LightDefinitions defined in this function. the number of entries.



isDefineBackground
public boolean isDefineBackground()(Code)
Returns whether the computed color is applied to the foreground or background of the element. true, if the color is applied as background, false if the color is applied as foreground.



isUseAbsoluteValue
public boolean isUseAbsoluteValue()(Code)
Defines, whether all negative limits should be made positive, by calling 'Math.abs'. Returns the useAbsoluteValue.



isUseOppositeLogic
public boolean isUseOppositeLogic()(Code)
Returns whether limits specify the lower or the upper boundary of a range. true, if limits specify the upper boundaries, false otherwise.



processRootBand
protected void processRootBand(Band b)(Code)
Process the given band and color the named element of that band if it exists.
Parameters:
  b - the band that should be colored.



setColor
public void setColor(int index, Color color)(Code)
Updates the color at the given index in the list of LightDefinition entries.
Parameters:
  index - the position of the entry that should be updated.
Parameters:
  color - the new color.



setColor
public void setColor(Color[] colors)(Code)
Updates all colors defined in this function mapped to their respective position. If the color-array contains more entries than the function has, new LightDefinitions will be added. If the given array contains fewer entries, the extra LightDefinitions will be deleted.
Parameters:
  colors - the colors as array.



setDefaultColor
public void setDefaultColor(Color defaultColor)(Code)
Defines the default color that is used if none of the limits applies.
Parameters:
  defaultColor - the default color.



setDefineBackground
public void setDefineBackground(boolean defineBackground)(Code)
Defines whether the computed color is applied to the foreground or background of the element.
Parameters:
  defineBackground - true, if the color is applied as background, false if the color is applied as foreground.



setField
public void setField(String field)(Code)
Sets the field name for the function.

The field name corresponds to a column name in the data-row.
Parameters:
  field - the field name.




setLimit
public void setLimit(int index, Number value)(Code)
Updates the numerical limit at the given index in the list of LightDefinition entries.
Parameters:
  index - the position of the entry that should be updated.
Parameters:
  value - the new numerical limit.



setLimit
public void setLimit(Number[] limits)(Code)
Updates all numerical limits defined in this function mapped to their respective position. If the numerical limits-array contains more entries than the function has, new LightDefinitions will be added. If the given array contains fewer entries, the extra LightDefinitions will be deleted.
Parameters:
  limits - the numerical limits as array.



setUseAbsoluteValue
public void setUseAbsoluteValue(boolean useAbsoluteValue)(Code)
Defines, whether all negative limits should be made positive, by calling 'Math.abs'.
Parameters:
  useAbsoluteValue - The useAbsoluteValue to set.



setUseOppositeLogic
public void setUseOppositeLogic(boolean useOppositeLogic)(Code)
Defines whether limits specify the lower or the upper boundary of a range. This property defaults to false, making limits define the lower boundary.
Parameters:
  useOppositeLogic - true, if limits specify the upper boundaries, false otherwise.



Methods inherited from org.jfree.report.function.AbstractElementFormatFunction
public String getElement()(Code)(Java Doc)
public Object getValue()(Code)(Java Doc)
public void groupFinished(ReportEvent event)(Code)(Java Doc)
public void groupStarted(ReportEvent event)(Code)(Java Doc)
public void itemsAdvanced(ReportEvent event)(Code)(Java Doc)
public void itemsStarted(ReportEvent event)(Code)(Java Doc)
public void pageFinished(ReportEvent event)(Code)(Java Doc)
public void pageStarted(ReportEvent event)(Code)(Java Doc)
abstract protected void processRootBand(Band b)(Code)(Java Doc)
public void reportFinished(ReportEvent event)(Code)(Java Doc)
public void reportStarted(ReportEvent event)(Code)(Java Doc)
public void setElement(String name)(Code)(Java Doc)

Methods inherited from org.jfree.report.function.AbstractFunction
public void groupFinished(ReportEvent event)(Code)(Java Doc)
public void groupStarted(ReportEvent event)(Code)(Java Doc)
public void itemsAdvanced(ReportEvent event)(Code)(Java Doc)
public void itemsFinished(ReportEvent event)(Code)(Java Doc)
public void itemsStarted(ReportEvent event)(Code)(Java Doc)
public void reportDone(ReportEvent event)(Code)(Java Doc)
public void reportFinished(ReportEvent event)(Code)(Java Doc)
public void reportInitialized(ReportEvent event)(Code)(Java Doc)
public void reportStarted(ReportEvent event)(Code)(Java Doc)

Methods inherited from org.jfree.report.function.AbstractExpression
public Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public DataRow getDataRow()(Code)(Java Doc)
public int getDependencyLevel()(Code)(Java Doc)
public Expression getInstance()(Code)(Java Doc)
public String getName()(Code)(Java Doc)
public Configuration getReportConfiguration()(Code)(Java Doc)
public ResourceBundleFactory getResourceBundleFactory()(Code)(Java Doc)
public ExpressionRuntime getRuntime()(Code)(Java Doc)
final public boolean isActive()(Code)(Java Doc)
public boolean isDeepTraversing()(Code)(Java Doc)
public boolean isPreserve()(Code)(Java Doc)
final public void setActive(boolean active)(Code)(Java Doc)
public void setDependencyLevel(int level)(Code)(Java Doc)
public void setName(String name)(Code)(Java Doc)
public void setPreserve(boolean preserve)(Code)(Java Doc)
public void setRuntime(ExpressionRuntime runtime)(Code)(Java Doc)

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.