JWordDocument.TableElement

java.lang.Object
- javax.swing.text.AbstractDocument.AbstractElement
- - javax.swing.text.AbstractDocument.BranchElement
  - - com.pilot.jword.JWordDocument.TableElement

All Implemented Interfaces:

java.io.Serializable, javax.swing.text.AttributeSet, javax.swing.text.Element, javax.swing.text.MutableAttributeSet, javax.swing.tree.TreeNode

Enclosing class:

JWordDocument
```
public class JWordDocument.TableElement
extends javax.swing.text.AbstractDocument.BranchElement
```
Represents a table and is composed of RowElements

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface javax.swing.text.AttributeSet
  javax.swing.text.AttributeSet.CharacterAttribute, javax.swing.text.AttributeSet.ColorAttribute, javax.swing.text.AttributeSet.FontAttribute, javax.swing.text.AttributeSet.ParagraphAttribute

Field Summary

Fields
Modifier and Type Field and Description

static int DEFAULT_CELL_MARGIN

static java.lang.String ELEMENT_NAME_TABLE
- Fields inherited from interface javax.swing.text.AttributeSet
  NameAttribute, ResolveAttribute

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_CELL_MARGIN`
`static java.lang.String`	`ELEMENT_NAME_TABLE`

Constructor Summary

Constructors
Constructor and Description
`TableElement(javax.swing.text.Element parent, javax.swing.text.AttributeSet attr)` constructor
`TableElement(int[] rowOffsets, int[] rowLengths, javax.swing.text.Element parent, javax.swing.text.AttributeSet attr, javax.swing.text.AttributeSet paraAttr, javax.swing.text.AttributeSet charAttr, int rowCount, int colCount, int[] widths, int[] heights, boolean nested)` Constructs a new table element in the document.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getAbsoluteColumnWidth(int baseWidth, int columnIndex)` Calculate and return the absolute width of the given column
`int`	`getAbsoluteWidth(int baseWidth)` calculate and return the absolute width of the table in case the table width is given in percent values this will try to find the actual width by calculating the percent of the parent area.
`java.lang.Object`	`getAttribute(java.lang.Object attrName)`
`java.awt.Color`	`getBackColor()` returns table default back color
`Borders`	`getBorders()` returns border attributes
`JWordDocument.CellElement`	`getCell(int rowIndex, int colIndex)` return a cell of the table at the given row/col position
`int`	`getCellSpacing()` returns cell spacing value (in twips)
`TableColumn`	`getColumn(int i)` returns attributes of ith table column
`java.util.ArrayList<TableColumn>`	`getColumns()` returns column list of this table
`JWordDocument.CellElement`	`getFirstCell()` return first cell of table
`int`	`getHAlign()` returns tables horizontal alignment
`Dimension`	`getHeight()` Gets the table height (sum of row heights).
`JWordDocument.CellElement`	`getLastCell()` return first cell of table
`int`	`getLeftIndent()` returns tables left indent (in twips)
`java.awt.Insets`	`getMargins()` Gets the cell's margins.
`java.lang.String`	`getName()` Gets the element name.
`int`	`getParentWidth(int baseWidth)` returns the width of the usable area where this table is located
`int`	`getRowIndex(JWordDocument.RowElement row)` return index of row in table (0 based) returns -1 if row is not in this table
`javax.swing.text.Style`	`getTableStyle()` returns table style or null
`Dimension`	`getWidth()` Gets the table width (sum of column widths).
`boolean`	`isLeaf()` Checks whether the element is a leaf.
`boolean`	`isNested()` return whether the table is nested whithin another
`void`	`setAlignment(int align)` Sets table alignment.
`void`	`setBackColor(java.awt.Color backColor)` set default back color
`void`	`setBorders(Borders ba)` Sets cell borders attributes.
`void`	`setLeftIndent(int leftIndent)` sets tables left indent (in twips)
`void`	`setMargins(java.awt.Insets margins)` Sets the cell's margins.
`void`	`setMargins(int top, int left, int bottom, int right)` Sets the cell's margins.
`void`	`setNested(boolean nested)`

