Java Doc for WarningRegionProperties.java in  » Chart » Chart2D_1.9.6k » net » sourceforge » chart2d » 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 » Chart » Chart2D_1.9.6k » net.sourceforge.chart2d 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   net.sourceforge.chart2d.WarningRegionProperties

WarningRegionProperties
final public class WarningRegionProperties (Code)
The properties of a warning region for GraphChart2D charts. A warning region is a rectangular region of a graph that when a graph component enters it, the graph component in that region is painted with a specific color; also the background of that region is also a specific color. Pass this to any number of GraphChart2D objects.


Field Summary
final public static  ColorBACKGROUND_COLOR_DEFAULT
     The default is Color.pink.
final public static  booleanBACKGROUND_EXISTENCE_DEFAULT
     The default is true.
final public static  ColorCOMPONENT_COLOR_DEFAULT
     The default is Color.red.
final public static  floatHIGH
     Indicates the high value should be the maximum.
final public static  floatHIGH_DEFAULT
     The default is HIGH.
final public static  floatLOW
     Indicates the low value should be the minimum.
final public static  floatLOW_DEFAULT
     The default is LOW.

Constructor Summary
public  WarningRegionProperties()
     Creates a WarningRegionProperties object with the documented default values.
public  WarningRegionProperties(WarningRegionProperties warningRegionProps)
     Creates a WarningRegionProperties object with property values copied from another object.

Method Summary
final  voidaddGraphChart2D(GraphChart2D graphChart2D)
     Adds a GraphChart2D to the set of objects using these properties.
final  WarningRegionconfigureWarningRegion()
     A convencience method for creating a WarningRegion set with these properties.
final public  ColorgetBackgroundColor()
     Gets the color that the graph background becomes in this region if the graph background exists.
final public  booleangetBackgroundExistence()
     Gets the existence of the background irrespective of the existence of the graph's background.
final public  ColorgetComponentColor()
     Gets the color that any component entering this region should become.
final  booleangetGraphChart2DNeedsUpdate(GraphChart2D graphChart2D)
     Gets whether this object needs to be updated with new properties.
Parameters:
  graphChart2D - The object that may need to be updated.
final public  floatgetHigh()
     Gets the high value of this warning region.
final public  floatgetLow()
     Gets the low value of this warning region.
final  voidremoveGraphChart2D(GraphChart2D graphChart2D)
     Removes a GraphChart2D from the set of objects using these properties.
final public  voidsetBackgroundColor(Color c)
     Sets the color that the graph background becomes in this region if the graph background exists.
final public  voidsetBackgroundExistence(boolean existence)
     Sets the existence of the background irrespective of the existence of the graph's background.
final public  voidsetComponentColor(Color c)
     Sets the color that any component entering this region should become.
final public  voidsetHigh(float h)
     Sets the high value of this warning region.
final public  voidsetLow(float l)
     Sets the low value of this warning region.
final public  voidsetToDefaults()
     Sets all properties to their default values.
final public  voidsetWarningRegionProperties(WarningRegionProperties warningRegionProps)
     Sets all properties to be the values of another WarningRegionProperties object.
final  voidupdateGraphChart2D(GraphChart2D graphChart2D)
     Updates the properties of this GraphChart2D.
final  booleanvalidate(boolean debug)
     Validates the properties of this object. If debug is true then prints a messages indicating whether each property is valid. Returns true if all the properties were valid and false otherwise.
Parameters:
  debug - If true then will print status messages.

Field Detail
BACKGROUND_COLOR_DEFAULT
final public static Color BACKGROUND_COLOR_DEFAULT(Code)
The default is Color.pink.



BACKGROUND_EXISTENCE_DEFAULT
final public static boolean BACKGROUND_EXISTENCE_DEFAULT(Code)
The default is true.



COMPONENT_COLOR_DEFAULT
final public static Color COMPONENT_COLOR_DEFAULT(Code)
The default is Color.red.



HIGH
final public static float HIGH(Code)
Indicates the high value should be the maximum. For use with setHigh(). Note that HIGH - N where N is some number is invalid.



HIGH_DEFAULT
final public static float HIGH_DEFAULT(Code)
The default is HIGH.



LOW
final public static float LOW(Code)
Indicates the low value should be the minimum. For use with setHigh(). Note that LOW - N where N is some number is invalid.



LOW_DEFAULT
final public static float LOW_DEFAULT(Code)
The default is LOW.




