|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectaspose.pdf.Paragraph
public abstract class Paragraph
Represents a paragraph object.
Nested Class Summary | |
---|---|
class |
Paragraph.VerticalPositionInfo
for Text MarginInfo |
Field Summary | |
---|---|
static int |
INNER_INDENT
|
boolean |
isNeedAddToPage
Indicates whether the paragraph need add to page or not. |
boolean |
isPositionProcessed
Indicates whether the paragraph'position has been processed. |
int |
RealPageNumber
Real PageNumber of the paragraph. |
Paragraph.VerticalPositionInfo |
VerticalPosInfo
Indicates the paragraph's vertical position information. |
Constructor Summary | |
---|---|
Paragraph()
Initializes a new instance of the Paragraph class. |
Method Summary | |
---|---|
abstract java.lang.Object |
completeClone()
|
void |
copyTo(Paragraph par)
|
float |
getHeight()
Gets a float value that indicates the Height of the paragraph |
java.lang.String |
getID()
Gets a String that indicates the ID of the paragraph. |
boolean |
getIsNeedAddToPage()
Gets a boolean value that indicates whether the paragraph need add to page or not. |
boolean |
getIsPositionGot()
Gets a boolean value that indicates whether the paragraph is Position Got |
boolean |
getIsPositionProcessed()
Gets a boolean value that indicates whether the paragraph'position has been processed. |
float |
getLeft()
Gets a float value that indicates the left position of the paragraph. |
MarginInfo |
getMargin()
Get MarginInfo object that indicates the margin info of the paragraph. |
boolean |
getMayNeedReprocess()
Gets a boolean value that indicates whether the paragraph may need be reprocessed or not. |
boolean |
getNeedReprocess()
Gets a boolean value that indicates the paragraph need processing or not. |
Paragraph |
getNextParagraphInHeading()
Gets a Paragraph object that indicates the next paragraph in heading
link. |
int |
getPageNumber()
Gets a int value that indicates the PageNumber of the paragraph. |
Cell |
getParentCell()
get Cell object that indicates the parent cell of the paragraph. |
PositioningType |
getPositioningType()
Get the positioning type for custom positioning. |
float |
getPosX()
Gets a float value that indicates the x-coordinate of the paragraph beginning position. |
float |
getPosY()
Gets a float value that indicates the y-coordinate of the paragraph beginning position. |
int |
getRealPageNumber()
Gets a int value that indicates real PageNumber of the paragraph. |
java.lang.String |
getReferenceParagraphID()
Gets a String that indicates the reference paragraph when using paragraph relative customer positioning. |
Paragraph |
getRefPara()
Gets a Paragraph object that indicates the ref paragraph. |
Section |
getSection()
get Section object that indicates the parent section of the paragraph. |
float |
getTop()
Gets a float value that indicates the top position of the paragraph. |
Paragraph.VerticalPositionInfo |
getVerticalPosInfo()
Gets a VerticalPositionInfo object that indicates the paragraph's vertical position information. |
float |
getWidth()
Gets a float value that indicates the width of the paragraph |
boolean |
isDisabled()
Gets a boolean value that indicates whether this paragraph is disabled. |
boolean |
isEndNote()
get a boolean value that indicates if the current Text is endnote. |
boolean |
isFirstParagraph()
Gets a boolean value that indicates whether the paragraph is the first paragraph of a page. |
boolean |
isFirstParagraphInColumn()
Gets a boolean value that indicates whether the paragraph be the first paragraph of a column. |
boolean |
isFootNote()
get a boolean value that indicates this paragraph is footnote or not. |
boolean |
isFootNoteProcessed()
get a boolean value that indicates the processing of the footnote. |
boolean |
isInHeaderFooter()
Gets a boolean value that indicates whether the paragraph is in Header/Footer |
boolean |
isInList()
Get a boolean value that indicates whether this paragraph is used as a list item. |
boolean |
isKeptTogether()
Gets a boolean value that indicates whether all lines in the paragraph are to remain on the same page. |
boolean |
isKeptWithNext()
Gets a boolean value that indicates whether current paragraph remains in the same page along with next paragraph. |
boolean |
isOnOddPage()
Gets a boolean value that indicates whether this paragraph be shown in odd page only. |
void |
setEndNote(boolean isEndNote)
set a boolean value that indicates if the current Text is endnote. |
void |
setFootNoteProcessed(boolean footNoteProcessed)
set a boolean value that indicates the processing of the footnote. |
void |
setHeight(float paraHeight)
Sets a float value that indicates the Height of the paragraph |
void |
setID(java.lang.String paraID)
Sets a String that indicates the ID of the paragraph. |
void |
setIsDisabled(boolean isDisabled)
Sets a boolean value that indicates whether this paragraph is disabled. |
void |
setIsFirstParagraph(boolean isFirstParagraph)
Sets a boolean value that indicates whether the paragraph is the first paragraph of a page. |
void |
setIsFirstParagraphInColumn(boolean isFirstInColumn)
Sets a boolean value that indicates whether the paragraph be the first paragraph of a column. |
void |
setIsFootNote(boolean isFootNote)
set a boolean value that indicates this paragraph is footnote or not. |
void |
setIsInHeaderFooter(boolean isInHeaderFooter)
Sets a boolean value that indicates whether the paragraph is in Header/Footer |
void |
setIsInList(boolean isInList)
Set a boolean value that indicates whether this paragraph is used as a list item. |
void |
setIsKeptTogether(boolean isKeptTogether)
Sets a boolean value that indicates whether all lines in the paragraph are to remain on the same page. |
void |
setIsKeptWithNext(boolean isKeptWithNext)
Sets a boolean value that indicates whether current paragraph remains in the same page along with next paragraph. |
void |
setIsNeedAddToPage(boolean isNeedAddToPage)
Sets a boolean value that indicates whether the paragraph need add to page or not. |
void |
setIsOnOddPage(boolean isOnOddPage)
Sets a boolean value that indicates whether this paragraph be shown in odd page only. |
void |
setIsPositionGot(boolean isPositionGot)
Sets a boolean value that indicates whether the paragraph is Position Got |
void |
setIsPositionProcessed(boolean isPositionProcessed)
Sets a boolean value that indicates whether the paragraph'position has been processed. |
void |
setLeft(float leftPos)
Sets a float value that indicates the left position of the paragraph. |
void |
setMargin(MarginInfo paragraphMargin)
sets MarginInfo object that indicates the margin info of the paragraph. |
void |
setMayNeedReprocess(boolean mayNeedReprocess)
Sets a boolean value that indicates whether the paragraph may need be reprocessed or not. |
void |
setNeedReprocess(boolean isNeedReprocess)
Sets a boolean value that indicates the paragraph need processing or not. |
void |
setNextParagraphInHeading(Paragraph nextParaInHeading)
Sets a Paragraph object that indicates the next paragraph in heading
link. |
void |
setPageNumber(int paragraphPageNumber)
Sets a int value that indicates the PageNumber of the paragraph. |
void |
setParentCell(Cell parCell)
set a boolean value that indicates the parent cell of the paragraph. |
void |
setParentIsTable(boolean parentIsTable)
set a boolean value that indicates the parent of this paragraph is table. |
void |
setPositioningType(PositioningType posType)
Set the positioning type for custom positioning. |
void |
setPosX(float posX)
sets a float value that indicates the x-coordinate of the paragraph beginning position. |
void |
setPosY(float posY)
Sets a float value that indicates the y-coordinate of the paragraph beginning position. |
void |
setRealPageNumber(int realPageNumber)
Sets a int value that indicates real PageNumber of the paragraph. |
void |
setReferenceParagraphID(java.lang.String refParaID)
Sets a String that indicates the reference paragraph when using paragraph relative customer positioning. |
void |
setRefPara(Paragraph refPara)
Sets a Paragraph object that indicates the ref paragraph. |
void |
setSection(Section parentSection)
set a boolean value that indicates the parent section of the paragraph. |
void |
setTop(float topPos)
Sets a float value that indicates the top position of the paragraph. |
void |
setVerticalPosInfo(Paragraph.VerticalPositionInfo VerticalPosInfo)
Sets a VerticalPositionInfo value that indicates the paragraph's vertical position information. |
void |
setWidth(float paraWidth)
Sets a float value that indicates the width of the paragraph |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int INNER_INDENT
public int RealPageNumber
public boolean isNeedAddToPage
public boolean isPositionProcessed
public Paragraph.VerticalPositionInfo VerticalPosInfo
Constructor Detail |
---|
public Paragraph()
Paragraph
class.
Method Detail |
---|
public abstract java.lang.Object completeClone()
public void setParentIsTable(boolean parentIsTable)
parentIsTable
- public boolean isFootNoteProcessed()
public void setFootNoteProcessed(boolean footNoteProcessed)
footNoteProcessed
- public boolean isFootNote()
public void setIsFootNote(boolean isFootNote)
isFootNote
- public boolean isEndNote()
public void setEndNote(boolean isEndNote)
isEndNote
- public Section getSection()
Section
object that indicates the parent section of the paragraph.
public void setSection(Section parentSection)
parentSection
- public Cell getParentCell()
Cell
object that indicates the parent cell of the paragraph.
public void setParentCell(Cell parCell)
parCell
- public MarginInfo getMargin()
MarginInfo
object that indicates the margin info of the paragraph.
public void setMargin(MarginInfo paragraphMargin)
MarginInfo
object that indicates the margin info of the paragraph.
paragraphMargin
- public float getPosX()
public void setPosX(float posX)
posX
- public float getPosY()
public void setPosY(float posY)
posY
- public float getWidth()
public void setWidth(float paraWidth)
paraWidth
- public float getHeight()
public void setHeight(float paraHeight)
paraHeight
- public int getPageNumber()
public void setPageNumber(int paragraphPageNumber)
paragraphPageNumber
- public int getRealPageNumber()
public void setRealPageNumber(int realPageNumber)
realPageNumber
- public Paragraph getNextParagraphInHeading()
Paragraph
object that indicates the next paragraph in heading
link.
public void setNextParagraphInHeading(Paragraph nextParaInHeading)
Paragraph
object that indicates the next paragraph in heading
link.
nextParaInHeading
- public java.lang.String getID()
public void setID(java.lang.String paraID)
paraID
- public boolean isFirstParagraph()
public void setIsFirstParagraph(boolean isFirstParagraph)
isFirstParagraph
- public boolean isFirstParagraphInColumn()
public void setIsFirstParagraphInColumn(boolean isFirstInColumn)
isFirstInColumn
- public boolean isKeptTogether()
public void setIsKeptTogether(boolean isKeptTogether)
isKeptTogether
- public boolean isKeptWithNext()
public void setIsKeptWithNext(boolean isKeptWithNext)
isKeptWithNext
- public boolean isDisabled()
public void setIsDisabled(boolean isDisabled)
isDisabled
- public boolean isInList()
public void setIsInList(boolean isInList)
isInList
- public boolean isOnOddPage()
public void setIsOnOddPage(boolean isOnOddPage)
isOnOddPage
- public float getLeft()
Remarks: The property is used for custom positioning. You need not use this property if you want the paragraph be auto aligned.
public void setLeft(float leftPos)
leftPos
- public float getTop()
Remarks: The property is used for custom positioning. You need not use this property if you want the paragraph be auto aligned.
public void setTop(float topPos)
Remarks: The property is used for custom positioning. You need not use this property if you want the paragraph be auto aligned.
topPos
- public PositioningType getPositioningType()
public void setPositioningType(PositioningType posType)
posType
- public java.lang.String getReferenceParagraphID()
public void setReferenceParagraphID(java.lang.String refParaID)
refParaID
- public Paragraph getRefPara()
Paragraph
object that indicates the ref paragraph.
public void setRefPara(Paragraph refPara)
Paragraph
object that indicates the ref paragraph.
refPara
- public boolean getNeedReprocess()
public void setNeedReprocess(boolean isNeedReprocess)
isNeedReprocess
- public boolean isInHeaderFooter()
public void setIsInHeaderFooter(boolean isInHeaderFooter)
isInHeaderFooter
- public boolean getIsPositionGot()
public void setIsPositionGot(boolean isPositionGot)
isPositionGot
- public boolean getIsNeedAddToPage()
public void setIsNeedAddToPage(boolean isNeedAddToPage)
isNeedAddToPage
- public boolean getIsPositionProcessed()
public void setIsPositionProcessed(boolean isPositionProcessed)
isPositionProcessed
- public boolean getMayNeedReprocess()
public void setMayNeedReprocess(boolean mayNeedReprocess)
mayNeedReprocess
- public Paragraph.VerticalPositionInfo getVerticalPosInfo()
public void setVerticalPosInfo(Paragraph.VerticalPositionInfo VerticalPosInfo)
VerticalPosInfo
- public void copyTo(Paragraph par)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |