|
|||||||||
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 the 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 | |
---|---|
boolean |
equalFormatting(Paragraph para)
Determines whether the paragraphs have the same formatting. |
int |
getAlignment()
Returns the alignment of a paragraph. |
char |
getBulletCharacter()
Returns the character which is used for a paragraph's bullet. |
java.awt.Color |
getBulletColor()
Returns the color of a paragraph's bullet. |
short |
getBulletColorIndex()
Returns the index of a bulet's color in a color scheme or (-1) for scheme-independent color. |
int |
getBulletFontIndex()
Returns the font index of a paragraph's bullet. |
short |
getBulletHeight()
Returns the bullet size relatively to the size of the first portion in the paragraph. |
short |
getBulletOffset()
Returns the offset of a paragraph's bullet. |
int |
getBulletType()
Returns the type of a bullet. |
short |
getDepth()
Returns the depth of a paragraph. |
boolean |
getHasBullet()
Determines whether the paragraph has a bullet. |
short |
getNumberedBulletStartWith()
Returns the beginning value of a numbered bullet. |
int |
getNumberedBulletStyle()
Returns the style of a numbered bullet. |
short |
getPictureBulletId()
Returns the Id of a PictureBullet. |
Portions |
getPortions()
Returns the collection of text portions. |
int |
getRawAlignment()
Returns the alignment of a paragraph. |
char |
getRawBulletCharacter()
Returns the raw character which is used for bullets in a paragraph. |
java.awt.Color |
getRawBulletColor()
Returns the raw color of a bullet. |
int |
getRawBulletFontIndex()
Returns the raw font of a bullet. |
short |
getRawBulletHeight()
Returns the raw bullet size relative to the size of the first portion of a paragraph. |
short |
getRawBulletOffset()
Returns the raw offset of a bullet. |
short |
getRawNumberedBulletStartWith()
Returns the raw beginning value of a numbered bullet. |
int |
getRawNumberedBulletStyle()
Returns the raw style of a numbered bullet. |
short |
getRawPictureBulletId()
Returns the Id of a PictureBullet. |
short |
getRawSpaceAfter()
Returns the raw amount of space after the last line of a paragraphPositive value means space defined in percents of line. |
short |
getRawSpaceBefore()
Returns the raw amount of space before the first line of a paragraph. |
short |
getRawSpaceWithin()
Returns the raw amount of space between base lines of a paragraph. |
int |
getRawTextDirection()
Returns the raw direction of a text in a paragraph. |
short |
getRawTextOffset()
Returns the raw offset of a text. |
short |
getSpaceAfter()
Returns the amount of space after the last line of a paragraph, in percents of line. |
short |
getSpaceBefore()
Returns the amount of space before the first line of a paragraph, in percents of line. |
short |
getSpaceWithin()
Returns the amount of space between base lines of a paragraph, in percents of line. |
java.lang.String |
getText()
Returns the plain text of a paragraph. |
short |
getTextOffset()
Returns the offset of a paragraph's text. |
boolean |
isBulletHardColor()
Determines whether the bullet uses own color. |
boolean |
isBulletHardFont()
Determines whether the bullet uses own font. |
boolean |
isBulletHardSize()
Determines whether the bullet has own size. |
boolean |
isExtendedBullet()
Returns (true) if paragraph has extended bullets (image or numbered). |
void |
setAlignment(int value)
Sets the alignment of a paragraph. |
void |
setBulletCharacter(char value)
Sets the character which is used for a paragraph's bullet. |
void |
setBulletColor(java.awt.Color value)
Sets the color of a paragraph's bullet. |
void |
setBulletColorIndex(short value)
Sets the index of a bulet's color in a color scheme or (-1) for scheme-independent color. |
void |
setBulletFontIndex(int value)
Sets the font index of a paragraph's bullet. |
void |
setBulletHardColor(boolean value)
Sets whether the bullet uses own color. |
void |
setBulletHardFont(boolean value)
Sets whether the bullet uses own font. |
void |
setBulletHardSize(boolean value)
Sets whether the bullet has own size. |
void |
setBulletHeight(short value)
Sets the bullet size relatively to the size of the first portion in the paragraph. |
void |
setBulletOffset(short value)
Sets the offset of the paragraph's bullet. |
void |
setBulletType(int value)
Sets the type of a bullet. |
void |
setDepth(short value)
Sets the depth of a paragraph. |
void |
setHasBullet(boolean value)
Sets whether the paragraph has a bullet. |
void |
setNumberedBulletStartWith(short value)
Sets the beginning value of a numbered bullet. |
void |
setNumberedBulletStyle(int value)
Sets the style of a numbered bullet. |
void |
setPictureBulletId(short value)
Sets the Id of a PictureBullet. |
void |
setRawAlignment(int value)
Sets the alignment of a paragraph. |
void |
setRawBulletCharacter(char value)
Sets the raw character which is used for bullets in a paragraph. |
void |
setRawBulletColor(java.awt.Color value)
Sets the raw color of a bullet. |
void |
setRawBulletFontIndex(int value)
Sets the raw font of a bullet. |
void |
setRawBulletHeight(short value)
Sets the raw bullet size relative to the size of the first portion of a paragraph. |
void |
setRawBulletOffset(short value)
Sets the raw offset of a bullet. |
void |
setRawNumberedBulletStartWith(short value)
Sets the raw beginning value of a numbered bullet. |
void |
setRawNumberedBulletStyle(int value)
Sets the raw style of a numbered bullet. |
void |
setRawPictureBulletId(short value)
Sets the Id of a PictureBullet. |
void |
setRawSpaceAfter(short value)
Sets the raw amount of space after the last line of a paragraph. |
void |
setRawSpaceBefore(short value)
Sets the raw amount of space before the first line of a paragraphPositive value means space defined in percents of line. |
void |
setRawSpaceWithin(short value)
Sets the raw amount of space between base lines of a paragraph. |
void |
setRawTextOffset(short value)
Sets the raw offset of a text. |
void |
setSpaceAfter(short value)
Sets the amount of space after the last line of a paragraph, in percents of line. |
void |
setSpaceBefore(short value)
Sets the amount of space before the first line of a paragraph, in percents of line. |
void |
setSpaceWithin(short value)
Sets the amount of space between base lines of a paragraph, in percents of line. |
void |
setText(java.lang.String value)
Sets the plain text of a paragraph. |
void |
setTextOffset(short value)
Sets the offset of a paragraph's text. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Paragraph()
public Paragraph(Paragraph para)
para
- Paragraph object to clone.Method Detail |
---|
public boolean equalFormatting(Paragraph para)
para
- another paragraph to compare.
public short getDepth()
public void setDepth(short value)
value
- new depth of a paragraph.public boolean getHasBullet()
public void setHasBullet(boolean value)
value
- true if paragraph has a bullet.public boolean isBulletHardColor()
public void setBulletHardColor(boolean value)
value
- (true) if bullet uses own color and (false) if
bullet uses color of the first portion in the paragraph.public java.awt.Color getBulletColor()
public void setBulletColor(java.awt.Color value)
value
- new bullet color.public short getBulletColorIndex()
public void setBulletColorIndex(short value)
value
- the index of a bulet's color.public boolean isBulletHardFont()
public void setBulletHardFont(boolean value)
value
- (
true) if bullet has own font and (false) if
bullet uses font of the first portion in the paragraph.public int getBulletFontIndex()
public void setBulletFontIndex(int value)
value
- new font index.public boolean isBulletHardSize()
public void setBulletHardSize(boolean value)
value
- true if bullet has own size and false if
bullet uses size of the first portion in a paragraph.public short getBulletHeight()
Returns the bullet size relatively 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. Negative value means bullet height is equal to absolute BulletHeight value and does not depend on portion's font height.
public void setBulletHeight(short value)
Sets the bullet size relatively 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. Negative value means bullet height is equal to absolute BulletHeight value and does not depend on portion's font height.
value
- new bullet height.public char getBulletCharacter()
public void setBulletCharacter(char value)
Sets the character which is used for a paragraph's bullet.
Switches bullet type to Symbol on assigning.
value
- new bullet character.public short getSpaceBefore()
Returns the amount of space before the first line of a paragraph, in percents of line.
Positive value means space defined in percents of line. Values (-8) and less should be divided by (-8) to obtain space in points.
public void setSpaceBefore(short value)
Sets the amount of space before the first line of a paragraph, in percents of line.
Positive value means space defined in percents of line. Values (-8) and less should be divided by (-8) to obtain space in points.
value
- new value of the space before a paragraph.public short getSpaceAfter()
Returns the amount of space after the last line of a paragraph, in percents of line.
Positive value means space defined in percents of line. Values (-8) and less should be divided by (-8) to obtain space in points.
public void setSpaceAfter(short value)
Sets the amount of space after the last line of a paragraph, in percents of line.
Positive value means space defined in percents of line. Values (-8) and less should be divided by (-8) to obtain space in points.
value
- new value of the space after a paragraph.public short getSpaceWithin()
Returns the amount of space between base lines of a paragraph, in percents of line.
Positive value means space defined in percents of line. Values (-8) and less should be divided by (-8) to obtain space in points.
public void setSpaceWithin(short value)
Sets the amount of space between base lines of a paragraph, in percents of line.
Positive value means space defined in percents of line. Values (-8) and less should be divided by (-8) to obtain space in points.
value
- new value of the space between base lines in a paragraph.public short getBulletOffset()
public void setBulletOffset(short value)
value
- new bullet offset.public short getTextOffset()
public void setTextOffset(short value)
value
- new text offset.public int getAlignment()
TextAlignment
.
public void setAlignment(int value)
value
- new paragraph alignment. See TextAlignment
.public boolean isExtendedBullet()
public int getBulletType()
BulletType
.
public void setBulletType(int value)
value
- new type of a bullet. See BulletType
.public int getNumberedBulletStyle()
Returns the style of a numbered bullet. See NumberedBulletStyle
.
Value ignored for other types of bullets.
public void setNumberedBulletStyle(int value)
value
- new style of a numbered bullet. See
NumberedBulletStyle
.public short getNumberedBulletStartWith()
Returns the beginning value of a numbered bullet.
On assigning value greater than (0), switches bullet type to numbered.
public void setNumberedBulletStartWith(short value)
Sets the beginning value of a numbered bullet.
On assigning value greater than (0), switches bullet type to numbered.
value
- new beginning value of a numbered bullet.public short getPictureBulletId()
public void setPictureBulletId(short value)
value
- new Id of a PictureBullet.public int getRawAlignment()
Returns the alignment of a paragraph. See TextAlignment
.
TextAlignment.DEFAULT means value should be inherited from the master.
public void setRawAlignment(int value)
Sets the alignment of a paragraph.
TextAlignment.DEFAULT means value should be inherited from the master.
value
- new alignment of a paragraph. See TextAlignment
.public int getRawTextDirection()
Returns the raw direction of a text in a paragraph. See TextDirection
.
TextDirection.DEFAULT means value should be inherited from the master.
public java.awt.Color getRawBulletColor()
Returns the raw color of a bullet.
Black transparent value means the color should be inherited from the master.
public void setRawBulletColor(java.awt.Color value)
Sets the raw color of a bullet.
Black transparent value means the color should be inherited from the master.
value
- new raw color of a bullet.public int getRawBulletFontIndex()
Returns the raw font of a bullet.
public void setRawBulletFontIndex(int value)
Sets the raw font of a bullet.
value
- new raw font of a bullet.public short getRawBulletHeight()
Returns the raw bullet size relative to the size of the first portion of a paragraph.
Can be a short value from 25 to 400, indicating that the bullet size can be from 25 percent to 400 percent of the text-character size. Value (-1) means bullet size 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.
public void setRawBulletHeight(short value)
Sets the raw bullet size relative to the size of the first portion of a paragraph.
Can be a short value from 25 to 400, indicating that the bullet size can be from 25 percent to 400 percent of the text-character size. Value (-1) means bullet size 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.
value
- new raw bullet size relative to the size of the first portion
of a paragraph.public char getRawBulletCharacter()
Returns the raw character which is used for bullets in a paragraph.
Switches bullet type to Symbol on assigning. Value (-1) means bullet character should be inherited from the master.
public void setRawBulletCharacter(char value)
Sets the raw character which is used for bullets in a paragraph.
Switches bullet type to Symbol on assigning. Value (-1) means bullet character should be inherited from the master.
value
- new raw character which is used for bullets in a paragraph.public short getRawSpaceBefore()
Returns the raw amount of space before the first line of a paragraph.
Positive value means space defined in percents of line. Values (-8) and less should be divided by (-8) to obtain space in points. Value (-1) means raw space should be inherited from the master.
public void setRawSpaceBefore(short value)
Sets the raw amount of space before the first line of a paragraph
Positive value means space defined in percents of line. Values (-8) and less should be divided by (-8) to obtain space in points. Value (-1) means raw space should be inherited from the master.
value
- new raw amount of space before the first line of a paragraph.public short getRawSpaceAfter()
Returns the raw amount of space after the last line of a paragraph
Positive value means space defined in percents of line. Values (-8) and less should be divided by (-8) to obtain space in points. Value (-1) means raw space should be inherited from the master.
public void setRawSpaceAfter(short value)
Sets the raw amount of space after the last line of a paragraph.
Positive value means space defined in percents of line. Values (-8) and less should be divided by (-8) to obtain space in points. Value (-1) means raw space should be inherited from the master.
value
- new raw amount of space after the last line in a paragraph.public short getRawSpaceWithin()
Returns the raw amount of space between base lines of a paragraph.
Positive value means space defined in percents of line. Values (-8) and less should be divided by (-8) to obtain space in points. Value (-1) means raw space should be inherited from the master.
public void setRawSpaceWithin(short value)
Sets the raw amount of space between base lines of a paragraph.
Positive value means space defined in percents of line. Values (-8) and less should be divided by (-8) to obtain space in points. Value (-1) means raw space should be inherited from the master.
value
- new raw amount of space between base lines of a paragraph.public short getRawBulletOffset()
Returns the raw offset of a bullet.
Value (-1) means raw bullet should be inherited from the ruler or the master.
public void setRawBulletOffset(short value)
Sets the raw offset of a bullet.
Value (-1) means raw bullet should be inherited from the ruler or the master.
value
- new raw offset of a bullet.public short getRawTextOffset()
Returns the raw offset of a text.
Value (-1) means raw text should be inherited from the ruler or the master.
public void setRawTextOffset(short value)
Sets the raw offset of a text.
Value (-1) means raw text should be inherited from the ruler or the master.
value
- new raw offset of a text.public int getRawNumberedBulletStyle()
Returns the raw style of a numbered bullet. See NumberedBulletStyle
.
NumberedBulletStyle.BulletDefault means value should be inherited from the master.
public void setRawNumberedBulletStyle(int value)
Sets the raw style of a numbered bullet.
NumberedBulletStyle.BulletDefault means value should be inherited from the master.
value
- new raw style of a numbered bullet. See
NumberedBulletStyle
.public short getRawNumberedBulletStartWith()
Returns the raw beginning value of a numbered bullet.
(-1) means value should be inherited from the master.
public void setRawNumberedBulletStartWith(short value)
Sets the raw beginning value of a numbered bullet.
(-1) means value should be inherited from the master.
value
- new raw beginning value of a numbered bullet.public short getRawPictureBulletId()
public void setRawPictureBulletId(short value)
Sets the Id of a PictureBullet.
value
- new raw Id of a PictureBullet.public Portions getPortions()
public java.lang.String getText()
public void setText(java.lang.String value) throws PptEditException
value
- new plain text.
PptEditException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |