com.aspose.slides
Class Paragraph

java.lang.Object
  extended by com.aspose.slides.Paragraph

public final class Paragraph
extends java.lang.Object

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
 int getAlignment()
          Returns the alignment of a paragraph.
 char getBulletCharacter()
          Returns the character that is used for the paragraph's bullet.
 java.awt.Color getBulletColor()
          Returns the color of the paragraph's bullet.
 short getBulletColorIndex()
          Returns the index of a bulet's color in a color scheme or (-1) for scheme-independed color.
 int getBulletFontIndex()
          Returns the font of the 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 the paragraph's bullet.
 int getBulletType()
          Returns the type of a bullet.
 short getDepth()
          Returns the depth of a paragraph.
 short getHasBullet()
          Determines whether the paragraph has bullet.
 short getNumberedBulletStartWith()
          Returns the beginning value of a numbered bullet.
 int getNumberedBulletStyle()
          Returns the style of a numbered bullet.
 short getPictureBulletId()
          Returns the PictureBullet id.
 Portions getPortions()
          Returns the collection of a text portions.
 int getRawAlignment()
          Returns the alignment of a paragraph.
 char getRawBulletCharacter()
          Returns the character that is used for bullets in the specified text.
 java.awt.Color getRawBulletColor()
          Returns the color of a bullet.
 int getRawBulletFontIndex()
          Returns the font of the bullet.
 short getRawBulletHeight()
          Returns the bullet size relative to the size of the first portion in a paragraph.
 short getRawBulletOffset()
          Returns the offset of the bullet.
 short getRawHasBullet()
          Returns raw value of a bullet: -1 - value should be inherited from the master.
 short getRawIsBulletHardColor()
          Returns raw color of a bullet: -1 - if value must be inherited from the master slide.
 short getRawIsBulletHardFont()
          Returns raw font of a bullet: -1 - if value must be inherited from the master slide.
 short getRawNumberedBulletStartWith()
          Returns the beginning value of a numbered bullet.
 int getRawNumberedBulletStyle()
          Returns the style of a numbered bullet.
 short getRawPictureBulletId()
          Returns the PictureBullet Id.
 short getRawSpaceAfter()
          Returns the amount of space after the last line in a paragraph, Positive value means space defined in percents of line.
 short getRawSpaceBefore()
          Returns the amount of space before the first line in a paragraph, Positive value means space defined in percents of line.
 short getRawSpaceWithin()
          Returns the amount of space between base lines in a paragraph, Positive value means space defined in percents of line.
 short getRawTextOffset()
          Returns the offset of the text.
 short getSpaceAfter()
          Returns the amount of space after the last line in the paragraph, in percents of line.
 short getSpaceBefore()
          Returns the amount of space before the first line in the paragraph, in percents of line.
 short getSpaceWithin()
          Returns the amount of space between base lines in the paragraph, in percents of line.
 java.lang.String getText()
          Returns the plain text of the whole paragraph.
 short getTextOffset()
          Returns the offset of the paragraph's text.
 boolean isBulletHardColor()
          Determines whether the bullet uses own color.
 boolean isBulletHardFont()
          Determines whether the bullet uses own font.
 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 that is used for the paragraph's bullet.
 void setBulletColor(java.awt.Color value)
          Sets the color of the paragraph's bullet.
 void setBulletColorIndex(short value)
          Sets the index of a bulet's color in a color scheme or (-1) for scheme-independed color.
 void setBulletFontIndex(int value)
          Sets the font of the 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 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(short value)
          Sets whether the paragraph has 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 PictureBullet id.
 void setRawAlignment(int value)
          Sets the alignment of a paragraph.
 void setRawBulletCharacter(char value)
          Sets the character that is used for bullets in the specified text.
 void setRawBulletColor(java.awt.Color value)
          Sets the color of a bullet.
 void setRawBulletFontIndex(int value)
          Sets the font of the bullet.
 void setRawBulletHeight(short value)
          Sets the bullet size relative to the size of the first portion in a paragraph.
 void setRawBulletOffset(short value)
          Sets the offset of the bullet.
 void setRawHasBullet(short value)
          Sets raw value of a bullet: -1 - value should be inherited from the master.
 void setRawIsBulletHardColor(short value)
          Sets raw color of a bullet: -1 - if value must be inherited from the master slide.
 void setRawIsBulletHardFont(short value)
          Sets raw font of a bullet: -1 - if value must be inherited from the master slide.
 void setRawNumberedBulletStartWith(short value)
          Sets the beginning value of a numbered bullet.
 void setRawNumberedBulletStyle(int value)
          Sets the style of a numbered bullet.
 void setRawPictureBulletId(short value)
          Sets the PictureBullet Id.
 void setRawSpaceAfter(short value)
          Sets the amount of space after the last line in a paragraph, Positive value means space defined in percents of line.
 void setRawSpaceBefore(short value)
          Sets the amount of space before the first line in a paragraph, Positive value means space defined in percents of line.
 void setRawSpaceWithin(short value)
          Sets the amount of space between base lines in a paragraph, Positive value means space defined in percents of line.
 void setRawTextOffset(short value)
          Sets the offset of the text.
 void setSpaceAfter(short value)
          Sets the amount of space after the last line in the paragraph, in percents of line.
 void setSpaceBefore(short value)
          Sets the amount of space before the first line in the paragraph, in percents of line.
 void setSpaceWithin(short value)
          Sets the amount of space between base lines in the paragraph, in percents of line.
 void setText(java.lang.String value)
          Sets the plain text of the whole paragraph.
 void setTextOffset(short value)
          Sets the offset of the paragraph's text.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Paragraph

public Paragraph()
Initializes a new instance of the Paragraph class.


Paragraph

public Paragraph(Paragraph para)
Initializes a new instance of the Paragraph class.

Parameters:
para - Paragraph object to clone.
Method Detail

getDepth

public short getDepth()
Returns the depth of a paragraph.

Returns:
The depth of a paragraph.

setDepth

public void setDepth(short value)
Sets the depth of a paragraph.

Parameters:
value - new depth of a paragraph.

getHasBullet

public short getHasBullet()
Determines whether the paragraph has bullet.

Returns:
-1 - default value.
 0 if paragraph doesn't have a bullet.
 1 if paragraph has a bullet.

setHasBullet

public void setHasBullet(short value)
Sets whether the paragraph has bullet.

Parameters:
value -
-1 default value.
 0 if paragraph doesn't have a bullet.
 1 if paragraph has a bullet.

isBulletHardColor

public boolean isBulletHardColor()
Determines whether the bullet uses own color.

Returns:
(true) if bullet uses own color and (false) if bullet uses color of the first portion in the paragraph.

setBulletHardColor

public void setBulletHardColor(boolean value)
Sets whether the bullet uses own color.

Parameters:
value - ( true) if bullet uses own color and (false) if bullet uses color of the first portion in the paragraph.

getBulletColor

public java.awt.Color getBulletColor()
Returns the color of the paragraph's bullet.

Returns:
The bullet color.

setBulletColor

public void setBulletColor(java.awt.Color value)
Sets the color of the paragraph's bullet.

Parameters:
value - new bullet color.

getBulletColorIndex

public short getBulletColorIndex()
Returns the index of a bulet's color in a color scheme or (-1) for scheme-independed color.

Returns:
the index of a bulet's color.

setBulletColorIndex

public void setBulletColorIndex(short value)
Sets the index of a bulet's color in a color scheme or (-1) for scheme-independed color.

Parameters:
value - the index of a bulet's color.

isBulletHardFont

public boolean isBulletHardFont()
Determines whether the bullet uses own font.

Returns:
(true) if the bullet has own font and (false) if it uses font of the first portion in a paragraph.

setBulletHardFont

public void setBulletHardFont(boolean value)
Sets whether the bullet uses own font.

Parameters:
value - ( true) if bullet has own font and (false) if bullet uses font of the first portion in the paragraph.

getBulletFontIndex

public int getBulletFontIndex()
Returns the font of the paragraph's bullet.

Returns:
The font index.

setBulletFontIndex

public void setBulletFontIndex(int value)
Sets the font of the paragraph's bullet.

Parameters:
value - new font index.

getBulletHeight

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.

Returns:
The bullet height.

setBulletHeight

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.

Parameters:
value - new bullet height.

getBulletCharacter

public char getBulletCharacter()
Returns the character that is used for the paragraph's bullet.

Returns:
The bullet character.

setBulletCharacter

public void setBulletCharacter(char value)
Sets the character that is used for the paragraph's bullet. Switches bullet type to Symbol on assigning.

Parameters:
value - new bullet character.

getSpaceBefore

public short getSpaceBefore()
Returns the amount of space before the first line in the paragraph, in percents of line. Positive value means space defined in percents of line. Values (-8) and less should be devided by (-8) to obtain space in points.

Returns:
The space before the paragraph.

setSpaceBefore

public void setSpaceBefore(short value)
Sets the amount of space before the first line in the paragraph, in percents of line. Positive value means space defined in percents of line. Values (-8) and less should be devided by (-8) to obtain space in points.

Parameters:
value - new value for the space before the paragraph.

getSpaceAfter

public short getSpaceAfter()
Returns the amount of space after the last line in the paragraph, in percents of line. Positive value means space defined in percents of line. Values (-8) and less should be devided by (-8) to obtain space in points.

Returns:
The space after the paragraph.

setSpaceAfter

public void setSpaceAfter(short value)
Sets the amount of space after the last line in the paragraph, in percents of line. Positive value means space defined in percents of line. Values (-8) and less should be devided by (-8) to obtain space in points.

Parameters:
value - new value for the space after the paragraph.

getSpaceWithin

public short getSpaceWithin()
Returns the amount of space between base lines in the paragraph, in percents of line. Positive value means space defined in percents of line. Values (-8) and less should be devided by (-8) to obtain space in points.

Returns:
The space between base lines in the paragraph.

setSpaceWithin

public void setSpaceWithin(short value)
Sets the amount of space between base lines in the paragraph, in percents of line. Positive value means space defined in percents of line. Values (-8) and less should be devided by (-8) to obtain space in points.

Parameters:
value - new value for the space between base lines in the paragraph.

getBulletOffset

public short getBulletOffset()
Returns the offset of the paragraph's bullet.

Returns:
The bullet offset.

setBulletOffset

public void setBulletOffset(short value)
Sets the offset of the paragraph's bullet.

Parameters:
value - new bullet offset.

getTextOffset

public short getTextOffset()
Returns the offset of the paragraph's text.

Returns:
The text offset.

setTextOffset

public void setTextOffset(short value)
Sets the offset of the paragraph's text.

Parameters:
value - new text offset.

getAlignment

public int getAlignment()
Returns the alignment of a paragraph.

Returns:
The paragraph alignment. See TextAlignment.

setAlignment

public void setAlignment(int value)
Sets the alignment of a paragraph.

Parameters:
value - new paragraph alignment. See TextAlignment.

isExtendedBullet

public boolean isExtendedBullet()
Returns (true) if paragraph has extended bullets (image or numbered).

Returns:
true if paragraph has extended bullets.

getBulletType

public int getBulletType()
Returns the type of a bullet.

Returns:
the type of a bullet. See BulletType.

setBulletType

public void setBulletType(int value)
Sets the type of a bullet.

Parameters:
value - the type of a bullet. See BulletType.

getNumberedBulletStyle

public int getNumberedBulletStyle()
Returns the style of a numbered bullet. Value ignored for other types of bullets.

Returns:
the style of a numbered bullet. See NumberedBulletStyle.

setNumberedBulletStyle

public void setNumberedBulletStyle(int value)
Sets the style of a numbered bullet. Value ignored for other types of bullets.

Parameters:
value - the style of a numbered bullet. See NumberedBulletStyle.

getNumberedBulletStartWith

