Java Doc for TextRecord.java in  » Collaboration » poi-3.0.2-beta2 » org » apache » poi » hssf » record » 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 » Collaboration » poi 3.0.2 beta2 » org.apache.poi.hssf.record 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.apache.poi.hssf.record.Record
      org.apache.poi.hssf.record.TextRecord

TextRecord
public class TextRecord extends Record (Code)
The text record is used to define text stored on a chart. NOTE: This source is automatically generated please do not modify this file. Either subclass or remove the record in src/records/definitions.
author:
   Glen Stampoultzis (glens at apache.org)


Field Summary
final public static  shortDATA_LABEL_PLACEMENT_ABOVE
    
final public static  shortDATA_LABEL_PLACEMENT_AUTO
    
final public static  shortDATA_LABEL_PLACEMENT_AXIS
    
final public static  shortDATA_LABEL_PLACEMENT_BELOW
    
final public static  shortDATA_LABEL_PLACEMENT_CENTER
    
final public static  shortDATA_LABEL_PLACEMENT_CHART_DEPENDENT
    
final public static  shortDATA_LABEL_PLACEMENT_INSIDE
    
final public static  shortDATA_LABEL_PLACEMENT_LEFT
    
final public static  shortDATA_LABEL_PLACEMENT_OUTSIDE
    
final public static  shortDATA_LABEL_PLACEMENT_RIGHT
    
final public static  shortDATA_LABEL_PLACEMENT_USER_MOVED
    
final public static  shortDISPLAY_MODE_OPAQUE
    
final public static  shortDISPLAY_MODE_TRANSPARENT
    
final public static  byteHORIZONTAL_ALIGNMENT_BOTTOM
    
final public static  byteHORIZONTAL_ALIGNMENT_CENTER
    
final public static  byteHORIZONTAL_ALIGNMENT_JUSTIFY
    
final public static  byteHORIZONTAL_ALIGNMENT_LEFT
    
final public static  shortROTATION_NONE
    
final public static  shortROTATION_ROTATED_90_DEGREES
    
final public static  shortROTATION_ROTATED_90_DEGREES_CLOCKWISE
    
final public static  shortROTATION_TOP_TO_BOTTOM
    
final public static  byteVERTICAL_ALIGNMENT_BOTTOM
    
final public static  byteVERTICAL_ALIGNMENT_CENTER
    
final public static  byteVERTICAL_ALIGNMENT_JUSTIFY
    
final public static  byteVERTICAL_ALIGNMENT_TOP
    
final public static  shortsid
    

Constructor Summary
public  TextRecord()
    
public  TextRecord(RecordInputStream in)
     Constructs a Text record and sets its fields appropriately.

Method Summary
public  Objectclone()
    
protected  voidfillFields(RecordInputStream in)
    
public  shortgetDataLabelPlacement()
    
public  shortgetDisplayMode()
     Get the display mode field for the Text record.
public  intgetHeight()
     Get the height field for the Text record.
public  bytegetHorizontalAlignment()
     Get the horizontal alignment field for the Text record.
public  shortgetIndexOfColorValue()
     Get the index of color value field for the Text record.
public  shortgetOptions1()
     Get the options1 field for the Text record.
public  shortgetOptions2()
     Get the options2 field for the Text record.
public  intgetRecordSize()
    
public  intgetRgbColor()
     Get the rgbColor field for the Text record.
public  shortgetRotation()
    
public  shortgetSid()
    
public  shortgetTextRotation()
     Get the text rotation field for the Text record.
public  bytegetVerticalAlignment()
     Get the vertical alignment field for the Text record.
public  intgetWidth()
     Get the width field for the Text record.
public  intgetX()
     Get the x field for the Text record.
public  intgetY()
     Get the y field for the Text record.
public  booleanisAutoBackground()
    
public  booleanisAutoColor()
    
public  booleanisAutoGeneratedText()
    
public  booleanisAutoLabelDeleted()
    
public  booleanisGenerated()
    
public  booleanisShowBubbleSizes()
    
public  booleanisShowCategoryLabelAsPercentage()
    
public  booleanisShowKey()
    
public  booleanisShowLabel()
    
public  booleanisShowValue()
    
public  booleanisShowValueAsPercentage()
    
public  booleanisVertical()
    
public  intserialize(int offset, byte[] data)
    
public  voidsetAutoBackground(boolean value)
     Sets the auto background field value.
public  voidsetAutoColor(boolean value)
     Sets the auto color field value.
