com.lowagie.text.pdf
Class PdfPCell

java.lang.Object
  |
  +--com.lowagie.text.Rectangle
        |
        +--com.lowagie.text.pdf.PdfPCell
All Implemented Interfaces:
Element, MarkupAttributes

public class PdfPCell
extends Rectangle

A cell in a PdfPTable.


Field Summary
private  int arabicOptions
           
private  PdfPCellEvent cellEvent
          Holds value of property cellEvent.
private  int colspan
          Holds value of property colspan.
protected  float extraParagraphSpace
          The extra space between paragraphs.
private  float fixedHeight
          Holds value of property fixedHeight.
protected  float fixedLeading
          The fixed text leading.
protected  float followingIndent
          The following paragraph lines indent.
private  int horizontalAlignment
          Holds value of property horizontalAlignment.
private  Image image
          Holds value of property image.
protected  float indent
          The first paragraph line indent.
private  float minimumHeight
          Holds value of property minimumHeight.
protected  float multipliedLeading
          The text leading that is multiplied by the biggest font size in the line.
private  boolean noWrap
          Holds value of property noWrap.
private  float paddingBottom
          Holds value of property paddingBottom.
private  float paddingLeft
          Holds value of property paddingLeft.
private  float paddingRight
          Holds value of property paddingLeft.
private  float paddingTop
          Holds value of property paddingTop.
protected  Phrase phrase
          The text in the cell.
protected  float rightIndent
          The right paragraph lines indent.
protected  int runDirection
           
private  float spaceCharRatio
           
private  PdfPTable table
          Holds value of property table.
private  int verticalAlignment
          Holds value of property verticalAlignment.
 
Fields inherited from class com.lowagie.text.Rectangle
background, border, borderWidth, BOTTOM, BOX, color, grayFill, LEFT, llx, lly, markupAttributes, NO_BORDER, RIGHT, rotation, TOP, UNDEFINED, urx, ury
 
Fields inherited from interface com.lowagie.text.Element
ALIGN_BASELINE, ALIGN_BOTTOM, ALIGN_CENTER, ALIGN_JUSTIFIED, ALIGN_LEFT, ALIGN_MIDDLE, ALIGN_RIGHT, ALIGN_TOP, ALIGN_UNDEFINED, ANCHOR, ANNOTATION, AUTHOR, CCITT_BLACKIS1, CCITT_ENCODEDBYTEALIGN, CCITT_ENDOFBLOCK, CCITT_ENDOFLINE, CCITTG3_1D, CCITTG3_2D, CCITTG4, CELL, CHAPTER, CHUNK, CREATIONDATE, CREATOR, GRAPHIC, HEADER, IMGRAW, IMGTEMPLATE, JPEG, KEYWORDS, LIST, LISTITEM, PARAGRAPH, PHRASE, PRODUCER, PTABLE, RECTANGLE, ROW, SECTION, SUBJECT, TABLE, TITLE
 
Constructor Summary
PdfPCell(Image image)
          Constructs a PdfPCell with an Image.
PdfPCell(Image image, boolean fit)
          Constructs a PdfPCell with an Image.
PdfPCell(PdfPCell cell)
          Constructs a deep copy of a PdfPCell.
PdfPCell(PdfPTable table)
          Constructs a PdfPCell with a PdfPtable.
PdfPCell(Phrase phrase)
          Constructs a PdfPCell with a Phrase.
 
Method Summary
 int getArabicOptions()
          Gets the arabic shaping options.
 PdfPCellEvent getCellEvent()
          Gets the cell event for this cell.
 int getColspan()
          Getter for property colspan.
 float getExtraParagraphSpace()
          Sets the extra space between paragraphs.
 float getFixedHeight()
          Getter for property fixedHeight.
 float getFollowingIndent()
          Gets the following paragraph lines indent.
 int getHorizontalAlignment()
          Gets the horizontal alignment for the cell.
 Image getImage()
          Getter for property image.
 float getIndent()
          Gets the first paragraph line indent.
 float getLeading()
          Gets the fixed leading
 float getMinimumHeight()
          Getter for property minimumHeight.
 float getMultipliedLeading()
          Gets the variable leading
 float getPaddingBottom()
          Getter for property paddingBottom.
 float getPaddingLeft()
           
 float getPaddingRight()
          Getter for property paddingRight.
 float getPaddingTop()
          Getter for property paddingTop.
 Phrase getPhrase()
          Gets the Phrase from this cell.
 float getRightIndent()
          Gets the right paragraph lines indent.
 int getRunDirection()
           
 float getSpaceCharRatio()
          Gets the space/character extra spacing ratio for fully justified text.
