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


java.lang.Object
   org.apache.poi.hwpf.usermodel.Range
      org.apache.poi.hwpf.usermodel.CharacterRun

CharacterRun
public class CharacterRun extends Range implements Cloneable(Code)
This class represents a run of text that share common properties.
author:
   Ryan Ackley


Field Summary
final public static  shortSPRM_BRC
    
final public static  shortSPRM_CHARSCALE
    
final public static  shortSPRM_CPG
    
final public static  shortSPRM_DISPFLDRMARK
    
final public static  shortSPRM_DTTMRMARK
    
final public static  shortSPRM_DTTMRMARKDEL
    
final public static  shortSPRM_DXASPACE
    
final public static  shortSPRM_FBOLD
    
final public static  shortSPRM_FCAPS
    
final public static  shortSPRM_FDATA
    
final public static  shortSPRM_FDSTRIKE
    
final public static  shortSPRM_FELID
    
final public static  shortSPRM_FEMBOSS
    
final public static  shortSPRM_FFLDVANISH
    
final public static  shortSPRM_FIMPRINT
    
final public static  shortSPRM_FITALIC
    
final public static  shortSPRM_FOBJ
    
final public static  shortSPRM_FOLE2
    
final public static  shortSPRM_FOUTLINE
    
final public static  shortSPRM_FRMARK
    
final public static  shortSPRM_FRMARKDEL
    
final public static  shortSPRM_FSHADOW
    
final public static  shortSPRM_FSMALLCAPS
    
final public static  shortSPRM_FSPEC
    
final public static  shortSPRM_FSTRIKE
    
final public static  shortSPRM_FVANISH
    
final public static  shortSPRM_HIGHLIGHT
    
final public static  shortSPRM_HPS
    
final public static  shortSPRM_HPSKERN
    
final public static  shortSPRM_HPSPOS
    
final public static  shortSPRM_IBSTRMARK
    
final public static  shortSPRM_IBSTRMARKDEL
    
final public static  shortSPRM_ICO
    
final public static  shortSPRM_IDCTHINT
    
final public static  shortSPRM_IDSIRMARKDEL
    
final public static  shortSPRM_ISS
    
final public static  shortSPRM_ISTD
    
final public static  shortSPRM_KUL
    
final public static  shortSPRM_LID
    
final public static  shortSPRM_NONFELID
    
final public static  shortSPRM_OBJLOCATION
    
final public static  shortSPRM_PICLOCATION
    
final public static  shortSPRM_PROPRMARK
    
final public static  shortSPRM_RGFTCASCII
    
final public static  shortSPRM_RGFTCFAREAST
    
final public static  shortSPRM_RGFTCNOTFAREAST
    
final public static  shortSPRM_SFXTEXT
    
final public static  shortSPRM_SHD
    
final public static  shortSPRM_SYMBOL
    
final public static  shortSPRM_YSRI
    
 SprmBuffer_chpx
    
 CharacterProperties_props
    

Constructor Summary
 CharacterRun(CHPX chpx, StyleSheet ss, short istd, Range parent)
    

Method Summary
public  Objectclone()
     Used to create a deep copy of this object.
public  CharacterPropertiescloneProperties()
    
public  intgetCharacterSpacing()
    
public  intgetColor()
    
public  StringgetFontName()
    
public  intgetFontSize()
    
public  intgetIco24()
     Get the ico24 field for the CHP record.
public  intgetKerning()
    
public  intgetObjOffset()
    
public  intgetPicOffset()
    
public  shortgetSubSuperScriptIndex()
    
public  intgetUnderlineCode()
    
public  intgetVerticalOffset()
    
public  booleanisBold()
    
public  booleanisCapitalized()
    
public  booleanisData()
    
public  booleanisDoubleStrikeThrough()
    
public  booleanisEmbossed()
    
public  booleanisFldVanished()
    
public  booleanisHighlighted()
    
public  booleanisImprinted()
    
public  booleanisItalic()
    
public  booleanisMarkedDeleted()
    
public  booleanisMarkedInserted()
    
public  booleanisObj()
    
public  booleanisOle2()
    
public  booleanisOutlined()
    
public  booleanisShadowed()
    
public  booleanisSmallCaps()
    
public  booleanisSpecialCharacter()
    
public  booleanisStrikeThrough()
    
public  booleanisVanished()
    
public  voidmarkDeleted(boolean mark)
    
public  voidmarkInserted(boolean mark)
    
public  voidsetBold(boolean bold)
    
public  voidsetCapitalized(boolean caps)
    
public  voidsetCharacterSpacing(int twips)
    