public  voidsetAutoGeneratedText(boolean value)
     Sets the auto generated text field value.
public  voidsetAutoLabelDeleted(boolean value)
     Sets the auto label deleted field value.
public  voidsetDataLabelPlacement(short value)
     Sets the data label placement field value.
public  voidsetDisplayMode(short field_3_displayMode)
     Set the display mode field for the Text record.
public  voidsetGenerated(boolean value)
     Sets the generated field value.
public  voidsetHeight(int field_8_height)
     Set the height field for the Text record.
public  voidsetHorizontalAlignment(byte field_1_horizontalAlignment)
     Set the horizontal alignment field for the Text record.
public  voidsetIndexOfColorValue(short field_10_indexOfColorValue)
     Set the index of color value field for the Text record.
public  voidsetOptions1(short field_9_options1)
     Set the options1 field for the Text record.
public  voidsetOptions2(short field_11_options2)
     Set the options2 field for the Text record.
public  voidsetRgbColor(int field_4_rgbColor)
     Set the rgbColor field for the Text record.
public  voidsetRotation(short value)
     Sets the rotation field value.
public  voidsetShowBubbleSizes(boolean value)
     Sets the show bubble sizes field value.
public  voidsetShowCategoryLabelAsPercentage(boolean value)
     Sets the show category label as percentage field value.
public  voidsetShowKey(boolean value)
     Sets the show key field value.
public  voidsetShowLabel(boolean value)
     Sets the show label field value.
public  voidsetShowValue(boolean value)
     Sets the show value field value.
public  voidsetShowValueAsPercentage(boolean value)
     Sets the show value as percentage field value.
public  voidsetTextRotation(short field_12_textRotation)
     Set the text rotation field for the Text record.
public  voidsetVertical(boolean value)
     Sets the vertical field value.
public  voidsetVerticalAlignment(byte field_2_verticalAlignment)
     Set the vertical alignment field for the Text record.
public  voidsetWidth(int field_7_width)
     Set the width field for the Text record.
public  voidsetX(int field_5_x)
     Set the x field for the Text record.
public  voidsetY(int field_6_y)
     Set the y field for the Text record.
public  StringtoString()
    
protected  voidvalidateSid(short id)
    

Field Detail
DATA_LABEL_PLACEMENT_ABOVE
final public static short DATA_LABEL_PLACEMENT_ABOVE(Code)



DATA_LABEL_PLACEMENT_AUTO
final public static short DATA_LABEL_PLACEMENT_AUTO(Code)



DATA_LABEL_PLACEMENT_AXIS
final public static short DATA_LABEL_PLACEMENT_AXIS(Code)



DATA_LABEL_PLACEMENT_BELOW
final public static short DATA_LABEL_PLACEMENT_BELOW(Code)



DATA_LABEL_PLACEMENT_CENTER
final public static short DATA_LABEL_PLACEMENT_CENTER(Code)



DATA_LABEL_PLACEMENT_CHART_DEPENDENT
final public static short DATA_LABEL_PLACEMENT_CHART_DEPENDENT(Code)



DATA_LABEL_PLACEMENT_INSIDE
final public static short DATA_LABEL_PLACEMENT_INSIDE(Code)



DATA_LABEL_PLACEMENT_LEFT
final public static short DATA_LABEL_PLACEMENT_LEFT(Code)



DATA_LABEL_PLACEMENT_OUTSIDE
final public static short DATA_LABEL_PLACEMENT_OUTSIDE(Code)



DATA_LABEL_PLACEMENT_RIGHT
final public static short DATA_LABEL_PLACEMENT_RIGHT(Code)



DATA_LABEL_PLACEMENT_USER_MOVED
final public static short DATA_LABEL_PLACEMENT_USER_MOVED(Code)



DISPLAY_MODE_OPAQUE
final public static short DISPLAY_MODE_OPAQUE(Code)



DISPLAY_MODE_TRANSPARENT
final public static short DISPLAY_MODE_TRANSPARENT(Code)



HORIZONTAL_ALIGNMENT_BOTTOM
final public static byte HORIZONTAL_ALIGNMENT_BOTTOM(Code)



HORIZONTAL_ALIGNMENT_CENTER
final public static byte HORIZONTAL_ALIGNMENT_CENTER(Code)



HORIZONTAL_ALIGNMENT_JUSTIFY
final public static byte HORIZONTAL_ALIGNMENT_JUSTIFY(Code)



HORIZONTAL_ALIGNMENT_LEFT
final public static byte HORIZONTAL_ALIGNMENT_LEFT(Code)



