ActiveXLS
Class ExcelAutoFormat

System.Object
  ActiveXLS.ExcelAutoFormat

public class ExcelAutoFormat

extends System.Object

This class stores the table autoformat information like font name, font size, font bold, font italic, word wrap, font underline style, font subscript, font superscript, font strikethrough, background color, foreground color, horizontal alignment, vertical alignment, number or date format, cell locked or hidden, shrink, border type, border color. A table autoformat can be applied to a range of cells.

Constructor Summary

ExcelAutoFormat()
Defines a table autoformat that is initialized with the default style.

ExcelAutoFormat(ExcelAutoFormat xlsAutoFormat)
Defines a table autoformat based on a predefined autoformat.

ExcelAutoFormat(ExcelStyle xlsStyleTable)
Defines a table autoformat that is initialized with a specific style.

ExcelAutoFormat(ExcelStyle xlsStyleTable, ExcelStyle xlsStyleTableHeaderRow, ExcelStyle xlsStyleTableFooterRow)
Defines a table autoformat that is initialized with a specific style and has a specific header row and footer row style.

ExcelAutoFormat(ExcelStyle xlsStyleEvenRowStripes, ExcelStyle xlsStyleOddRowStripes, ExcelStyle xlsStyleTableHeaderRow, ExcelStyle xlsStyleTableFooterRow)
Defines a table autoformat that is initialized with a specific striped style and has a specific header row and footer row style.

ExcelAutoFormat(int autoformat)
Defines a table autoformat that is one of the predefined autoformats.

Method Summary

ExcelAutoFormat	Clone() Creates and returns a copy of this object.
int	getAutoFormatType() Returns the type of this autoformat.
ExcelStyle	getBottomLeftCellStyle() Returns the style applied to the bottom left cell.
ExcelStyle	getBottomRightCellStyle() Returns the style applied to the bottom right cell.
ExcelStyle	getEvenColumnStripesStyle() Returns the style applied to the even columns.
ExcelStyle	getEvenRowStripesStyle() Returns the style applied to the even rows.
ExcelStyle	getFooterRowStyle() Returns the style applied to the footer row.
ExcelStyle	getHeaderRowStyle() Returns the style applied to the header row.
ExcelStyle	getLeftColumnStyle() Returns the style applied to the left column.
ExcelStyle	getOddColumnStripesStyle() Returns the style applied to the odd columns.
ExcelStyle	getOddRowStripesStyle() Returns the style applied to the odd rows.
ExcelStyle	getRightColumnStyle() Returns the style applied to the right column.
ExcelStyle	getTableStyle() Returns the style applied to the table.
ExcelStyle	getTopLeftCellStyle() Returns the style applied to the top left cell.
ExcelStyle	getTopRightCellStyle() Returns the style applied to the top right cell.
void	InitAs(int autoformat) Initializes the table autoformat that is one of the predefined autoformats.
void	setBottomLeftCellStyle(ExcelStyle xlsStyle) Sets the style of the bottom left cell.
void	setBottomRightCellStyle(ExcelStyle xlsStyle) Sets the style of the bottom right cell.
void	setEvenColumnStripesStyle(ExcelStyle xlsStyle) Sets the style of the even columns.
void	setEvenRowStripesStyle(ExcelStyle xlsStyle) Sets the style of the even rows.
void	setFooterRowStyle(ExcelStyle xlsStyle) Sets the style of the footer row.
void	setHeaderRowStyle(ExcelStyle xlsStyle) Sets the style of the header row.
void	setLeftColumnStyle(ExcelStyle xlsStyle) Sets the style of the left column.
void	setOddColumnStripesStyle(ExcelStyle xlsStyle) Sets the style of the odd columns.
void	setOddRowStripesStyle(ExcelStyle xlsStyle) Sets the style of the odd rows.
void	setRightColumnStyle(ExcelStyle xlsStyle) Sets the style of the right column.
void	setTableStyle(ExcelStyle xlsStyle) Sets the style of the table.
void	setTopLeftCellStyle(ExcelStyle xlsStyle) Sets the style of the top left cell.
void	setTopRightCellStyle(ExcelStyle xlsStyle) Sets the style of the top right cell.

Constructor Detail

ExcelAutoFormat

public ExcelAutoFormat()

