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


net.sf.jasperreports.engine.JRElement

All known Subclasses:   net.sf.jasperreports.engine.base.JRBaseElement,  net.sf.jasperreports.engine.fill.JRFillElement,
JRElement
public interface JRElement extends JRChild,JRStyleContainer(Code)
An abstract representation of a report element. All report elements implement this interface. The interface contains constants and methods that apply to all report elements.
author:
   Teodor Danciu (teodord@users.sourceforge.net)
version:
   $Id: JRElement.java 1229 2006-04-19 10:27:35Z teodord $


Field Summary
final public static  byteMODE_OPAQUE
     Specifies that the element is opaque.
final public static  byteMODE_TRANSPARENT
     Specifies that the element is transparent.
final public static  bytePOSITION_TYPE_FIX_RELATIVE_TO_BOTTOM
     If the height of the parent report section is affected by elements that stretch, the current element will try to conserve the original distance between its bottom margin and the bottom of the band.
final public static  bytePOSITION_TYPE_FIX_RELATIVE_TO_TOP
     The element will simply ignore what happens to the other section elements and tries to conserve the y offset measured from the top of its parent report section.
final public static  bytePOSITION_TYPE_FLOAT
     The element will float in its parent section if it is pushed downwards by other elements fount above it.
final public static  byteSTRETCH_TYPE_NO_STRETCH
     The element preserves its original specified height.
final public static  byteSTRETCH_TYPE_RELATIVE_TO_BAND_HEIGHT
     The graphic element will adapt its height to match the new height of the report section it placed on, which has been affected by stretch.
final public static  byteSTRETCH_TYPE_RELATIVE_TO_TALLEST_OBJECT
     Users have the possibility to group the elements of a report section in multiple imbricate groups.


Method Summary
public  voidcollectExpressions(JRExpressionCollector collector)
    
public  ColorgetBackcolor()
    
public  JRElementGroupgetElementGroup()
     Indicates the logical group that the element belongs to.
public  ColorgetForecolor()
    
public  intgetHeight()
    
public  StringgetKey()
     Returns the string value that uniquely identifies the element.
public  bytegetMode()
     Returns the element transparency mode. The default value depends on the type of the report element.
public  ColorgetOwnBackcolor()
    
public  ColorgetOwnForecolor()
    
public  BytegetOwnMode()
    
public  bytegetPositionType()
    
public  JRExpressiongetPrintWhenExpression()
     Gets the the expression that is evaluated in order to decide if the element should be displayed.
public  JRGroupgetPrintWhenGroupChanges()
     Returns the group for which an element with a printRepeatedValues attribute set to true will be redisplayed even if the value has not changed.
public  bytegetStretchType()
    
public  intgetWidth()
    
public  intgetX()
     Gets the the section relative horizontal offset of the element top left corner.
public  intgetY()
     Gets the the section relative vertical offset of the element top left corner.
public  booleanisPrintInFirstWholeBand()
     Returns true if an element with a printRepeatedValues attribute set to true will be redisplayed for every new page or column that is not an overflow from a previous page or column.
public  booleanisPrintRepeatedValues()
     Specifies if the element value will be printed for every iteration, even if its value has not changed.
public  booleanisPrintWhenDetailOverflows()
     If this is set to true, the element will be reprinted on the next page if the band does not fit in the current page.
public  booleanisRemoveLineWhenBlank()
     Returns true if the remaining blank space appearing when the value is not printed will be removed.
public  voidsetBackcolor(Color backcolor)
    
public  voidsetForecolor(Color forecolor)
    
public  voidsetMode(byte mode)
     Returns the element transparency mode. The default value depends on the type of the report element.
public  voidsetMode(Byte mode)
    
public  voidsetPositionType(byte positionType)
     Sets the position type for the element.
public  voidsetPrintInFirstWholeBand(boolean isPrintInFirstWholeBand)
     Specifies whether an element with a printRepeatedValues attribute set to true should be redisplayed for every new page or column that is not an overflow from a previous page or column.
