|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.aspose.slides.Paragraph
public final class Paragraph
Represents a paragraph of a text.
Constructor Summary | |
---|---|
Paragraph()
Initializes a new instance of the Paragraph class. |
|
Paragraph(Paragraph para)
Initializes a new instance of the Paragraph class. |
Method Summary | |
---|---|
int |
getAlignment()
Returns or sets the alignment of a paragraph. |
char |
getBulletCharacter()
Returns or sets the character that is used for bullets in the specified text. |
java.awt.Color |
getBulletColor()
|
short |
getBulletColorIndex()
Returns or sets the index of a bullet's color in a color scheme or <b>-1</b> for scheme-independent color. |
int |
getBulletFontIndex()
Returns or sets the font of a bullet. |
short |
getBulletHeight()
Returns or sets the bullet size relative to the size of the first portion in the paragraph. |
short |
getBulletOffset()
Returns or sets the offset of a bullet. |
int |
getBulletType()
Returns or sets the type of a bullet. |
short |
getDepth()
Returns or sets a depth of a paragraph. |
boolean |
getEastAsianLineBreak()
Returns or sets value, which determines if special east asian linebreaking rules will be applied. |
boolean |
getExtendedBullet()
Returns <b>true</b> if paragraph has extended bullets (image or numbered). |
boolean |
getHangingPunctuation()
Returns or sets value, which determines if punctuation which doesn't fit to a line width, won't be carried out to the next line. |
short |
getNumberedBulletStartWith()
Returns or sets the beginning value of a numbered bullet. |
int |
getNumberedBulletStyle()
Returns or sets the style of a numbered bullet. |
short |
getPictureBulletId()
Returns or sets the PictureBullet id. |
PortionCollection |
getPortions()
Returns the collection of a text portions. |
int |
getRawAlignment()
Returns or sets the alignment of a paragraph. |
char |
getRawBulletCharacter()
Returns or sets the character that is used for bullets in the specified text. |
java.awt.Color |
getRawBulletColor()
|
int |
getRawBulletFontIndex()
Returns or sets the font of the bullet. |
short |
getRawBulletHeight()
Returns or sets the bullet size relative to the size of the first portion in the paragraph. |
short |
getRawBulletOffset()
Returns or sets the offset of a bullet. |
short |
getRawEastAsianLineBreak()
Returns or sets value, which determines if special east asian linebreaking rules will be applied. |
short |
getRawHangingPunctuation()
Returns or sets value, which determines if punctuation which doesn't fit to a line width, won't be carried out to the next line. |
short |
getRawNumberedBulletAuto()
Determines whether the bullet is auto numbered bullet. |
short |
getRawNumberedBulletStartWith()
Returns or sets the beginning value of a numbered bullet. |
int |
getRawNumberedBulletStyle()
Returns or sets the style of a numbered bullet. |
short |
getRawPictureBulletId()
Returns or sets the PictureBullet Id. |
short |
getRawSpaceAfter()
Returns or sets the amount of space after the last line in a paragraph, Positive value means space defined in percents of line. |
short |
getRawSpaceBefore()
Returns or sets the amount of space before the first line in a paragraph, Positive value means space defined in percents of line. |
short |
getRawSpaceWithin()
Returns or sets the amount of space between base lines in a paragraph, Positive value means space defined in percents of line. |
short |
getRawTextOffset()
Returns or sets the offset of a text. |
short |
getSpaceAfter()
Returns or sets the amount of space after the last line in the paragraph, Positive value means space defined in percents of line. |
short |
getSpaceBefore()
Returns or sets the amount of space before the first line in the paragraph, Positive value means space defined in percents of line. |
short |
getSpaceWithin()
Returns or sets the amount of space between base lines in the paragraph, Positive value means space defined in percents of line. |
java.lang.String |
getText()
Gets or sets the plain text of a paragraph. |
short |
getTextOffset()
Returns or sets the offset of a text. |
boolean |
hasBullet()
Determines whether the paragraph has a bullet. |
void |
hasBullet(boolean value)
|
boolean |
isBulletHardColor()
Returns <b>true</b> if bullet has own color and
<b>false</b> if bullet uses color of the first portion in a paragraph. |
void |
isBulletHardColor(boolean value)
|
boolean |
isBulletHardFont()
Returns <b>true</b> if bullet has own font and
<b>false</b> if bullet uses font of the first portion in the paragraph. |
void |
isBulletHardFont(boolean value)
|
boolean |
isBulletHardSize()
Returns <b>true</b> if bullet has own size and
<b>false</b> if bullet uses size of the first portion in the paragraph. |
void |
isBulletHardSize(boolean value)
|
void |
setAlignment(int value)
|
void |
setBulletCharacter(char value)
|
void |
setBulletColor(java.awt.Color value)
|
void |
setBulletColorIndex(short value)
|
void |
setBulletFontIndex(int value)
|
void |
setBulletHeight(short value)
|
void |
setBulletOffset(short value)
|
void |
setBulletType(int value)
|
void |
setDepth(short value)
|
void |
setEastAsianLineBreak(boolean value)
|
void |
setHangingPunctuation(boolean value)
|
void |
setNumberedBulletStartWith(short value)
|
void |
setNumberedBulletStyle(int value)
|
void |
setPictureBulletId(short value)
|
void |
setRawAlignment(int value)
|
void |
setRawBulletCharacter(char value)
|
void |
setRawBulletColor(java.awt.Color value)
|
void |
setRawBulletFontIndex(int value)
|
void |
setRawBulletHeight(short value)
|
void |
setRawBulletOffset(short value)
|
void |
setRawEastAsianLineBreak(short value)
|
void |
setRawHangingPunctuation(short value)
|
void |
setRawNumberedBulletAuto(short value)
|
void |
setRawNumberedBulletStartWith(short value)
|
void |
setRawNumberedBulletStyle(int value)
|
void |
setRawPictureBulletId(short value)
|
void |
setRawSpaceAfter(short value)
|
void |
setRawSpaceBefore(short value)
|
void |
setRawSpaceWithin(short value)
|
void |
setRawTextOffset(short value)
|
void |
setSpaceAfter(short value)
|
void |
setSpaceBefore(short value)
|
void |
setSpaceWithin(short value)
|
void |
setText(java.lang.String value)
|
void |
setTextOffset(short value)
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Paragraph()
Initializes a new instance of the Paragraph class.
public Paragraph(Paragraph para)
Initializes a new instance of the Paragraph class.
Method Detail |
---|
public short getDepth()
Returns or sets a depth of a paragraph.
Read/write short
.
public void setDepth(short value)
public boolean hasBullet()
Determines whether the paragraph has a bullet.
Read/write bool
.
public void hasBullet(boolean value)
public boolean isBulletHardColor()
Returns <b>true</b>
if bullet has own color and
<b>false</b>
if bullet uses color of the first portion in a paragraph.
Read/write bool
.
public void isBulletHardColor(boolean value)
public java.awt.Color getBulletColor()
public void setBulletColor(java.awt.Color value)
public short getBulletColorIndex()
Returns or sets the index of a bullet's color in a color scheme or
<b>-1</b>
for scheme-independent color.
Read/write short
public void setBulletColorIndex(short value)
public boolean isBulletHardFont()
Returns <b>true</b>
if bullet has own font and
<b>false</b>
if bullet uses font of the first portion in the paragraph.
Read/write bool
.
public void isBulletHardFont(boolean value)
public int getBulletFontIndex()
Returns or sets the font of a bullet.
Read/write int
.
public void setBulletFontIndex(int value)
public boolean isBulletHardSize()
Returns <b>true</b>
if bullet has own size and
<b>false</b>
if bullet uses size of the first portion in the paragraph.
Read/write bool
.
public void isBulletHardSize(boolean value)
public short getBulletHeight()
Returns or sets the bullet size relative to the size of the first portion
in the paragraph. Can be a short value from 25 through 400, indicating that
the bullet size can be from 25 percent through 400 percent of the text-character
size.
Negative value means bullet height is equal to absolute BulletHeight value and
does not depend on portion's font height.
Read/write short
.
public void setBulletHeight(short value)
public char getBulletCharacter()
Returns or sets the character that is used for bullets in the specified text.
Switches bullet type to Symbol on assigning.
Read/write char
.
public void setBulletCharacter(char value)
public short getSpaceBefore()
Returns or sets the amount of space before the first line in the paragraph,
Positive value means space defined in percents of line.
Values <b>-8</b>
and less should be divided by <b>-8</b>
to obtain space in points.
Read/write short
.
public void setSpaceBefore(short value)
public short getSpaceAfter()
Returns or sets the amount of space after the last line in the paragraph,
Positive value means space defined in percents of line.
Values <b>-8</b>
and less should be divided by <b>-8</b>
to obtain space in points.
Read/write short
.
public void setSpaceAfter(short value)
public short getSpaceWithin()
Returns or sets the amount of space between base lines in the paragraph,
Positive value means space defined in percents of line.
Values <b>-8</b>
and less should be divided by <b>-8</b>
to obtain space in points.
Read/write short
.
public void setSpaceWithin(short value)
public short getBulletOffset()
Returns or sets the offset of a bullet.
Read/write short
.
public void setBulletOffset(short value)
public short getTextOffset()
Returns or sets the offset of a text.
Read/write short
.
public void setTextOffset(short value)
public int getAlignment()
Returns or sets the alignment of a paragraph.
Read/write TextAlignment
.
public void setAlignment(int value)
public boolean getExtendedBullet()
Returns <b>true</b>
if paragraph has extended bullets (image or numbered).
Read-only bool
.
public int getBulletType()
Returns or sets the type of a bullet.
Read/write Aspose.Slides.BulletType
.
public void setBulletType(int value)
public int getNumberedBulletStyle()
Returns or sets the style of a numbered bullet. Value ignored for other types of bullets.
Read/write Aspose.Slides.NumberedBulletStyle
.
public void setNumberedBulletStyle(int value)
public short getNumberedBulletStartWith()
Returns or sets the beginning value of a numbered bullet.
On assigning value greater than 0, switches bullet type to numbered.
Read/Write short
public void setNumberedBulletStartWith(short value)
public short getPictureBulletId()
Returns or sets the PictureBullet id.
<b>-1</b>
for other types of bullets.
public void setPictureBulletId(short value)
public boolean getEastAsianLineBreak()
Returns or sets value, which determines if special east asian linebreaking rules will be applied.
Read/write bool
.
public void setEastAsianLineBreak(boolean value)
public boolean getHangingPunctuation()
Returns or sets value, which determines if punctuation which doesn't fit to a line width, won't be carried out to the next line.
Read/write bool
.
public void setHangingPunctuation(boolean value)
public int getRawAlignment()
Returns or sets the alignment of a paragraph.
TextAlignment.Default means value should be inherited from the master.
Read/write TextAlignment
.
public void setRawAlignment(int value)
public java.awt.Color getRawBulletColor()
public void setRawBulletColor(java.awt.Color value)
public int getRawBulletFontIndex()
Returns or sets the font of the bullet.
<b>-1</b>
means font should be inherited from the master.
Read/write int
.
public void setRawBulletFontIndex(int value)
public short getRawBulletHeight()
Returns or sets the bullet size relative to the size of the first portion
in the paragraph. Can be a short value from 25 through 400, indicating that
the bullet size can be from 25 percent through 400 percent of the text-character
size.
<b>-1</b>
means value should be inherited from the master.
Another negative value means bullet height is equal to absolute RawBulletHeight value
and does not depend on portion's font height.
Read/write short
.
public void setRawBulletHeight(short value)
public char getRawBulletCharacter()
Returns or sets the character that is used for bullets in the specified text.
Switches bullet type to Symbol on assigning.
<b>(char)-1</b>
means value should be inherited from the master.
Read/write char
.
public void setRawBulletCharacter(char value)
public short getRawSpaceBefore()
Returns or sets the amount of space before the first line in a paragraph,
Positive value means space defined in percents of line.
Values <b>-8</b>
and lesser should be divided by <b>-8</b>
to obtain space in points.
<b>-1</b>
means value should be inherited from the master.
Read/write short
.
public void setRawSpaceBefore(short value)
public short getRawSpaceAfter()
Returns or sets the amount of space after the last line in a paragraph,
Positive value means space defined in percents of line.
Values <b>-8</b>
and lesser should be divided by <b>-8</b>
to obtain space in points.
<b>-1</b>
means value should be inherited from the master.
Read/write short
.
public void setRawSpaceAfter(short value)
public short getRawSpaceWithin()
Returns or sets the amount of space between base lines in a paragraph,
Positive value means space defined in percents of line.
Values <b>-8</b>
and lesser should be divided by <b>-8</b>
to obtain space in points.
<b>-1</b>
means value should be inherited from the master.
Read/write short
.
public void setRawSpaceWithin(short value)
public short getRawBulletOffset()
Returns or sets the offset of a bullet.
<b>-1</b>
means value should be inherited from the ruler or the master.
Read/write short
.
public void setRawBulletOffset(short value)
public short getRawTextOffset()
Returns or sets the offset of a text.
<b>-1</b>
means value should be inherited from the ruler or the master.
Read/write short
.
public void setRawTextOffset(short value)
public short getRawNumberedBulletAuto()
Determines whether the bullet is auto numbered bullet.
<b>-1</b>
means value should be inherited from the ruler or the master.
Read/write <b>short</b>
.
public void setRawNumberedBulletAuto(short value)
public int getRawNumberedBulletStyle()
Returns or sets the style of a numbered bullet.
NumberedBulletStyle.BulletDefault means value should be inherited from the master.
Read/write NumberedBulletStyle
.
public void setRawNumberedBulletStyle(int value)
public short getRawNumberedBulletStartWith()
Returns or sets the beginning value of a numbered bullet.
<b>-1</b>
means value should be inherited from the master.
Read/Write short
public void setRawNumberedBulletStartWith(short value)
public short getRawPictureBulletId()
Returns or sets the PictureBullet Id.
Read/Write short
-1 | paragraph doesn't have picture bullet. |
-2 | value should be inherited from the master. |
public void setRawPictureBulletId(short value)
public short getRawEastAsianLineBreak()
Returns or sets value, which determines if special east asian linebreaking rules will be applied.
Read/write short
.
1 | use EA line break rules. |
0 | don't use EA line break rules. |
-1 | use inherited value. |
public void setRawEastAsianLineBreak(short value)
public short getRawHangingPunctuation()
Returns or sets value, which determines if punctuation which doesn't fit to a line width, won't be carried out to the next line.
Read/write short
.
1 | leave punctuation on same line. |
0 | carry punctuation to the next line. |
-1 | use inherited value. |
public void setRawHangingPunctuation(short value)
public PortionCollection getPortions()
Returns the collection of a text portions.
Read-only Aspose.Slides.PortionCollection
.
public java.lang.String getText()
Gets or sets the plain text of a paragraph.
Value: The text.
public void setText(java.lang.String value)
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |