com.aspose.cells

Class Column

java.lang.Object

com.aspose.cells.Column

public class Column
extends java.lang.Object

Represents a single column in a worksheet.

Example

 
         //Instantiating a Workbook object
         Workbook workbook = new Workbook();
 
         //Obtaining the reference of the first worksheet
         Worksheet worksheet = workbook.getWorksheets().get(0);
         Style style = workbook.createStyle();
 
         //Setting the background color to Blue
         style.setBackgroundColor(Color.getBlue());
 
         //Setting the foreground color to Red
         style.setForegroundColor(Color.getRed());
 
         //setting Background Pattern
         style.setPattern(BackgroundType.DIAGONAL_STRIPE);
 
         //New Style Flag
         StyleFlag styleFlag = new StyleFlag();
 
         //Set All Styles
         styleFlag.setAll(true);
 
         //Get first Column
         Column column = worksheet.getCells().getColumns().get(0);
 
         //Apply Style to first Column
         column.applyStyle(style, styleFlag);
 
         //Saving the Excel file
         workbook.save("book1.xls");
 

Method Summary

Methods

Modifier and Type	Method and Description
void	applyStyle(Style style, StyleFlag flag) Applies formats for a whole column.
byte	getGroupLevel() Gets the group level of the column.
int	getIndex() Gets the index of this column.
Style	getStyle() Gets the style of this column.
double	getWidth() Gets the column width in unit of characters.
boolean	hasCustomStyle() Indicates whether this column has custom style settings(different from the default one inherited from workbook).
boolean	isCollapsed() whether the column is collapsed
boolean	isHidden() Indicates whether the column is hidden.
void	setCollapsed(boolean value) whether the column is collapsed
void	setGroupLevel(byte value) Gets the group level of the column.
void	setHidden(boolean value) Indicates whether the column is hidden.
void	setStyle(Style style) Sets the style of this column.
void	setWidth(double value) Sets the column width in unit of characters.

Methods inherited from class java.lang.Object

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

Method Detail

getIndex

public int getIndex()

Gets the index of this column.

getWidth

public double getWidth()

Gets the column width in unit of characters.

Remarks

For spreadsheet, column width is measured as the number of characters of the maximum digit width of the numbers 0~9 as rendered in the normal style's font.

setWidth

public void setWidth(double value)

Sets the column width in unit of characters.

Remarks

For spreadsheet, column width is measured as the number of characters of the maximum digit width of the numbers 0~9 as rendered in the normal style's font.

getGroupLevel

public byte getGroupLevel()

Gets the group level of the column.

setGroupLevel

public void setGroupLevel(byte value)

Gets the group level of the column.

isHidden

public boolean isHidden()

Indicates whether the column is hidden.

setHidden

public void setHidden(boolean value)

Indicates whether the column is hidden.

hasCustomStyle

public boolean hasCustomStyle()

Indicates whether this column has custom style settings(different from the default one inherited from workbook).

applyStyle

public void applyStyle(Style style,
              StyleFlag flag)

Applies formats for a whole column.

Parameters:

style - The style object which will be applied.

flag - Flags which indicates applied formatting properties.

getStyle

public Style getStyle()

Gets the style of this column.

Remarks

Modifying the returned style object directly takes no effect for this column or any cells in this column. You have to call applyStyle(Style,StyleFlag) or setStyle(Style) method to apply the change to this column.

Column's style is the style which will be inherited by cells in this column(those cells that have no custom style settings, such as existing cells that have not been set style explicitly, or those that have not been instantiated)

setStyle

public void setStyle(Style style)

Sets the style of this column.

Remarks

This method only sets the given style as the default style for this column, without changing the style settings for existing cells in this column. To update style settings of existing cells to the specified style at the same time, please use applyStyle(Style,StyleFlag)

Parameters:

style - the style to be used as the default style for cells in this column.

isCollapsed

public boolean isCollapsed()

whether the column is collapsed

setCollapsed

public void setCollapsed(boolean value)

whether the column is collapsed