ROTATION_NONE
final public static short ROTATION_NONE(Code)



ROTATION_ROTATED_90_DEGREES
final public static short ROTATION_ROTATED_90_DEGREES(Code)



ROTATION_ROTATED_90_DEGREES_CLOCKWISE
final public static short ROTATION_ROTATED_90_DEGREES_CLOCKWISE(Code)



ROTATION_TOP_TO_BOTTOM
final public static short ROTATION_TOP_TO_BOTTOM(Code)



VERTICAL_ALIGNMENT_BOTTOM
final public static byte VERTICAL_ALIGNMENT_BOTTOM(Code)



VERTICAL_ALIGNMENT_CENTER
final public static byte VERTICAL_ALIGNMENT_CENTER(Code)



VERTICAL_ALIGNMENT_JUSTIFY
final public static byte VERTICAL_ALIGNMENT_JUSTIFY(Code)



VERTICAL_ALIGNMENT_TOP
final public static byte VERTICAL_ALIGNMENT_TOP(Code)



sid
final public static short sid(Code)




Constructor Detail
TextRecord
public TextRecord()(Code)



TextRecord
public TextRecord(RecordInputStream in)(Code)
Constructs a Text record and sets its fields appropriately.
Parameters:
  in - the RecordInputstream to read the record from




Method Detail
clone
public Object clone()(Code)



fillFields
protected void fillFields(RecordInputStream in)(Code)



getDataLabelPlacement
public short getDataLabelPlacement()(Code)
the data label placement field value.



getDisplayMode
public short getDisplayMode()(Code)
Get the display mode field for the Text record. One of DISPLAY_MODE_TRANSPARENTDISPLAY_MODE_OPAQUE



getHeight
public int getHeight()(Code)
Get the height field for the Text record.



getHorizontalAlignment
public byte getHorizontalAlignment()(Code)
Get the horizontal alignment field for the Text record. One of HORIZONTAL_ALIGNMENT_LEFTHORIZONTAL_ALIGNMENT_CENTERHORIZONTAL_ALIGNMENT_BOTTOMHORIZONTAL_ALIGNMENT_JUSTIFY



getIndexOfColorValue
public short getIndexOfColorValue()(Code)
Get the index of color value field for the Text record.



getOptions1
public short getOptions1()(Code)
Get the options1 field for the Text record.



getOptions2
public short getOptions2()(Code)
Get the options2 field for the Text record.



getRecordSize
public int getRecordSize()(Code)
Size of record (exluding 4 byte header)



getRgbColor
public int getRgbColor()(Code)
Get the rgbColor field for the Text record.



getRotation
public short getRotation()(Code)
the rotation field value.



getSid
public short getSid()(Code)



getTextRotation
public short getTextRotation()(Code)
Get the text rotation field for the Text record.



getVerticalAlignment
public byte getVerticalAlignment()(Code)
Get the vertical alignment field for the Text record. One of VERTICAL_ALIGNMENT_TOPVERTICAL_ALIGNMENT_CENTERVERTICAL_ALIGNMENT_BOTTOMVERTICAL_ALIGNMENT_JUSTIFY



getWidth
public int getWidth()(Code)
Get the width field for the Text record.



getX
public int getX()(Code)
Get the x field for the Text record.



getY
public int getY()(Code)
Get the y field for the Text record.



isAutoBackground
public boolean isAutoBackground()(Code)
the auto background field value.



isAutoColor
public boolean isAutoColor()(Code)
true = automaticly selected colour, false = user-selected the auto color field value.



isAutoGeneratedText
public boolean isAutoGeneratedText()(Code)
the auto generated text field value.



isAutoLabelDeleted
public boolean isAutoLabelDeleted()(Code)
the auto label deleted field value.



isGenerated
public boolean isGenerated()(Code)
the generated field value.



isShowBubbleSizes
public boolean isShowBubbleSizes()(Code)
the show bubble sizes field value.



isShowCategoryLabelAsPercentage
public boolean isShowCategoryLabelAsPercentage()(Code)
the show category label as percentage field value.



isShowKey
public boolean isShowKey()(Code)
true = draw legend the show key field value.



isShowLabel
public boolean isShowLabel()(Code)
the show label field value.



isShowValue
public boolean isShowValue()(Code)
false = text is category label the show value field value.



isShowValueAsPercentage
public boolean isShowValueAsPercentage()(Code)
the show value as percentage field value.



isVertical
public boolean isVertical()(Code)
true = text is vertical the vertical field value.