public  voidsetColor(int color)
    
public  voidsetData(boolean data)
    
public  voidsetDoubleStrikethrough(boolean dstrike)
    
public  voidsetEmbossed(boolean emboss)
    
public  voidsetFldVanish(boolean fldVanish)
    
public  voidsetFontSize(int halfPoints)
    
public  voidsetFtcAscii(int ftcAscii)
    
public  voidsetFtcFE(int ftcFE)
    
public  voidsetFtcOther(int ftcOther)
    
public  voidsetHighlighted(byte color)
    
public  voidsetIco24(int colour24)
     Set the ico24 field for the CHP record.
public  voidsetImprinted(boolean imprint)
    
public  voidsetItalic(boolean italic)
    
public  voidsetKerning(int kern)
    
public  voidsetObj(boolean obj)
    
public  voidsetObjOffset(int obj)
    
public  voidsetOle2(boolean ole)
    
public  voidsetOutline(boolean outlined)
    
public  voidsetPicOffset(int offset)
    
public  voidsetShadow(boolean shadow)
    
public  voidsetSmallCaps(boolean smallCaps)
    
public  voidsetSpecialCharacter(boolean spec)
    
public  voidsetSubSuperScriptIndex(short iss)
    
public  voidsetUnderlineCode(int kul)
    
public  voidsetVanished(boolean vanish)
    
public  voidsetVerticalOffset(int hpsPos)
    
public  voidstrikeThrough(boolean strike)
    
public  inttype()
     Here for runtime type determination using a switch statement convenient.

Field Detail
SPRM_BRC
final public static short SPRM_BRC(Code)



SPRM_CHARSCALE
final public static short SPRM_CHARSCALE(Code)



SPRM_CPG
final public static short SPRM_CPG(Code)



SPRM_DISPFLDRMARK
final public static short SPRM_DISPFLDRMARK(Code)



SPRM_DTTMRMARK
final public static short SPRM_DTTMRMARK(Code)



SPRM_DTTMRMARKDEL
final public static short SPRM_DTTMRMARKDEL(Code)



SPRM_DXASPACE
final public static short SPRM_DXASPACE(Code)



SPRM_FBOLD
final public static short SPRM_FBOLD(Code)



SPRM_FCAPS
final public static short SPRM_FCAPS(Code)



SPRM_FDATA
final public static short SPRM_FDATA(Code)



SPRM_FDSTRIKE
final public static short SPRM_FDSTRIKE(Code)



SPRM_FELID
final public static short SPRM_FELID(Code)



SPRM_FEMBOSS
final public static short SPRM_FEMBOSS(Code)



SPRM_FFLDVANISH
final public static short SPRM_FFLDVANISH(Code)



SPRM_FIMPRINT
final public static short SPRM_FIMPRINT(Code)



SPRM_FITALIC
final public static short SPRM_FITALIC(Code)



SPRM_FOBJ
final public static short SPRM_FOBJ(Code)



SPRM_FOLE2
final public static short SPRM_FOLE2(Code)



SPRM_FOUTLINE
final public static short SPRM_FOUTLINE(Code)



SPRM_FRMARK
final public static short SPRM_FRMARK(Code)



SPRM_FRMARKDEL
final public static short SPRM_FRMARKDEL(Code)



SPRM_FSHADOW
final public static short SPRM_FSHADOW(Code)



SPRM_FSMALLCAPS
final public static short SPRM_FSMALLCAPS(Code)



SPRM_FSPEC
final public static short SPRM_FSPEC(Code)



SPRM_FSTRIKE
final public static short SPRM_FSTRIKE(Code)



SPRM_FVANISH
final public static short SPRM_FVANISH(Code)



SPRM_HIGHLIGHT
final public static short SPRM_HIGHLIGHT(Code)



SPRM_HPS
final public static short SPRM_HPS(Code)



SPRM_HPSKERN
final public static short SPRM_HPSKERN(Code)



SPRM_HPSPOS
final public static short SPRM_HPSPOS(Code)



SPRM_IBSTRMARK
final public static short SPRM_IBSTRMARK(Code)



SPRM_IBSTRMARKDEL
final public static short SPRM_IBSTRMARKDEL(Code)



SPRM_ICO
final public static short SPRM_ICO(Code)



SPRM_IDCTHINT
final public static short SPRM_IDCTHINT(Code)



SPRM_IDSIRMARKDEL
final public static short SPRM_IDSIRMARKDEL(Code)



SPRM_ISS
final public static short SPRM_ISS(Code)



SPRM_ISTD
final public static short SPRM_ISTD(Code)



