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


java.lang.Object
   org.apache.poi.hslf.model.Shape
      org.apache.poi.hslf.model.SimpleShape
         org.apache.poi.hslf.model.TextBox

All known Subclasses:   org.apache.poi.hslf.model.TableCell,  org.apache.poi.hslf.model.Placeholder,
TextBox
public class TextBox extends SimpleShape (Code)
Represents a TextFrame shape in PowerPoint.

Contains the text in a text frame as well as the properties and methods that control alignment and anchoring of the text.


author:
   Yegor Kozlov


Field Summary
final public static  intAlignCenter
    
final public static  intAlignJustify
    
final public static  intAlignLeft
    
final public static  intAlignRight
    
final public static  intAnchorBottom
    
final public static  intAnchorBottomBaseline
    
final public static  intAnchorBottomCentered
    
final public static  intAnchorBottomCenteredBaseline
    
final public static  intAnchorMiddle
    
final public static  intAnchorMiddleCentered
    
final public static  intAnchorTop
    
final public static  intAnchorTopBaseline
    
final public static  intAnchorTopCentered
    
final public static  intAnchorTopCenteredBaseline
    
final public static  intWrapByPoints
    
final public static  intWrapNone
    
final public static  intWrapSquare
    
final public static  intWrapThrough
    
final public static  intWrapTopBottom
    
protected  EscherTextboxWrapper_txtbox
     Escher container which holds text attributes such as TextHeaderAtom, TextBytesAtom ot TextCharsAtom, StyleTextPropAtom etc.
protected  TextRun_txtrun
    

Constructor Summary
protected  TextBox(EscherContainerRecord escherRecord, Shape parent)
     Create a TextBox object and initialize it from the supplied Record container.
public  TextBox(Shape parent)
     Create a new TextBox.
public  TextBox()
     Create a new TextBox.

Method Summary
protected  voidafterInsert(Sheet sh)
     When a textbox is added to a sheet we need to tell upper-level PPDrawing about it.
protected  EscherContainerRecordcreateSpContainer(boolean isChild)
    
public  intgetHorizontalAlignment()
    
public  intgetMarginBottom()
     Returns the distance (in points) between the bottom of the text frame and the bottom of the inscribed rectangle of the shape that contains the text.
public  intgetMarginLeft()
     Returns the distance (in EMUs) between the left edge of the text frame and the left edge of the inscribed rectangle of the shape that contains the text.
public  intgetMarginRight()
     Returns the distance (in EMUs) between the right edge of the text frame and the right edge of the inscribed rectangle of the shape that contains the text.
public  intgetMarginTop()
     Returns the distance (in EMUs) between the top of the text frame and the top of the inscribed rectangle of the shape that contains the text.
public  StringgetText()
     Returns the text contained in this text frame.
public  intgetTextId()
    
public  TextRungetTextRun()
    
public  intgetVerticalAlignment()
     Returns the type of vertical alignment for the text.
public  intgetWordWrap()
     Returns the value indicating word wrap.
public  voidresizeToFitText()
     Adjust the size of the TextBox so it encompasses the text inside it.
public  voidsetBackgroundColor(Color color)
     The color used to fill this shape.
public  voidsetHorizontalAlignment(int align)
    
public  voidsetMarginBottom(int margin)
     Sets the botom margin.
public  voidsetMarginLeft(int margin)
     Sets the left margin.
public  voidsetMarginRight(int margin)
     Sets the right margin.
public  voidsetMarginTop(int margin)
     Sets the top margin.
public  voidsetSheet(Sheet sheet)
    
public  voidsetText(String text)
     Sets the text contained in this text frame.
public  voidsetTextId(int id)
    
public  voidsetVerticalAlignment(int align)
     Sets the type of vertical alignment for the text.
public  voidsetWordWrap(int wrap)
    

Field Detail
AlignCenter
final public static int AlignCenter(Code)



AlignJustify
final public static int AlignJustify(Code)



AlignLeft
final public static int AlignLeft(Code)
How to align the text



AlignRight
final public static int AlignRight(Code)



AnchorBottom
final public static int AnchorBottom(Code)



