jet.api
Class TableHeaderFooterInfo

java.lang.Object
  jet.api.TableHeaderFooterInfo

public class TableHeaderFooterInfo
extends java.lang.Object

Constructor Summary

TableHeaderFooterInfo(java.util.Vector displayInfos)

TableHeaderFooterInfo(java.util.Vector displayInfos, double width, double height)

Method Summary

boolean	addDisplayInfo(DisplayFieldInfo o) Appends a display's information of this detail.
void	addDisplayInfo(int index, DisplayFieldInfo element) Inserts a display's information of the detail at the specified position.
void	clearDisplayInfos() Removes all of displays' information from the detail.
DisplayFieldInfo	getDisplayInfo(int index) Returns the DisplayFieldInfo at the specified position.
java.util.Vector	getDisplayInfos() Gets displays' information of this detail.
double	getHeight() Gets the height of table header
double	getWidth() Gets the width of table header
boolean	isVerticalToDetail() Indicates whether is a Vertical Group Header in table
boolean	removeDisplayInfo(DisplayFieldInfo o) Removes the first occurrence of the DisplayFieldInfo.
DisplayFieldInfo	removeDisplayInfo(int index) Removes the DisplayFieldInfo at the specified position.
void	setDisplayInfos(java.util.Vector displayInfos) Sets displays' information of this detail.
void	setHeight(double height) Sets the height of table header
void	setVerticalToDetail(boolean isVerticaltoDetail) Sets whether create a Vertical Group Header in table
void	setWidth(double width) Sets the width of table header

Methods inherited from class java.lang.Object

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

Constructor Detail

TableHeaderFooterInfo

public TableHeaderFooterInfo(java.util.Vector displayInfos)

TableHeaderFooterInfo

public TableHeaderFooterInfo(java.util.Vector displayInfos,
                             double width,
                             double height)

Method Detail

getDisplayInfos

public java.util.Vector getDisplayInfos()

Gets displays' information of this detail.

Returns:

Vector of DisplayFieldInfo.

setDisplayInfos

public void setDisplayInfos(java.util.Vector displayInfos)

Sets displays' information of this detail.

addDisplayInfo

public void addDisplayInfo(int index,
                           DisplayFieldInfo element)

Inserts a display's information of the detail at the specified position.

Parameters:

index - index at which the DisplayFieldInfo is to be inserted.

element - DisplayFieldInfo to be inserted.

Throws:

java.lang.ArrayIndexOutOfBoundsException - index is out of range (index < 0 || index > size()).

addDisplayInfo

public boolean addDisplayInfo(DisplayFieldInfo o)

Appends a display's information of this detail.

Parameters:

o - DisplayFieldInfo to be appended.

Returns:

true (as per the general contract of Collection.add).

clearDisplayInfos

public void clearDisplayInfos()

Removes all of displays' information from the detail.

getDisplayInfo

public DisplayFieldInfo getDisplayInfo(int index)

Returns the DisplayFieldInfo at the specified position.

Parameters:

index - index of DisplayFieldInfo to return.

Returns:

DisplayFieldInfo at the specified index

Throws:

java.lang.ArrayIndexOutOfBoundsException - index is out of range (index < 0 || index >= size()).

removeDisplayInfo

public DisplayFieldInfo removeDisplayInfo(int index)

Removes the DisplayFieldInfo at the specified position. shifts any subsequent DisplayFieldInfo to the left (subtracts one from their indices). Returns the DisplayFieldInfo that was removed.

Parameters:

index - the index of the DisplayFieldInfo to removed.

Returns:

DisplayFieldInfo that was removed

Throws:

java.lang.ArrayIndexOutOfBoundsException - index out of range (index < 0 || index >= size()).

removeDisplayInfo

public boolean removeDisplayInfo(DisplayFieldInfo o)

Removes the first occurrence of the DisplayFieldInfo. If the Vector does not contain the DisplayFieldInfo, it is unchanged. More formally, removes the DisplayFieldInfo with the lowest index i such that (o==null ? get(i)==null : o.equals(get(i))) (if such an DisplayFieldInfo exists).

Parameters:

o - DisplayFieldInfo to be removed, if present.

Returns:

true if the Vector contained the HeaderInfo.

getHeight

public double getHeight()

Gets the height of table header

Returns:

table height.

setHeight

public void setHeight(double height)

Sets the height of table header

Parameters:

height - the height of table header.

getWidth

public double getWidth()

Gets the width of table header

Returns:

table width.

setWidth

public void setWidth(double width)

Sets the width of table header

Parameters:

width - the width of table header.

setVerticalToDetail

public void setVerticalToDetail(boolean isVerticaltoDetail)

Sets whether create a Vertical Group Header in table

Parameters:

isVerticaltoDetail - set true when it is a Vertical Group Header in table..

isVerticalToDetail

public boolean isVerticalToDetail()

Indicates whether is a Vertical Group Header in table

Returns:

true when it is a Vertical Group Header in table.