com.aspose.slides
Class ParagraphFormat

java.lang.Object
  extended by com.aspose.slides.ParagraphFormat
All Implemented Interfaces:
IChartParagraphFormat, IParagraphFormat, IPresentationComponent, ISlideComponent

public class ParagraphFormat
extends java.lang.Object
implements IParagraphFormat, IChartParagraphFormat

This class contains the paragraph formatting properties. Unlike ParagraphFormatEffectiveData, all properties of this class are writeable.


This class is used to return and manipulate paragraph formatting properties defined for the particular paragraph. This means that no inheritance is applied when getting values so for the majority of cases you will get values meaning "undefined".

In order to get the effective formatting parameter values including inherited you need to use Paragraph.CreateParagraphFormatEffective method which returns a ParagraphFormatEffectiveData instance.


Method Summary
 int getAlignment()
           Returns or sets the text alignment in a paragraph with no inheritance.
 IBulletFormat getBullet()
           
 char getBulletChar()
          Deprecated. 
 IColorFormat getBulletColor()
          Deprecated. 
 IColorFormat getBulletColorFormat()
          Deprecated. 
 IFontData getBulletFont()
          Deprecated. 
 float getBulletHeight()
          Deprecated. 
 byte getBulletType()
          Deprecated. 
 IPortionFormat getDefaultPortionFormat()
           Returns default portion format of a paragraph.
 float getDefaultTabSize()
           Returns or sets default tabulation size with no inheritance.
 short getDepth()
           Returns or sets depth of the paragraph.
 byte getEastAsianLineBreak()
           Determines whether the East Asian line break is used in a paragraph.
 int getFontAlignment()
           Returns or sets a font alignment in a paragraph with no inheritance.
 byte getHangingPunctuation()
           Determines whether the hanging punctuation is used in a paragraph.
 float getIndent()
           Returns or sets text indentation in a paragraph with no inheritance.
 byte getLatinLineBreak()
           Determines whether the Latin line break is used in a paragraph.
 float getMarginLeft()
           Returns or sets the left margin in a paragraph with no inheritance.
 float getMarginRight()
           Returns or sets the right margin in a paragraph with no inheritance.
 short getNumberedBulletStartWith()
          Deprecated. 
 int getNumberedBulletStyle()
          Deprecated. 
 IPresentation getPresentation()
           Returns the parent presentation of a paragraph.
 byte getRightToLeft()
           Determines whether the Right to Left writing is used in a paragraph.
 IBaseSlide getSlide()
           Returns the parent slide of a paragraph.
 float getSpaceAfter()
           Returns or sets the amount of space after the last line in a paragraph with no inheritance.
 float getSpaceBefore()
           Returns or sets the amount of space before the first line in a paragraph with no inheritance.
 float getSpaceWithin()
           Returns or sets the amount of space between base lines in a paragraph.
 ITabCollection getTabs()
           Returns tabulations of a paragraph.
 byte isBulletHardColor()
          Deprecated. 
 void isBulletHardColor(byte value)
          Deprecated. 
 byte isBulletHardFont()
          Deprecated. 
 void isBulletHardFont(byte value)
          Deprecated. 
 void setAlignment(int value)
           
 void setBulletChar(char value)
          Deprecated. 
 void setBulletFont(IFontData value)
          Deprecated. 
 void setBulletHeight(float value)
          Deprecated. 
 void setBulletType(byte value)
          Deprecated. 
 void setDefaultTabSize(float value)
           
 void setDepth(short value)
           
 void setEastAsianLineBreak(byte value)
           
 void setFontAlignment(int value)
           
 void setHangingPunctuation(byte value)
           
 void setIndent(float value)
           
 void setLatinLineBreak(byte value)
           
 void setMarginLeft(float value)
           
 void setMarginRight(float value)
           
 void setNumberedBulletStartWith(short value)
          Deprecated. 
 void setNumberedBulletStyle(int value)
          Deprecated. 
 void setRightToLeft(byte value)
           
 void setSpaceAfter(float value)
           
 void setSpaceBefore(float value)
           
 void setSpaceWithin(float value)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getDepth

public short getDepth()

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

Specified by:
getDepth in interface IParagraphFormat

setDepth

public void setDepth(short value)
Specified by:
setDepth in interface IParagraphFormat

getAlignment

public int getAlignment()

Returns or sets the text alignment in a paragraph with no inheritance. Read/write TextAlignment.

Specified by:
getAlignment in interface IChartParagraphFormat
Specified by:
getAlignment in interface IParagraphFormat

setAlignment

public void setAlignment(int value)
Specified by:
setAlignment in interface IChartParagraphFormat
Specified by:
setAlignment in interface IParagraphFormat

