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

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL 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 .PageFunction

All known Subclasses:   org.jfree.report.function .PageOfPagesFunction,  org.jfree.report.function .PageTotalFunction,
PageFunction
public class PageFunction extends AbstractFunction implements PageEventListener(Code)
A report function that counts pages. This method is only useable when a report processor is used, which generated PageEvents. The PageableReportProcessor is one of them.
As with all page dependent functions: The function will only be active, when the page events get fired, this usually only happens during the last pagination run and the printing. The function level will be negative when this happens.

author:
   Thomas Morgner

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

Method Summary
public int getDependencyLevel()
     Returns the defined dependency level.
public String getGroup()
     Returns the group name.
protected int getPage()
     Returns the current page.
public int getPageIncrement()
     Returns the page increment.
public int getStartPage()
     Returns the page number where the counting starts.
public Object getValue()
     Returns the page number (function value).
public void groupStarted(ReportEvent event)
     Receives notification that a group has started.
public boolean isDeepTraversing()
     Checks, whether this expression is a deep-traversing expression.
protected boolean isIgnoreNextGroupStart()
     A internal flag that defines wether the next group start should be ignored.
protected boolean isIgnoreNextPageStart()
     Returns, whether the next page-start event will be ignored.
protected boolean isIgnorePageCancelEvents()
     A obsolete getter.
public void pageFinished(ReportEvent event)
     Receives notification that a page is completed.
public void pageStarted(ReportEvent event)
     Receives notification from the report engine that a new page is starting.
public void reportInitialized(ReportEvent event)
     Receives notification that the report has started.
public void setDependencyLevel(int dependencyLevel)
     Defines the defined dependency level.
public void setGroup(String group)
     Sets the name of the group that the function acts upon.
public void setIgnorePageCancelEvents(boolean ignorePageCancelEvents)
     A obsolete setter.
protected void setPage(int page)
     Sets the current page.
public void setPageIncrement(int pageIncrement)
     Defines the page increment.
public void setStartPage(int startPage)
     Defines the page number where the counting starts.

Constructor Detail
PageFunction
public PageFunction()(Code)
Constructs an unnamed function.
This constructor is intended for use by the SAX handler class only.

PageFunction
public PageFunction(String name)(Code)
Constructs a named function.
Parameters:
  name - the function name.

Method Detail
getDependencyLevel
public int getDependencyLevel()(Code)
Returns the defined dependency level. For page functions, this level can be as low as the pagination level. the dependency level.

getGroup
public String getGroup()(Code)
Returns the group name. the group name.

getPage
protected int getPage()(Code)
Returns the current page. the current page.

getPageIncrement
public int getPageIncrement()(Code)
Returns the page increment. the page increment.

getStartPage
public int getStartPage()(Code)
Returns the page number where the counting starts. the page number of the first page.

getValue
public Object getValue()(Code)
Returns the page number (function value). the page number.

groupStarted
public void groupStarted(ReportEvent event)(Code)
Receives notification that a group has started.
Parameters:
  event - the event.

isDeepTraversing
public boolean isDeepTraversing()(Code)
Checks, whether this expression is a deep-traversing expression. Deep-traversing expressions receive events from all sub-reports. This returns true, as this function has to receive page-events even if a sub-report is currently being processed. true.

isIgnoreNextGroupStart
protected boolean isIgnoreNextGroupStart()(Code)
A internal flag that defines wether the next group start should be ignored. We have to ignore the first group start of each report so that the report-header becomes part of the first group's page sequence. the internal flag.

isIgnoreNextPageStart
protected boolean isIgnoreNextPageStart()(Code)
Returns, whether the next page-start event will be ignored. This is an internal state flag to keep the computation in sync with the events. the flag.

isIgnorePageCancelEvents
protected boolean isIgnorePageCancelEvents()(Code)
A obsolete getter. Ignore it please, it has no effect. true, if you care to know.

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 from the report engine that a new page is starting. Grabs the page number from the report state and stores it.
Parameters:
  event - the event.

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

setDependencyLevel
public void setDependencyLevel(int dependencyLevel)(Code)
Defines the defined dependency level. For page functions, this level can be as low as the pagination level.
Parameters:
  dependencyLevel - the dependency level.

setGroup
public void setGroup(String group)(Code)
Sets the name of the group that the function acts upon.
Parameters:
  group - the group name.

setIgnorePageCancelEvents
public void setIgnorePageCancelEvents(boolean ignorePageCancelEvents)(Code)
A obsolete setter. Ignore it please, it has no effect.
Parameters:
  ignorePageCancelEvents - ignored.

setPage
protected void setPage(int page)(Code)
Sets the current page.
Parameters:
  page - the page.

setPageIncrement
public void setPageIncrement(int pageIncrement)(Code)
Defines the page increment.
Parameters:
  pageIncrement - the page increment.

setStartPage
public void setStartPage(int startPage)(Code)
Defines the page number where the counting starts.
Parameters:
  startPage - the page number of the first page.

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

All other trademarks are property of their respective owners.