|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectaspose.pdf.Segment
public class Segment
Represents a collection of Segment
objects.
Typical usages are the following:
Nested Class Summary | |
---|---|
class |
Segment.VerticalSegInfo
for Text MarginInfo |
Field Summary | |
---|---|
boolean |
isEmptySegInHeading
A boolean value indicates whether heading is empty. |
boolean |
IsEndNoteNumber
Indicates whether it is end note number. |
boolean |
IsFootNumber
A boolean value indicates whether it is foot number. |
boolean |
isNBSegment
A boolean value indicates whether it is a NB segment. |
boolean |
isPositionGot
A boolean value indicates whether the position has been gotten . |
boolean |
isTABSymbol
A boolean value indicates whether it is a TAB symbol. |
java.lang.String |
TargetID
The ID of target . |
Segment.VerticalSegInfo |
VerticalSegPosInfo
The vertical segment position information . |
Constructor Summary | |
---|---|
Segment()
Initializes a new instance of the Segment class. |
|
Segment(java.lang.String content)
Initializes a new instance of the Segment class. |
|
Segment(java.lang.String content,
TextInfo info)
Initializes a new instance of the Segment class. |
|
Segment(Text text)
Initializes a new instance of the Segment class. |
Method Summary | |
---|---|
java.lang.Object |
completeClone()
Clones a new Segment object. |
java.lang.String |
getContent()
Gets a string that indicates the content of the text segment. |
java.lang.String |
getDateFormat()
Gets or sets a String that indicates the date format of the replaceable date symbol($D). |
java.lang.String |
getDefaultFontName()
Gets or sets a String that indicates the default font supports segment.Content. |
float |
getDescender()
Get the descender object of the segment. |
EndNote |
getEndNote()
get or set the EndNote object that indicates the end note of the current segment. |
LineBlock |
getFirstLineBlock()
Get the first line block object. |
FootNote |
getFootNote()
get or set the FootNote object that indicates the footnote of the current segment. |
boolean |
getHasRTLChar()
Get a value that indicates whether the segment has Arabic or Hebrew character |
boolean |
getHaveFootNoteNumberInfo()
Gets a boolean value that indicates whether the text have footnote number information. |
float |
getHeight()
Gets a float value that indicates the height of the segment. |
Hyperlink |
getHyperlink()
Gets a Hyperlink object that indicates the hyper
link info of the segment. |
java.lang.String |
getID()
Gets or sets a String that indicates the ID of the segment. |
Paragraph |
getInlineParagraph()
Gets or sets a Paragraph object that indicates the inline paragraph. |
boolean |
getIsAutoHyphenated()
Gets a boolean value that indicates whether the text is hyphenated automatically. |
boolean |
getIsFootNumber()
Get the IsFootNumber object indicates whether it is foot number. |
boolean |
getIsHyphenatable()
Gets a boolean value that indicates whether the segment is can be hyphenated.If the hyphenchar can not be inserted when hyphenating this word,it is false. |
boolean |
getIsNBSSymbol()
Get a boolean value indicates whether it is a NBS symbol. |
boolean |
getIsNLSymbol()
Get a boolean value indicates whether it is a NL symbol. |
boolean |
getIsPageNumSymbol()
Get a boolean value indicates whether it is a page number symbol. |
boolean |
getIsRefPageNumSymbol()
Get a boolean value indicates whether it is a page reference number symbol. |
boolean |
getIsSectionPageNumSymbol()
Get a boolean value indicates whether it is a section page number symbol. |
boolean |
getIsSplitedFromLargeSeg()
Get a boolean value indicates whether it is splited from a large segment. |
boolean |
getIsSymbol()
Get a boolean value indicates whether it is symbol. |
boolean |
getIsSymbolReplaceable()
Gets or sets a boolean value that indicates whether a symbol like $p is replaceable or not. |
java.lang.String |
getIsTogetherWithInlineImage()
Gets or sets a String that indicates whether the segment combine with Inline Image |
boolean |
getIsTotalPageNumSymbol()
Get a boolean value indicates whether it is a total page number symbol. |
boolean |
getIsTotalSectionNextPageNumSymbol()
Get a boolean value indicates whether it is a total section next page number symbol. |
boolean |
getIsTotalSectionPageNumSymbol()
Get a boolean value indicates whether it is a total section page number symbol. |
int |
getNextSegmentsUnderline()
Get the next segments underline object . |
int |
getPageNumber()
Get the pageNumber object . |
float |
getPosX()
Gets or sets a float value that indicates the x-coordinate of the segment beginning position. |
float |
getPosY()
Gets a float value that indicates the y-coordinate of the segment beginning position. |
TabLeaderType |
getTabLeaderType()
Get the tabLeaderType object |
TextInfo |
getTextInfo()
Gets a TextInfo object that indicates the text info
of the segment. |
int |
getTogetherSegNumbers()
Get a int value indicates the numbers of together segments |
float |
getWidth()
Gets or sets a float value that indicates the width of the segment. |
boolean |
IsNumeric()
Whether the segment is numeric |
void |
setContent(java.lang.String value)
Sets a string that indicates the content of the text segment. |
void |
setDateFormat(java.lang.String value)
Gets or sets a String that indicates the date format of the replaceable date symbol($D). |
void |
setDefaultFontName(java.lang.String value)
Gets or sets a String that indicates the default font supports segment.Content. |
void |
setDescender(float descender)
Set the descender object of the segment. |
void |
setEndNote(EndNote value)
get or set the EndNote object that indicates the end note of the current segment. |
void |
setFirstLineBlock(LineBlock value)
Set the first line block object. |
void |
setFootNote(FootNote value)
get or set the FootNote object that indicates the footnote of the current segment. |
void |
setHaveFootNoteNumberInfo(boolean value)
sets a boolean value that indicates whether the text have footnote number information. |
void |
setHeight(float value)
Sets a float value that indicates the height of the segment. |
void |
setHyperlink(Hyperlink value)
Sets a Hyperlink object that indicates the hyper
link info of the segment. |
void |
setID(java.lang.String value)
Gets or sets a String that indicates the ID of the segment. |
void |
setInlineParagraph(Paragraph value)
Gets or sets a Paragraph object that indicates the inline paragraph. |
void |
setIsAutoHyphenated(boolean value)
sets a boolean value that indicates whether the text is hyphenated automatically. |
void |
setIsFootNumber(boolean isFootNumber)
Set the IsFootNumber object indicates whether it is foot number. |
void |
setIsHyphenatable(boolean value)
sets a boolean value that indicates whether the segment is can be hyphenated.If the hyphenchar can not be inserted when hyphenating this word,it is false. |
void |
setIsNBSSymbol(boolean isNBSSymbol)
Set a boolean value indicates whether it is a NBS symbol. |
void |
setIsNLSymbol(boolean isNLSymbol)
Set a boolean value indicates whether it is a NL symbol. |
void |
setIsPageNumSymbol(boolean value)
Set a boolean value indicates whether it is a page number symbol. |
void |
setIsRefPageNumSymbol(boolean isRefPageNumSymbol)
Set a boolean value indicates whether it is a page reference number symbol. |
void |
setIsSectionPageNumSymbol(boolean isSectionPageNumSymbol)
Set a boolean value indicates whether it is a section page number symbol. |
void |
setIsSplitedFromLargeSeg(boolean isSplitedFromLargeSeg)
Set a boolean value indicates whether it is splited from a large segment. |
void |
setIsSymbol(boolean isSymbol)
Set a boolean value indicates whether it is symbol. |
void |
setIsSymbolReplaceable(boolean value)
Gets or sets a boolean value that indicates whether a symbol like $p is replaceable or not. |
void |
setIsTotalPageNumSymbol(boolean isTotalPageNumSymbol)
Set a boolean value indicates whether it is a total page number symbol. |
void |
setIsTotalSectionNextPageNumSymbol(boolean IsTotalSectionNextPageNumSymbol)
Set a boolean value indicates whether it is a total section next page number symbol. |
void |
setIsTotalSectionPageNumSymbol(boolean isTotalSectionPageNumSymbol)
Set a boolean value indicates whether it is a total section page number symbol. |
void |
setLanguageSort(java.lang.String value)
set a String that indicates the sort of the language. |
void |
setNextSegmentsUnderline(int NextSegmentsUnderline)
Set the next segments underline object . |
void |
setPageNumber(int pageNumber)
Set the pageNumber object . |
void |
setPosX(float value)
Gets or sets a float value that indicates the x-coordinate of the segment beginning position. |
void |
setPosY(float value)
Sets a float value that indicates the y-coordinate of the segment beginning position. |
void |
setTabLeaderType(TabLeaderType tabLeaderType)
Set the tabLeaderType object |
void |
setTextInfo(TextInfo value)
Sets a TextInfo object that indicates the text info
of the segment. |
void |
setTogetherSegNumber(int togetherNum)
Set a int value indicates the numbers of together segments |
void |
setWidth(float value)
Gets or sets a float value that indicates the width of the segment. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public boolean IsFootNumber
public boolean IsEndNoteNumber
public boolean isEmptySegInHeading
public boolean isTABSymbol
public boolean isNBSegment
public boolean isPositionGot
public java.lang.String TargetID
public Segment.VerticalSegInfo VerticalSegPosInfo
Constructor Detail |
---|
public Segment()
Segment
class.
public Segment(java.lang.String content)
Segment
class.
content
- The content of the segment.public Segment(java.lang.String content, TextInfo info)
Segment
class.
content
- The content of the segment.info
- The text format info of the segment.public Segment(Text text)
Segment
class.
text
-
Remarks:This constructor can inherit common property values from the specified
Text
object.
Method Detail |
---|
public boolean getHaveFootNoteNumberInfo()
public void setHaveFootNoteNumberInfo(boolean value)
public boolean getIsAutoHyphenated()
public void setIsAutoHyphenated(boolean value)
public boolean getIsHyphenatable()
public void setIsHyphenatable(boolean value)
public TextInfo getTextInfo()
TextInfo
object that indicates the text info
of the segment.
public void setTextInfo(TextInfo value)
TextInfo
object that indicates the text info
of the segment.
public FootNote getFootNote()
public void setFootNote(FootNote value)
public EndNote getEndNote()
public void setEndNote(EndNote value)
public boolean getIsFootNumber()
public void setIsFootNumber(boolean isFootNumber)
public java.lang.String getContent()
public void setContent(java.lang.String value)
value
- public java.lang.String getDateFormat()
public void setDateFormat(java.lang.String value)
public float getHeight()
public void setHeight(float value)
value
- public float getPosY()
public void setPosY(float value)
value
- public boolean getIsSymbolReplaceable()
public void setIsSymbolReplaceable(boolean value)
public java.lang.String getID()
public void setID(java.lang.String value)
public LineBlock getFirstLineBlock()
public void setFirstLineBlock(LineBlock value)
public Hyperlink getHyperlink()
Hyperlink
object that indicates the hyper
link info of the segment.
public void setHyperlink(Hyperlink value)
Hyperlink
object that indicates the hyper
link info of the segment.
value
- public java.lang.Object completeClone()
Segment
object. All members are cloned.
Segment
object.public Paragraph getInlineParagraph()
Paragraph
object that indicates the inline paragraph.
If this property is set, the segment become the inline paragraph of Text
and the Content
is disabled. Image
, Graph
, FormField
and
Attachment
can be used as inline paragraph.
Typical usages are the following:
public void setInlineParagraph(Paragraph value)
Paragraph
object that indicates the inline paragraph.
If this property is set, the segment become the inline paragraph of Text
and the Content
is disabled. Image
, Graph
, FormField
and
Attachment
can be used as inline paragraph.
Typical usages are the following:
public float getDescender()
public void setDescender(float descender)
public int getNextSegmentsUnderline()
public void setNextSegmentsUnderline(int NextSegmentsUnderline)
public int getPageNumber()
public void setPageNumber(int pageNumber)
public java.lang.String getIsTogetherWithInlineImage()
public boolean getIsSymbol()
public void setIsSymbol(boolean isSymbol)
public boolean getIsPageNumSymbol()
public void setIsPageNumSymbol(boolean value)
public boolean getIsRefPageNumSymbol()
public void setIsRefPageNumSymbol(boolean isRefPageNumSymbol)
public boolean getIsSectionPageNumSymbol()
public void setIsSectionPageNumSymbol(boolean isSectionPageNumSymbol)
public boolean getIsTotalPageNumSymbol()
public void setIsTotalPageNumSymbol(boolean isTotalPageNumSymbol)
public boolean getIsTotalSectionPageNumSymbol()
public void setIsTotalSectionPageNumSymbol(boolean isTotalSectionPageNumSymbol)
public boolean getIsTotalSectionNextPageNumSymbol()
public void setIsTotalSectionNextPageNumSymbol(boolean IsTotalSectionNextPageNumSymbol)
public boolean getIsNBSSymbol()
public void setIsNBSSymbol(boolean isNBSSymbol)
public boolean getIsNLSymbol()
public void setIsNLSymbol(boolean isNLSymbol)
public boolean IsNumeric()
public float getWidth()
public void setWidth(float value)
public float getPosX()
public void setPosX(float value)
public TabLeaderType getTabLeaderType()
public void setTabLeaderType(TabLeaderType tabLeaderType)
public boolean getIsSplitedFromLargeSeg()
public void setIsSplitedFromLargeSeg(boolean isSplitedFromLargeSeg)
public int getTogetherSegNumbers()
public void setTogetherSegNumber(int togetherNum)
public boolean getHasRTLChar()
public java.lang.String getDefaultFontName()
public void setDefaultFontName(java.lang.String value)
public void setLanguageSort(java.lang.String value)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |