Home  Products  Purchase  Downloads  Demos  Forums  Blogs  Wiki  API  Corporate

com.aspose.powerpoint
Class Paragraph

java.lang.Object
  extended by com.aspose.powerpoint.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 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.
 short getDepth()
          Returns the depth of a paragraph.
 short getHasBullet()
          Determines whether the paragraph has bullet.
 Portions getPortions()
          Returns the collection of a text portions.
 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 isBulletHardFont()
          Determines whether the bullet uses own font.
 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 setBulletFontIndex(short value)
          Sets the font of the paragraph's bullet.
 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 setDepth(short value)
          Sets the depth of a paragraph.
 void setHasBullet(short value)
          Sets whether the paragraph has bullet.
 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 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 if paragraph has a bullet, 0 if paragraph doesn't have a bullet and -1 - default value.

setHasBullet

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

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

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.

isBulletHardFont

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

Returns:
true if the bullet uses 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 uses own font and false if bullet uses font of the first portion in the paragraph.

getBulletFontIndex

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

Returns:
The font index.

setBulletFontIndex

public void setBulletFontIndex(short 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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

setAlignment

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

Parameters:
value - new paragraph alignment.

getPortions

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

Returns:
The collection of a text portions.

getText

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

Returns:
The plain text.