Defines a table autoformat that is initialized with the default style.

ExcelAutoFormat

public ExcelAutoFormat(int autoformat)

Defines a table autoformat that is one of the predefined autoformats.

Parameters:

autoformat - the predefined autoformat. Possible values are available in Styles class.

ExcelAutoFormat

public ExcelAutoFormat(ExcelStyle xlsStyleTable)

Defines a table autoformat that is initialized with a specific style.

Parameters:

xlsStyleTable - the style applied to the table

ExcelAutoFormat

public ExcelAutoFormat(ExcelStyle xlsStyleTable,
                       ExcelStyle xlsStyleTableHeaderRow,
                       ExcelStyle xlsStyleTableFooterRow)

Defines a table autoformat that is initialized with a specific style and has a specific header row and footer row style.

Parameters:

xlsStyleTable - the style applied to the table

xlsStyleTableHeaderRow - the style applied to the header row

xlsStyleTableFooterRow - the style applied to the footer row

ExcelAutoFormat

public ExcelAutoFormat(ExcelStyle xlsStyleEvenRowStripes,
                       ExcelStyle xlsStyleOddRowStripes,
                       ExcelStyle xlsStyleTableHeaderRow,
                       ExcelStyle xlsStyleTableFooterRow)

Defines a table autoformat that is initialized with a specific striped style and has a specific header row and footer row style.

Parameters:

xlsStyleEvenRowStripes - the style applied to the even rows

xlsStyleOddRowStripes - the style applied to the odd rows

xlsStyleTableHeaderRow - the style applied to the header row

xlsStyleTableFooterRow - the style applied to the footer row

ExcelAutoFormat

public ExcelAutoFormat(ExcelAutoFormat xlsAutoFormat)

Defines a table autoformat based on a predefined autoformat.

Parameters:

xlsAutoFormat - the table autoformat

Method Detail

setTableStyle

public void setTableStyle(ExcelStyle xlsStyle)

Sets the style of the table.

Parameters:

xlsStyle - the style applied to the table

See Also:

getTableStyle(), setHeaderRowStyle(ActiveXLS.ExcelStyle), setFooterRowStyle(ActiveXLS.ExcelStyle), setLeftColumnStyle(ActiveXLS.ExcelStyle), setRightColumnStyle(ActiveXLS.ExcelStyle)

getTableStyle

public ExcelStyle getTableStyle()

Returns the style applied to the table.

Returns:

the style applied to the table

See Also:

setTableStyle(ActiveXLS.ExcelStyle), getHeaderRowStyle(), getFooterRowStyle(), getLeftColumnStyle(), getRightColumnStyle()

setHeaderRowStyle

public void setHeaderRowStyle(ExcelStyle xlsStyle)

Sets the style of the header row.

Parameters:

xlsStyle - the style applied to the header row

See Also:

getHeaderRowStyle(), setTableStyle(ActiveXLS.ExcelStyle), setFooterRowStyle(ActiveXLS.ExcelStyle), setLeftColumnStyle(ActiveXLS.ExcelStyle), setRightColumnStyle(ActiveXLS.ExcelStyle)

getHeaderRowStyle

public ExcelStyle getHeaderRowStyle()

Returns the style applied to the header row.

Returns:

the style applied to the header row

See Also:

setHeaderRowStyle(ActiveXLS.ExcelStyle), getTableStyle(), getFooterRowStyle(), getLeftColumnStyle(), getRightColumnStyle()

setFooterRowStyle

public void setFooterRowStyle(ExcelStyle xlsStyle)

Sets the style of the footer row.

Parameters:

xlsStyle - the style applied to the footer row

See Also:

getFooterRowStyle(), setHeaderRowStyle(ActiveXLS.ExcelStyle), setTableStyle(ActiveXLS.ExcelStyle), setLeftColumnStyle(ActiveXLS.ExcelStyle), setRightColumnStyle(ActiveXLS.ExcelStyle)

getFooterRowStyle

public ExcelStyle getFooterRowStyle()

Returns the style applied to the footer row.

Returns:

the style applied to the footer row

See Also:

setFooterRowStyle(ActiveXLS.ExcelStyle), getTableStyle(), getHeaderRowStyle(), getLeftColumnStyle(), getRightColumnStyle()

setLeftColumnStyle