public short getNumberedBulletStartWith()
Returns the beginning value of a numbered bullet. On assigning value greater than (0), switches bullet type to numbered.

Returns:
the beginning value of a numbered bullet.

setNumberedBulletStartWith

public void setNumberedBulletStartWith(short value)
Sets the beginning value of a numbered bullet. On assigning value greater than (0), switches bullet type to numbered.

Parameters:
value - the beginning value of a numbered bullet.

getPictureBulletId

public short getPictureBulletId()
Returns the PictureBullet id. (-1) for other types of bullets.

Returns:
the PictureBullet id.

setPictureBulletId

public void setPictureBulletId(short value)
Sets the PictureBullet id. (-1) for other types of bullets.

Parameters:
value - the PictureBullet id.

getRawAlignment

public int getRawAlignment()
Returns the alignment of a paragraph. TextAlignment.DEFAULT means value should be inherited from the master.

Returns:
the alignment of a paragraph. See TextAlignment.

setRawAlignment

public void setRawAlignment(int value)
Sets the alignment of a paragraph. TextAlignment.DEFAULT means value should be inherited from the master.

Parameters:
value - the alignment of a paragraph. See TextAlignment.

getRawHasBullet

public short getRawHasBullet()
Returns raw value of a bullet:

Returns:
Returns raw value of a bullet.

setRawHasBullet

public void setRawHasBullet(short value)
Sets raw value of a bullet:

Parameters:
value - Sets raw value of a bullet.

getRawBulletColor

public java.awt.Color getRawBulletColor()
Returns the color of a bullet. Black transparent value means the color should be inherited from the master.

Returns:
the color of a bullet.

setRawBulletColor

public void setRawBulletColor(java.awt.Color value)
Sets the color of a bullet. Black transparent value means the color should be inherited from the master.

Parameters:
value - the color of a bullet.

getRawIsBulletHardFont

public short getRawIsBulletHardFont()
Returns raw font of a bullet:

Returns:
Returns raw font of a bullet.

setRawIsBulletHardFont

public void setRawIsBulletHardFont(short value)
Sets raw font of a bullet:

Parameters:
value - Sets raw font of a bullet.

getRawIsBulletHardColor

public short getRawIsBulletHardColor()
Returns raw color of a bullet:

Returns:
Returns raw color of a bullet.

setRawIsBulletHardColor

public void setRawIsBulletHardColor(short value)
Sets raw color of a bullet:

getRawBulletFontIndex

public int getRawBulletFontIndex()
Returns the font of the bullet.

Returns:
Returns the font of the bullet.

setRawBulletFontIndex

public void setRawBulletFontIndex(int value)
Sets the font of the bullet.

Parameters:
value - Sets the font of the bullet.

getRawBulletHeight

public short getRawBulletHeight()
Returns the bullet size relative to the size of the first portion in 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.

Returns:
Returns the bullet size relative to the size of the first portion in a paragraph.

setRawBulletHeight

public void setRawBulletHeight(short value)
Sets the bullet size relative to the size of the first portion in 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.

Parameters:
value - the bullet size relative to the size of the first portion in a paragraph.

getRawBulletCharacter

public char getRawBulletCharacter()
Returns the character that is used for bullets in the specified text. Switches bullet type to Symbol on assigning. Value (-1) means bullet character should be inherited from the master.

Returns:
the character that is used for bullets in the specified text.

setRawBulletCharacter

public void setRawBulletCharacter(char value)
Sets the character that is used for bullets in the specified text. Switches bullet type to Symbol on assigning. Value (-1) means bullet character should be inherited from the master.

Parameters:
value - Sets the character that is used for bullets in the specified text.

getRawSpaceBefore

public short getRawSpaceBefore()
Returns the amount of space before the first line in a paragraph, Positive value means space defined in percents of line. Values (-8) and less should be devided by (-8) to obtain space in points. Value (-1) means raw space should be inherited from the master.

Returns:
Returns the amount of space before the first line in a paragraph.

setRawSpaceBefore

