|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectaspose.pdf.Paragraph
aspose.pdf.Text
public class Text
Represents a text Paragraph
in a Pdf document.
Typical usages are the following:
Nested Class Summary |
---|
Nested classes/interfaces inherited from class aspose.pdf.Paragraph |
---|
Paragraph.VerticalPositionInfo |
Field Summary | |
---|---|
AlignmentType |
BakAlignmentOfRotateText
The alignment of the backup text . |
float |
FirstLineHeight
The height of first line . |
float |
FloatingBoxHeight
The height of FloatingBox. |
float |
FloatingBoxMarginLeft
The Left border distance of the FloatingBox. |
float |
FloatingBoxMarginRight
The right border distance of the FloatingBox. |
float |
FloatingBoxMarginTop
The top border distance of the FloatingBox. |
float |
FloatingBoxPosX
The x-axis starting point for the text box location. |
float |
FloatingBoxPosY
The y-axis starting point for the text box location |
float |
FloatingBoxWidth
The Width of FloatingBox. |
boolean |
HasNonBreakSpace
A boolean value indicates whether it has nonbreak space . |
int |
HowManyLinesOfRotateText
The lines belong to the text . |
boolean |
IsLongWordProcessed
the corresponding substitute of the Text . |
boolean |
IsMarginForBorderAdded
A boolean value indicates whether the marin for border has been added . |
boolean |
IsRtlSegmentModeProcessed
A boolean value indicates whether RTL segment mode has been processed . |
boolean |
IsSegmentsReversed
A boolean value indicates whether the segments has been reversed . |
boolean |
IsSubstitutionNeed
A boolean value indicates whether it is in need of substitution . |
boolean |
IsWidowOrphanControlSet
|
float |
LastLineHeight
The last line height . |
float |
LineHeightOfRotateText
The height of a line . |
float |
RealWidthOfRotateText
The real width of the text . |
float |
ShowLengthOfRotateText
the width of show text . |
TabLeaders |
TabLeaders
The tab Leaders of the text . |
TextLines |
TextLines
Generate a series of TextLine object after doing Branch processing |
Fields inherited from class aspose.pdf.Paragraph |
---|
INNER_INDENT, isNeedAddToPage, isPositionProcessed, RealPageNumber, VerticalPosInfo |
Constructor Summary | |
---|---|
Text()
Initializes a new instance of the Text class. |
|
Text(HeaderFooter hf)
Initializes a new instance of the Text class. |
|
Text(HeaderFooter hf,
java.lang.String content)
Initializes a new instance of the Text class. |
|
Text(Section section)
Initializes a new instance of the Text class. |
|
Text(Section section,
java.lang.String content)
Initializes a new instance of the Text class. |
|
Text(java.lang.String content)
Initializes a new instance of the Text class. |
|
Text(java.lang.String content,
TextInfo info)
Initializes a new instance of the Text class. |
Method Summary | |
---|---|
java.lang.Object |
clone()
Clones a new Text object. |
java.lang.Object |
completeClone()
Clones a new Text object. both format info and content of
the text is cloned. |
float |
getAdditionalHeightForRotating()
Get additional height for rotating . |
Segments |
getBakSegments()
Get the bakSegment object . |
float |
getCurrentFootNoteHeight()
get or set a float value that indicates the total height of all footnotes the current Text has. the default value is 0. |
TabAlignmentType |
getCustomStopAlignmentType()
Get the custom stop alignment type . |
float |
getFirstLineHeight()
Get the height of first line . |
float |
getFirstLineIndent()
Gets an float value that indicates the indent of the first line in a text paragraph.The unit is point. |
FormField |
getformfield()
Gets a FormField object that indicates the FormField this Text contains. |
GraphicState |
getGraphicState()
Gets or sets a GraphicState object that indicates the
graphic state for this text. |
boolean |
getHasFootNote()
get or set a boolean value that indicates if the current Text has footnote. |
boolean |
getHasInline()
If the text has inline paragraph. |
boolean |
getHasInlineImage()
If the text has inline Image paragraph. |
boolean |
getHasInlineRadioButton()
If the text has inline radio paragraph. |
boolean |
getHasNonBreakSpace()
Get a boolean value indicates whether it has nonbreak space . |
boolean |
getHasRightToLeftSeg()
If the text has right-to-left segment |
boolean |
getHasSplitedSegment()
If the text has segment splited from large ones. |
boolean |
getHasTABSymbol()
Get a boolean value indicates whether it has tab symbol . |
java.awt.Color |
getInlineRadioButtonBackgroundColor()
Gets a System.Drawing object that indicates
the color of the inlineRadiobutton's background. |
int |
getInlineRadioButtonCheckedIndex()
Gets a int value that indicates the index of the inlineRadioButton that has been checked. |
java.awt.Color |
getInlineRadioButtonColor()
Gets a System.Drawing object that indicates
the color of the inline radio button. |
java.lang.String |
getInlineRadioButtonFieldName()
Gets a String that indicates the name of inlineRadioButton's the field. |
boolean |
getIsAlignedByWord()
Gets a boolean value that indicates whether the text is aligned by word. |
boolean |
getIsAutoFontAdjustProcessed()
Get a boolean value indicates whether font adjustment has been processed . |
boolean |
getIsAutoHyphenated()
Gets a boolean value that indicates whether the text is hyphenated automatically. |
boolean |
getIsEmpty()
get a boolean value indicates whether it is empty . |
boolean |
getIsHtmlTagSupported()
Gets a boolean value that indicates whether the HTML tags in text is supported. |
boolean |
getIsMacroReProcessed()
Get a boolean value indicates whether Macro has been processed . |
boolean |
getIsNCSymbol()
Get a boolean value indicates whether it is NC symbol . |
boolean |
getIsNeedRepeating()
Gets a boolean value that indicates whether the paragraph need to be repeated on next page. |
boolean |
getIsNPSymbol()
Get a boolean value indicates whether it is next page symbol . |
boolean |
getIsRealRTLText()
Get a boolean value indicates whether it is real RTL text . |
boolean |
getIsSimpleSegment()
Indicates whether the text is SimpleSegment or not. |
boolean |
getIsSpaced()
Gets a boolean value that indicates whether the spaces at the begin of the text and returns in the text be shown. |
boolean |
getIsSymbolProcessed()
Get a boolean value indicates whether the symbols have been processed . |
boolean |
getIsWidowOrphanControlEnabled()
Gets a boolean value that indicates whether the Widow/Orphan control is enabled. |
float |
getLastLineHeight()
Get the last line height . |
float |
getOpacity()
Gets or sets a float value between 0.0 and 1.0 that indicates the opacity of the text. |
float |
getRotatingAngle()
Gets a float value that indicates the number of degrees by which the text should be rotated anticlockwise when displayed or printed. |
Segments |
getSegments()
Gets a Segments collection that indicates all
segments in the text paragraph. |
TabLeaders |
getTabLeaders()
Get the tab Leaders of the text . |
TabStops |
getTabStops()
Gets a TabStops that indicates the tab stop
positions in the text paragraph. |
float |
getTextHeight(Pdf doc,
float width)
Get the height of a text paragraph. |
TextInfo |
getTextInfo()
Gets a TextInfo object that indicates the text info
of the text paragraph. |
float |
getTextWidth()
Gets a float value that indicates the width paragraph.The unit is point. |
int |
getZIndex()
Gets a int value that indicates the Z-order of the text. |
void |
setBackupFirstLineIndent(float value)
Sets an float value to backup the indent of the first line in a text paragraph.The unit is point. |
void |
setBakSegments(Segments bakSegments)
Set the bakSegment object . |
void |
setCurrentFootNoteHeight(float value)
get or set a float value that indicates the total height of all footnotes the current Text has. the default value is 0. |
void |
setCustomStopAlignmentType(TabAlignmentType customStopAlignmentType)
Set the custom stop alignment type . |
void |
setFirstLineHeight(float FirstLineHeight)
Set the height of first line . |
void |
setFirstLineIndent(float value)
Sets an float value that indicates the indent of the first line in a text paragraph.The unit is point. |
void |
setformfield(FormField value)
Sets a FormField object that indicates the FormField this Text contains. |
void |
setHasFootNote(boolean value)
Sets a boolean value that indicates if the current Text has footnote. |
void |
setInlineRadioButtonBackgroundColor(java.awt.Color value)
Sets a System.Drawing object that indicates
the color of the inlineRadiobutton's background. |
void |
setInlineRadioButtonCheckedIndex(int value)
Sets a int value that indicates the index of the inlineRadioButton that has been checked. |
void |
setInlineRadioButtonColor(java.awt.Color value)
Sets a System.Drawing object that indicates
the color of the inline radio button. |
void |
setInlineRadioButtonFieldName(java.lang.String value)
Sets a String that indicates the name of inlineRadioButton's the field. |
void |
setIsAlignedByWord(boolean value)
Sets a boolean value that indicates whether the text is aligned by word. |
void |
setIsAutoFontAdjustProcessed(boolean IsAutoFontAdjustProcessed)
Set a boolean value indicates whether font adjustment has been processed . |
void |
setIsAutoHyphenated(boolean value)
Sets a boolean value that indicates whether the text is hyphenated automatically. |
void |
setIsHtmlTagSupported(boolean value)
Sets a boolean value that indicates whether the HTML tags in text is supported. |
void |
setIsMacroReProcessed(boolean IsMacroReProcessed)
Set a boolean value indicates whether Macro has been processed . |
void |
setIsNCSymbol(boolean isNCSymbol)
Set a boolean value indicates whether it is NC symbol . |
void |
setIsNeedRepeating(boolean value)
Sets a boolean value that indicates whether the paragraph need to be repeated on next page. |
void |
setIsNPSymbol(boolean isNPSymbol)
Set a boolean value indicates whether it is next page symbol . |
void |
setIsRealRTLText(boolean value)
Set a boolean value indicates whether it is real RTL text . |
void |
setIsSimpleSegment(boolean value)
Indicates whether the text is SimpleSegment or not. |
void |
setIsSpaced(boolean value)
Sets a boolean value that indicates whether the spaces at the begin of the text and returns in the text be shown. |
void |
setIsSymbolProcessed(boolean IsSymbolProcessed)
Set a boolean value indicates whether the symbols have been processed . |
void |
setIsWidowOrphanControlEnabled(boolean value)
Sets a boolean value that indicates whether the Widow/Orphan control is enabled. |
void |
setLastLineHeight(float LastLineHeight)
Set the last line height . |
void |
setOpacity(float value)
Gets or sets a float value between 0.0 and 1.0 that indicates the opacity of the text. |
void |
setRotatingAngle(float value)
Sets a float value that indicates the number of degrees by which the text should be rotated anticlockwise when displayed or printed. |
void |
setSegments(Segments value)
Sets a Segments collection that indicates all
segments in the text paragraph. |
void |
setTabLeaders(TabLeaders tabLeaders)
Set the tab Leaders of the text . |
void |
setTabStops(TabStops value)
Sets a TabStops that indicates the tab stop
positions in the text paragraph. |
void |
setTextInfo(TextInfo value)
Sets a TextInfo object that indicates the text info
of the text paragraph. |
void |
setTextWidth(float value)
Sets a float value that indicates the width paragraph.The unit is point. |
void |
setZIndex(int value)
Sets a int value that indicates the Z-order of the text. |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public boolean IsWidowOrphanControlSet
public TabLeaders TabLeaders
public float FloatingBoxHeight
public float FloatingBoxWidth
public float FloatingBoxPosX
public float FloatingBoxPosY
public float FloatingBoxMarginLeft
public float FloatingBoxMarginRight
public float FloatingBoxMarginTop
public boolean IsSubstitutionNeed
public boolean IsMarginForBorderAdded
public float FirstLineHeight
public float LastLineHeight
public boolean IsLongWordProcessed
public TextLines TextLines
public boolean IsSegmentsReversed
public float ShowLengthOfRotateText
public int HowManyLinesOfRotateText
public float LineHeightOfRotateText
public float RealWidthOfRotateText
public AlignmentType BakAlignmentOfRotateText
public boolean HasNonBreakSpace
public boolean IsRtlSegmentModeProcessed
Constructor Detail |
---|
public Text()
Text
class.
public Text(java.lang.String content)
Text
class.
content
- The content of the first segment of the text.public Text(java.lang.String content, TextInfo info)
Text
class.
content
- The content of the first segment of the text.info
- The text format info of the first segment of the text.public Text(Section section)
Text
class.
section
- The specified Section
object.
Remarks: This constructor can inherit common property values from the specified
Section
object.
public Text(Section section, java.lang.String content)
Text
class.
section
- The specified Section
object.content
- The content of the first segment of the text.
Remarks: This constructor can inherit common property values from the specified
Section
object.
public Text(HeaderFooter hf)
Text
class.
hf
- The specified HeaderFooter
object.
Remarks: This constructor can inherit common property values from the specified
HeaderFooter
object.
public Text(HeaderFooter hf, java.lang.String content)
Text
class.
hf
- The specified HeaderFooter
object.content
- The content of the first segment of the text.
Remarks: This constructor can inherit common property values from the specified
HeaderFooter
object.
Method Detail |
---|
public GraphicState getGraphicState()
GraphicState
object that indicates the
graphic state for this text.
public float getOpacity()
public void setOpacity(float value)
public boolean getIsAutoHyphenated()
public void setIsAutoHyphenated(boolean value)
public boolean getHasFootNote()
public void setHasFootNote(boolean value)
public float getCurrentFootNoteHeight()
public void setCurrentFootNoteHeight(float value)
public TextInfo getTextInfo()
TextInfo
object that indicates the text info
of the text paragraph.
public void setTextInfo(TextInfo value)
TextInfo
object that indicates the text info
of the text paragraph.
public TabStops getTabStops()
TabStops
that indicates the tab stop
positions in the text paragraph.
public void setTabStops(TabStops value)
TabStops
that indicates the tab stop
positions in the text paragraph.
public Segments getSegments()
Segments
collection that indicates all
segments in the text paragraph.
public void setSegments(Segments value)
Segments
collection that indicates all
segments in the text paragraph.
public float getFirstLineIndent()
public void setFirstLineIndent(float value)
public void setBackupFirstLineIndent(float value)
public boolean getIsSpaced()
Typical usages are the following:
public void setIsSpaced(boolean value)
Typical usages are the following:
public boolean getIsWidowOrphanControlEnabled()
public void setIsWidowOrphanControlEnabled(boolean value)
public boolean getIsAlignedByWord()
public void setIsAlignedByWord(boolean value)
public float getTextWidth()
Remarks: The property is used for custom positioning. You need not use this property if you want the paragraph be auto aligned.
public void setTextWidth(float value)
Remarks: The property is used for custom positioning. You need not use this property if you want the paragraph be auto aligned.
public TabLeaders getTabLeaders()
public void setTabLeaders(TabLeaders tabLeaders)
public float getRotatingAngle()
Typical usages are the following:
public void setRotatingAngle(float value)
Typical usages are the following:
public boolean getIsNeedRepeating()
public void setIsNeedRepeating(boolean value)
public java.lang.Object completeClone()
Text
object. both format info and content of
the text is cloned.
completeClone
in class Paragraph
Text
object.public java.lang.Object clone()
Text
object. Only format info of the text is cloned.
clone
in class java.lang.Object
Text
objectpublic float getTextHeight(Pdf doc, float width)
doc
- The Pdf
object.width
- The width of the text paragraph.
Remarks: If encryption is used, Pdf.Security should be set before this method.
public boolean getIsNPSymbol()
public void setIsNPSymbol(boolean isNPSymbol)
public boolean getIsNCSymbol()
public void setIsNCSymbol(boolean isNCSymbol)
public boolean getIsHtmlTagSupported()
public void setIsHtmlTagSupported(boolean value)
public boolean getIsSymbolProcessed()
public void setIsSymbolProcessed(boolean IsSymbolProcessed)
public boolean getHasInline()
public boolean getIsEmpty()
public float getFirstLineHeight()
public void setFirstLineHeight(float FirstLineHeight)
public float getLastLineHeight()
public void setLastLineHeight(float LastLineHeight)
public java.lang.String getInlineRadioButtonFieldName()
public void setInlineRadioButtonFieldName(java.lang.String value)
public int getInlineRadioButtonCheckedIndex()
public void setInlineRadioButtonCheckedIndex(int value)
public java.awt.Color getInlineRadioButtonBackgroundColor()
System.Drawing
object that indicates
the color of the inlineRadiobutton's background.
public void setInlineRadioButtonBackgroundColor(java.awt.Color value)
System.Drawing
object that indicates
the color of the inlineRadiobutton's background.
public java.awt.Color getInlineRadioButtonColor()
System.Drawing
object that indicates
the color of the inline radio button.
public void setInlineRadioButtonColor(java.awt.Color value)
System.Drawing
object that indicates
the color of the inline radio button.
public FormField getformfield()
public void setformfield(FormField value)
public boolean getHasInlineRadioButton()
public Segments getBakSegments()
public void setBakSegments(Segments bakSegments)
public float getAdditionalHeightForRotating()
public boolean getHasNonBreakSpace()
public boolean getHasInlineImage()
public boolean getHasTABSymbol()
public boolean getIsSimpleSegment()
public void setIsSimpleSegment(boolean value)
public boolean getIsRealRTLText()
public void setIsRealRTLText(boolean value)
public TabAlignmentType getCustomStopAlignmentType()
public void setCustomStopAlignmentType(TabAlignmentType customStopAlignmentType)
public boolean getHasSplitedSegment()
public boolean getHasRightToLeftSeg()
public int getZIndex()
public void setZIndex(int value)
public boolean getIsAutoFontAdjustProcessed()
public void setIsAutoFontAdjustProcessed(boolean IsAutoFontAdjustProcessed)
public boolean getIsMacroReProcessed()
public void setIsMacroReProcessed(boolean IsMacroReProcessed)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |