PdfLine defines an array with PdfChunk-objects
* that fit into 1 line.
*/
public class PdfLine {
// membervariables
/** The arraylist containing the chunks. */
protected ArrayList line;
/** The left indentation of the line. */
protected float left;
/** The width of the line. */
protected float width;
/** The alignment of the line. */
protected int alignment;
/** The heigth of the line. */
protected float height;
/** The listsymbol (if necessary). */
protected PdfChunk listSymbol = null;
/** The listsymbol (if necessary). */
protected float symbolIndent;
/** true if the chunk splitting was caused by a newline. */
protected boolean newlineSplit = false;
/** The original width. */
protected float originalWidth;
protected boolean isRTL = false;
// constructors
/**
* Constructs a new PdfLine-object.
*
* @param left the limit of the line at the left
* @param right the limit of the line at the right
* @param alignment the alignment of the line
* @param height the height of the line
*/
PdfLine(float left, float right, int alignment, float height) {
this.left = left;
this.width = right - left;
this.originalWidth = this.width;
this.alignment = alignment;
this.height = height;
this.line = new ArrayList();
}
PdfLine(float left, float remainingWidth, int alignment, boolean newlineSplit, ArrayList line, boolean isRTL) {
this.left = left;
this.width = remainingWidth;
this.alignment = alignment;
this.line = line;
this.newlineSplit = newlineSplit;
this.isRTL = isRTL;
}
// methods
/**
* Adds a PdfChunk to the PdfLine.
*
* @param chunk the PdfChunk to add
* @return null if the chunk could be added completely; if not
* a PdfChunk containing the part of the chunk that could
* not be added is returned
*/
PdfChunk add(PdfChunk chunk) {
// nothing happens if the chunk is null.
if (chunk == null || chunk.toString().equals("")) {
return null;
}
// we split the chunk to be added
PdfChunk overflow = chunk.split(width);
newlineSplit = (chunk.isNewlineSplit() || overflow == null);
// if (chunk.isNewlineSplit() && alignment == Element.ALIGN_JUSTIFIED)
// alignment = Element.ALIGN_LEFT;
// if the length of the chunk > 0 we add it to the line
if (chunk.length() > 0) {
if (overflow != null)
chunk.trimLastSpace();
width -= chunk.width();
line.add(chunk);
}
// if the length == 0 and there were no other chunks added to the line yet,
// we risk to end up in an endless loop trying endlessly to add the same chunk
else if (line.size() < 1) {
chunk = overflow;
overflow = chunk.truncate(width);
width -= chunk.width();
if (chunk.length() > 0) {
line.add(chunk);
return overflow;
}
// if the chunck couldn't even be truncated, we add everything, so be it
else {
if (overflow != null)
line.add(overflow);
return null;
}
}
else {
width += ((PdfChunk)(line.get(line.size() - 1))).trimLastSpace();
}
return overflow;
}
// methods to retrieve information
/**
* Returns the number of chunks in the line.
*
* @return a value
*/
public int size() {
return line.size();
}
/**
* Returns an iterator of PdfChunks.
*
* @return an Iterator
*/
public Iterator iterator() {
return line.iterator();
}
/**
* Returns the height of the line.
*
* @return a value
*/
float height() {
return height;
}
/**
* Returns the left indentation of the line taking the alignment of the line into account.
*
* @return a value
*/
float indentLeft() {
if (isRTL) {
switch (alignment) {
case Element.ALIGN_LEFT:
return left + width;
case Element.ALIGN_CENTER:
return left + (width / 2f);
default:
return left;
}
}
else {
switch (alignment) {
case Element.ALIGN_RIGHT:
return left + width;
case Element.ALIGN_CENTER:
return left + (width / 2f);
default:
return left;
}
}
}
/**
* Checks if this line has to be justified.
*
* @return true if the alignment equals ALIGN_JUSTIFIED and there is some width left.
*/
public boolean hasToBeJustified() {
return ((alignment == Element.ALIGN_JUSTIFIED || alignment == Element.ALIGN_JUSTIFIED_ALL) && width != 0);
}
/**
* Resets the alignment of this line.
*
* The alignment of the last line of for instance a Paragraph
* that has to be justified, has to be reset to ALIGN_LEFT.
*/
public void resetAlignment() {
if (alignment == Element.ALIGN_JUSTIFIED) {
alignment = Element.ALIGN_LEFT;
}
}
/**
* Returns the width that is left, after a maximum of characters is added to the line.
*
* @return a value
*/
float widthLeft() {
return width;
}
/**
* Returns the number of space-characters in this line.
*
* @return a value
*/
int numberOfSpaces() {
String string = toString();
int length = string.length();
int numberOfSpaces = 0;
for (int i = 0; i < length; i++) {
if (string.charAt(i) == ' ') {
numberOfSpaces++;
}
}
return numberOfSpaces;
}
/**
* Sets the listsymbol of this line.
*
* This is only necessary for the first line of a ListItem.
*
* @param listItem the list symbol
*/
public void setListItem(ListItem listItem) {
this.listSymbol = new PdfChunk(listItem.listSymbol(), null);
this.symbolIndent = listItem.indentationLeft();
}
/**
* Returns the listsymbol of this line.
*
* @return a PdfChunk if the line has a listsymbol; null otherwise
*/
public PdfChunk listSymbol() {
return listSymbol;
}
/**
* Return the indentation needed to show the listsymbol.
*
* @return a value
*/
public float listIndent() {
return symbolIndent;
}
/**
* Get the string representation of what is in this line.
*
* @return a String
*/
public String toString() {
StringBuffer tmp = new StringBuffer();
for (Iterator i = line.iterator(); i.hasNext(); ) {
tmp.append(((PdfChunk) i.next()).toString());
}
return tmp.toString();
}
/**
* Checks if a newline caused the line split.
* @return true if a newline caused the line split
*/
public boolean isNewlineSplit() {
return newlineSplit && (alignment != Element.ALIGN_JUSTIFIED_ALL);
}
/**
* Gets the index of the last PdfChunk with metric attributes
* @return the last PdfChunk with metric attributes
*/
public int getLastStrokeChunk() {
int lastIdx = line.size() - 1;
for (; lastIdx >= 0; --lastIdx) {
PdfChunk chunk = (PdfChunk)line.get(lastIdx);
if (chunk.isStroked())
break;
}
return lastIdx;
}
/**
* Gets a PdfChunk by index.
* @param idx the index
* @return the PdfChunk or null if beyond the array
*/
public PdfChunk getChunk(int idx) {
if (idx < 0 || idx >= line.size())
return null;
return (PdfChunk)line.get(idx);
}
/**
* Gets the original width of the line.
* @return the original width of the line
*/
public float getOriginalWidth() {
return originalWidth;
}
/**
* Gets the maximum size of all the fonts used in this line
* including images (if there are images in the line and if
* the leading has to be changed).
* @return maximum size of all the fonts used in this line
*/
float getMaxSize() {
float maxSize = 0;
for (int k = 0; k < line.size(); ++k) {
PdfChunk chunk = (PdfChunk)line.get(k);
if ( /*!chunk.isImage() ssteward: dropped in 1.44 */ true || !chunk.changeLeading()) {
maxSize = Math.max(chunk.font().size(), maxSize);
}
/* ssteward: dropped in 1.44
else {
maxSize = Math.max(chunk.getImage().scaledHeight() + chunk.getImageOffsetY() , maxSize);
}
*/
}
return maxSize;
}
/**
* Gets the maximum size of all the fonts used in this line
* including images.
* @return maximum size of all the fonts used in this line
*/
float getMaxSizeSimple() {
float maxSize = 0;
for (int k = 0; k < line.size(); ++k) {
PdfChunk chunk = (PdfChunk)line.get(k);
if ( /*!chunk.isImage() ssteward: dropped in 1.44 */ true ) {
maxSize = Math.max(chunk.font().size(), maxSize);
}
/* ssteward: dropped in 1.44
else {
maxSize = Math.max(chunk.getImage().scaledHeight() + chunk.getImageOffsetY() , maxSize);
}
*/
}
return maxSize;
}
boolean isRTL() {
return isRTL;
}
/**
* Gets a width corrected with a charSpacing and wordSpacing.
* @param charSpacing
* @param wordSpacing
* @return a corrected width
*/
public float getWidthCorrected(float charSpacing, float wordSpacing) {
float total = 0;
for (int k = 0; k < line.size(); ++k) {
PdfChunk ck = (PdfChunk)line.get(k);
total += ck.getWidthCorrected(charSpacing, wordSpacing);
}
return total;
}
/**
* Gets the maximum size of the ascender for all the fonts used
* in this line.
* @return maximum size of all the ascenders used in this line
*/
public float getAscender() {
float ascender = 0;
for (int k = 0; k < line.size(); ++k) {
PdfChunk ck = (PdfChunk)line.get(k);
/* ssteward: dropped in 1.44
if (ck.isImage())
ascender = Math.max(ascender, ck.getImage().scaledHeight() + ck.getImageOffsetY());
else {
*/
PdfFont font = ck.font();
ascender = Math.max(ascender, font.getFont().getFontDescriptor(BaseFont.ASCENT, font.size()));
/*
}
*/
}
return ascender;
}
/**
* Gets the biggest descender for all the fonts used
* in this line. Note that this is a negative number.
* @return maximum size of all the ascenders used in this line
*/
public float getDescender() {
float descender = 0;
for (int k = 0; k < line.size(); ++k) {
PdfChunk ck = (PdfChunk)line.get(k);
/* ssteward: dropped in 1.44
if (ck.isImage())
descender = Math.min(descender, ck.getImageOffsetY());
else {
*/
PdfFont font = ck.font();
descender = Math.min(descender, font.getFont().getFontDescriptor(BaseFont.DESCENT, font.size()));
/*
}
*/
}
return descender;
}
}