public void setRawSpaceBefore(short value)
Sets the amount of space before the first line in a paragraph, Positive value means space defined in percents of line. Values (-8) and less should be devided by (-8) to obtain space in points. Value (-1) means raw space should be inherited from the master.

Parameters:
value - Sets the amount of space before the first line in a paragraph.

getRawSpaceAfter

public short getRawSpaceAfter()
Returns the amount of space after the last line in a paragraph, Positive value means space defined in percents of line. Values (-8) and less should be devided by (-8) to obtain space in points. Value (-1) means raw spase should be inherited from the master.

Returns:
the amount of space after the last line in a paragraph.

setRawSpaceAfter

public void setRawSpaceAfter(short value)
Sets the amount of space after the last line in a paragraph, Positive value means space defined in percents of line. Values (-8) and less should be devided by (-8) to obtain space in points. Value (-1) means raw spase should be inherited from the master.

Parameters:
value - the amount of space after the last line in a paragraph.

getRawSpaceWithin

public short getRawSpaceWithin()
Returns the amount of space between base lines in a paragraph, Positive value means space defined in percents of line. Values (-8) and less should be devided by (-8) to obtain space in points. Value (-1) means raw spase should be inherited from the master.

Returns:
Returns the amount of space between base lines in a paragraph.

setRawSpaceWithin

public void setRawSpaceWithin(short value)
Sets the amount of space between base lines in a paragraph, Positive value means space defined in percents of line. Values (-8) and less should be devided by (-8) to obtain space in points. Value (-1) means raw spase should be inherited from the master.

Parameters:
value - the amount of space between base lines in a paragraph.

getRawBulletOffset

public short getRawBulletOffset()
Returns the offset of the bullet. Value (-1) means raw bullet should be inherited from the ruler or the master.

Returns:
the offset of the bullet.

setRawBulletOffset

public void setRawBulletOffset(short value)
Sets the offset of the bullet. Value (-1) means raw bullet should be inherited from the ruler or the master.

Parameters:
value - the offset of the bullet.

getRawTextOffset

public short getRawTextOffset()
Returns the offset of the text. Value (-1) means raw text should be inherited from the ruler or the master.

Returns:
the offset of the text.

setRawTextOffset

public void setRawTextOffset(short value)
Sets the offset of the text. Value (-1) means raw text should be inherited from the ruler or the master.

Parameters:
value - the offset of the text.

getRawNumberedBulletStyle

public int getRawNumberedBulletStyle()
Returns the style of a numbered bullet. NumberedBulletStyle.BulletDefault means value should be inherited from the master.

Returns:
the style of a numbered bullet. See NumberedBulletStyle.

setRawNumberedBulletStyle

public void setRawNumberedBulletStyle(int value)
Sets the style of a numbered bullet. NumberedBulletStyle.BulletDefault means value should be inherited from the master.

Parameters:
value - the style of a numbered bullet. See NumberedBulletStyle.

getRawNumberedBulletStartWith

public short getRawNumberedBulletStartWith()
Returns the beginning value of a numbered bullet. (-1) means value should be inherited from the master.

Returns:
the beginning value of a numbered bullet.

setRawNumberedBulletStartWith

public void setRawNumberedBulletStartWith(short value)
Sets the beginning value of a numbered bullet. (-1) means value should be inherited from the master.

Parameters:
value - the beginning value of a numbered bullet.

getRawPictureBulletId

public short getRawPictureBulletId()
Returns the PictureBullet Id.

Returns:
the PictureBullet Id.

setRawPictureBulletId

public void setRawPictureBulletId(short value)
Sets the PictureBullet Id.

Parameters:
value - the PictureBullet Id.

getPortions

public Portions getPortions()
Returns the collection of a text portions.

Returns:
The collection of a text portions. See Portions.

getText

public java.lang.String getText()
Returns the plain text of the whole paragraph.

Returns:
The plain text.

setText

public void setText(java.lang.String value)
             throws PptEditException
Sets the plain text of the whole paragraph.

Parameters:
value - the plain text.
Throws:
PptEditException