public  voidsetPrintRepeatedValues(boolean isPrintRepeatedValues)
    
public  voidsetPrintWhenDetailOverflows(boolean isPrintWhenDetailOverflows)
     If this is set to true, the element will be reprinted on the next page if the band does not fit in the current page.
public  voidsetRemoveLineWhenBlank(boolean isRemoveLineWhenBlank)
     Specifies whether the remaining blank space appearing when the value is not printed will be removed.
public  voidsetStretchType(byte stretchType)
     Sets the stretch type for the element.
public  voidsetWidth(int width)
    
public  voidsetX(int x)
     Sets the the section relative horizontal offset of the element top left corner.

Field Detail
MODE_OPAQUE
final public static byte MODE_OPAQUE(Code)
Specifies that the element is opaque.



MODE_TRANSPARENT
final public static byte MODE_TRANSPARENT(Code)
Specifies that the element is transparent.



POSITION_TYPE_FIX_RELATIVE_TO_BOTTOM
final public static byte POSITION_TYPE_FIX_RELATIVE_TO_BOTTOM(Code)
If the height of the parent report section is affected by elements that stretch, the current element will try to conserve the original distance between its bottom margin and the bottom of the band.



POSITION_TYPE_FIX_RELATIVE_TO_TOP
final public static byte POSITION_TYPE_FIX_RELATIVE_TO_TOP(Code)
The element will simply ignore what happens to the other section elements and tries to conserve the y offset measured from the top of its parent report section.



POSITION_TYPE_FLOAT
final public static byte POSITION_TYPE_FLOAT(Code)
The element will float in its parent section if it is pushed downwards by other elements fount above it. It will try to conserve the distance between it and the neighboring elements placed immediately above.



STRETCH_TYPE_NO_STRETCH
final public static byte STRETCH_TYPE_NO_STRETCH(Code)
The element preserves its original specified height.



STRETCH_TYPE_RELATIVE_TO_BAND_HEIGHT
final public static byte STRETCH_TYPE_RELATIVE_TO_BAND_HEIGHT(Code)
The graphic element will adapt its height to match the new height of the report section it placed on, which has been affected by stretch.



STRETCH_TYPE_RELATIVE_TO_TALLEST_OBJECT
final public static byte STRETCH_TYPE_RELATIVE_TO_TALLEST_OBJECT(Code)
Users have the possibility to group the elements of a report section in multiple imbricate groups. The only reason one might have for grouping your report elements is to be able to stretch them to fit the tallest object.





Method Detail
collectExpressions
public void collectExpressions(JRExpressionCollector collector)(Code)



getBackcolor
public Color getBackcolor()(Code)



getElementGroup
public JRElementGroup getElementGroup()(Code)
Indicates the logical group that the element belongs to. More elements can be grouped in order to get the height of the tallest one.
See Also:   JRElement.STRETCH_TYPE_RELATIVE_TO_TALLEST_OBJECT



getForecolor
public Color getForecolor()(Code)



getHeight
public int getHeight()(Code)



getKey
public String getKey()(Code)
Returns the string value that uniquely identifies the element.



getMode
public byte getMode()(Code)
Returns the element transparency mode. The default value depends on the type of the report element. Graphic elements like rectangles and lines are opaque by default, but the images are transparent. Both static texts and text fields are transparent by default, and so are the subreport elements. MODE_OPAQUE or MODE_TRANSPARENT



getOwnBackcolor
public Color getOwnBackcolor()(Code)



getOwnForecolor
public Color getOwnForecolor()(Code)



getOwnMode
public Byte getOwnMode()(Code)



getPositionType
public byte getPositionType()(Code)
Returns the position type for the element a byte value representing one of the position type constants in this class



getPrintWhenExpression
public JRExpression getPrintWhenExpression()(Code)
Gets the the expression that is evaluated in order to decide if the element should be displayed. The print expression always returns a boolean value.