(package private)  PdfPTable getTable()
          Getter for property table.
 int getVerticalAlignment()
          Gets the vertical alignment for the cell.
 boolean isNoWrap()
          Getter for property noWrap.
 void setArabicOptions(int arabicOptions)
          Sets the arabic shaping options.
 void setCellEvent(PdfPCellEvent cellEvent)
          Sets the cell event for this cell.
 void setColspan(int colspan)
          Setter for property colspan.
 void setExtraParagraphSpace(float extraParagraphSpace)
          Sets the extra space between paragraphs.
 void setFixedHeight(float fixedHeight)
          Setter for property fixedHeight.
 void setFollowingIndent(float indent)
          Sets the following paragraph lines indent.
 void setHorizontalAlignment(int horizontalAlignment)
          Sets the horizontal alignment for the cell.
 void setImage(Image image)
          Setter for property image.
 void setIndent(float indent)
          Sets the first paragraph line indent.
 void setLeading(float fixedLeading, float multipliedLeading)
          Sets the leading fixed and variable.
 void setMinimumHeight(float minimumHeight)
          Setter for property minimumHeight.
 void setNoWrap(boolean noWrap)
          Setter for property noWrap.
 void setPadding(float padding)
           
 void setPaddingBottom(float paddingBottom)
          Setter for property paddingBottom.
 void setPaddingLeft(float paddingLeft)
          Setter for property paddingLeft.
 void setPaddingRight(float paddingRight)
          Setter for property paddingRight.
 void setPaddingTop(float paddingTop)
          Setter for property paddingTop.
 void setPhrase(Phrase phrase)
          Sets the Phrase for this cell.
 void setRightIndent(float indent)
          Sets the right paragraph lines indent.
 void setRunDirection(int runDirection)
           
 void setSpaceCharRatio(float spaceCharRatio)
          Sets the ratio between the extra word spacing and the extra character spacing when the text is fully justified.
(package private)  void setTable(PdfPTable table)
           
 void setVerticalAlignment(int verticalAlignment)
          Sets the vertical alignment for the cell.
 
Methods inherited from class com.lowagie.text.Rectangle
backgroundColor, border, borderColor, borderWidth, bottom, bottom, getChunks, getMarkupAttribute, getMarkupAttributeNames, getMarkupAttributes, getRotation, grayFill, hasBorder, hasBorders, height, left, left, process, rectangle, right, right, rotate, setBackgroundColor, setBorder, setBorderColor, setBorderWidth, setBottom, setGrayFill, setLeft, setMarkupAttribute, setMarkupAttributes, setRight, setTop, top, top, type, width
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.lowagie.text.Element
toString
 

Field Detail

horizontalAlignment

private int horizontalAlignment
Holds value of property horizontalAlignment.


verticalAlignment

private int verticalAlignment
Holds value of property verticalAlignment.


paddingLeft

private float paddingLeft
Holds value of property paddingLeft.


paddingRight

private float paddingRight
Holds value of property paddingLeft.


paddingTop

private float paddingTop
Holds value of property paddingTop.


paddingBottom

private float paddingBottom
Holds value of property paddingBottom.


fixedLeading

protected float fixedLeading
The fixed text leading.


multipliedLeading

protected float multipliedLeading
The text leading that is multiplied by the biggest font size in the line.


extraParagraphSpace

protected float extraParagraphSpace
The extra space between paragraphs.


indent

protected float indent
The first paragraph line indent.


followingIndent

protected float followingIndent
The following paragraph lines indent.


rightIndent

protected float rightIndent
The right paragraph lines indent.


phrase

protected Phrase phrase
The text in the cell.


fixedHeight

private float fixedHeight
Holds value of property fixedHeight.


noWrap

private boolean noWrap
Holds value of property noWrap.


table

private PdfPTable table
Holds value of property table.


minimumHeight

private float minimumHeight
Holds value of property minimumHeight.


colspan

private int colspan
Holds value of property colspan.


spaceCharRatio

private float spaceCharRatio

runDirection

protected int runDirection

image

private Image image
Holds value of property image.


cellEvent

private PdfPCellEvent cellEvent
Holds value of property cellEvent.


arabicOptions

private int arabicOptions
Constructor Detail

PdfPCell

public PdfPCell(Phrase phrase)
Constructs a PdfPCell with a Phrase. The default padding is 2.

Parameters:
phrase - the text

PdfPCell

public PdfPCell(Image image)
Constructs a PdfPCell with an Image. The default padding is 0.

Parameters:
image - the Image

PdfPCell

public PdfPCell(Image image,
                boolean fit)
Constructs a PdfPCell with an Image. The default padding is 0.25 for a border width of 0.5.

Parameters:
image - the Image
fit - true to fit the image to the cell

PdfPCell

public PdfPCell(PdfPTable table)
Constructs a PdfPCell with a PdfPtable. This constructor allows nested tables. The default padding is 0.

Parameters:
table - The PdfPTable

PdfPCell

public PdfPCell(PdfPCell cell)
Constructs a deep copy of a PdfPCell.

Parameters:
cell - the PdfPCell to duplicate
Method Detail

getPhrase

public Phrase getPhrase()
Gets the Phrase from this cell.

Returns:
the Phrase

setPhrase

public void setPhrase(Phrase phrase)
Sets the Phrase for this cell.

Parameters:
phrase - the Phrase

getHorizontalAlignment

public int getHorizontalAlignment()
Gets the horizontal alignment for the cell.

Returns:
the horizontal alignment for the cell

setHorizontalAlignment

public void setHorizontalAlignment(int horizontalAlignment)
Sets the horizontal alignment for the cell. It could be Element.ALIGN_CENTER for example.

Parameters:
horizontalAlignment - The horizontal alignment

getVerticalAlignment

public int getVerticalAlignment()
Gets the vertical alignment for the cell.

Returns:
the vertical alignment for the cell

setVerticalAlignment

public void setVerticalAlignment(int verticalAlignment)
Sets the vertical alignment for the cell. It could be Element.ALIGN_MIDDLE for example.

Parameters:
verticalAlignment - The vertical alignment

getPaddingLeft

public float getPaddingLeft()
Returns:
Value of property paddingLeft.

setPaddingLeft

public void setPaddingLeft(float paddingLeft)
Setter for property paddingLeft.

Parameters:
paddingLeft - New value of property paddingLeft.

getPaddingRight

public float getPaddingRight()
Getter for property paddingRight.

Returns:
Value of property paddingRight.

setPaddingRight

public void setPaddingRight(float paddingRight)
Setter for property paddingRight.

Parameters:
paddingRight - New value of property paddingRight.

getPaddingTop

public float getPaddingTop()
Getter for property paddingTop.

Returns:
Value of property paddingTop.

setPaddingTop

public void setPaddingTop(float paddingTop)
Setter for property paddingTop.

Parameters:
paddingTop - New value of property paddingTop.

getPaddingBottom

public float getPaddingBottom()
Getter for property paddingBottom.

Returns:
Value of property paddingBottom.

setPaddingBottom

public void setPaddingBottom(float paddingBottom)
Setter for property paddingBottom.

Parameters:
paddingBottom - New value of property paddingBottom.

setPadding

public void setPadding(float padding)

setLeading

public void setLeading(float fixedLeading,
                       float multipliedLeading)
Sets the leading fixed and variable. The resultant leading will be fixedLeading+multipliedLeading*maxFontSize where maxFontSize is the size of the bigest font in the line.

