CellXFRecord documentation

FRAMES NO FRAMES SUMMARY: NESTED CONSTR ENUM FIELD METHOD ELEMENT

DETAIL: FIELD CONSTR ENUM METHOD ELEMENT

jxl.write.biff

Class CellXFRecord

Tab mode

All derived types

public class CellXFRecord
extends XFRecord

A cell XF Record

SinceNot specified.

VersionNot specified.

AuthorNot specified.

Wiki javadoc Use textile entry format.

Add your comments here.

Fields inherited from jxl.biffWritableRecordData
maxRecordLength

Fields inherited from jxl.biffXFRecord
biff7 biff8 cell formatIndex style

Constructor Summary
CellXFRecord( FontRecord fnt, DisplayFormat form ) Constructor
CellXFRecord( CellFormat format ) A public copy constructor which can be used for copy formats between different sheets

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, Colour c ) Sets the border style for cells with this format
void	setIndentation( int i ) Sets the indentation of the cell text
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 jxl.biffByteData
getBytes ()

Methods inherited from jxl.formatCellFormat
getAlignment () getBackgroundColour () getBorder (Border) getBorderColour (Border) getBorderLine (Border) getFont () getFormat () getIndentation () getOrientation () getPattern () getVerticalAlignment () getWrap () hasBorders () isLocked () isShrinkToFit ()

Methods inherited from java.langObject
clone () equals (Object) finalize () getClass () hashCode () notify () notifyAll () toString () wait (long, int) wait () wait (long)

Methods inherited from jxl.biffRecordData
getCode () getRecord ()

Methods inherited from jxl.biffWritableRecordData
getBytes () getData ()

Methods inherited from jxl.biffXFRecord
equals (Object) getAlignment () getBackgroundColour () getBorder (Border) getBorderColour (Border) getBorderLine (Border) getData () getDateFormat () getFont () getFormat () getFormatRecord () getHidden () getIndentation () getLocked () getNumberFormat () getOrientation () getPattern () getVerticalAlignment () getWrap () getXFIndex () hasBorders () hashCode () initialize (int, FormattingRecords, Fonts) isDate () isInitialized () isLocked () isNumber () isRead () isShrinkToFit () setFont (FontRecord) setXFAlignment (Alignment) setXFBackground (Colour, Pattern) setXFBorder (Border, BorderLineStyle, Colour) setXFCellOptions (int) setXFDetails (XFRecord.XFType, int) setXFIndentation (int) setXFLocked (boolean) setXFOrientation (Orientation) setXFShrinkToFit (boolean) setXFVerticalAlignment (VerticalAlignment) setXFWrap (boolean) uninitialize ()

Methods inherited from jxl.biffXFRecord

Constructor Detail

CellXFRecord

protected CellXFRecord ( FontRecord fnt, DisplayFormat form )

Constructor

Parameters

Type	Name	Description
FontRecord	fnt	the font
DisplayFormat	form	the format

Wiki javadoc Use textile entry format.

Add your comments here.

CellXFRecord

protected CellXFRecord ( CellFormat format )

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

Parameters

Type	Name	Description
CellFormat	format	No description provided.

Wiki javadoc Use textile entry format.

Add your comments here.

Method Detail

setAlignment

public void setAlignment ( Alignment a )

throws

WriteException

Sets the alignment for the cell

Parameters

Type	Name	Description
Alignment	a	the alignment

Returns void No description provided.

Exceptions

WriteException

No description provided.

Wiki javadoc Use textile entry format.

Add your comments here.

setBackground

public void setBackground ( Colour c, Pattern p )

throws

WriteException

Sets the background for the cell

Parameters

Type	Name	Description
Colour	c	the background colour
Pattern	p	the background patter

Returns void No description provided.

Exceptions

WriteException

No description provided.

Wiki javadoc Use textile entry format.

Add your comments here.

setBorder

public void setBorder ( Border b, BorderLineStyle ls, Colour c )

throws

WriteException

Sets the border style for cells with this format

Parameters

Type	Name	Description
Border	b	the border
BorderLineStyle	ls	the line for the specified border
Colour	c	No description provided.

Returns void No description provided.

Exceptions

WriteException

No description provided.

Wiki javadoc Use textile entry format.

Add your comments here.

setIndentation

public void setIndentation ( int i )

throws

WriteException

Sets the indentation of the cell text

Parameters

Type	Name	Description
int	i	the indentation

Returns void No description provided.

Exceptions

WriteException

No description provided.

Wiki javadoc Use textile entry format.

Add your comments here.

setLocked

public void setLocked ( boolean l )

throws

WriteException

Sets whether or not this XF record locks the cell

Parameters

Type	Name	Description
boolean	l	the locked flag

Returns void No description provided.

Exceptions

WriteException

No description provided.

Wiki javadoc Use textile entry format.

Add your comments here.

setOrientation

public void setOrientation ( Orientation o )

throws

WriteException

Sets the text orientation for cells with this style

Parameters

Type	Name	Description
Orientation	o	the orientation

Returns void No description provided.

Exceptions

WriteException

No description provided.

Wiki javadoc Use textile entry format.

Add your comments here.

setShrinkToFit

public void setShrinkToFit ( boolean s )

throws

WriteException

Sets the shrink to fit flag

Parameters

Type	Name	Description
boolean	s	No description provided.

Returns void No description provided.

Exceptions

WriteException

No description provided.

Wiki javadoc Use textile entry format.

Add your comments here.

setVerticalAlignment

public void setVerticalAlignment ( VerticalAlignment va )

throws

WriteException

Sets the vertical alignment for cells with this style

Parameters

Type	Name	Description
VerticalAlignment	va	the vertical alignment

Returns void No description provided.

Exceptions

WriteException

No description provided.

Wiki javadoc Use textile entry format.

Add your comments here.

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

Type	Name	Description
boolean	w	the wrap

Returns void No description provided.

Exceptions

WriteException

No description provided.

Wiki javadoc Use textile entry format.

Add your comments here.