getSpaceWithin

public float getSpaceWithin()

Returns or sets the amount of space between base lines in a paragraph. Positive value means percentage, negative - size in points. No inheritance applied. Read/write float.

Specified by:
getSpaceWithin in interface IChartParagraphFormat
Specified by:
getSpaceWithin in interface IParagraphFormat

setSpaceWithin

public void setSpaceWithin(float value)
Specified by:
setSpaceWithin in interface IChartParagraphFormat
Specified by:
setSpaceWithin in interface IParagraphFormat

getSpaceBefore

public float getSpaceBefore()

Returns or sets the amount of space before the first line in a paragraph with no inheritance. Read/write float.

Specified by:
getSpaceBefore in interface IChartParagraphFormat
Specified by:
getSpaceBefore in interface IParagraphFormat

setSpaceBefore

public void setSpaceBefore(float value)
Specified by:
setSpaceBefore in interface IChartParagraphFormat
Specified by:
setSpaceBefore in interface IParagraphFormat

getSpaceAfter

public float getSpaceAfter()

Returns or sets the amount of space after the last line in a paragraph with no inheritance. Read/write float.

Specified by:
getSpaceAfter in interface IChartParagraphFormat
Specified by:
getSpaceAfter in interface IParagraphFormat

setSpaceAfter

public void setSpaceAfter(float value)
Specified by:
setSpaceAfter in interface IChartParagraphFormat
Specified by:
setSpaceAfter in interface IParagraphFormat

getEastAsianLineBreak

public byte getEastAsianLineBreak()

Determines whether the East Asian line break is used in a paragraph. No inheritance applied. Read/write NullableBool.

Specified by:
getEastAsianLineBreak in interface IChartParagraphFormat
Specified by:
getEastAsianLineBreak in interface IParagraphFormat

setEastAsianLineBreak

public void setEastAsianLineBreak(byte value)
Specified by:
setEastAsianLineBreak in interface IChartParagraphFormat
Specified by:
setEastAsianLineBreak in interface IParagraphFormat

getRightToLeft

public byte getRightToLeft()

Determines whether the Right to Left writing is used in a paragraph. No inheritance applied. Read/write NullableBool.

Specified by:
getRightToLeft in interface IChartParagraphFormat
Specified by:
getRightToLeft in interface IParagraphFormat

setRightToLeft

public void setRightToLeft(byte value)
Specified by:
setRightToLeft in interface IChartParagraphFormat
Specified by:
setRightToLeft in interface IParagraphFormat

getLatinLineBreak

public byte getLatinLineBreak()

Determines whether the Latin line break is used in a paragraph. No inheritance applied. Read/write NullableBool.

Specified by:
getLatinLineBreak in interface IChartParagraphFormat
Specified by:
getLatinLineBreak in interface IParagraphFormat

setLatinLineBreak

public void setLatinLineBreak(byte value)
Specified by:
setLatinLineBreak in interface IChartParagraphFormat
Specified by:
setLatinLineBreak in interface IParagraphFormat

getHangingPunctuation

public byte getHangingPunctuation()

Determines whether the hanging punctuation is used in a paragraph. No inheritance applied. Read/write NullableBool.

Specified by:
getHangingPunctuation in interface IChartParagraphFormat
Specified by:
getHangingPunctuation in interface IParagraphFormat

setHangingPunctuation

public void setHangingPunctuation(byte value)
Specified by:
setHangingPunctuation in interface IChartParagraphFormat
Specified by:
setHangingPunctuation in interface IParagraphFormat

getMarginLeft

public float getMarginLeft()

Returns or sets the left margin in a paragraph with no inheritance. Read/write float.

Specified by:
getMarginLeft in interface IChartParagraphFormat
Specified by:
getMarginLeft in interface IParagraphFormat

setMarginLeft

public void setMarginLeft(float value)
Specified by:
setMarginLeft in interface IChartParagraphFormat
Specified by:
setMarginLeft in interface IParagraphFormat

getMarginRight

public float getMarginRight()

Returns or sets the right margin in a paragraph with no inheritance. Read/write float.

Specified by:
getMarginRight in interface IChartParagraphFormat
Specified by:
getMarginRight in interface IParagraphFormat

setMarginRight

public void setMarginRight(float value)
Specified by:
setMarginRight in interface IChartParagraphFormat
Specified by:
setMarginRight in interface IParagraphFormat

getIndent

public float getIndent()

Returns or sets text indentation in a paragraph with no inheritance. Read/write float.

Specified by:
getIndent in interface IChartParagraphFormat
Specified by:
getIndent in interface IParagraphFormat

