|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectaspose.pdf.Paragraph
aspose.pdf.Text
aspose.pdf.Heading
public class Heading
Represents a heading in Pdf document.
Typical usages are the following:
Nested Class Summary |
---|
Nested classes/interfaces inherited from class aspose.pdf.Paragraph |
---|
Paragraph.VerticalPositionInfo |
Field Summary |
---|
Fields inherited from class aspose.pdf.Paragraph |
---|
INNER_INDENT, isNeedAddToPage, isPositionProcessed, RealPageNumber, VerticalPosInfo |
Constructor Summary | |
---|---|
Heading()
Constructor - initializes a new instance of the Heading class. |
|
Heading(Pdf pdf,
Section section,
int level)
Constructor - initializes a new instance of the Heading class. |
Method Summary | |
---|---|
java.lang.Object |
clone()
Clones a new Heading object. |
java.lang.Object |
completeClone()
Clones a new Heading object. |
float |
getBakLabelWidth()
Gets a float value that indicates the heading's label width. |
AlignmentType |
getBulletAlignment()
Deprecated. This function is now obsolete. You should use getLabelAlignment() to get the alignment type of Bullet/Label. |
Color |
getBulletColor()
Deprecated. This function is now obsolete. You should use getLabelColor() to set the color of bullet/label. |
java.lang.String |
getBulletFontName()
Deprecated. This function is now obsolete. You should use getLabelFontName() to get the font name for bullet. |
java.lang.String |
getBulletTTFFile()
Gets a String that indicates the truetype font file name for the bullet. |
java.lang.String |
getCaptionLebel()
Deprecated. This function is now obsolete. You should use Label to get the caption label. |
HeadingType |
getHeadingType()
Gets a HeadingType object for this heading. |
Image |
getImageLabel()
Gets the Image used as label. |
boolean |
getIsAutoHyphenated()
Gets or sets a boolean value that indicates whether the text is hyphenated automatically. |
boolean |
getIsAutoSequence()
Gets a boolean value that indicates whether the number of the heading is in an automatic sequence. |
boolean |
getIsBulletUnicode()
Deprecated. This function is now obsolete. You should use getIsLabelUnicode() to get whether the bullet/Label uses a unicode character. |
boolean |
getIsInBookmark()
Gets a boolean value that indicates whether heading is shown in bookmark. |
boolean |
getIsLabelBold()
Gets a boolean value that indicates whether the number of the heading is bold. |
boolean |
getIsLabelItalic()
Gets a boolean value that indicates whether the number of the heading is italic. |
boolean |
getIsLabelUnderline()
Gets a boolean value that indicates whether the number of the heading is underline. |
boolean |
getIsLabelUnicode()
Gets a boolean value that indicates whether the bullet/Label uses a unicode character. |
boolean |
getIsOnlyLebel()
Gets a boolean value that indicates whether the heading is only for label. |
boolean |
getIsPrefixed()
Gets a boolean value that indicates if the prefix of the number is shown when using auto sequence. |
boolean |
getIsRTLHeading()
Gets a boolean value indicates whether heading is RTL format. |
java.lang.String |
getLabel()
Gets or sets an string value that indicates the user-defined heading label. |
AlignmentType |
getLabelAlignment()
Gets an AlignmentType object that indicates the
alignment type of Bullet/Label. |
Color |
getLabelColor()
Gets a Color object that indicates the color of the
bullet/label. |
java.lang.String |
getLabelFontName()
Gets a String value that indicates the font name of label. |
float |
getLabelFontSize()
Gets a float value that indicates the font size of label. |
java.lang.String |
getLabelPattern()
Gets the heading pattern in the "ch(s)%ch(s)" form, ch(s) can be none ,an ASCII or a combination of ASCIIs, % stands for the heading number. |
float |
getLabelWidth()
Gets a float value that indicates the width of the label of the heading. |
int |
getLevel()
Gets an int value that indicates the level of the heading. |
NumberArr |
getNumberArray()
Gets a NumberArr object that indicates the heading number array. |
Heading |
getPreHeading()
Gets the previous Heading object. |
float |
getRightMarginPosX()
Gets a float value that indicates the heading's right margin position. |
int |
getStartNumber()
Gets an int number that indicates the start number of this heading when using auto numbering. |
java.lang.String |
getUserLabel()
Deprecated. This function is now obsolete. You should use getLabel() to get the user label. |
void |
setBakLabelWidth(float bakLabelWidth)
Sets a float value that indicates the heading's label width. |
void |
setBulletAlignment(AlignmentType value)
Deprecated. This function is now obsolete. You should use setLabelAlignment() to set the alignment type of Bullet/Label. |
void |
setBulletColor(Color value)
Deprecated. This function is now obsolete. You should use setLabelColor() to set the color of bullet/label. |
void |
setBulletFontName(java.lang.String value)
Deprecated. This property is now obsolete. You should use setLabelFontName() to set the font name for bullet. |
void |
setBulletTTFFile(java.lang.String value)
Sets a String that indicates the truetype font file name for the bullet. |
void |
setCaptionLebel(java.lang.String value)
Deprecated. This function is now obsolete. You should use Label to set the caption label. |
void |
setHeadingType(HeadingType value)
Sets a HeadingType object for this heading. |
void |
setImageLabel(Image value)
Sets an Image object used as label. |
void |
setIsAutoSequence(boolean value)
Sets a boolean value that indicates whether the number of the heading is in an automatic sequence. |
void |
setIsBulletUnicode(boolean value)
Deprecated. This function is now obsolete. You should use setIsLabelUnicode() to set whether the bullet/Label uses a unicode character. |
void |
setIsInBookmark(boolean value)
Sets a boolean value that indicates whether heading is shown in bookmark. |
void |
setIsLabelBold(boolean value)
Sets a boolean value that indicates whether the number of the heading is bold. |
void |
setIsLabelItalic(boolean value)
Sets a boolean value that indicates whether the number of the heading is italic. |
void |
setIsLabelUnderline(boolean value)
Sets a boolean value that indicates whether the number of the heading is underline. |
void |
setIsLabelUnicode(boolean value)
Sets a boolean value that indicates whether the bullet/Label uses a unicode character. |
void |
setIsOnlyLebel(boolean isOnlyLebel)
Sets a boolean value that indicates whether the heading is only for label. |
void |
setIsPrefixed(boolean value)
Sets a boolean value that indicates if the prefix of the number is shown when using auto sequence. |
void |
setIsRTLHeading(boolean isRTLHeading)
Sets a boolean value indicates whether heading is RTL format. |
void |
setLabel(java.lang.String value)
Sets an string value that indicates the user-defined heading label. |
void |
setLabelAlignment(AlignmentType value)
Sets an AlignmentType object that indicates the
alignment type of Bullet/Label. |
void |
setLabelColor(Color value)
Sets a Color object that indicates the color of the
bullet/label. |
void |
setLabelFontName(java.lang.String value)
Sets a String value that indicates the font name of label. |
void |
setLabelFontSize(float value)
Sets a float value that indicates the font size of label. |
void |
setLabelPattern(java.lang.String value)
Sets the heading pattern in the "ch(s)%ch(s)" form, ch(s) can be none, an ASCII or a combination of ASCIIs, % stands for the heading number. |
void |
setLabelWidth(float value)
Sets a float value that indicates the width of the label of the heading. |
void |
setLevel(int value)
Sets an int value that indicates the level of the heading. |
void |
setNumberArray(NumberArr value)
Sets a NumberArr object that indicates the heading number array. |
void |
setPdf(Pdf value)
Sets a Pdf object that contains the heading. |
void |
setPreHeading(Heading value)
Gets the previous Heading object. |
void |
setRightMarginPosX(float RightMarginPosX)
Sets a float value that indicates the heading's right margin position. |
void |
setStartNumber(int value)
Sets an int number that indicates the start number of this heading when using auto numbering. |
void |
setUserLabel(java.lang.String value)
Deprecated. This property is now obsolete. You should use setLabel() to set the user label. |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Heading()
Heading
class.
public Heading(Pdf pdf, Section section, int level)
Heading
class.
Remarks: This constructor can inherit common property values from
the specified Section
object.
pdf
- The specified Pdf
object.section
- The specified Section
object.level
- The heading level.Method Detail |
---|
public boolean getIsAutoHyphenated()
getIsAutoHyphenated
in class Text
public NumberArr getNumberArray()
NumberArr
object that indicates the heading number array.
NumberArr
public void setNumberArray(NumberArr value)
NumberArr
object that indicates the heading number array.
value
- A NumberArr
object.public int getLevel()
public void setLevel(int value)
value
- An int value.public java.lang.String getLabel()
public void setLabel(java.lang.String value)
value
- A String value.public java.lang.String getCaptionLebel()
public void setCaptionLebel(java.lang.String value)
public float getLabelWidth()
public void setLabelWidth(float value)
value
- A float value.public Color getLabelColor()
Color
object that indicates the color of the
bullet/label.
Color
object.public void setLabelColor(Color value)
Color
object that indicates the color of the
bullet/label.
value
- A Color
objectpublic AlignmentType getLabelAlignment()
AlignmentType
object that indicates the
alignment type of Bullet/Label.
AlignmentType
object.public void setLabelAlignment(AlignmentType value)
AlignmentType
object that indicates the
alignment type of Bullet/Label.
value
- An AlignmentType
object.public AlignmentType getBulletAlignment()
AlignmentType
object that indicates the alignment type of
Bullet/Label.
AlignmentType
object.public void setBulletAlignment(AlignmentType value)
value
- An AlignmentType
object.public Color getBulletColor()
Color
object that indicates the color of the bullet/label.
Color
object.public void setBulletColor(Color value)
value
- A Color
object.public boolean getIsLabelBold()
public void setIsLabelBold(boolean value)
value
- A boolean value.public boolean getIsLabelItalic()
public void setIsLabelItalic(boolean value)
value
- A boolean value.public boolean getIsLabelUnderline()
public void setIsLabelUnderline(boolean value)
value
- A boolean value.public java.lang.String getLabelFontName()
public void setLabelFontName(java.lang.String value)
value
- A String value.public float getLabelFontSize()
public void setLabelFontSize(float value)
value
- A float value.public boolean getIsAutoSequence()
public void setIsAutoSequence(boolean value)
value
- A boolean value.public void setPdf(Pdf value)
Pdf
object that contains the heading.
value
- A Pdf
object.public HeadingType getHeadingType()
HeadingType
object for this heading.
HeadingType
object.public void setHeadingType(HeadingType value)
HeadingType
object for this heading.
value
- A HeadingType
object.public java.lang.String getUserLabel()
public void setUserLabel(java.lang.String value)
setBulletFontName(String)
to "Symbol" and "ZapfDingbats" and set this property to the char value of
the bullt symbol. For example,setUserlabel("44") and setBulletFontName("ZapfDingbats")
value
- A String value.public void setImageLabel(Image value)
Image
object used as label. If ImageLabel is not
null, the ImageLabel substitutes for number heading. The size of the
ImageLabel will be adjusted following the Segment.getTextInfo().setFontSize().
value
- An Image
object.public Image getImageLabel()
Image
object.public void setLabelPattern(java.lang.String value)
value
- A String value.public java.lang.String getLabelPattern()
public Heading getPreHeading()
Heading
object.
Heading
object.public void setPreHeading(Heading value)
Heading
object.
value
- An Heading
object.public java.lang.String getBulletFontName()
public void setBulletFontName(java.lang.String value)
value
- A String value.public boolean getIsBulletUnicode()
public void setIsBulletUnicode(boolean value)
value
- A boolean value.public boolean getIsLabelUnicode()
public void setIsLabelUnicode(boolean value)
value
- A boolean value.public java.lang.String getBulletTTFFile()
public void setBulletTTFFile(java.lang.String value)
value
- A String value.public boolean getIsInBookmark()
public void setIsInBookmark(boolean value)
value
- A boolean value.public int getStartNumber()
public void setStartNumber(int value)
value
- An int value.public boolean getIsPrefixed()
public void setIsPrefixed(boolean value)
value
- A boolean value.public java.lang.Object clone()
Heading
object. Only format info of the Heading is cloned.
clone
in class Text
Heading
object.public java.lang.Object completeClone()
Heading
object. Both format info and content of the Heading is
cloned.
completeClone
in class Text
Heading
object.public boolean getIsOnlyLebel()
public void setIsOnlyLebel(boolean isOnlyLebel)
isOnlyLebel
- A boolean value.public float getBakLabelWidth()
public void setBakLabelWidth(float bakLabelWidth)
public float getRightMarginPosX()
public void setRightMarginPosX(float RightMarginPosX)
RightMarginPosX
- A float value.public boolean getIsRTLHeading()
public void setIsRTLHeading(boolean isRTLHeading)
isRTLHeading
- A boolean value.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |