com.aspose.slides
Class Paragraph

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

public final class Paragraph
extends java.lang.Object

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

Paragraph

public Paragraph()

Initializes a new instance of the Paragraph class.


Paragraph

public Paragraph(Paragraph para)

Initializes a new instance of the Paragraph class.

Method Detail

getDepth

public short getDepth()

Returns or sets a depth of a paragraph. Read/write short.


setDepth

public void setDepth(short value)

hasBullet

public boolean hasBullet()

Determines whether the paragraph has a bullet. Read/write bool.


hasBullet

public void hasBullet(boolean value)

isBulletHardColor

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.


isBulletHardColor

public void isBulletHardColor(boolean value)

getBulletColor

public java.awt.Color getBulletColor()

setBulletColor

public void setBulletColor(java.awt.Color value)

getBulletColorIndex

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


setBulletColorIndex

public void setBulletColorIndex(short value)

isBulletHardFont

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.


isBulletHardFont

public void isBulletHardFont(boolean value)

getBulletFontIndex

public int getBulletFontIndex()

Returns or sets the font of a bullet. Read/write int.


setBulletFontIndex

public void setBulletFontIndex(int value)

isBulletHardSize

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.


isBulletHardSize

public void isBulletHardSize(boolean value)

getBulletHeight

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.


setBulletHeight

public void setBulletHeight(short value)

getBulletCharacter

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.


setBulletCharacter

public void setBulletCharacter(char value)

getSpaceBefore

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.


setSpaceBefore

public void setSpaceBefore(short value)

getSpaceAfter

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.


setSpaceAfter

public void setSpaceAfter(short value)

getSpaceWithin

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.


setSpaceWithin

public void setSpaceWithin(short value)

getBulletOffset

public short getBulletOffset()

Returns or sets the offset of a bullet. Read/write short.


setBulletOffset

public void setBulletOffset(short value)

getTextOffset

public short getTextOffset()

Returns or sets the offset of a text. Read/write short.


setTextOffset

public void setTextOffset(short value)

getAlignment

public int getAlignment()

Returns or sets the alignment of a paragraph. Read/write TextAlignment.


setAlignment

public void setAlignment(int value)

getExtendedBullet

public boolean getExtendedBullet()

Returns <b>true</b> if paragraph has extended bullets (image or numbered). Read-only bool.


getBulletType

public int getBulletType()

Returns or sets the type of a bullet. Read/write Aspose.Slides.BulletType.


setBulletType

public void setBulletType(int value)

getNumberedBulletStyle

public int getNumberedBulletStyle()

Returns or sets the style of a numbered bullet. Value ignored for other types of bullets. Read/write Aspose.Slides.NumberedBulletStyle.


setNumberedBulletStyle

public void setNumberedBulletStyle(int value)

getNumberedBulletStartWith

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


setNumberedBulletStartWith

public void setNumberedBulletStartWith(short value)

getPictureBulletId

public short getPictureBulletId()

Returns or sets the PictureBullet id. <b>-1</b> for other types of bullets.


setPictureBulletId

public void setPictureBulletId(short value)

getEastAsianLineBreak

public boolean getEastAsianLineBreak()

Returns or sets value, which determines if special east asian linebreaking rules will be applied. Read/write bool.


setEastAsianLineBreak

public void setEastAsianLineBreak(boolean value)

getHangingPunctuation

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.


setHangingPunctuation

public void setHangingPunctuation(boolean value)

getRawAlignment

public int getRawAlignment()

Returns or sets the alignment of a paragraph. TextAlignment.Default means value should be inherited from the master. Read/write TextAlignment.


setRawAlignment

public void setRawAlignment(int value)

getRawBulletColor

public java.awt.Color getRawBulletColor()

setRawBulletColor

public void setRawBulletColor(java.awt.Color value)

getRawBulletFontIndex

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.


setRawBulletFontIndex

public void setRawBulletFontIndex(int value)

getRawBulletHeight

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.


setRawBulletHeight

public void setRawBulletHeight(short value)

getRawBulletCharacter

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.


setRawBulletCharacter

public void setRawBulletCharacter(char value)

getRawSpaceBefore

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.


setRawSpaceBefore

public void setRawSpaceBefore(short value)

getRawSpaceAfter

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.


setRawSpaceAfter

public void setRawSpaceAfter(short value)

getRawSpaceWithin

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.


setRawSpaceWithin

public void setRawSpaceWithin(short value)

getRawBulletOffset

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.


setRawBulletOffset

public void setRawBulletOffset(short value)

getRawTextOffset

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.


setRawTextOffset

public void setRawTextOffset(short value)

getRawNumberedBulletAuto

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>.


setRawNumberedBulletAuto

public void setRawNumberedBulletAuto(short value)

getRawNumberedBulletStyle

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.


setRawNumberedBulletStyle

public void setRawNumberedBulletStyle(int value)

getRawNumberedBulletStartWith

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


setRawNumberedBulletStartWith

public void setRawNumberedBulletStartWith(short value)

getRawPictureBulletId

public short getRawPictureBulletId()

Returns or sets the PictureBullet Id. Read/Write short

-1paragraph doesn't have picture bullet.
-2value should be inherited from the master.


setRawPictureBulletId

public void setRawPictureBulletId(short value)

getRawEastAsianLineBreak

public short getRawEastAsianLineBreak()

Returns or sets value, which determines if special east asian linebreaking rules will be applied. Read/write short.

1use EA line break rules.
0don't use EA line break rules.
-1use inherited value.


setRawEastAsianLineBreak

public void setRawEastAsianLineBreak(short value)

getRawHangingPunctuation

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.

1leave punctuation on same line.
0carry punctuation to the next line.
-1use inherited value.


setRawHangingPunctuation

public void setRawHangingPunctuation(short value)

getPortions

public PortionCollection getPortions()

Returns the collection of a text portions. Read-only Aspose.Slides.PortionCollection.


getText

public java.lang.String getText()

Gets or sets the plain text of a paragraph.

Value: The text.


setText

public void setText(java.lang.String value)