LibreOffice Module xmerge (master): org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo Class Reference

LibreOffice Module xmerge (master) 1

This is a class to define a table-column structure. More...

Collaboration diagram for org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo:

Public Member Functions
	ColumnRowInfo (int type)
	Constructor for a `ColumnRowInfo`. More...

	ColumnRowInfo (int dimension, int repeated, int type, boolean userDefined)
	Constructor for a `ColumnRowInfo` that includes userDefined field. More...

void	setFormat (Format fmt)
	Sets the format. More...

Format	getFormat ()
	Get the current `Format`. More...

int	getSize ()
	Get the height (for rows) or width (for columns). More...

void	setSize (int dimension)
	Set the height (for rows) or width (for columns). More...

int	getRepeated ()
	Get the repeat count for this item. More...

void	setRepeated (int repeated)
	Set the repeat count for this item. More...

boolean	isRow ()
	Does this `ColumnRowInfo` represent a row? More...

boolean	isColumn ()
	Does this `ColumnRowInfo` represent a column? More...

boolean	isUserDefined ()
	Test if the row height has been set manually. More...

boolean	isDefaultSize ()
	Test if the row height is default. More...

Static Public Attributes
final static int	COLUMN = 0x01

final static int	ROW = 0x02

Private Member Functions
	ColumnRowInfo (int dimension, int repeated, int type)
	Constructor for a `ColumnRowInfo`. More...

Private Attributes
int	type

int	dimension = 0

int	repeated = 1

boolean	userDefined = true

Format	fmt = new Format()

Static Private Attributes
final static int	DEFAULTROWSIZE_MIN = 250

final static int	DEFAULTROWSIZE_MAX = 260

Detailed Description

This is a class to define a table-column structure.

This can then be used by plug-ins to write or read their own column types.

Definition at line 27 of file ColumnRowInfo.java.

Constructor & Destructor Documentation

◆ ColumnRowInfo() [1/3]

org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.ColumnRowInfo ( int type )

inline

Constructor for a ColumnRowInfo.

Parameters

type	whether `ROW` or `COLUMN` record.

Definition at line 46 of file ColumnRowInfo.java.

References org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.type.

◆ ColumnRowInfo() [2/3]

org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.ColumnRowInfo	(	int	dimension,
		int	repeated,
		int	type
	)

inlineprivate

Constructor for a ColumnRowInfo.

Parameters

dimension	if it's a row the height, a column the width.
repeated	how many times it is repeated.
type	whether `ROW` or `COLUMN` record.

Definition at line 58 of file ColumnRowInfo.java.

References org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.dimension, org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.repeated, and org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.type.

◆ ColumnRowInfo() [3/3]

org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.ColumnRowInfo	(	int	dimension,
		int	repeated,
		int	type,
		boolean	userDefined
	)

inline

Constructor for a ColumnRowInfo that includes userDefined field.

Parameters

dimension	if it's a row the height, a column the width.
repeated	how many times it is repeated.
type	whether `ROW` or `COLUMN` record.
userDefined	whether the record is manually set.

Definition at line 73 of file ColumnRowInfo.java.

References org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.dimension, org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.repeated, org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.type, and org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.userDefined.

Member Function Documentation

◆ getFormat()

Format org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.getFormat ( )

inline

Get the current Format.

Returns: The current Format.

Definition at line 94 of file ColumnRowInfo.java.

References org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.fmt.

Referenced by org.openoffice.xmerge.converter.xml.sxc.SxcDocumentSerializer.traverseCell().

◆ getRepeated()

int org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.getRepeated ( )

inline

Get the repeat count for this item.

Returns: The number of times this item is repeated.

Definition at line 124 of file ColumnRowInfo.java.

References org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.repeated.

Referenced by org.openoffice.xmerge.converter.xml.sxc.SxcDocumentDeserializer.processCells(), org.openoffice.xmerge.converter.xml.sxc.SxcDocumentDeserializer.processColumns(), and org.openoffice.xmerge.converter.xml.sxc.SxcDocumentSerializer.traverseCell().

◆ getSize()

int org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.getSize ( )

inline

Get the height (for rows) or width (for columns).

Returns: The height or width.

Definition at line 104 of file ColumnRowInfo.java.

References org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.dimension.