getPrintWhenGroupChanges
public JRGroup getPrintWhenGroupChanges()(Code)
Returns the group for which an element with a printRepeatedValues attribute set to true will be redisplayed even if the value has not changed.
See Also:   JRElement.isPrintRepeatedValues



getStretchType
public byte getStretchType()(Code)
Returns the stretch type for the element a byte value representing one of the strech type constants in this class



getWidth
public int getWidth()(Code)



getX
public int getX()(Code)
Gets the the section relative horizontal offset of the element top left corner.



getY
public int getY()(Code)
Gets the the section relative vertical offset of the element top left corner.



isPrintInFirstWholeBand
public boolean isPrintInFirstWholeBand()(Code)
Returns true if an element with a printRepeatedValues attribute set to true will be redisplayed for every new page or column that is not an overflow from a previous page or column.
See Also:   JRElement.isPrintRepeatedValues



isPrintRepeatedValues
public boolean isPrintRepeatedValues()(Code)
Specifies if the element value will be printed for every iteration, even if its value has not changed.
See Also:   JRElement.isRemoveLineWhenBlank
See Also:   JRElement.isPrintInFirstWholeBand



isPrintWhenDetailOverflows
public boolean isPrintWhenDetailOverflows()(Code)
If this is set to true, the element will be reprinted on the next page if the band does not fit in the current page. Actually if there is at least one element with this attribute, the band is redisplayed from the beginning, except those elements that fitted in the current page and have isPrintWhenDetailOverflow set to false.



isRemoveLineWhenBlank
public boolean isRemoveLineWhenBlank()(Code)
Returns true if the remaining blank space appearing when the value is not printed will be removed. Under certain circumstances (the element has an empty string as its value or contains a repeated value that is supressed) the space reserved for the current element remains empty. If this method returns true, it means the engine will try to suppress the blank line, but will only succeed if no other elements occupy the same vertical space.



setBackcolor
public void setBackcolor(Color backcolor)(Code)



setForecolor
public void setForecolor(Color forecolor)(Code)



setMode
public void setMode(byte mode)(Code)
Returns the element transparency mode. The default value depends on the type of the report element. Graphic elements like rectangles and lines are opaque by default, but the images are transparent. Both static texts and text fields are transparent by default, and so are the subreport elements.



setMode
public void setMode(Byte mode)(Code)



setPositionType
public void setPositionType(byte positionType)(Code)
Sets the position type for the element.
Parameters:
  positionType - a byte value that must be one of the position type constants in this class



setPrintInFirstWholeBand
public void setPrintInFirstWholeBand(boolean isPrintInFirstWholeBand)(Code)
Specifies whether an element with a printRepeatedValues attribute set to true should be redisplayed for every new page or column that is not an overflow from a previous page or column.
See Also:   JRElement.isPrintRepeatedValues



setPrintRepeatedValues
public void setPrintRepeatedValues(boolean isPrintRepeatedValues)(Code)



setPrintWhenDetailOverflows
public void setPrintWhenDetailOverflows(boolean isPrintWhenDetailOverflows)(Code)
If this is set to true, the element will be reprinted on the next page if the band does not fit in the current page. Actually if there is at least one element with this attribute, the band is redisplayed from the beginning, except those elements that fitted in the current page and have isPrintWhenDetailOverflow set to false.



setRemoveLineWhenBlank
public void setRemoveLineWhenBlank(boolean isRemoveLineWhenBlank)(Code)
Specifies whether the remaining blank space appearing when the value is not printed will be removed. Under certain circumstances (the element has an empty string as its value or contains a repeated value that is supressed) the space reserved for the current element remains empty. If the parameter is set to true, it means the engine will try to suppress the blank line, but will only succeed if no other elements occupy the same vertical space.



setStretchType
public void setStretchType(byte stretchType)(Code)
Sets the stretch type for the element.
Parameters:
  stretchType - a byte value that must be one of the stretch type constants in this class



setWidth
public void setWidth(int width)(Code)



setX
public void setX(int x)(Code)
Sets the the section relative horizontal offset of the element top left corner.



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