Java Doc for TextRun.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.TextRun

TextRun
public class TextRun (Code)
This class represents a run of text in a powerpoint document. That run could be text on a sheet, or text in a note. It is only a very basic class for now
author:
   Nick Burch


Field Summary
protected  TextBytesAtom_byteAtom
    
protected  TextCharsAtom_charAtom
    
protected  TextHeaderAtom_headerAtom
    
protected  boolean_isUnicode
    
protected  Record[]_records
     all text run records that follow TextHeaderAtom.
protected  RichTextRun[]_rtRuns
    
protected  StyleTextPropAtom_styleAtom
    

Constructor Summary
public  TextRun(TextHeaderAtom tha, TextCharsAtom tca, StyleTextPropAtom sta)
    
public  TextRun(TextHeaderAtom tha, TextBytesAtom tba, StyleTextPropAtom sta)
    

Method Summary
public synchronized  voidchangeTextInRichTextRun(RichTextRun run, String s)
    
public synchronized  voidensureStyleAtomPresent()
     Ensure a StyleTextPropAtom is present for this run, by adding if required.
public  Hyperlink[]getHyperlinks()
    
protected  intgetIndex()
    
public  StringgetRawText()
     Returns the raw text content of the run.
public  RichTextRun[]getRichTextRuns()
    
public  intgetRunType()
     Returns the type of the text, from the TextHeaderAtom.
protected  intgetShapeId()
    
public  SheetgetSheet()
    
public  StringgetText()
     Returns the text content of the run, which has been made safe for printing and other use.
protected  voidsetIndex(int id)
    
public  voidsetRunType(int type)
     Changes the type of the text.
protected  voidsetShapeId(int id)
    
public  voidsetSheet(Sheet sheet)
    
public synchronized  voidsetText(String s)
     Changes the text, and sets it all to have the same styling as the the first character has.
public  voidsupplySlideShow(SlideShow ss)
     Supply the SlideShow we belong to.

Field Detail
_byteAtom
protected TextBytesAtom _byteAtom(Code)



_charAtom
protected TextCharsAtom _charAtom(Code)



_headerAtom
protected TextHeaderAtom _headerAtom(Code)



_isUnicode
protected boolean _isUnicode(Code)



_records
protected Record[] _records(Code)
all text run records that follow TextHeaderAtom. (there can be misc InteractiveInfo, TxInteractiveInfo and other records)



_rtRuns
protected RichTextRun[] _rtRuns(Code)



_styleAtom
protected StyleTextPropAtom _styleAtom(Code)




Constructor Detail
TextRun
public TextRun(TextHeaderAtom tha, TextCharsAtom tca, StyleTextPropAtom sta)(Code)
Constructs a Text Run from a Unicode text block
Parameters:
  tha - the TextHeaderAtom that defines what's what
Parameters:
  tca - the TextCharsAtom containing the text
Parameters:
  sta - the StyleTextPropAtom which defines the character stylings



TextRun
public TextRun(TextHeaderAtom tha, TextBytesAtom tba, StyleTextPropAtom sta)(Code)
Constructs a Text Run from a Ascii text block
Parameters:
  tha - the TextHeaderAtom that defines what's what
Parameters:
  tba - the TextBytesAtom containing the text
Parameters:
  sta - the StyleTextPropAtom which defines the character stylings




Method Detail
changeTextInRichTextRun
public synchronized void changeTextInRichTextRun(RichTextRun run, String s)(Code)
Handles an update to the text stored in one of the Rich Text Runs
Parameters:
  run -
Parameters:
  s -



ensureStyleAtomPresent
public synchronized void ensureStyleAtomPresent()(Code)
Ensure a StyleTextPropAtom is present for this run, by adding if required. Normally for internal TextRun use.



getHyperlinks
public Hyperlink[] getHyperlinks()(Code)
Returns the array of all hyperlinks in this text run the array of all hyperlinks in this text runor null if not found.



getIndex
protected int getIndex()(Code)
0-based index of the text run in the SLWT container



getRawText
public String getRawText()(Code)
Returns the raw text content of the run. This hasn't had any changes applied to it, and so is probably unlikely to print out nicely.



getRichTextRuns
public RichTextRun[] getRichTextRuns()(Code)
Fetch the rich text runs (runs of text with the same styling) that are contained within this block of text



getRunType
public int getRunType()(Code)
Returns the type of the text, from the TextHeaderAtom. Possible values can be seen from TextHeaderAtom
See Also:   org.apache.poi.hslf.record.TextHeaderAtom



getShapeId
protected int getShapeId()(Code)
Shape ID



getSheet
public Sheet getSheet()(Code)



getText
public String getText()(Code)
Returns the text content of the run, which has been made safe for printing and other use.



setIndex
protected void setIndex(int id)(Code)

Parameters:
  id - 0-based index of the text run in the SLWT container



setRunType
public void setRunType(int type)(Code)
Changes the type of the text. Values should be taken from TextHeaderAtom. No checking is done to ensure you set this to a valid value!
See Also:   org.apache.poi.hslf.record.TextHeaderAtom



setShapeId
protected void setShapeId(int id)(Code)

Parameters:
  id - Shape ID



setSheet
public void setSheet(Sheet sheet)(Code)



setText
public synchronized void setText(String s)(Code)
Changes the text, and sets it all to have the same styling as the the first character has. If you care about styling, do setText on a RichTextRun instead



supplySlideShow
public void supplySlideShow(SlideShow ss)(Code)
Supply the SlideShow we belong to. Also passes it on to our child RichTextRuns



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.