Package org.apache.poi.wp.usermodel
Interface CharacterRun
- All Known Implementing Classes:
CharacterRun,XWPFFieldRun,XWPFHyperlinkRun,XWPFRun
public interface CharacterRun
This class represents a run of text that share common properties.
-
Method Summary
Modifier and TypeMethodDescriptionintGets the fonts which shall be used to display the text contents of this run.intintbooleanisBold()booleanbooleanbooleanbooleanbooleanbooleanisItalic()booleanbooleanbooleanvoidsetBold(boolean bold) voidsetCapitalized(boolean caps) voidsetCharacterSpacing(int twips) voidsetDoubleStrikethrough(boolean dstrike) voidsetEmbossed(boolean emboss) voidsetFontSize(int halfPoints) voidsetImprinted(boolean imprint) voidsetItalic(boolean italic) voidsetKerning(int kern) voidsetShadow(boolean shadow) voidsetSmallCaps(boolean smallCaps) voidsetStrikeThrough(boolean strike) text()
-
Method Details
-
isBold
boolean isBold() -
setBold
void setBold(boolean bold) -
isItalic
boolean isItalic() -
setItalic
void setItalic(boolean italic) -
isSmallCaps
boolean isSmallCaps() -
setSmallCaps
void setSmallCaps(boolean smallCaps) -
isCapitalized
boolean isCapitalized() -
setCapitalized
void setCapitalized(boolean caps) -
isStrikeThrough
boolean isStrikeThrough() -
setStrikeThrough
void setStrikeThrough(boolean strike) -
isDoubleStrikeThrough
boolean isDoubleStrikeThrough() -
setDoubleStrikethrough
void setDoubleStrikethrough(boolean dstrike) -
isShadowed
boolean isShadowed() -
setShadow
void setShadow(boolean shadow) -
isEmbossed
boolean isEmbossed() -
setEmbossed
void setEmbossed(boolean emboss) -
isImprinted
boolean isImprinted() -
setImprinted
void setImprinted(boolean imprint) -
getFontSize
int getFontSize() -
setFontSize
void setFontSize(int halfPoints) -
getCharacterSpacing
int getCharacterSpacing() -
setCharacterSpacing
void setCharacterSpacing(int twips) -
getKerning
int getKerning() -
setKerning
void setKerning(int kern) -
isHighlighted
boolean isHighlighted() -
getFontName
String getFontName()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- Returns:
- a string representing the font
-
text
String text()- Returns:
- The text of the run, including any tabs/spaces/etc
-