public void setLeftColumnStyle(ExcelStyle xlsStyle)

Sets the style of the left column.

Parameters:

xlsStyle - the style applied to the left column

See Also:

getLeftColumnStyle(), setTableStyle(ActiveXLS.ExcelStyle), setHeaderRowStyle(ActiveXLS.ExcelStyle), setFooterRowStyle(ActiveXLS.ExcelStyle), setRightColumnStyle(ActiveXLS.ExcelStyle)

getLeftColumnStyle

public ExcelStyle getLeftColumnStyle()

Returns the style applied to the left column.

Returns:

the style applied to the left column

See Also:

setLeftColumnStyle(ActiveXLS.ExcelStyle), getTableStyle(), getHeaderRowStyle(), getFooterRowStyle(), getRightColumnStyle()

setRightColumnStyle

public void setRightColumnStyle(ExcelStyle xlsStyle)

Sets the style of the right column.

Parameters:

xlsStyle - the style applied to the right column

See Also:

getRightColumnStyle(), setHeaderRowStyle(ActiveXLS.ExcelStyle), setFooterRowStyle(ActiveXLS.ExcelStyle), setTableStyle(ActiveXLS.ExcelStyle), setLeftColumnStyle(ActiveXLS.ExcelStyle)

getRightColumnStyle

public ExcelStyle getRightColumnStyle()

Returns the style applied to the right column.

Returns:

the style applied to the right column

See Also:

setRightColumnStyle(ActiveXLS.ExcelStyle), getTableStyle(), getHeaderRowStyle(), getFooterRowStyle(), getLeftColumnStyle()

setTopLeftCellStyle

public void setTopLeftCellStyle(ExcelStyle xlsStyle)

Sets the style of the top left cell.

Parameters:

xlsStyle - the style applied to the top left cell

See Also:

getTopLeftCellStyle(), setTopRightCellStyle(ActiveXLS.ExcelStyle), setBottomLeftCellStyle(ActiveXLS.ExcelStyle), setBottomRightCellStyle(ActiveXLS.ExcelStyle)

getTopLeftCellStyle

public ExcelStyle getTopLeftCellStyle()

Returns the style applied to the top left cell.

Returns:

the style applied to the top left cell

See Also:

setTopLeftCellStyle(ActiveXLS.ExcelStyle), getTopRightCellStyle(), getBottomLeftCellStyle(), getBottomRightCellStyle()

setTopRightCellStyle

public void setTopRightCellStyle(ExcelStyle xlsStyle)

Sets the style of the top right cell.

Parameters:

xlsStyle - the style applied to the top right cell

See Also:

getTopRightCellStyle(), setTopLeftCellStyle(ActiveXLS.ExcelStyle), setBottomLeftCellStyle(ActiveXLS.ExcelStyle), setBottomRightCellStyle(ActiveXLS.ExcelStyle)

getTopRightCellStyle

public ExcelStyle getTopRightCellStyle()

Returns the style applied to the top right cell.

Returns:

the style applied to the top right cell

See Also:

setTopRightCellStyle(ActiveXLS.ExcelStyle), getTopLeftCellStyle(), getBottomLeftCellStyle(), getBottomRightCellStyle()

setBottomLeftCellStyle

public void setBottomLeftCellStyle(ExcelStyle xlsStyle)

Sets the style of the bottom left cell.

Parameters:

xlsStyle - the style applied to the bottom left cell

See Also:

getBottomLeftCellStyle(), setTopLeftCellStyle(ActiveXLS.ExcelStyle), setTopRightCellStyle(ActiveXLS.ExcelStyle), setBottomRightCellStyle(ActiveXLS.ExcelStyle)

getBottomLeftCellStyle

public ExcelStyle getBottomLeftCellStyle()

Returns the style applied to the bottom left cell.

Returns:

the style applied to the bottom left cell

See Also:

setBottomLeftCellStyle(ActiveXLS.ExcelStyle), getTopLeftCellStyle(), getTopRightCellStyle(), getBottomRightCellStyle()

setBottomRightCellStyle

public void setBottomRightCellStyle(ExcelStyle xlsStyle)

Sets the style of the bottom right cell.

Parameters:

xlsStyle - the style applied to the bottom right cell

See Also:

