org.apache.poi.sl.usermodel
Interface TextShape<S extends Shape<S,P>,P extends TextParagraph<S,P,?>>
- All Superinterfaces:
- IAdjustableShape, java.lang.Iterable<P>, PlaceableShape<S,P>, Shape<S,P>, SimpleShape<S,P>
- All Known Subinterfaces:
- AutoShape<S,P>, FreeformShape<S,P>, Line<S,P>, TableCell<S,P>, TextBox<S,P>
- All Known Implementing Classes:
- HSLFAutoShape, HSLFFreeformShape, HSLFLine, HSLFTableCell, HSLFTextBox, HSLFTextShape, Placeholder, Polygon, XSLFAutoShape, XSLFFreeformShape, XSLFTableCell, XSLFTextBox, XSLFTextShape
public interface TextShape<S extends Shape<S,P>,P extends TextParagraph<S,P,?>>
- extends SimpleShape<S,P>, java.lang.Iterable<P>
Methods inherited from interface java.lang.Iterable |
iterator |
getTextParagraphs
java.util.List<? extends TextParagraph<S,P,?>> getTextParagraphs()
- Returns:
- the TextParagraphs for this text box
getInsets
Insets2D getInsets()
- Returns:
- text shape margin
getTextHeight
double getTextHeight()
- Compute the cumulative height occupied by the text
getVerticalAlignment
VerticalAlignment getVerticalAlignment()
- Returns the type of vertical alignment for the text.
- Returns:
- the type of vertical alignment
isHorizontalCentered
boolean isHorizontalCentered()
- Returns if the text is centered.
If true and if the individual paragraph settings allow it,
the whole text block will be displayed centered, i.e. its left and right
margin will be maximized while still keeping the alignment of the paragraphs
- Returns:
- true, if the text anchor is horizontal centered
getWordWrap
boolean getWordWrap()
- Returns:
- whether to wrap words within the bounding rectangle
getTextDirection
TextShape.TextDirection getTextDirection()
- Returns:
- vertical orientation of the text
Copyright 2015 The Apache Software Foundation or
its licensors, as applicable.