Heading

Inheritance: java.lang.Object, com.aspose.pdf.BaseParagraph, com.aspose.pdf.TextFragment

public final class Heading extends TextFragment

Represents heading.

Constructors

Constructor	Description
Heading()	For internal usage only
Heading(int level)	Initializes a new instance of the Cell class.

Methods

Method	Description
getTocPage()	Gets the page that contains this heading.
setTocPage(Page value)	Sets the page that contains this heading.
getTop()	Gets the top Y of this headings(for internal use).
setTop(double value)	sets the top Y of this headings(for internal use).
getStartNumber()	Gets the heading start number.
setStartNumber(int value)	Gets the heading start number.
isAutoSequence()	Gets the heading should be numered automatically.
setAutoSequence(boolean value)	sets the heading should be numered automatically.
isInList()	Gets the heading should be in toc list.
setInList(boolean value)	sets the heading should be in toc list.
getDestinationPage()	Gets the destination page.
setDestinationPage(Page value)	sets the destination page.
getLevel()	Gets the level.
setLevel(int value)	sets the level.
getStyle()	Gets or sets style.
setStyle(int value)	sets or sets style.
getUserLabel()	Gets or sets user label.
setUserLabel(TextSegment value)	Gets or sets user label.
deepClone()	Clone the heading.
cloneWithSegments()	Clone the heading with all segments.

Heading()

public Heading()

For internal usage only

Heading(int level)

public Heading(int level)

Initializes a new instance of the Cell class.

Parameters:

Parameter	Type	Description
level	int	The headings level.

getTocPage()

public Page getTocPage()

Gets the page that contains this heading.

Returns: Page - The page.

setTocPage(Page value)

public void setTocPage(Page value)

Sets the page that contains this heading.

Parameters:

Parameter	Type	Description
value	Page	The page.

getTop()

public double getTop()

Gets the top Y of this headings(for internal use).

Returns: double - The top Y value

setTop(double value)

public void setTop(double value)

sets the top Y of this headings(for internal use).

Parameters:

Parameter	Type	Description
value	double	The top Y value

getStartNumber()

public int getStartNumber()

Gets the heading start number.

Returns: int - Value: The startNumber.

setStartNumber(int value)

public void setStartNumber(int value)

Gets the heading start number.

Value: The startNumber.

Parameters:

Parameter	Type	Description
value	int	The startNumber.

isAutoSequence()

public boolean isAutoSequence()

Gets the heading should be numered automatically.

Returns: boolean - The IsAutoSequens.

setAutoSequence(boolean value)

public void setAutoSequence(boolean value)

sets the heading should be numered automatically.

Parameters:

Parameter	Type	Description
value	boolean	The IsAutoSequens.

isInList()

public boolean isInList()

Gets the heading should be in toc list.

Returns: boolean - The IsInList.

setInList(boolean value)

public void setInList(boolean value)

sets the heading should be in toc list.

Parameters:

Parameter	Type	Description
value	boolean	The IsInList.

getDestinationPage()

public Page getDestinationPage()

Gets the destination page.

Returns: Page - The destination page.

setDestinationPage(Page value)

public void setDestinationPage(Page value)

sets the destination page.

Parameters:

Parameter	Type	Description
value	Page	The destination page.

getLevel()

public int getLevel()

Gets the level.

Returns: int - The heading level.

setLevel(int value)

public void setLevel(int value)

sets the level.

Parameters:

Parameter	Type	Description
value	int	The heading level.

getStyle()

public int getStyle()

Gets or sets style.

Returns: int - The heading style.

setStyle(int value)

public void setStyle(int value)

sets or sets style.

Parameters:

Parameter	Type	Description
value	int	The heading style.

getUserLabel()

public TextSegment getUserLabel()

Gets or sets user label.

Returns: TextSegment - TextSegment object

setUserLabel(TextSegment value)

public void setUserLabel(TextSegment value)

Gets or sets user label.

Parameters:

Parameter	Type	Description
value	TextSegment	TextSegment object

deepClone()

public Object deepClone()

Clone the heading.

Returns: java.lang.Object - The cloned object

cloneWithSegments()

public Object cloneWithSegments()

Clone the heading with all segments.

Returns: java.lang.Object - The cloned object