AnchorBottomBaseline
final public static int AnchorBottomBaseline(Code)



AnchorBottomCentered
final public static int AnchorBottomCentered(Code)



AnchorBottomCenteredBaseline
final public static int AnchorBottomCenteredBaseline(Code)



AnchorMiddle
final public static int AnchorMiddle(Code)



AnchorMiddleCentered
final public static int AnchorMiddleCentered(Code)



AnchorTop
final public static int AnchorTop(Code)
How to anchor the text



AnchorTopBaseline
final public static int AnchorTopBaseline(Code)



AnchorTopCentered
final public static int AnchorTopCentered(Code)



AnchorTopCenteredBaseline
final public static int AnchorTopCenteredBaseline(Code)



WrapByPoints
final public static int WrapByPoints(Code)



WrapNone
final public static int WrapNone(Code)



WrapSquare
final public static int WrapSquare(Code)
How to wrap the text



WrapThrough
final public static int WrapThrough(Code)



WrapTopBottom
final public static int WrapTopBottom(Code)



_txtbox
protected EscherTextboxWrapper _txtbox(Code)
Escher container which holds text attributes such as TextHeaderAtom, TextBytesAtom ot TextCharsAtom, StyleTextPropAtom etc.



_txtrun
protected TextRun _txtrun(Code)
Low-level object which holds actual text and format data




Constructor Detail
TextBox
protected TextBox(EscherContainerRecord escherRecord, Shape parent)(Code)
Create a TextBox object and initialize it from the supplied Record container.
Parameters:
  escherRecord - EscherSpContainer container which holds information about this shape
Parameters:
  parent - the parent of the shape



TextBox
public TextBox(Shape parent)(Code)
Create a new TextBox. This constructor is used when a new shape is created.
Parameters:
  parent - the parent of this Shape. For example, if this text box is a cellin a table then the parent is Table.



TextBox
public TextBox()(Code)
Create a new TextBox. This constructor is used when a new shape is created.




Method Detail
afterInsert
protected void afterInsert(Sheet sh)(Code)
When a textbox is added to a sheet we need to tell upper-level PPDrawing about it.
Parameters:
  sh - the sheet we are adding to



createSpContainer
protected EscherContainerRecord createSpContainer(boolean isChild)(Code)
Create a new textBox and initialize internal structures the created EscherContainerRecord which holds shape data



getHorizontalAlignment
public int getHorizontalAlignment()(Code)



getMarginBottom
public int getMarginBottom()(Code)
Returns the distance (in points) between the bottom of the text frame and the bottom of the inscribed rectangle of the shape that contains the text. Default value is 1/20 inch. the botom margin



getMarginLeft
public int getMarginLeft()(Code)
Returns the distance (in EMUs) between the left edge of the text frame and the left edge of the inscribed rectangle of the shape that contains the text. Default value is 1/10 inch. the left margin



getMarginRight
public int getMarginRight()(Code)
Returns the distance (in EMUs) between the right edge of the text frame and the right edge of the inscribed rectangle of the shape that contains the text. Default value is 1/10 inch. the right margin



getMarginTop
public int getMarginTop()(Code)
Returns the distance (in EMUs) between the top of the text frame and the top of the inscribed rectangle of the shape that contains the text. Default value is 1/20 inch. the top margin



getText
public String getText()(Code)
Returns the text contained in this text frame. the text string for this textbox.



getTextId
public int getTextId()(Code)
id for the text.



getTextRun
public TextRun getTextRun()(Code)
the TextRun object for this text box



getVerticalAlignment
public int getVerticalAlignment()(Code)
Returns the type of vertical alignment for the text. One of the Anchor* constants defined in this class. the type of alignment



getWordWrap
public int getWordWrap()(Code)
Returns the value indicating word wrap. One of the Wrap* constants defined in this class. the value indicating word wrap



resizeToFitText
public void resizeToFitText()(Code)
Adjust the size of the TextBox so it encompasses the text inside it.



setBackgroundColor
public void setBackgroundColor(Color color)(Code)
The color used to fill this shape.
Parameters:
  color - the background color



setHorizontalAlignment
public void setHorizontalAlignment(int align)(Code)



