Package org.apache.poi.hwpf.usermodel
Class CharacterRun
java.lang.Object
org.apache.poi.hwpf.usermodel.Range
org.apache.poi.hwpf.usermodel.CharacterRun
- All Implemented Interfaces:
Cloneable
,CharacterRun
This class represents a run of text that share common properties.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected SprmBuffer
protected short
protected CharacterProperties
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
static final short
Fields inherited from class org.apache.poi.hwpf.usermodel.Range
_characters, _charEnd, _charRangeFound, _charStart, _doc, _end, _paragraphs, _parEnd, _parRangeFound, _parStart, _sectionEnd, _sections, _sectionStart, _start, _text, TYPE_CHARACTER, TYPE_LISTENTRY, TYPE_PARAGRAPH, TYPE_SECTION, TYPE_TABLE, TYPE_TEXT, TYPE_UNDEFINED
-
Method Summary
Modifier and TypeMethodDescriptionclone()
Used to create a deep copy of this object.int
int
getColor()
String[]
Gets the fonts which shall be used to display the text contents of this run.int
byte
int
getIco24()
Get the ico24 field for the CHP record.int
int
int
int
short
Returns the index of the base style which applies to this Run.short
char
Returns the symbol character, if this is a symbol character run.Returns the symbol font, if this is a symbol character run.int
int
boolean
isBold()
boolean
boolean
isData()
Does the picture offset represent picture or binary data? If it's set, then the picture offset refers to a NilPICFAndBinData structure, otherwise to a PICFAndOfficeArtDataboolean
boolean
boolean
boolean
boolean
boolean
isItalic()
boolean
boolean
boolean
isObj()
boolean
isOle2()
boolean
boolean
boolean
boolean
boolean
boolean
isSymbol()
Returns true, if the CharacterRun is a special character run containing a symbol, otherwise false.boolean
void
markDeleted
(boolean mark) void
markInserted
(boolean mark) void
setBold
(boolean bold) void
setCapitalized
(boolean caps) void
setCharacterSpacing
(int twips) void
setColor
(int color) void
setData
(boolean data) void
setDoubleStrikethrough
(boolean dstrike) void
setEmbossed
(boolean emboss) void
setFldVanish
(boolean fldVanish) void
setFontSize
(int halfPoints) void
setFtcAscii
(int ftcAscii) void
setFtcFE
(int ftcFE) void
setFtcOther
(int ftcOther) void
setHighlighted
(byte color) void
setIco24
(int colour24) Set the ico24 field for the CHP record.void
setImprinted
(boolean imprint) void
setItalic
(boolean italic) void
setKerning
(int kern) void
setObj
(boolean obj) void
setObjOffset
(int obj) void
setOle2
(boolean ole) void
setOutline
(boolean outlined) void
setPicOffset
(int offset) void
setShadow
(boolean shadow) void
setSmallCaps
(boolean smallCaps) void
setSpecialCharacter
(boolean spec) void
setStrikeThrough
(boolean strike) void
setSubSuperScriptIndex
(short iss) void
setUnderlineCode
(int kul) void
setVanished
(boolean vanish) void
setVerticalOffset
(int hpsPos) void
strikeThrough
(boolean strike) toString()
int
type()
Here for runtime type determination using a switch statement convenient.Methods inherited from class org.apache.poi.hwpf.usermodel.Range
adjustFIB, delete, getCharacterRun, getDocument, getEndOffset, getParagraph, getSection, getStartOffset, getTable, initAll, insertAfter, insertBefore, insertTableBefore, numCharacterRuns, numParagraphs, numSections, replaceText, replaceText, replaceText, reset, sanityCheck, stripFields, text
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.apache.poi.wp.usermodel.CharacterRun
text
-
Field Details
-
SPRM_FRMARKDEL
public static final short SPRM_FRMARKDEL- See Also:
-
SPRM_FRMARK
public static final short SPRM_FRMARK- See Also:
-
SPRM_FFLDVANISH
public static final short SPRM_FFLDVANISH- See Also:
-
SPRM_PICLOCATION
public static final short SPRM_PICLOCATION- See Also:
-
SPRM_IBSTRMARK
public static final short SPRM_IBSTRMARK- See Also:
-
SPRM_DTTMRMARK
public static final short SPRM_DTTMRMARK- See Also:
-
SPRM_FDATA
public static final short SPRM_FDATA- See Also:
-
SPRM_SYMBOL
public static final short SPRM_SYMBOL- See Also:
-
SPRM_FOLE2
public static final short SPRM_FOLE2- See Also:
-
SPRM_HIGHLIGHT
public static final short SPRM_HIGHLIGHT- See Also:
-
SPRM_OBJLOCATION
public static final short SPRM_OBJLOCATION- See Also:
-
SPRM_ISTD
public static final short SPRM_ISTD- See Also:
-
SPRM_FBOLD
public static final short SPRM_FBOLD- See Also:
-
SPRM_FITALIC
public static final short SPRM_FITALIC- See Also:
-
SPRM_FSTRIKE
public static final short SPRM_FSTRIKE- See Also:
-
SPRM_FOUTLINE
public static final short SPRM_FOUTLINE- See Also:
-
SPRM_FSHADOW
public static final short SPRM_FSHADOW- See Also:
-
SPRM_FSMALLCAPS
public static final short SPRM_FSMALLCAPS- See Also:
-
SPRM_FCAPS
public static final short SPRM_FCAPS- See Also:
-
SPRM_FVANISH
public static final short SPRM_FVANISH- See Also:
-
SPRM_KUL
public static final short SPRM_KUL- See Also:
-
SPRM_DXASPACE
public static final short SPRM_DXASPACE- See Also:
-
SPRM_LID
public static final short SPRM_LID- See Also:
-
SPRM_ICO
public static final short SPRM_ICO- See Also:
-
SPRM_HPS
public static final short SPRM_HPS- See Also:
-
SPRM_HPSPOS
public static final short SPRM_HPSPOS- See Also:
-
SPRM_ISS
public static final short SPRM_ISS- See Also:
-
SPRM_HPSKERN
public static final short SPRM_HPSKERN- See Also:
-
SPRM_YSRI
public static final short SPRM_YSRI- See Also:
-
SPRM_RGFTCASCII
public static final short SPRM_RGFTCASCII- See Also:
-
SPRM_RGFTCFAREAST
public static final short SPRM_RGFTCFAREAST- See Also:
-
SPRM_RGFTCNOTFAREAST
public static final short SPRM_RGFTCNOTFAREAST- See Also:
-
SPRM_CHARSCALE
public static final short SPRM_CHARSCALE- See Also:
-
SPRM_FDSTRIKE
public static final short SPRM_FDSTRIKE- See Also:
-
SPRM_FIMPRINT
public static final short SPRM_FIMPRINT- See Also:
-
SPRM_FSPEC
public static final short SPRM_FSPEC- See Also:
-
SPRM_FOBJ
public static final short SPRM_FOBJ- See Also:
-
SPRM_PROPRMARK
public static final short SPRM_PROPRMARK- See Also:
-
SPRM_FEMBOSS
public static final short SPRM_FEMBOSS- See Also:
-
SPRM_SFXTEXT
public static final short SPRM_SFXTEXT- See Also:
-
SPRM_DISPFLDRMARK
public static final short SPRM_DISPFLDRMARK- See Also:
-
SPRM_IBSTRMARKDEL
public static final short SPRM_IBSTRMARKDEL- See Also:
-
SPRM_DTTMRMARKDEL
public static final short SPRM_DTTMRMARKDEL- See Also:
-
SPRM_BRC
public static final short SPRM_BRC- See Also:
-
SPRM_SHD
public static final short SPRM_SHD- See Also:
-
SPRM_IDSIRMARKDEL
public static final short SPRM_IDSIRMARKDEL- See Also:
-
SPRM_CPG
public static final short SPRM_CPG- See Also:
-
SPRM_NONFELID
public static final short SPRM_NONFELID- See Also:
-
SPRM_FELID
public static final short SPRM_FELID- See Also:
-
SPRM_IDCTHINT
public static final short SPRM_IDCTHINT- See Also:
-
_istd
protected short _istd -
_chpx
-
_props
-
-
Method Details
-
type
public int type()Here for runtime type determination using a switch statement convenient.- Returns:
- TYPE_CHARACTER
-
isMarkedDeleted
public boolean isMarkedDeleted() -
markDeleted
public void markDeleted(boolean mark) -
isBold
public boolean isBold()- Specified by:
isBold
in interfaceCharacterRun
-
setBold
public void setBold(boolean bold) - Specified by:
setBold
in interfaceCharacterRun
-
isItalic
public boolean isItalic()- Specified by:
isItalic
in interfaceCharacterRun
-
setItalic
public void setItalic(boolean italic) - Specified by:
setItalic
in interfaceCharacterRun
-
isOutlined
public boolean isOutlined() -
setOutline
public void setOutline(boolean outlined) -
isFldVanished
public boolean isFldVanished() -
setFldVanish
public void setFldVanish(boolean fldVanish) -
isSmallCaps
public boolean isSmallCaps()- Specified by:
isSmallCaps
in interfaceCharacterRun
-
setSmallCaps
public void setSmallCaps(boolean smallCaps) - Specified by:
setSmallCaps
in interfaceCharacterRun
-
isCapitalized
public boolean isCapitalized()- Specified by:
isCapitalized
in interfaceCharacterRun
-
setCapitalized
public void setCapitalized(boolean caps) - Specified by:
setCapitalized
in interfaceCharacterRun
-
isVanished
public boolean isVanished() -
setVanished
public void setVanished(boolean vanish) -
isMarkedInserted
public boolean isMarkedInserted() -
markInserted
public void markInserted(boolean mark) -
isStrikeThrough
public boolean isStrikeThrough()- Specified by:
isStrikeThrough
in interfaceCharacterRun
-
setStrikeThrough
public void setStrikeThrough(boolean strike) - Specified by:
setStrikeThrough
in interfaceCharacterRun
-
strikeThrough
public void strikeThrough(boolean strike) -
isShadowed
public boolean isShadowed()- Specified by:
isShadowed
in interfaceCharacterRun
-
setShadow
public void setShadow(boolean shadow) - Specified by:
setShadow
in interfaceCharacterRun
-
isEmbossed
public boolean isEmbossed()- Specified by:
isEmbossed
in interfaceCharacterRun
-
setEmbossed
public void setEmbossed(boolean emboss) - Specified by:
setEmbossed
in interfaceCharacterRun
-
isImprinted
public boolean isImprinted()- Specified by:
isImprinted
in interfaceCharacterRun
-
setImprinted
public void setImprinted(boolean imprint) - Specified by:
setImprinted
in interfaceCharacterRun
-
isDoubleStrikeThrough
public boolean isDoubleStrikeThrough()- Specified by:
isDoubleStrikeThrough
in interfaceCharacterRun
-
setDoubleStrikethrough
public void setDoubleStrikethrough(boolean dstrike) - Specified by:
setDoubleStrikethrough
in interfaceCharacterRun
-
setFtcAscii
public void setFtcAscii(int ftcAscii) -
setFtcFE
public void setFtcFE(int ftcFE) -
setFtcOther
public void setFtcOther(int ftcOther) -
getFontSize
public int getFontSize()- Specified by:
getFontSize
in interfaceCharacterRun
-
setFontSize
public void setFontSize(int halfPoints) - Specified by:
setFontSize
in interfaceCharacterRun
-
getCharacterSpacing
public int getCharacterSpacing()- Specified by:
getCharacterSpacing
in interfaceCharacterRun
-
setCharacterSpacing
public void setCharacterSpacing(int twips) - Specified by:
setCharacterSpacing
in interfaceCharacterRun
-
getSubSuperScriptIndex
public short getSubSuperScriptIndex() -
setSubSuperScriptIndex
public void setSubSuperScriptIndex(short iss) -
getUnderlineCode
public int getUnderlineCode() -
setUnderlineCode
public void setUnderlineCode(int kul) -
getColor
public int getColor() -
setColor
public void setColor(int color) -
getVerticalOffset
public int getVerticalOffset() -
setVerticalOffset
public void setVerticalOffset(int hpsPos) -
getKerning
public int getKerning()- Specified by:
getKerning
in interfaceCharacterRun
-
setKerning
public void setKerning(int kern) - Specified by:
setKerning
in interfaceCharacterRun
-
isHighlighted
public boolean isHighlighted()- Specified by:
isHighlighted
in interfaceCharacterRun
-
getHighlightedColor
public byte getHighlightedColor() -
setHighlighted
public void setHighlighted(byte color) -
getFontName
Description copied from interface:CharacterRun
Gets the fonts which shall be used to display the text contents of this run. Specifies a font which shall be used to format all "normal" characters in the run- Specified by:
getFontName
in interfaceCharacterRun
- Returns:
- a string representing the font
-
isSpecialCharacter
public boolean isSpecialCharacter() -
setSpecialCharacter
public void setSpecialCharacter(boolean spec) -
isObj
public boolean isObj() -
setObj
public void setObj(boolean obj) -
getPicOffset
public int getPicOffset() -
setPicOffset
public void setPicOffset(int offset) -
isData
public boolean isData()Does the picture offset represent picture or binary data? If it's set, then the picture offset refers to a NilPICFAndBinData structure, otherwise to a PICFAndOfficeArtData -
setData
public void setData(boolean data) -
isOle2
public boolean isOle2() -
setOle2
public void setOle2(boolean ole) -
getObjOffset
public int getObjOffset() -
setObjOffset
public void setObjOffset(int obj) -
getIco24
public int getIco24()Get the ico24 field for the CHP record. -
setIco24
public void setIco24(int colour24) Set the ico24 field for the CHP record. -
clone
Used to create a deep copy of this object.- Overrides:
clone
in classObject
- Returns:
- A deep copy.
- Throws:
CloneNotSupportedException
- never
-
isSymbol
public boolean isSymbol()Returns true, if the CharacterRun is a special character run containing a symbol, otherwise false.In case of a symbol, the
Range.text()
method always returns a single character 0x0028, but word actually stores the character in a different field. UsegetSymbolCharacter()
to get that character andgetSymbolFont()
to determine its font. -
getSymbolCharacter
public char getSymbolCharacter()Returns the symbol character, if this is a symbol character run.- Throws:
IllegalStateException
- If this is not a symbol character run: callisSymbol()
first.- See Also:
-
getSymbolFont
Returns the symbol font, if this is a symbol character run. Might return null, if the font index is not found in the font table.- Throws:
IllegalStateException
- If this is not a symbol character run: callisSymbol()
first.- See Also:
-
getBorder
-
getLanguageCode
public int getLanguageCode() -
getStyleIndex
public short getStyleIndex()Returns the index of the base style which applies to this Run. Details of the style can be looked up from the
StyleSheet
, viaStyleSheet.getStyleDescription(int)
.Note that runs typically override some of the style properties from the base, so normally style information should be fetched directly from the
CharacterRun
itself. -
toString
-
getDropDownListValues
-
getDropDownListDefaultItemIndex
-