serialize
public int serialize(int offset, byte[] data)(Code)



setAutoBackground
public void setAutoBackground(boolean value)(Code)
Sets the auto background field value.



setAutoColor
public void setAutoColor(boolean value)(Code)
Sets the auto color field value. true = automaticly selected colour, false = user-selected



setAutoGeneratedText
public void setAutoGeneratedText(boolean value)(Code)
Sets the auto generated text field value.



setAutoLabelDeleted
public void setAutoLabelDeleted(boolean value)(Code)
Sets the auto label deleted field value.



setDataLabelPlacement
public void setDataLabelPlacement(short value)(Code)
Sets the data label placement field value.



setDisplayMode
public void setDisplayMode(short field_3_displayMode)(Code)
Set the display mode field for the Text record.
Parameters:
  field_3_displayMode - One of DISPLAY_MODE_TRANSPARENTDISPLAY_MODE_OPAQUE



setGenerated
public void setGenerated(boolean value)(Code)
Sets the generated field value.



setHeight
public void setHeight(int field_8_height)(Code)
Set the height field for the Text record.



setHorizontalAlignment
public void setHorizontalAlignment(byte field_1_horizontalAlignment)(Code)
Set the horizontal alignment field for the Text record.
Parameters:
  field_1_horizontalAlignment - One of HORIZONTAL_ALIGNMENT_LEFTHORIZONTAL_ALIGNMENT_CENTERHORIZONTAL_ALIGNMENT_BOTTOMHORIZONTAL_ALIGNMENT_JUSTIFY



setIndexOfColorValue
public void setIndexOfColorValue(short field_10_indexOfColorValue)(Code)
Set the index of color value field for the Text record.



setOptions1
public void setOptions1(short field_9_options1)(Code)
Set the options1 field for the Text record.



setOptions2
public void setOptions2(short field_11_options2)(Code)
Set the options2 field for the Text record.



setRgbColor
public void setRgbColor(int field_4_rgbColor)(Code)
Set the rgbColor field for the Text record.



setRotation
public void setRotation(short value)(Code)
Sets the rotation field value.



setShowBubbleSizes
public void setShowBubbleSizes(boolean value)(Code)
Sets the show bubble sizes field value.



setShowCategoryLabelAsPercentage
public void setShowCategoryLabelAsPercentage(boolean value)(Code)
Sets the show category label as percentage field value.



setShowKey
public void setShowKey(boolean value)(Code)
Sets the show key field value. true = draw legend



setShowLabel
public void setShowLabel(boolean value)(Code)
Sets the show label field value.



setShowValue
public void setShowValue(boolean value)(Code)
Sets the show value field value. false = text is category label



setShowValueAsPercentage
public void setShowValueAsPercentage(boolean value)(Code)
Sets the show value as percentage field value.



setTextRotation
public void setTextRotation(short field_12_textRotation)(Code)
Set the text rotation field for the Text record.



setVertical
public void setVertical(boolean value)(Code)
Sets the vertical field value. true = text is vertical



setVerticalAlignment
public void setVerticalAlignment(byte field_2_verticalAlignment)(Code)
Set the vertical alignment field for the Text record.
Parameters:
  field_2_verticalAlignment - One of VERTICAL_ALIGNMENT_TOPVERTICAL_ALIGNMENT_CENTERVERTICAL_ALIGNMENT_BOTTOMVERTICAL_ALIGNMENT_JUSTIFY



setWidth
public void setWidth(int field_7_width)(Code)
Set the width field for the Text record.



setX
public void setX(int field_5_x)(Code)
Set the x field for the Text record.



setY
public void setY(int field_6_y)(Code)
Set the y field for the Text record.



toString
public String toString()(Code)



validateSid
protected void validateSid(short id)(Code)
Checks the sid matches the expected side for this record
Parameters:
  id - the expected sid.



Methods inherited from org.apache.poi.hssf.record.Record
public Object clone()(Code)(Java Doc)
abstract protected void fillFields(RecordInputStream in)(Code)(Java Doc)
public int getRecordSize()(Code)(Java Doc)
abstract public short getSid()(Code)(Java Doc)
public boolean isInValueSection()(Code)(Java Doc)
public boolean isValue()(Code)(Java Doc)
public byte[] serialize()(Code)(Java Doc)
abstract public int serialize(int offset, byte[] data)(Code)(Java Doc)
public String toString()(Code)(Java Doc)
abstract protected void validateSid(short id)(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
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.