setMarginBottom
public void setMarginBottom(int margin)(Code)
Sets the botom margin.
See Also:   TextBox.getMarginBottom()
Parameters:
  margin - the bottom margin



setMarginLeft
public void setMarginLeft(int margin)(Code)
Sets the left margin.
See Also:   TextBox.getMarginLeft()
Parameters:
  margin - the left margin



setMarginRight
public void setMarginRight(int margin)(Code)
Sets the right margin.
See Also:   TextBox.getMarginRight()
Parameters:
  margin - the right margin



setMarginTop
public void setMarginTop(int margin)(Code)
Sets the top margin.
See Also:   TextBox.getMarginTop()
Parameters:
  margin - the top margin



setSheet
public void setSheet(Sheet sheet)(Code)



setText
public void setText(String text)(Code)
Sets the text contained in this text frame.
Parameters:
  text - the text string used by this object.



setTextId
public void setTextId(int id)(Code)
Sets text ID
Parameters:
  id - of the text



setVerticalAlignment
public void setVerticalAlignment(int align)(Code)
Sets the type of vertical alignment for the text. One of the Anchor* constants defined in this class.
Parameters:
  align - - the type of alignment



setWordWrap
public void setWordWrap(int wrap)(Code)
Specifies how the text should be wrapped
Parameters:
  wrap - the value indicating how the text should be wrapped



Methods inherited from org.apache.poi.hslf.model.SimpleShape
protected EscherContainerRecord createSpContainer(boolean isChild)(Code)(Java Doc)
public Color getFillColor()(Code)(Java Doc)
public Color getLineColor()(Code)(Java Doc)
public int getLineDashing()(Code)(Java Doc)
public int getLineStyle()(Code)(Java Doc)
public double getLineWidth()(Code)(Java Doc)
public void setFillColor(Color color)(Code)(Java Doc)
public void setLineColor(Color color)(Code)(Java Doc)
public void setLineDashing(int pen)(Code)(Java Doc)
public void setLineStyle(int style)(Code)(Java Doc)
public void setLineWidth(double width)(Code)(Java Doc)

Fields inherited from org.apache.poi.hslf.model.Shape
final public static int EMU_PER_CENTIMETER(Code)(Java Doc)
final public static int EMU_PER_INCH(Code)(Java Doc)
final public static int EMU_PER_POINT(Code)(Java Doc)
final public static int MASTER_DPI(Code)(Java Doc)
final public static int PIXEL_DPI(Code)(Java Doc)
final public static int POINT_DPI(Code)(Java Doc)
protected EscherContainerRecord _escherContainer(Code)(Java Doc)
protected Shape _parent(Code)(Java Doc)
protected Sheet _sheet(Code)(Java Doc)
protected POILogger logger(Code)(Java Doc)

Methods inherited from org.apache.poi.hslf.model.Shape
protected void afterInsert(Sheet sh)(Code)(Java Doc)
abstract protected EscherContainerRecord createSpContainer(boolean isChild)(Code)(Java Doc)
public java.awt.Rectangle getAnchor()(Code)(Java Doc)
protected Color getColor(int rgb)(Code)(Java Doc)
public static EscherRecord getEscherChild(EscherContainerRecord owner, int recordId)(Code)(Java Doc)
public static EscherProperty getEscherProperty(EscherOptRecord opt, int propId)(Code)(Java Doc)
public Fill getFill()(Code)(Java Doc)
public Hyperlink getHyperlink()(Code)(Java Doc)
public Shape getParent()(Code)(Java Doc)
public String getShapeName()(Code)(Java Doc)
public int getShapeType()(Code)(Java Doc)
public Sheet getSheet()(Code)(Java Doc)
public EscherContainerRecord getSpContainer()(Code)(Java Doc)
public void moveTo(int x, int y)(Code)(Java Doc)
public void setAnchor(java.awt.Rectangle anchor)(Code)(Java Doc)
public static void setEscherProperty(EscherOptRecord opt, short propId, int value)(Code)(Java Doc)
public void setShapeType(int type)(Code)(Java Doc)
public void setSheet(Sheet sheet)(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.