Methods inherited from class javax.swing.text.AbstractDocument.BranchElement
children, getAllowsChildren, getElement, getElementCount, getElementIndex, getEndOffset, getStartOffset, positionToElement, replace, toString

Methods inherited from class javax.swing.text.AbstractDocument.AbstractElement
addAttribute, addAttributes, containsAttribute, containsAttributes, copyAttributes, dump, getAttributeCount, getAttributeNames, getAttributes, getChildAt, getChildCount, getDocument, getIndex, getParent, getParentElement, getResolveParent, isDefined, isEqual, removeAttribute, removeAttributes, removeAttributes, setResolveParent

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - ELEMENT_NAME_TABLE
```
public static final java.lang.String ELEMENT_NAME_TABLE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_CELL_MARGIN
```
public static final int DEFAULT_CELL_MARGIN
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TableElement
```
public TableElement(int[] rowOffsets,
                    int[] rowLengths,
                    javax.swing.text.Element parent,
                    javax.swing.text.AttributeSet attr,
                    javax.swing.text.AttributeSet paraAttr,
                    javax.swing.text.AttributeSet charAttr,
                    int rowCount,
                    int colCount,
                    int[] widths,
                    int[] heights,
                    boolean nested)
```
    Constructs a new table element in the document.
    
    Parameters:
    
    rowOffsets - The start offsets for each table row.
    
    rowLengths - Lengths (char length) for each row.
    
    parent - The parent element.
    
    attr - The attributes for the table.
    
    rowCount - The number of rows.
    
    colCount - The number of columns.
    
    widths - The list of column's widths.
    
    heights - The list of rows' heights.
  - TableElement
```
public TableElement(javax.swing.text.Element parent,
                    javax.swing.text.AttributeSet attr)
```
    constructor
    
    Parameters:
    
    parent -
    
    attr -
- Method Detail
  - getAttribute
```
public java.lang.Object getAttribute(java.lang.Object attrName)
```
    Specified by:
    
    getAttribute in interface javax.swing.text.AttributeSet
    
    Overrides:
    
    getAttribute in class javax.swing.text.AbstractDocument.AbstractElement
  - getColumns
```
public java.util.ArrayList<TableColumn> getColumns()
```
    returns column list of this table
    
    Returns:
  - getColumn
```
public TableColumn getColumn(int i)
```
    returns attributes of ith table column
    
    Parameters:
    
    i -
    
    Returns:
  - getName
```
public java.lang.String getName()
```
    Gets the element name.
    
    Specified by:
    
    getName in interface javax.swing.text.Element
    
    Overrides:
    
    getName in class javax.swing.text.AbstractDocument.BranchElement
    
    Returns:
    
    The element name.
  - getTableStyle
```
public javax.swing.text.Style getTableStyle()
```
    returns table style or null
    
    Returns:
  - getWidth
```
public Dimension getWidth()
```
    Gets the table width (sum of column widths).
  - getAbsoluteWidth
```
public int getAbsoluteWidth(int baseWidth)
```
    calculate and return the absolute width of the table in case the table width is given in percent values this will try to find the actual width by calculating the percent of the parent area. If the baseWidth is larger than 0, the function will use the baseWidth instead of the page (or column) width for the outmost tables. If table width is given in physical values, returns the value without modifying.
    
    Parameters:
    
    baseWidth -
    
    Returns:
  - getParentWidth
```
public int getParentWidth(int baseWidth)
```
    returns the width of the usable area where this table is located
    
    Returns:
  - getAbsoluteColumnWidth
```
public int getAbsoluteColumnWidth(int baseWidth,
                                  int columnIndex)
```
    Calculate and return the absolute width of the given column
    
    Parameters:
    
    baseWidth -
    
    columnIndex -
    
    Returns:
  - getHeight
```
public Dimension getHeight()
```
    Gets the table height (sum of row heights).
  - getFirstCell
