jxl.write.biff
Class CellXFRecord

java.lang.Object
  |
  +--jxl.biff.RecordData
        |
        +--jxl.biff.WritableRecordData
              |
              +--jxl.biff.XFRecord
                    |
                    +--jxl.write.biff.CellXFRecord

All Implemented Interfaces:

ByteData, CellFormat

Direct Known Subclasses:

WritableCellFormat

public class CellXFRecord

extends XFRecord

A cell XF Record

Inner classes inherited from class jxl.biff.XFRecord

XFRecord.BiffType, XFRecord.XFType

Fields inherited from class jxl.biff.XFRecord

align, backgroundColour, biff7, biff8, biffType, bottomBorder, cell, copied, date, dateFormat, dateFormats, excelFormat, font, fontIndex, format, formatIndex, formatInfoInitialized, formattingRecords, hidden, initialized, javaDateFormats, javaNumberFormats, leftBorder, locked, number, numberFormat, numberFormats, options, orientation, parentFormat, pattern, read, rightBorder, shrinkToFit, style, topBorder, usedAttributes, valign, wrap, xfFormatType, xfIndex

Fields inherited from class jxl.biff.WritableRecordData

maxRecordLength

Fields inherited from class jxl.biff.RecordData

code, record

Constructor Summary

protected	CellXFRecord(CellFormat format) A public copy constructor which can be used for copy formats between different sheets
protected	CellXFRecord(FontRecord fnt, DisplayFormat form) Constructor
(package private)	CellXFRecord(XFRecord fmt) Copy constructor.

Method Summary

void	setAlignment(Alignment a) Sets the alignment for the cell
void	setBackground(Colour c, Pattern p) Sets the background for the cell
void	setBorder(Border b, BorderLineStyle ls) Sets the border style for cells with this format
void	setLocked(boolean l) Sets whether or not this XF record locks the cell
void	setOrientation(Orientation o) Sets the text orientation for cells with this style
void	setShrinkToFit(boolean s) Sets the shrink to fit flag
void	setVerticalAlignment(VerticalAlignment va) Sets the vertical alignment for cells with this style
void	setWrap(boolean w) Sets the text wrapping for cells with this style.

Methods inherited from class jxl.biff.XFRecord

equals, getAlignment, getBackgroundColour, getBorder, getData, getDateFormat, getFont, getFontIndex, getFormat, getFormatRecord, getHidden, getLocked, getNumberFormat, getOrientation, getPattern, getVerticalAlignment, getWrap, getXFIndex, hasBorders, initialize, initializeFormatInformation, isDate, isInitialized, isNumber, isRead, isShrinkToFit, rationalize, setFontIndex, setFormatIndex, setXFAlignment, setXFBackground, setXFBorder, setXFCellOptions, setXFDetails, setXFIndex, setXFLocked, setXFOrientation, setXFShrinkToFit, setXFVerticalAlignment, setXFWrap, uninitialize

Methods inherited from class jxl.biff.WritableRecordData

getBytes, handleContinueRecords

Methods inherited from class jxl.biff.RecordData

getCode, getRecord

Methods inherited from class java.lang.Object

, clone, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait

Constructor Detail

CellXFRecord

protected CellXFRecord(FontRecord fnt,
                       DisplayFormat form)

Constructor

Parameters:

fnt - the font

form - the format

CellXFRecord

CellXFRecord(XFRecord fmt)

Copy constructor. Invoked when copying formats to handle cell merging

Parameters:

fmt - the format to copy

CellXFRecord

protected CellXFRecord(CellFormat format)

A public copy constructor which can be used for copy formats between different sheets

Method Detail

setAlignment

public void setAlignment(Alignment a)
                  throws WriteException

Sets the alignment for the cell

Parameters:

a - the alignment

Throws:

WriteException -

setBackground

public void setBackground(Colour c,
                          Pattern p)
                   throws WriteException

Sets the background for the cell

Parameters:

c - the background colour

p - the background patter

Throws:

WriteException -

setLocked

public void setLocked(boolean l)
               throws WriteException

Sets whether or not this XF record locks the cell

Parameters:

l - the locked flag

Throws:

WriteException -

setShrinkToFit

public void setShrinkToFit(boolean s)
                    throws WriteException

Sets the shrink to fit flag

Parameters:

b - the shrink to fit flag

setVerticalAlignment

public void setVerticalAlignment(VerticalAlignment va)
                          throws WriteException

Sets the vertical alignment for cells with this style

Parameters:

va - the vertical alignment

Throws:

WriteException -

setOrientation

public void setOrientation(Orientation o)
                    throws WriteException

Sets the text orientation for cells with this style

Parameters:

o - the orientation

Throws:

WriteException -

setWrap

public void setWrap(boolean w)
             throws WriteException

Sets the text wrapping for cells with this style. If the parameter is set to TRUE, then data in this cell will be wrapped around, and the cell's height adjusted accordingly

Parameters:

w - the wrap

Throws:

WriteException -

setBorder

public void setBorder(Border b,
                      BorderLineStyle ls)
               throws WriteException

Sets the border style for cells with this format

Parameters:

b - the border

ls - the line for the specified border

Throws:

WriteException -