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.


Field Summary
 boolean m_bBuHardColor
           
 boolean m_bBuHardFont
           
 boolean m_bBuHardSize
           
 boolean m_bBuOn
           
 boolean m_bDefaultBulletColor
           
 boolean m_bDefaultExtendedBullet
           
 short m_nAsianLB_1
           
 short m_nAsianLB_2
           
 short m_nAsianLB_3
           
 short m_nBiDi
           
 short m_nBuFlags
           
 short m_nBulletChar
           
 java.awt.Color m_nBulletColor
           
 int m_nBulletColorIndex
           
 int m_nBulletExtFlag
           
 short m_nBulletFont
           
 short m_nBulletHeight
           
 short m_nBulletId
           
 short m_nBulletOfs
           
 short m_nBulletStartWith
           
 short m_nBulletStyle
           
 short m_nDefaultTabSize
           
 int m_nFlags
           
 short m_nHasAutoNumber
           
 short m_nLineFeed
           
 short m_nLowerDist
           
 short m_nTextOfs
           
 short m_nUpperDist
           
 
Constructor Summary
Paragraph()
          Initializes a new instance of the Paragraph class.
Paragraph(int dummy)
           
Paragraph(Paragraph para)
          Initializes a new instance of the Paragraph class.
 
Method Summary
 boolean equalFormatting(Paragraph para)
           
 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()
          Returns or sets a color of a bullet.
 short getBulletColorIndex()
          Returns or sets the index of a bullet's color in a color scheme or -1 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 getHasBullet()
          Determines whether the paragraph has a bullet.
 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. -1 for other types of bullets.
 Portions 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()
          Returns or sets the color of a bullet.
 int getRawBulletFontIndex()
          Returns or sets the font of the bullet. -1 means font should be inherited from the master.
 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. -1 means value should be inherited from the ruler or the master.
 short getRawNumberedBulletAuto()
          Determines whether the bullet is auto numbered bullet. -1 means value should be inherited from the ruler or the master.
 short getRawNumberedBulletStartWith()
          Returns or sets the beginning value of a numbered bullet. -1 means value should be inherited from the master.
 int getRawNumberedBulletStyle()
          Returns or sets the style of a numbered bullet.
 short getRawPictureBulletId()
           
 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. -1 means value should be inherited from the ruler or the master.
 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()
          Returns or sets the plain text of a paragraph.
 short getTextOffset()
          Returns or sets the offset of a text.
 boolean isBulletHardColor()
          Returns true if bullet has own color and false if bullet uses color of the first portion in a paragraph.
 boolean isBulletHardFont()
          Returns true if bullet has own font and false if bullet uses font of the first portion in the paragraph.
 void isBulletHardFont(boolean value)
           
 boolean isBulletHardSize()
          Returns true if bullet has own size and false if bullet uses size of the first portion in the paragraph.
 void isBulletHardSize(boolean value)
           
 boolean isExtendedBullet()
          Returns true if paragraph has extended bullets (image or numbered).
 void setAlignment(int value)
           
 void setBulletCharacter(char value)
           
 void setBulletColor(java.awt.Color value)
           
 void setBulletColorIndex(short value)
           
 void setBulletFontIndex(int value)
           
 void setBulletHardColor(boolean value)
           
 void setBulletHeight(short value)
           
 void setBulletOffset(short value)
           
 void setBulletType(int value)
           
 void setDepth(short value)
           
 void setHasBullet(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 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
 

Field Detail

m_nFlags

public int m_nFlags

m_nBuFlags

public short m_nBuFlags

m_bBuOn

public boolean m_bBuOn

m_bBuHardFont

public boolean m_bBuHardFont

m_bBuHardColor

public boolean m_bBuHardColor

m_bBuHardSize

public boolean m_bBuHardSize

m_nBulletChar

public short m_nBulletChar

m_nBulletFont

public short m_nBulletFont

m_nBulletHeight

public short m_nBulletHeight

m_nBulletColor

public java.awt.Color m_nBulletColor

m_nBulletColorIndex

public int m_nBulletColorIndex

m_bDefaultBulletColor

public boolean m_bDefaultBulletColor

m_bDefaultExtendedBullet

public boolean m_bDefaultExtendedBullet

m_nBulletExtFlag

public int m_nBulletExtFlag

m_nBulletId

public short m_nBulletId

m_nHasAutoNumber

public short m_nHasAutoNumber

m_nBulletStyle

public short m_nBulletStyle

m_nBulletStartWith

public short m_nBulletStartWith

m_nLineFeed

public short m_nLineFeed

m_nUpperDist

public short m_nUpperDist

m_nLowerDist

public short m_nLowerDist

m_nAsianLB_1

public short m_nAsianLB_1

m_nAsianLB_2

public short m_nAsianLB_2

m_nAsianLB_3

public short m_nAsianLB_3

m_nBiDi

public short m_nBiDi

m_nBulletOfs

public short m_nBulletOfs

m_nTextOfs

public short m_nTextOfs

m_nDefaultTabSize

public short m_nDefaultTabSize
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.


Paragraph

public Paragraph(int dummy)
Method Detail

equalFormatting

public boolean equalFormatting(Paragraph para)

getDepth

public short getDepth()
Returns or sets a depth of a paragraph.


setDepth

public void setDepth(short value)

getHasBullet

public boolean getHasBullet()
Determines whether the paragraph has a bullet.


setHasBullet

public void setHasBullet(boolean value)

isBulletHardColor

public boolean isBulletHardColor()
Returns true if bullet has own color and false if bullet uses color of the first portion in a paragraph.


setBulletHardColor

public void setBulletHardColor(boolean value)

getBulletColor

public java.awt.Color getBulletColor()
Returns or sets a color of a bullet.


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 -1 for scheme-independent color.


setBulletColorIndex

public void setBulletColorIndex(short value)

isBulletHardFont

public boolean isBulletHardFont()
Returns true if bullet has own font and false if bullet uses font of the first portion in the paragraph.


isBulletHardFont

public void isBulletHardFont(boolean value)

getBulletFontIndex

public int getBulletFontIndex()
Returns or sets the font of a bullet.


setBulletFontIndex

public void setBulletFontIndex(int value)

isBulletHardSize

public boolean isBulletHardSize()
Returns true if bullet has own size and false if bullet uses size of the first portion in the paragraph.


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.


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.


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 -8 and less should be divided by -8 to obtain space in points.


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 -8 and less should be divided by -8 to obtain space in points.


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 -8 and less should be divided by -8 to obtain space in points.


setSpaceWithin

public void setSpaceWithin(short value)

getBulletOffset

public short getBulletOffset()
Returns or sets the offset of a bullet.


setBulletOffset

public void setBulletOffset(short value)

getTextOffset

public short getTextOffset()
Returns or sets the offset of a text.


setTextOffset

public void setTextOffset(short value)

getAlignment

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


setAlignment

public void setAlignment(int value)

isExtendedBullet

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


getBulletType

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


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.


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.


setNumberedBulletStartWith

public void setNumberedBulletStartWith(short value)

getPictureBulletId

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


setPictureBulletId

public void setPictureBulletId(short value)

getRawAlignment

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


setRawAlignment

public void setRawAlignment(int value)

getRawBulletColor

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


setRawBulletColor

public void setRawBulletColor(java.awt.Color value)

getRawBulletFontIndex

public int getRawBulletFontIndex()
Returns or sets the font of the bullet. -1 means font should be inherited from the master.


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


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. (char)-1 means value should be inherited from the master.


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 -8 and lesser should be divided by -8 to obtain space in points. -1 means value should be inherited from the master.


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 -8 and lesser should be divided by -8 to obtain space in points. -1 means value should be inherited from the master.


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 -8 and lesser should be divided by -8 to obtain space in points. -1 means value should be inherited from the master.


setRawSpaceWithin

public void setRawSpaceWithin(short value)

getRawBulletOffset

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


setRawBulletOffset

public void setRawBulletOffset(short value)

getRawTextOffset

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


setRawTextOffset

public void setRawTextOffset(short value)

getRawNumberedBulletAuto

public short getRawNumberedBulletAuto()
Determines whether the bullet is auto numbered bullet. -1 means value should be inherited from the ruler or the master.


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.


setRawNumberedBulletStyle

public void setRawNumberedBulletStyle(int value)

getRawNumberedBulletStartWith

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


setRawNumberedBulletStartWith

public void setRawNumberedBulletStartWith(short value)

getRawPictureBulletId

public short getRawPictureBulletId()

setRawPictureBulletId

public void setRawPictureBulletId(short value)

getPortions

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


getText

public java.lang.String getText()
Returns or sets the plain text of a paragraph.


setText

public void setText(java.lang.String value)