Save This Page
Home » poi-src-3.2-FINAL-20081019 » org.apache » poi » hslf » usermodel » [javadoc | source]
org.apache.poi.hslf.usermodel
public class: RichTextRun [javadoc | source]
java.lang.Object
   org.apache.poi.hslf.usermodel.RichTextRun
Represents a run of text, all with the same style
Field Summary
protected  POILogger logger     
Constructor:
 public RichTextRun(TextRun parent,
    int startAt,
    int len) 
    Create a new wrapper around a (currently not) rich text string
    Parameters:
    parent -
    startAt -
    len -
 public RichTextRun(TextRun parent,
    int startAt,
    int len,
    TextPropCollection pStyle,
    TextPropCollection cStyle,
    boolean pShared,
    boolean cShared) 
    Create a new wrapper around a rich text string
    Parameters:
    parent - The parent TextRun
    startAt - The start position of this run
    len - The length of this run
    pStyle - The paragraph style property collection
    cStyle - The character style property collection
    pShared - The paragraph styles are shared with other runs
    cShared - The character styles are shared with other runs
Method from org.apache.poi.hslf.usermodel.RichTextRun Summary:
_getRawCharacterStyle,   _getRawParagraphStyle,   _isCharacterStyleShared,   _isParagraphStyleShared,   getAlignment,   getBulletChar,   getBulletColor,   getBulletFont,   getBulletOffset,   getBulletSize,   getEndIndex,   getFontColor,   getFontIndex,   getFontName,   getFontSize,   getIndentLevel,   getLength,   getLineSpacing,   getRawText,   getSpaceAfter,   getSpaceBefore,   getStartIndex,   getSuperscript,   getText,   getTextOffset,   isBold,   isBullet,   isBulletHard,   isEmbossed,   isItalic,   isShadowed,   isStrikethrough,   isUnderlined,   setAlignment,   setBold,   setBullet,   setBulletChar,   setBulletColor,   setBulletFont,   setBulletOffset,   setBulletSize,   setCharTextPropVal,   setEmbossed,   setFlag,   setFontColor,   setFontColor,   setFontIndex,   setFontName,   setFontSize,   setIndentLevel,   setItalic,   setLineSpacing,   setParaTextPropVal,   setRawText,   setShadowed,   setSpaceAfter,   setSpaceBefore,   setStrikethrough,   setSuperscript,   setText,   setTextOffset,   setUnderlined,   supplySlideShow,   supplyTextProps,   updateStartPosition
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.poi.hslf.usermodel.RichTextRun Detail:
 public TextPropCollection _getRawCharacterStyle() 
    Internal Use Only - get the underlying character style collection. For normal use, use the friendly setters and getters
 public TextPropCollection _getRawParagraphStyle() 
    Internal Use Only - get the underlying paragraph style collection. For normal use, use the friendly setters and getters
 public boolean _isCharacterStyleShared() 
    Internal Use Only - are the Character styles shared?
 public boolean _isParagraphStyleShared() 
    Internal Use Only - are the Paragraph styles shared?
 public int getAlignment() 
    Returns the type of horizontal alignment for the text. One of the Align* constants defined in the TextBox class.
 public char getBulletChar() 
    Returns the bullet character
 public Color getBulletColor() 
    Returns the bullet color
 public int getBulletFont() 
    Returns the bullet font
 public int getBulletOffset() 
    Returns the bullet offset
 public int getBulletSize() 
    Returns the bullet size
 public int getEndIndex() 
    The ending index, exclusive.
 public Color getFontColor() 
 public int getFontIndex() 
    Gets the font index
 public String getFontName() 
    Gets the font name
 public int getFontSize() 
    Gets the font size
 public int getIndentLevel() 
 public int getLength() 
    Get the length of the text
 public int getLineSpacing() 
    Returns the line spacing

    If linespacing >= 0, then linespacing is a percentage of normal line height. If linespacing < 0, the absolute value of linespacing is the spacing in master coordinates.

 public String getRawText() 
    Fetch the text, in raw storage form
 public int getSpaceAfter() 
    Returns spacing after a paragraph

    If spaceafter >= 0, then spaceafter is a percentage of normal line height. If spaceafter < 0, the absolute value of spaceafter is the spacing in master coordinates.

 public int getSpaceBefore() 
    Returns spacing before a paragraph

    If spacebefore >= 0, then spacebefore is a percentage of normal line height. If spacebefore < 0, the absolute value of spacebefore is the spacing in master coordinates.

 public int getStartIndex() 
    The beginning index, inclusive.
 public int getSuperscript() 
    Gets the subscript/superscript option
 public String getText() 
    Fetch the text, in output suitable form
 public int getTextOffset() 
    Returns the text offset
 public boolean isBold() 
    Is the text bold?
 public boolean isBullet() 
    Returns whether this rich text run has bullets
 public boolean isBulletHard() 
    Returns whether this rich text run has bullets
 public boolean isEmbossed() 
    Is this text embossed?
 public boolean isItalic() 
    Is the text italic?
 public boolean isShadowed() 
    Does the text have a shadow?
 public boolean isStrikethrough() 
    Gets the strikethrough flag
 public boolean isUnderlined() 
    Is the text underlined?
 public  void setAlignment(int align) 
    Sets the type of horizontal alignment for the text. One of the Align* constants defined in the TextBox class.
 public  void setBold(boolean bold) 
    Is the text bold?
 public  void setBullet(boolean flag) 
    Sets whether this rich text run has bullets
 public  void setBulletChar(char c) 
    Sets the bullet character
 public  void setBulletColor(Color color) 
    Sets the bullet color
 public  void setBulletFont(int idx) 
    Sets the bullet font
 public  void setBulletOffset(int offset) 
    Sets the bullet offset
 public  void setBulletSize(int size) 
    Sets the bullet size
 public  void setCharTextPropVal(String propName,
    int val) 
    Sets the value of the given Paragraph TextProp, add if required
 public  void setEmbossed(boolean flag) 
    Is this text embossed?
 public  void setFlag(boolean isCharacter,
    int index,
    boolean value) 
 public  void setFontColor(int bgr) 
    Sets color of the text, as a int bgr. (PowerPoint stores as BlueGreenRed, not the more usual RedGreenBlue)
 public  void setFontColor(Color color) 
    Sets color of the text, as a java.awt.Color
 public  void setFontIndex(int idx) 
    Sets the font index
 public  void setFontName(String fontName) 
    Sets the font name to use
 public  void setFontSize(int fontSize) 
    Sets the font size
 public  void setIndentLevel(int level) 
    Sets indentation level
 public  void setItalic(boolean italic) 
    Is the text italic?
 public  void setLineSpacing(int val) 
    Sets the line spacing.

    If linespacing >= 0, then linespacing is a percentage of normal line height. If linespacing < 0, the absolute value of linespacing is the spacing in master coordinates.

 public  void setParaTextPropVal(String propName,
    int val) 
    Sets the value of the given Character TextProp, add if required
 public  void setRawText(String text) 
    Change the text
 public  void setShadowed(boolean flag) 
    Does the text have a shadow?
 public  void setSpaceAfter(int val) 
    Sets spacing after a paragraph.

    If spaceafter >= 0, then spaceafter is a percentage of normal line height. If spaceafter < 0, the absolute value of spaceafter is the spacing in master coordinates.

 public  void setSpaceBefore(int val) 
    Sets spacing before a paragraph.

    If spacebefore >= 0, then spacebefore is a percentage of normal line height. If spacebefore < 0, the absolute value of spacebefore is the spacing in master coordinates.

 public  void setStrikethrough(boolean flag) 
    Sets the strikethrough flag
 public  void setSuperscript(int val) 
    Sets the subscript/superscript option
 public  void setText(String text) 
    Change the text
 public  void setTextOffset(int offset) 
    Sets the text offset
 public  void setUnderlined(boolean underlined) 
    Is the text underlined?
 public  void supplySlideShow(SlideShow ss) 
    Supply the SlideShow we belong to
 public  void supplyTextProps(TextPropCollection pStyle,
    TextPropCollection cStyle,
    boolean pShared,
    boolean cShared) 
    Supply (normally default) textprops, and if they're shared, when a run gets them
 public  void updateStartPosition(int startAt) 
    Tells the RichTextRun its new position in the parent TextRun