```
public JWordDocument.CellElement getFirstCell()
```
    return first cell of table
    
    Returns:
  - getCell
```
public JWordDocument.CellElement getCell(int rowIndex,
                                         int colIndex)
```
    return a cell of the table at the given row/col position
    
    Returns:
  - getLastCell
```
public JWordDocument.CellElement getLastCell()
```
    return first cell of table
    
    Returns:
  - getRowIndex
```
public int getRowIndex(JWordDocument.RowElement row)
```
    return index of row in table (0 based) returns -1 if row is not in this table
    
    Parameters:
    
    row -
    
    Returns:
  - getBorders
```
public Borders getBorders()
```
    returns border attributes
    
    Returns:
  - isLeaf
```
public boolean isLeaf()
```
    Checks whether the element is a leaf.
    
    Specified by:
    
    isLeaf in interface javax.swing.text.Element
    
    Specified by:
    
    isLeaf in interface javax.swing.tree.TreeNode
    
    Overrides:
    
    isLeaf in class javax.swing.text.AbstractDocument.BranchElement
    
    Returns:
    
    True if a leaf.
  - setBorders
```
public void setBorders(Borders ba)
```
    Sets cell borders attributes.
    
    Parameters:
    
    ba - The border attributes.
  - setBackColor
```
public void setBackColor(java.awt.Color backColor)
```
    set default back color
    
    Parameters:
    
    backColor -
  - getBackColor
```
public java.awt.Color getBackColor()
```
    returns table default back color
    
    Returns:
  - setAlignment
```
public void setAlignment(int align)
```
    Sets table alignment.
    
    Parameters:
    
    align - The new margins.
  - getHAlign
```
public int getHAlign()
```
    returns tables horizontal alignment
    
    Returns:
  - getLeftIndent
```
public int getLeftIndent()
```
    returns tables left indent (in twips)
    
    Returns:
  - setLeftIndent
```
public void setLeftIndent(int leftIndent)
```
    sets tables left indent (in twips)
    
    Parameters:
    
    leftIndent -
  - getCellSpacing
```
public int getCellSpacing()
```
    returns cell spacing value (in twips)
    
    Returns:
    
    cell spacing
  - isNested
```
public boolean isNested()
```
    return whether the table is nested whithin another
    
    Returns:
  - setNested
```
public void setNested(boolean nested)
```
    Parameters:
    
    nested -
  - getMargins
```
public java.awt.Insets getMargins()
```
    Gets the cell's margins.
    
    Returns:
    
    the page's margins.
  - setMargins
```
public void setMargins(java.awt.Insets margins)
```
    Sets the cell's margins.
    
    Parameters:
    
    margins - - the page's margins.
  - setMargins
```
public void setMargins(int top,
                       int left,
                       int bottom,
                       int right)
```
    Sets the cell's margins. Limits is between 5 and 300.
    
    Parameters:
    
    top - - the top margin.
    
    left - - the left margin.
    
    bottom - - the bottom margin.
    
    right - - the right margin.

Class JWordDocument.TableElement

Nested Class Summary

Nested classes/interfaces inherited from interface javax.swing.text.AttributeSet

Field Summary

Fields inherited from interface javax.swing.text.AttributeSet

Constructor Summary

Method Summary

Methods inherited from class javax.swing.text.AbstractDocument.BranchElement

Methods inherited from class javax.swing.text.AbstractDocument.AbstractElement

Methods inherited from class java.lang.Object

Field Detail

ELEMENT_NAME_TABLE

DEFAULT_CELL_MARGIN

Constructor Detail

TableElement

TableElement

Method Detail

getAttribute

getColumns

getColumn

getName

getTableStyle

getWidth

getAbsoluteWidth

getParentWidth

getAbsoluteColumnWidth

getHeight

getFirstCell

getCell

getLastCell

getRowIndex

getBorders

isLeaf

setBorders

setBackColor

getBackColor

setAlignment

getHAlign

getLeftIndent

setLeftIndent

getCellSpacing

isNested

setNested

getMargins

setMargins

setMargins