Constructor Detail
WarningRegionProperties
public WarningRegionProperties()(Code)
Creates a WarningRegionProperties object with the documented default values.



WarningRegionProperties
public WarningRegionProperties(WarningRegionProperties warningRegionProps)(Code)
Creates a WarningRegionProperties object with property values copied from another object. The copying is a deep copy.
Parameters:
  warningRegionProps - The properties to copy.




Method Detail
addGraphChart2D
final void addGraphChart2D(GraphChart2D graphChart2D)(Code)
Adds a GraphChart2D to the set of objects using these properties.
Parameters:
  graphChart2D - The Object2D to add.



configureWarningRegion
final WarningRegion configureWarningRegion()(Code)
A convencience method for creating a WarningRegion set with these properties. The appropriately set warning region.



getBackgroundColor
final public Color getBackgroundColor()(Code)
Gets the color that the graph background becomes in this region if the graph background exists. The color of the section of the graph background.



getBackgroundExistence
final public boolean getBackgroundExistence()(Code)
Gets the existence of the background irrespective of the existence of the graph's background. If true, then the background of the warning region will exist.



getComponentColor
final public Color getComponentColor()(Code)
Gets the color that any component entering this region should become. Only the portion of the component that is in the region will be this color. Examples of components are: bars, lines, and dots. The color of the components sections in the region.



getGraphChart2DNeedsUpdate
final boolean getGraphChart2DNeedsUpdate(GraphChart2D graphChart2D)(Code)
Gets whether this object needs to be updated with new properties.
Parameters:
  graphChart2D - The object that may need to be updated. If true then needs update.



getHigh
final public float getHigh()(Code)
Gets the high value of this warning region. For example, if your data ranges from 10000 to 0 and you want an orange region from 6000 to 8000, then set the high to 8000. If you want the region to extend from 8000 to the top of the graph, then set the high to HIGH. The high value of this region.



getLow
final public float getLow()(Code)
Gets the low value of this warning region. For example, if your data ranges from 10000 to 0 and you want an orange region from 6000 to 8000, then set the low to 6000. If you want the region to extend from 6000 to the bottom of the graph, then set the low to LOW. The low value of this region.



removeGraphChart2D
final void removeGraphChart2D(GraphChart2D graphChart2D)(Code)
Removes a GraphChart2D from the set of objects using these properties.
Parameters:
  graphChart2D - The Object2D to remove.



setBackgroundColor
final public void setBackgroundColor(Color c)(Code)
Sets the color that the graph background becomes in this region if the graph background exists.
Parameters:
  c - The color of the section of the graph background.



setBackgroundExistence
final public void setBackgroundExistence(boolean existence)(Code)
Sets the existence of the background irrespective of the existence of the graph's background.
Parameters:
  existence - If true, then the background of the warning region will exist.



setComponentColor
final public void setComponentColor(Color c)(Code)
Sets the color that any component entering this region should become. Only the portion of the component that is in the region will be this color. Examples of components are: bars, lines, and dots.
Parameters:
  c - The color of the components sections in the region.



setHigh
final public void setHigh(float h)(Code)
Sets the high value of this warning region. For example, if your data ranges from 10000 to 0 and you want an orange region from 6000 to 8000, then set the high to 8000. If you want the region to extend from 8000 to the top of the graph, then set the high to HIGH.
Parameters:
  h - The high value of this region.



setLow
final public void setLow(float l)(Code)
Sets the low value of this warning region. For example, if your data ranges from 10000 to 0 and you want an orange region from 6000 to 8000, then set the low to 6000. If you want the region to extend from 6000 to the bottom of the graph, then set the low to LOW.
Parameters:
  l - The low value of this region.



setToDefaults
final public void setToDefaults()(Code)
Sets all properties to their default values.



setWarningRegionProperties
final public void setWarningRegionProperties(WarningRegionProperties warningRegionProps)(Code)
Sets all properties to be the values of another WarningRegionProperties object. The copying is a deep copy.
Parameters:
  warningRegionProps - The properties to copy.



updateGraphChart2D
final void updateGraphChart2D(GraphChart2D graphChart2D)(Code)
Updates the properties of this GraphChart2D.
Parameters:
  graphChart2D - The object to update.



validate
final boolean validate(boolean debug)(Code)
Validates the properties of this object. If debug is true then prints a messages indicating whether each property is valid. Returns true if all the properties were valid and false otherwise.
Parameters:
  debug - If true then will print status messages. If true then valid.



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.