getBottomRightCellStyle(), setTopLeftCellStyle(ActiveXLS.ExcelStyle), setTopRightCellStyle(ActiveXLS.ExcelStyle), setBottomLeftCellStyle(ActiveXLS.ExcelStyle)

getBottomRightCellStyle

public ExcelStyle getBottomRightCellStyle()

Returns the style applied to the bottom right cell.

Returns:

the style applied to the bottom right cell

See Also:

setBottomRightCellStyle(ActiveXLS.ExcelStyle), getTopLeftCellStyle(), getTopRightCellStyle(), getBottomLeftCellStyle()

setEvenRowStripesStyle

public void setEvenRowStripesStyle(ExcelStyle xlsStyle)

Sets the style of the even rows.

Parameters:

xlsStyle - the style applied to the even rows

See Also:

getEvenRowStripesStyle(), setHeaderRowStyle(ActiveXLS.ExcelStyle), setFooterRowStyle(ActiveXLS.ExcelStyle), setOddRowStripesStyle(ActiveXLS.ExcelStyle)

getEvenRowStripesStyle

public ExcelStyle getEvenRowStripesStyle()

Returns the style applied to the even rows.

Returns:

the style applied to the even rows

See Also:

setEvenRowStripesStyle(ActiveXLS.ExcelStyle), getHeaderRowStyle(), getFooterRowStyle(), getOddRowStripesStyle()

setEvenColumnStripesStyle

public void setEvenColumnStripesStyle(ExcelStyle xlsStyle)

Sets the style of the even columns.

Parameters:

xlsStyle - the style applied to the even columns

See Also:

getEvenColumnStripesStyle(), setLeftColumnStyle(ActiveXLS.ExcelStyle), setRightColumnStyle(ActiveXLS.ExcelStyle), setOddColumnStripesStyle(ActiveXLS.ExcelStyle)

getEvenColumnStripesStyle

public ExcelStyle getEvenColumnStripesStyle()

Returns the style applied to the even columns.

Returns:

the style applied to the even columns

See Also:

setEvenColumnStripesStyle(ActiveXLS.ExcelStyle), getLeftColumnStyle(), getRightColumnStyle(), getOddColumnStripesStyle()

setOddRowStripesStyle

public void setOddRowStripesStyle(ExcelStyle xlsStyle)

Sets the style of the odd rows.

Parameters:

xlsStyle - the style applied to the odd rows

See Also:

getOddRowStripesStyle(), setHeaderRowStyle(ActiveXLS.ExcelStyle), setFooterRowStyle(ActiveXLS.ExcelStyle), setEvenRowStripesStyle(ActiveXLS.ExcelStyle)

getOddRowStripesStyle

public ExcelStyle getOddRowStripesStyle()

Returns the style applied to the odd rows.

Returns:

the style applied to the odd rows

See Also:

setOddRowStripesStyle(ActiveXLS.ExcelStyle), getHeaderRowStyle(), getFooterRowStyle(), getEvenRowStripesStyle()

setOddColumnStripesStyle

public void setOddColumnStripesStyle(ExcelStyle xlsStyle)

Sets the style of the odd columns.

Parameters:

xlsStyle - the style applied to the odd columns

See Also:

getOddColumnStripesStyle(), setLeftColumnStyle(ActiveXLS.ExcelStyle), setRightColumnStyle(ActiveXLS.ExcelStyle), setEvenColumnStripesStyle(ActiveXLS.ExcelStyle)

getOddColumnStripesStyle

public ExcelStyle getOddColumnStripesStyle()

Returns the style applied to the odd columns.

Returns:

the style applied to the odd columns

See Also:

setOddColumnStripesStyle(ActiveXLS.ExcelStyle), getLeftColumnStyle(), getRightColumnStyle(), getEvenColumnStripesStyle()

InitAs

public void InitAs(int autoformat)

Initializes the table autoformat that is one of the predefined autoformats.

Parameters:

autoformat - the predefined autoformat. Possible values are available in Styles class.

getAutoFormatType

public int getAutoFormatType()

Returns the type of this autoformat.

Returns:

the type of this autoformat. A list of predefined autoformats is available in Styles class. The method returns -1 if the autoformat is user defined.

Clone

public ExcelAutoFormat Clone()

Creates and returns a copy of this object.

Returns:

a clone of this instance.