org.odftoolkit.odfdom.doc.table
Class OdfTableColumn

java.lang.Object
  extended by org.odftoolkit.odfdom.doc.table.OdfTableColumn

Deprecated. As of release 0.8.8, replaced by org.odftoolkit.simple.table.Column in Simple API.

public class OdfTableColumn
extends Object

OdfTableColumn represents table column feature in ODF document.

OdfTableColumn provides methods to get table cells that belong to this table column.


Method Summary
 OdfTableCell getCellByIndex(int index)
          Deprecated. Get a cell with a specific index.
 int getCellCount()
          Deprecated. Get the count of cells in this column.
 int getColumnIndex()
          Deprecated. Get the index of this column in the owner table.
 OdfStyle getDefaultCellStyle()
          Deprecated. Get the default cell style of this column.
static OdfTableColumn getInstance(TableTableColumnElement colElement)
          Deprecated. Get the OdfTableColumn instance from the TableTableColumnElement instance.
 OdfTableColumn getNextColumn()
          Deprecated. Get the next column of the current column.
 TableTableColumnElement getOdfElement()
          Deprecated. Return an instance of TableTableColumnElement which represents this feature.
 OdfTableColumn getPreviousColumn()
          Deprecated. Get the previous column of the current column.
 OdfTable getTable()
          Deprecated. Get owner table of the current column.
 long getWidth()
          Deprecated. Get the width of the column (in Millimeter).
 boolean isOptimalWidth()
          Deprecated. Returns if the column always keeps its optimal width.
 void setDefaultCellStyle(OdfStyle style)
          Deprecated. Set the default cell style to this column.
 void setUseOptimalWidth(boolean isUseOptimalWidth)
          Deprecated. Set if the column always keeps its optimal width.
 void setWidth(long width)
          Deprecated. Set the width of the column (in Millimeter).
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getInstance

public static OdfTableColumn getInstance(TableTableColumnElement colElement)
Deprecated. 
Get the OdfTableColumn instance from the TableTableColumnElement instance.

Each TableTableColumnElement instance has a one-to-one relationship to the a OdfTableColumn instance.

Parameters:
colElement - the column element that need to get the corresponding OdfTableColumn instance
Returns:
the OdfTableColumn instance represent the specified column element

getTable

public OdfTable getTable()
Deprecated. 
Get owner table of the current column.

Returns:
the parent table of this column

getWidth

public long getWidth()
Deprecated. 
Get the width of the column (in Millimeter).

Returns:
the width of the current column (in Millimeter).

setWidth

public void setWidth(long width)
Deprecated. 
Set the width of the column (in Millimeter).

Parameters:
width - the width that will be set to the column (in Millimeter).

isOptimalWidth

public boolean isOptimalWidth()
Deprecated. 
Returns if the column always keeps its optimal width.

Returns:
true if the column always keeps its optimal width; vice versa

setUseOptimalWidth

public void setUseOptimalWidth(boolean isUseOptimalWidth)
Deprecated. 
Set if the column always keeps its optimal width.

Parameters:
isUseOptimalWidth - the flag that indicate column should keep its optimal width or not

getOdfElement

public TableTableColumnElement getOdfElement()
Deprecated. 
Return an instance of TableTableColumnElement which represents this feature.

Returns:
an instance of TableTableColumnElement

getCellCount

public int getCellCount()
Deprecated. 
Get the count of cells in this column.

Returns:
the cells count in the current column

getCellByIndex

public OdfTableCell getCellByIndex(int index)
Deprecated. 
Get a cell with a specific index. The table will be automatically expanded, when the given index is outside of the original table.

Parameters:
index - the cell index in this column
Returns:
the cell object in the given cell index

getPreviousColumn

public OdfTableColumn getPreviousColumn()
Deprecated. 
Get the previous column of the current column.

Returns:
the previous column before this column in the owner table

getNextColumn

public OdfTableColumn getNextColumn()
Deprecated. 
Get the next column of the current column.

Returns:
the next column after this column in the owner table

getColumnIndex

public int getColumnIndex()
Deprecated. 
Get the index of this column in the owner table.

Returns:
the index of the column

setDefaultCellStyle

public void setDefaultCellStyle(OdfStyle style)
Deprecated. 
Set the default cell style to this column.

The style should already exist in this document.

This method is not recommended for text document cases. These is a style assigned to each cell in tables under text documents. So setting the default cell style to a column may not work.

Parameters:
style - the cell style of the document

getDefaultCellStyle

public OdfStyle getDefaultCellStyle()
Deprecated. 
Get the default cell style of this column.

Returns:
the default cell style of this column


Copyright © 2008-2017 The Apache Software Foundation. All Rights Reserved.