Java Doc for JRCrosstab.java in  » Report » jasperreports-2.0.1 » net » sf » jasperreports » crosstabs » 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 » jasperreports 2.0.1 » net.sf.jasperreports.crosstabs 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


net.sf.jasperreports.crosstabs.JRCrosstab

All known Subclasses:   net.sf.jasperreports.crosstabs.design.JRDesignCrosstab,  net.sf.jasperreports.crosstabs.base.JRBaseCrosstab,  net.sf.jasperreports.engine.fill.JRFillCrosstab,
JRCrosstab
public interface JRCrosstab extends JRElement(Code)
Crosstab element interface.
author:
   Lucian Chirita (lucianc@users.sourceforge.net)
version:
   $Id: JRCrosstab.java 1741 2007-06-08 10:53:33Z lucianc $


Field Summary
final public static  intDEFAULT_COLUMN_BREAK_OFFSET
     The default offset used for column breaks.
final public static  byteRUN_DIRECTION_LTR
     Crosstab left to right run direction.
final public static  byteRUN_DIRECTION_RTL
     Crosstab right to left run direction.
final public static  StringVARIABLE_COLUMN_COUNT
     Name of the built-in column count variable.
final public static  StringVARIABLE_ROW_COUNT
     Name of the built-in row count variable.


Method Summary
public  JRCrosstabCell[][]getCells()
     Returns the data cell matrix.

A crosstab can have multiple data cells for row/groups totals. These cells are organized in a (rowGroupCount + 1) x (columnGroupCount + 1) matrix as following:

  • the row index of a cell is
    • the row group index, if the cell corresponds to a total row
    • rowGroupCount, otherwise
  • the column index of a cell is
    • the column group index, if the cell corresponds to a total column
    • columnGroupCount, otherwise

E.g.

public  intgetColumnBreakOffset()
     Returns the column break offset.

When the crosstab columns do not fit the width, the crosstab breaks the columns and prints the ones that don't fit after printing the first set of columns for all rows.

public  JRCrosstabColumnGroup[]getColumnGroups()
     Returns the column groups of the crosstab.
public  JRCrosstabDatasetgetDataset()
     Returns the input dataset of the crosstab.
public  JRElementgetElementByKey(String key)
     Searches for an element inside all crosstab cells.
public  JRCellContentsgetHeaderCell()
     Returns a cell which will be rendered at the upper-left corner of the crosstab.

The cell size will be calculated based on the row/column header cell widths/heights.

public  intgetId()
     Returns the ID of the crosstab.
public  JRCrosstabMeasure[]getMeasures()
     Returns the crosstab measures.
public  JRCrosstabParameter[]getParameters()
     Returns the crosstab parameters.
public  JRExpressiongetParametersMapExpression()
     Returns the parameters map expression.
public  JRCrosstabRowGroup[]getRowGroups()
     Returns the row groups of the crosstab.
public  bytegetRunDirection()
     Retrieves the run direction of this crosstab.
public  JRVariable[]getVariables()
     Returns the variables defined for the crosstab.
public  JRCellContentsgetWhenNoDataCell()
     Returns a cell which will be rendered when no data was fed to the crosstab.

If this cell is not specified for a crosstab, nothing will be rendered for an empty crosstab.

The cell sizes are the same as the crosstab element sizes.

public  booleanisRepeatColumnHeaders()
     Returns whether to repeat the column headers after a row break.
public  booleanisRepeatRowHeaders()
     Returns whether to repeat the row headers after a column break.
public  voidsetRunDirection(byte direction)
     Sets the run direction of the crosstab.

Field Detail
DEFAULT_COLUMN_BREAK_OFFSET
final public static int DEFAULT_COLUMN_BREAK_OFFSET(Code)
The default offset used for column breaks.
See Also:   JRCrosstab.getColumnBreakOffset()



RUN_DIRECTION_LTR
final public static byte RUN_DIRECTION_LTR(Code)
Crosstab left to right run direction.



RUN_DIRECTION_RTL
final public static byte RUN_DIRECTION_RTL(Code)
Crosstab right to left run direction.

When a crosstab is filled from right to left, the crosstab contents will start from the right extremity of the crosstab element area and grow towards the left.




VARIABLE_COLUMN_COUNT
final public static String VARIABLE_COLUMN_COUNT(Code)
Name of the built-in column count variable.



VARIABLE_ROW_COUNT
final public static String VARIABLE_ROW_COUNT(Code)
Name of the built-in row count variable.





Method Detail
getCells
public JRCrosstabCell[][] getCells()(Code)
Returns the data cell matrix.