SPRM_KUL
final public static short SPRM_KUL(Code)



SPRM_LID
final public static short SPRM_LID(Code)



SPRM_NONFELID
final public static short SPRM_NONFELID(Code)



SPRM_OBJLOCATION
final public static short SPRM_OBJLOCATION(Code)



SPRM_PICLOCATION
final public static short SPRM_PICLOCATION(Code)



SPRM_PROPRMARK
final public static short SPRM_PROPRMARK(Code)



SPRM_RGFTCASCII
final public static short SPRM_RGFTCASCII(Code)



SPRM_RGFTCFAREAST
final public static short SPRM_RGFTCFAREAST(Code)



SPRM_RGFTCNOTFAREAST
final public static short SPRM_RGFTCNOTFAREAST(Code)



SPRM_SFXTEXT
final public static short SPRM_SFXTEXT(Code)



SPRM_SHD
final public static short SPRM_SHD(Code)



SPRM_SYMBOL
final public static short SPRM_SYMBOL(Code)



SPRM_YSRI
final public static short SPRM_YSRI(Code)



_chpx
SprmBuffer _chpx(Code)



_props
CharacterProperties _props(Code)




Constructor Detail
CharacterRun
CharacterRun(CHPX chpx, StyleSheet ss, short istd, Range parent)(Code)

Parameters:
  chpx - The chpx this object is based on.
Parameters:
  ss - The stylesheet for the document this run belongs to.
Parameters:
  istd - The style index if this run's base style.
Parameters:
  parent - The parent range of this character run (usually a paragraph).




Method Detail
clone
public Object clone() throws CloneNotSupportedException(Code)
Used to create a deep copy of this object. A deep copy.
throws:
  CloneNotSupportedException - never



cloneProperties
public CharacterProperties cloneProperties()(Code)
clone the CharacterProperties object associated with this characterRun so that you can apply it to another CharacterRun



getCharacterSpacing
public int getCharacterSpacing()(Code)



getColor
public int getColor()(Code)



getFontName
public String getFontName()(Code)



getFontSize
public int getFontSize()(Code)



getIco24
public int getIco24()(Code)
Get the ico24 field for the CHP record.



getKerning
public int getKerning()(Code)



getObjOffset
public int getObjOffset()(Code)



getPicOffset
public int getPicOffset()(Code)



getSubSuperScriptIndex
public short getSubSuperScriptIndex()(Code)



getUnderlineCode
public int getUnderlineCode()(Code)



getVerticalOffset
public int getVerticalOffset()(Code)



isBold
public boolean isBold()(Code)



isCapitalized
public boolean isCapitalized()(Code)



isData
public boolean isData()(Code)



isDoubleStrikeThrough
public boolean isDoubleStrikeThrough()(Code)



isEmbossed
public boolean isEmbossed()(Code)



isFldVanished
public boolean isFldVanished()(Code)



isHighlighted
public boolean isHighlighted()(Code)



isImprinted
public boolean isImprinted()(Code)



isItalic
public boolean isItalic()(Code)



isMarkedDeleted
public boolean isMarkedDeleted()(Code)



isMarkedInserted
public boolean isMarkedInserted()(Code)



isObj
public boolean isObj()(Code)



isOle2
public boolean isOle2()(Code)



isOutlined
public boolean isOutlined()(Code)



isShadowed
public boolean isShadowed()(Code)



isSmallCaps
public boolean isSmallCaps()(Code)



isSpecialCharacter
public boolean isSpecialCharacter()(Code)



isStrikeThrough
public boolean isStrikeThrough()(Code)



isVanished
public boolean isVanished()(Code)



markDeleted
public void markDeleted(boolean mark)(Code)



markInserted
public void markInserted(boolean mark)(Code)



setBold
public void setBold(boolean bold)(Code)



setCapitalized
public void setCapitalized(boolean caps)(Code)



setCharacterSpacing
public void setCharacterSpacing(int twips)(Code)



setColor
public void setColor(int color)(Code)



setData
public void setData(boolean data)(Code)



setDoubleStrikethrough
public void setDoubleStrikethrough(boolean dstrike)(Code)



setEmbossed
public void setEmbossed(boolean emboss)(Code)



setFldVanish
public void setFldVanish(boolean fldVanish)(Code)



setFontSize
public void setFontSize(int halfPoints)(Code)



setFtcAscii
public void setFtcAscii(int ftcAscii)(Code)



setFtcFE
public void setFtcFE(int ftcFE)(Code)



setFtcOther
public void setFtcOther(int ftcOther)(Code)