setIndent

public void setIndent(float value)
Specified by:
setIndent in interface IChartParagraphFormat
Specified by:
setIndent in interface IParagraphFormat

getDefaultTabSize

public float getDefaultTabSize()

Returns or sets default tabulation size with no inheritance. Read/write float.

Specified by:
getDefaultTabSize in interface IChartParagraphFormat
Specified by:
getDefaultTabSize in interface IParagraphFormat

setDefaultTabSize

public void setDefaultTabSize(float value)
Specified by:
setDefaultTabSize in interface IChartParagraphFormat
Specified by:
setDefaultTabSize in interface IParagraphFormat

getTabs

public ITabCollection getTabs()

Returns tabulations of a paragraph. No inheritance applied. Read-only TabCollection.

Specified by:
getTabs in interface IChartParagraphFormat
Specified by:
getTabs in interface IParagraphFormat

getFontAlignment

public int getFontAlignment()

Returns or sets a font alignment in a paragraph with no inheritance. Read/write FontAlignment.

Specified by:
getFontAlignment in interface IChartParagraphFormat
Specified by:
getFontAlignment in interface IParagraphFormat

setFontAlignment

public void setFontAlignment(int value)
Specified by:
setFontAlignment in interface IChartParagraphFormat
Specified by:
setFontAlignment in interface IParagraphFormat

getDefaultPortionFormat

public IPortionFormat getDefaultPortionFormat()

Returns default portion format of a paragraph. No inheritance applied. Read-only PortionFormat.

Specified by:
getDefaultPortionFormat in interface IParagraphFormat

getSlide

public IBaseSlide getSlide()

Returns the parent slide of a paragraph. Read-only BaseSlide.

Specified by:
getSlide in interface ISlideComponent

getPresentation

public IPresentation getPresentation()

Returns the parent presentation of a paragraph. Read-only Presentation.

Specified by:
getPresentation in interface IPresentationComponent

getBullet

public IBulletFormat getBullet()
Specified by:
getBullet in interface IParagraphFormat

getBulletType

@Deprecated
public byte getBulletType()
Deprecated. 

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


setBulletType

@Deprecated
public void setBulletType(byte value)
Deprecated. 


getBulletChar

@Deprecated
public char getBulletChar()
Deprecated. 

Returns or sets the bullet char of a paragraph. Read/write char.


setBulletChar

@Deprecated
public void setBulletChar(char value)
Deprecated. 


getBulletFont

@Deprecated
public IFontData getBulletFont()
Deprecated. 

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


setBulletFont

@Deprecated
public void setBulletFont(IFontData value)
Deprecated. 


getBulletHeight

@Deprecated
public float getBulletHeight()
Deprecated. 

Returns or sets the bullet height of a paragraph. Read/write float.


setBulletHeight

@Deprecated
public void setBulletHeight(float value)
Deprecated. 


getBulletColor

@Deprecated
public IColorFormat getBulletColor()
Deprecated. 

Returns the color format of a bullet of a paragraph. Read-only ColorFormat.


getNumberedBulletStartWith

@Deprecated
public short getNumberedBulletStartWith()
Deprecated. 

Returns or sets the first number which is used for group of numbered bullets. Read/write short.


setNumberedBulletStartWith

@Deprecated
public void setNumberedBulletStartWith(short value)
Deprecated. 


getNumberedBulletStyle

@Deprecated
public int getNumberedBulletStyle()
Deprecated. 

Returns or sets the style of a numbered bullet. Read/write NumberedBulletStyle.


setNumberedBulletStyle

@Deprecated
public void setNumberedBulletStyle(int value)
Deprecated. 


isBulletHardColor

@Deprecated
public byte isBulletHardColor()
Deprecated. 

Determines whether the bullet has own color or inherits it from the first portion in the paragraph. <b>NullableBool.True</b> if bullet has own color and <b>NullableBool.False</b> if bullet inherits color from the first portion in the paragraph. Read/write NullableBool.


isBulletHardColor

@Deprecated
public void isBulletHardColor(byte value)
Deprecated. 


getBulletColorFormat

@Deprecated
public IColorFormat getBulletColorFormat()
Deprecated. 

Returns or sets the color of a bullet. Read-only ColorFormat.


isBulletHardFont

@Deprecated
public byte isBulletHardFont()
Deprecated. 

Determines whether the bullet has own font or inherits it from the first portion in the paragraph. <b>NullableBool.True</b> if bullet has own font and <b>NullableBool.False</b> if bullet inherits font from the first portion in the paragraph. Read/write NullableBool.


isBulletHardFont

@Deprecated
public void isBulletHardFont(byte value)
Deprecated.