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

RowBandingFunction

public class RowBandingFunction extends AbstractFunction implements PageEventListener(Code)

A function that alternates the background-color for each item-band within a group. If the function evaluates to true, then the background of the named element will be set to the visible-color, else it will be set to the invisible-color.

The ElementVisibilitySwitchFunction defines two parameters:

element
The name of the element in the itemband that should be modified. The element(s) must be named using the "name" attribute, if no name is given here, the ItemBand's background color is defined instead.
initial-state
The initial state of the function. (true or false) defaults to false. This is the reverse of the element's visiblity (set to false to start with an visible element, set to true to hide the element in the first itemrow).

author:
Thomas Morgner
author:
Michael D'Amour

Constructor Summary
public	RowBandingFunction() Default constructor.

Method Summary
public String	getElement() Returns the element name.
public boolean	getInitialState() Returns the initial visibility that is used on the start of a new report, a new group or a new page.
public boolean	getInitialTriggerValue() Gets the initial value for the visible trigger, either "true" or "false".
public Color	getInvisibleBackground() Returns the background color that is used if the row-banding background should be invisible.
public Boolean	getNewPageState() Returns the visibility state that should be used on new pages.
public int	getNumberOfElements() Returns the number of rows that must be processed before the visibility can switch again.
public Object	getValue() Returns the defined visibility of the element.
public Color	getVisibleBackground() Returns the background color that is used if the row-banding background should be visible.
public void	itemsAdvanced(ReportEvent event) Triggers the visibility of an element.
public void	itemsStarted(ReportEvent event) Receives notification that the items are being processed.
public void	pageFinished(ReportEvent event) Receives notification that a page is completed.
public void	pageStarted(ReportEvent event) Receives notification that a page has started.
public void	reportInitialized(ReportEvent event) Receives notification that report generation initializes the current run.
public void	setElement(String name) Sets the element name.
public void	setInitialState(boolean initialState) Defines the initial visibility that is used on the start of a new report, a new group or a new page.
public void	setInvisibleBackground(Color invisibleBackground) Defines the background color that is used if the row-banding background should be invisible.
public void	setNewPageState(Boolean newPageState) Defines the visibility state that should be used on new pages.
public void	setNumberOfElements(int numberOfElements) Defines the number of rows that must be processed before the visibility can switch again.
public void	setVisibleBackground(Color visibleBackground) Defines the background color that is used if the row-banding background should be visible.

Constructor Detail

RowBandingFunction
public RowBandingFunction()(Code)
	Default constructor.

Method Detail

getElement
public String getElement()(Code)
	Returns the element name. The element name. See Also: RowBandingFunction.setElement(String)

getInitialState
public boolean getInitialState()(Code)
	Returns the initial visibility that is used on the start of a new report, a new group or a new page. the initial value for the trigger.

getInitialTriggerValue
public boolean getInitialTriggerValue()(Code)
	Gets the initial value for the visible trigger, either "true" or "false". the initial value for the trigger.

getInvisibleBackground
public Color getInvisibleBackground()(Code)
	Returns the background color that is used if the row-banding background should be invisible. a color.

getNewPageState
public Boolean getNewPageState()(Code)
	Returns the visibility state that should be used on new pages. This is only used if resetOnPageStart is set to true. If this value is not defined, the initialState is used. the state on new pages.

getNumberOfElements
public int getNumberOfElements()(Code)
	Returns the number of rows that must be processed before the visibility can switch again. a row count.

getValue
public Object getValue()(Code)
	Returns the defined visibility of the element. Returns either true or false as java.lang.Boolean. the visibility of the element, either Boolean.TRUE or Boolean.FALSE.

getVisibleBackground
public Color getVisibleBackground()(Code)
	Returns the background color that is used if the row-banding background should be visible. a color.

itemsAdvanced
public void itemsAdvanced(ReportEvent event)(Code)
	Triggers the visibility of an element. If the named element was visible at the last itemsAdvanced call, it gets now invisible and vice versa. This creates the effect, that an element is printed every other line. Parameters: event - the report event.

itemsStarted
public void itemsStarted(ReportEvent event)(Code)
	Receives notification that the items are being processed. Sets the function value to false. Following this event, there will be a sequence of itemsAdvanced events until the itemsFinished event is raised. Parameters: event - Information about the 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 page has started. Parameters: event - the event.

reportInitialized
public void reportInitialized(ReportEvent event)(Code)
	Receives notification that report generation initializes the current run. The event carries a ReportState.Started state. Use this to initialize the report. Parameters: event - The event.

setElement
public void setElement(String name)(Code)
	Sets the element name. The name denotes an element or band within the root-band or the root-band itself. It is possible to define multiple elements with the same name to apply the modification to all of these elements. Parameters: name - The element name. See Also: org.jfree.report.function.FunctionUtilities.findAllElements(org.jfree.report.BandString)

setInitialState
public void setInitialState(boolean initialState)(Code)
	Defines the initial visibility that is used on the start of a new report, a new group or a new page. Parameters: initialState - the initial value for the trigger.

setInvisibleBackground
public void setInvisibleBackground(Color invisibleBackground)(Code)
	Defines the background color that is used if the row-banding background should be invisible. Parameters: invisibleBackground - a color.

setNewPageState
public void setNewPageState(Boolean newPageState)(Code)
	Defines the visibility state that should be used on new pages. This is only used if resetOnPageStart is set to true. If this value is not defined, the initialState is used. Parameters: newPageState - the state on new pages or null to use the initialState.

setNumberOfElements
public void setNumberOfElements(int numberOfElements)(Code)
	Defines the number of rows that must be processed before the visibility can switch again. Parameters: numberOfElements - a row count.

setVisibleBackground
public void setVisibleBackground(Color visibleBackground)(Code)
	Defines the background color that is used if the row-banding background should be visible. Parameters: visibleBackground - a color.

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.