setHighlighted
public void setHighlighted(byte color)(Code)



setIco24
public void setIco24(int colour24)(Code)
Set the ico24 field for the CHP record.



setImprinted
public void setImprinted(boolean imprint)(Code)



setItalic
public void setItalic(boolean italic)(Code)



setKerning
public void setKerning(int kern)(Code)



setObj
public void setObj(boolean obj)(Code)



setObjOffset
public void setObjOffset(int obj)(Code)



setOle2
public void setOle2(boolean ole)(Code)



setOutline
public void setOutline(boolean outlined)(Code)



setPicOffset
public void setPicOffset(int offset)(Code)



setShadow
public void setShadow(boolean shadow)(Code)



setSmallCaps
public void setSmallCaps(boolean smallCaps)(Code)



setSpecialCharacter
public void setSpecialCharacter(boolean spec)(Code)



setSubSuperScriptIndex
public void setSubSuperScriptIndex(short iss)(Code)



setUnderlineCode
public void setUnderlineCode(int kul)(Code)



setVanished
public void setVanished(boolean vanish)(Code)



setVerticalOffset
public void setVerticalOffset(int hpsPos)(Code)



strikeThrough
public void strikeThrough(boolean strike)(Code)



type
public int type()(Code)
Here for runtime type determination using a switch statement convenient. TYPE_CHARACTER



Fields inherited from org.apache.poi.hwpf.usermodel.Range
final public static int TYPE_CHARACTER(Code)(Java Doc)
final public static int TYPE_LISTENTRY(Code)(Java Doc)
final public static int TYPE_PARAGRAPH(Code)(Java Doc)
final public static int TYPE_SECTION(Code)(Java Doc)
final public static int TYPE_TABLE(Code)(Java Doc)
final public static int TYPE_TEXT(Code)(Java Doc)
final public static int TYPE_UNDEFINED(Code)(Java Doc)
protected int _charEnd(Code)(Java Doc)
protected boolean _charRangeFound(Code)(Java Doc)
protected int _charStart(Code)(Java Doc)
protected List _characters(Code)(Java Doc)
protected HWPFDocument _doc(Code)(Java Doc)
protected int _end(Code)(Java Doc)
protected int _parEnd(Code)(Java Doc)
protected boolean _parRangeFound(Code)(Java Doc)
protected int _parStart(Code)(Java Doc)
protected List _paragraphs(Code)(Java Doc)
protected int _sectionEnd(Code)(Java Doc)
boolean _sectionRangeFound(Code)(Java Doc)
protected int _sectionStart(Code)(Java Doc)
protected List _sections(Code)(Java Doc)
protected int _start(Code)(Java Doc)
protected List _text(Code)(Java Doc)
protected int _textEnd(Code)(Java Doc)
protected boolean _textRangeFound(Code)(Java Doc)
protected int _textStart(Code)(Java Doc)

Methods inherited from org.apache.poi.hwpf.usermodel.Range
public void delete()(Code)(Java Doc)
public CharacterRun getCharacterRun(int index)(Code)(Java Doc)
public Paragraph getParagraph(int index)(Code)(Java Doc)
public Section getSection(int index)(Code)(Java Doc)
public Table getTable(Paragraph paragraph)(Code)(Java Doc)
protected void initAll()(Code)(Java Doc)
public CharacterRun insertAfter(String text)(Code)(Java Doc)
public CharacterRun insertAfter(String text, CharacterProperties props)(Code)(Java Doc)
public Paragraph insertAfter(ParagraphProperties props, int styleIndex)(Code)(Java Doc)
protected Paragraph insertAfter(ParagraphProperties props, int styleIndex, String text)(Code)(Java Doc)
public ListEntry insertAfter(ParagraphProperties props, int listID, int level, int styleIndex)(Code)(Java Doc)
public CharacterRun insertBefore(String text)(Code)(Java Doc)
public CharacterRun insertBefore(String text, CharacterProperties props)(Code)(Java Doc)
public Paragraph insertBefore(ParagraphProperties props, int styleIndex)(Code)(Java Doc)
protected Paragraph insertBefore(ParagraphProperties props, int styleIndex, String text)(Code)(Java Doc)
public Table insertBefore(TableProperties props, int rows)(Code)(Java Doc)
public ListEntry insertBefore(ParagraphProperties props, int listID, int level, int styleIndex)(Code)(Java Doc)
public int numCharacterRuns()(Code)(Java Doc)
public int numParagraphs()(Code)(Java Doc)
public int numSections()(Code)(Java Doc)
public String text()(Code)(Java Doc)
public int type()(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.