A crosstab can have multiple data cells for row/groups totals. These cells are organized in a (rowGroupCount + 1) x (columnGroupCount + 1) matrix as following:

  • the row index of a cell is
    • the row group index, if the cell corresponds to a total row
    • rowGroupCount, otherwise
  • the column index of a cell is
    • the column group index, if the cell corresponds to a total column
    • columnGroupCount, otherwise

E.g. if the crosstab has Country and City (subgroup of Country) row groups and Year and Month column groups, the cells will be organized in the following matrix
0/Years total 1/Months total 2/Base
0/Countries total Total for all countries and all years Total for all countries and a year Total for all countries and a month
1/Cities total Total for a country and all years Total for a country and a year Total for a country and a month
2/Base Total for a city and all years Total for a city and a year Total for a city and a month

If the data cell for a total row/column is not specified, the cell will be inherited from lower levels, if possible. For example, if the "Total for all countries and a year" cell is not specified, the "Total for a country and a year" or "Total for a city and a year" cell will be used (in this order).

The data cell sizes are calculated from the base data cell sizes, i.e. the height of all data cells for a row will be the height of the base cell of that row. The base cell sizes are also inherited, e.g. if the height of a total row is not specified the height of the base row will be used. the data cell matrix




getColumnBreakOffset
public int getColumnBreakOffset()(Code)
Returns the column break offset.

When the crosstab columns do not fit the width, the crosstab breaks the columns and prints the ones that don't fit after printing the first set of columns for all rows. This method returns the offset to be used when continuing the printing after a column break. the column break offset




getColumnGroups
public JRCrosstabColumnGroup[] getColumnGroups()(Code)
Returns the column groups of the crosstab. the column groups



getDataset
public JRCrosstabDataset getDataset()(Code)
Returns the input dataset of the crosstab. the input dataset of the crosstab



getElementByKey
public JRElement getElementByKey(String key)(Code)
Searches for an element inside all crosstab cells.
Parameters:
  key - the element key the first element having the specified key



getHeaderCell
public JRCellContents getHeaderCell()(Code)
Returns a cell which will be rendered at the upper-left corner of the crosstab.

The cell size will be calculated based on the row/column header cell widths/heights. a cell which will be rendered at the upper-left corner of the crosstab




getId
public int getId()(Code)
Returns the ID of the crosstab.

The ID is generated when the report is compiled and is used internally. the ID of the crosstab




getMeasures
public JRCrosstabMeasure[] getMeasures()(Code)
Returns the crosstab measures. the crosstab measures



getParameters
public JRCrosstabParameter[] getParameters()(Code)
Returns the crosstab parameters.

Crosstabs have separate expression evaluators and cannot access the parameters/fields/variables of the report. In order to use a value from the report inside a crosstab, it should be passed as parameter to the crosstab.

A crosstab parameters has a name and a value expression. the crosstab parameters




getParametersMapExpression
public JRExpression getParametersMapExpression()(Code)
Returns the parameters map expression.

The set of values for crosstab parameters can be set using a map. If a parameter has also a value expression, it will overwrite the value from the map. the parameters map expression




getRowGroups
public JRCrosstabRowGroup[] getRowGroups()(Code)
Returns the row groups of the crosstab. the row groups



getRunDirection
public byte getRunDirection()(Code)
Retrieves the run direction of this crosstab. the run direction of this crosstab
See Also:   JRCrosstab.setRunDirection(byte)



getVariables
public JRVariable[] getVariables()(Code)
Returns the variables defined for the crosstab. variables defined for the crosstab
See Also:   JRCrosstabGroup.getVariable
See Also:   JRCrosstabMeasure.getVariable
See Also:   JRCrosstab.VARIABLE_ROW_COUNT
See Also:   JRCrosstab.VARIABLE_COLUMN_COUNT



getWhenNoDataCell
public JRCellContents getWhenNoDataCell()(Code)
Returns a cell which will be rendered when no data was fed to the crosstab.

If this cell is not specified for a crosstab, nothing will be rendered for an empty crosstab.

The cell sizes are the same as the crosstab element sizes. a cell which will be rendered when no data was fed to the crosstab




isRepeatColumnHeaders
public boolean isRepeatColumnHeaders()(Code)
Returns whether to repeat the column headers after a row break. whether to repeat the column headers after a row break



isRepeatRowHeaders
public boolean isRepeatRowHeaders()(Code)
Returns whether to repeat the row headers after a column break. whether to repeat the row headers after a column break



setRunDirection
public void setRunDirection(byte direction)(Code)
Sets the run direction of the crosstab.

Crosstabs can either be filled from left to right (the default) or from right to left (mainly for reports in RTL languages).


Parameters:
  direction - one of JRCrosstab.RUN_DIRECTION_LTR RUN_DIRECTION_LTRand JRCrosstab.RUN_DIRECTION_RTL RUN_DIRECTION_RTL



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