Parameters:
fixedLeading - the fixed leading
multipliedLeading - the variable leading

getLeading

public float getLeading()
Gets the fixed leading

Returns:
the leading

getMultipliedLeading

public float getMultipliedLeading()
Gets the variable leading

Returns:
the leading

setIndent

public void setIndent(float indent)
Sets the first paragraph line indent.

Parameters:
indent - the indent

getIndent

public float getIndent()
Gets the first paragraph line indent.

Returns:
the indent

getExtraParagraphSpace

public float getExtraParagraphSpace()
Sets the extra space between paragraphs.

Returns:
the extra space between paragraphs

setExtraParagraphSpace

public void setExtraParagraphSpace(float extraParagraphSpace)
Sets the extra space between paragraphs.

Parameters:
extraParagraphSpace - the extra space between paragraphs

getFixedHeight

public float getFixedHeight()
Getter for property fixedHeight.

Returns:
Value of property fixedHeight.

setFixedHeight

public void setFixedHeight(float fixedHeight)
Setter for property fixedHeight.

Parameters:
fixedHeight - New value of property fixedHeight.

isNoWrap

public boolean isNoWrap()
Getter for property noWrap.

Returns:
Value of property noWrap.

setNoWrap

public void setNoWrap(boolean noWrap)
Setter for property noWrap.

Parameters:
noWrap - New value of property noWrap.

getTable

PdfPTable getTable()
Getter for property table.

Returns:
Value of property table.

setTable

void setTable(PdfPTable table)

getMinimumHeight

public float getMinimumHeight()
Getter for property minimumHeight.

Returns:
Value of property minimumHeight.

setMinimumHeight

public void setMinimumHeight(float minimumHeight)
Setter for property minimumHeight.

Parameters:
minimumHeight - New value of property minimumHeight.

getColspan

public int getColspan()
Getter for property colspan.

Returns:
Value of property colspan.

setColspan

public void setColspan(int colspan)
Setter for property colspan.

Parameters:
colspan - New value of property colspan.

setFollowingIndent

public void setFollowingIndent(float indent)
Sets the following paragraph lines indent.

Parameters:
indent - the indent

getFollowingIndent

public float getFollowingIndent()
Gets the following paragraph lines indent.

Returns:
the indent

setRightIndent

public void setRightIndent(float indent)
Sets the right paragraph lines indent.

Parameters:
indent - the indent

getRightIndent

public float getRightIndent()
Gets the right paragraph lines indent.

Returns:
the indent

getSpaceCharRatio

public float getSpaceCharRatio()
Gets the space/character extra spacing ratio for fully justified text.

Returns:
the space/character extra spacing ratio

setSpaceCharRatio

public void setSpaceCharRatio(float spaceCharRatio)
Sets the ratio between the extra word spacing and the extra character spacing when the text is fully justified. Extra word spacing will grow spaceCharRatio times more than extra character spacing. If the ratio is PdfWriter.NO_SPACE_CHAR_RATIO then the extra character spacing will be zero.

Parameters:
spaceCharRatio - the ratio between the extra word spacing and the extra character spacing

setRunDirection

public void setRunDirection(int runDirection)

getRunDirection

public int getRunDirection()

getImage

public Image getImage()
Getter for property image.

Returns:
Value of property image.

setImage

public void setImage(Image image)
Setter for property image.

Parameters:
image - New value of property image.

getCellEvent

public PdfPCellEvent getCellEvent()
Gets the cell event for this cell.

Returns:
the cell event

setCellEvent

public void setCellEvent(PdfPCellEvent cellEvent)
Sets the cell event for this cell.

Parameters:
cellEvent - the cell event

getArabicOptions

public int getArabicOptions()
Gets the arabic shaping options.

Returns:
the arabic shaping options

setArabicOptions

public void setArabicOptions(int arabicOptions)
Sets the arabic shaping options. The option can be AR_NOVOWEL, AR_COMPOSEDTASHKEEL and AR_LIG.

Parameters:
arabicOptions - the arabic shaping options