Referenced by org.openoffice.xmerge.converter.xml.sxc.SxcDocumentDeserializer.processCells(), and org.openoffice.xmerge.converter.xml.sxc.SxcDocumentDeserializer.processColumns().

◆ isColumn()

boolean org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.isColumn ( )

inline

Does this ColumnRowInfo represent a column?

Returns: true if a column, false if not.

Definition at line 154 of file ColumnRowInfo.java.

References org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.COLUMN, and org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.type.

Referenced by org.openoffice.xmerge.converter.xml.sxc.SxcDocumentDeserializer.processColumns(), and org.openoffice.xmerge.converter.xml.sxc.SxcDocumentSerializer.traverseCell().

◆ isDefaultSize()

boolean org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.isDefaultSize ( )

inline

Test if the row height is default.

Returns: true if default otherwise false.

Definition at line 174 of file ColumnRowInfo.java.

References org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.DEFAULTROWSIZE_MAX, org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.DEFAULTROWSIZE_MIN, org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.dimension, org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.ROW, and org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.type.

◆ isRow()

boolean org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.isRow ( )

inline

Does this ColumnRowInfo represent a row?

Returns: true if a row, false if not.

Definition at line 144 of file ColumnRowInfo.java.

References org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.ROW, and org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.type.

Referenced by org.openoffice.xmerge.converter.xml.sxc.SxcDocumentDeserializer.processCells().

◆ isUserDefined()

boolean org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.isUserDefined ( )

inline

Test if the row height has been set manually.

Returns: true if user defined otherwise false.

Definition at line 164 of file ColumnRowInfo.java.

References org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.userDefined.

◆ setFormat()

void org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.setFormat ( Format fmt )

inline

Sets the format.

Parameters

fmt	The new format to use.

Definition at line 84 of file ColumnRowInfo.java.

References org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.fmt.

◆ setRepeated()

void org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.setRepeated ( int repeated )

inline

Set the repeat count for this item.

Parameters

repeated The number of times this item is repeated.

Definition at line 134 of file ColumnRowInfo.java.

References org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.repeated.

◆ setSize()

void org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.setSize ( int dimension )

inline

Set the height (for rows) or width (for columns).

Parameters

dimension The height or width.

Definition at line 114 of file ColumnRowInfo.java.

References org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.dimension.

Member Data Documentation

◆ COLUMN

final static int org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.COLUMN = 0x01

static

Definition at line 29 of file ColumnRowInfo.java.

Referenced by org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.isColumn(), and org.openoffice.xmerge.converter.xml.sxc.SxcDocumentSerializer.traverseTableColumn().

◆ DEFAULTROWSIZE_MAX

final static int org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.DEFAULTROWSIZE_MAX = 260

staticprivate

Definition at line 33 of file ColumnRowInfo.java.

Referenced by org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.isDefaultSize().

◆ DEFAULTROWSIZE_MIN

final static int org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.DEFAULTROWSIZE_MIN = 250

staticprivate

Definition at line 32 of file ColumnRowInfo.java.

Referenced by org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.isDefaultSize().

◆ dimension

int org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.dimension = 0

private

Definition at line 36 of file ColumnRowInfo.java.

Referenced by org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.ColumnRowInfo(), org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.getSize(), org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.isDefaultSize(), and org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.setSize().

◆ fmt

Format org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.fmt = new Format()

private

Definition at line 39 of file ColumnRowInfo.java.

Referenced by org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.getFormat(), and org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.setFormat().

◆ repeated

int org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.repeated = 1

private

Definition at line 37 of file ColumnRowInfo.java.

Referenced by org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.ColumnRowInfo(), org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.getRepeated(), and org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.setRepeated().

◆ ROW

final static int org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.ROW = 0x02

static

Definition at line 30 of file ColumnRowInfo.java.

Referenced by org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.isDefaultSize(), org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.isRow(), and org.openoffice.xmerge.converter.xml.sxc.SxcDocumentSerializer.traverseTableRow().

◆ type

int org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.type

private

Definition at line 35 of file ColumnRowInfo.java.

Referenced by org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.ColumnRowInfo(), org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.isColumn(), org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.isDefaultSize(), and org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.isRow().

◆ userDefined

boolean org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.userDefined = true

private

Definition at line 38 of file ColumnRowInfo.java.

Referenced by org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.ColumnRowInfo(), and org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo.isUserDefined().

The documentation for this class was generated from the following file:

ColumnRowInfo.java