Java Doc for ItemHideFunction.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.ItemHideFunction

ItemHideFunction
public class ItemHideFunction extends AbstractFunction implements PageEventListener(Code)
The ItemHideFunction hides equal values in a group. Only the first changed value is printed. This function uses the property element to define the name of the element in the ItemBand that should be made visible or invisible by this function. The property field defines the field in the datasource or the expression which should be used to determine the visibility.
author:
   Thomas Morgner



Constructor Summary
public  ItemHideFunction()
     Constructs an unnamed function.
public  ItemHideFunction(String name)
     Constructs a named function.

Method Summary
public  StringgetElement()
     Returns the name of the element in the item band that should be set visible/invisible.
public  StringgetField()
     Returns the field used by the function.
public  ExpressiongetInstance()
     Return a completly separated copy of this function.
public  ObjectgetValue()
     Returns the function value, in this case the visibility of the defined element.
public  booleanisIgnoreGroupBreaks()
     Returns whether a group start resets the visiblity of the element.
public  booleanisIgnorePageBreaks()
     Returns whether a page start resets the visiblity of the element.
public  voiditemsAdvanced(ReportEvent event)
     Receives notification that a row of data is being processed.
public  voiditemsStarted(ReportEvent event)
     Resets the state of the function when a new ItemGroup has started.
public  voidpageFinished(ReportEvent event)
     Receives notification that a page is completed.
public  voidpageStarted(ReportEvent event)
     Receives notification that a new page is being started.
public  voidreportInitialized(ReportEvent event)
     Receives notification that the report has started.
public  voidsetElement(String name)
     Sets the name of the element in the item band that should be set visible/invisible.
public  voidsetField(String field)
     Sets the field name for the function.
public  voidsetIgnoreGroupBreaks(boolean ignoreGroupBreaks)
     Defines whether a group start resets the visiblity of the element.
public  voidsetIgnorePageBreaks(boolean ignorePageBreaks)
     Returns whether a page start resets the visiblity of the element.


Constructor Detail
ItemHideFunction
public ItemHideFunction()(Code)
Constructs an unnamed function.

Make sure to set the function name before it is used, or function initialisation will fail.




ItemHideFunction
public ItemHideFunction(String name)(Code)
Constructs a named function.

The field must be defined before using the function.
Parameters:
  name - The function name.





Method Detail
getElement
public String getElement()(Code)
Returns the name of the element in the item band that should be set visible/invisible. The element name.



getField
public String getField()(Code)
Returns the field used by the function. The field name corresponds to a column name in the report's 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.



getValue
public Object getValue()(Code)
Returns the function value, in this case the visibility of the defined element. The function value.



isIgnoreGroupBreaks
public boolean isIgnoreGroupBreaks()(Code)
Returns whether a group start resets the visiblity of the element. false, if group breaks reset the visiblity, true otherwise.



isIgnorePageBreaks
public boolean isIgnorePageBreaks()(Code)
Returns whether a page start resets the visiblity of the element. false, if page breaks reset the visiblity, true otherwise.



itemsAdvanced
public void itemsAdvanced(ReportEvent event)(Code)
Receives notification that a row of data is being processed. Reads the data from the field defined for this function and hides the field if the value is equal to the last value and the this is not the first row of the item group.
Parameters:
  event - Information about the event.



itemsStarted
public void itemsStarted(ReportEvent event)(Code)
Resets the state of the function when a new ItemGroup has started.
Parameters:
  event - the report event.



pageFinished
public void pageFinished(ReportEvent event)(Code)
Receives notification that a page is completed.
Parameters:
  event - The event.



pageStarted
public void pageStarted(ReportEvent event)(Code)
Receives notification that a new page is being started.
Parameters:
  event - The event.



reportInitialized
public void reportInitialized(ReportEvent event)(Code)
Receives notification that the report has started.
Parameters:
  event - the event.



setElement
public void setElement(String name)(Code)
Sets the name of the element in the item band that should be set visible/invisible.
Parameters:
  name - the element name (must not be null).



setField
public void setField(String field)(Code)
Sets the field name for the function. The field name corresponds to a column name in the report's data-row.
Parameters:
  field - the field name.



setIgnoreGroupBreaks
public void setIgnoreGroupBreaks(boolean ignoreGroupBreaks)(Code)
Defines whether a group start resets the visiblity of the element.
Parameters:
  ignoreGroupBreaks - false, if group breaks reset the visiblity, true otherwise.



setIgnorePageBreaks
public void setIgnorePageBreaks(boolean ignorePageBreaks)(Code)
Returns whether a page start resets the visiblity of the element.
Parameters:
  ignorePageBreaks - false, if page breaks reset the visiblity, true otherwise.



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.