Package com.pnfsoftware.jeb.core.output.table.impl

Class AbstractTableDocument

java.lang.Object

com.pnfsoftware.jeb.util.events.EventSource

com.pnfsoftware.jeb.core.output.table.impl.AbstractTableDocument

All Implemented Interfaces:

IGenericDocument, ITableDocument, IEventSource

Direct Known Subclasses:

StaticTableDocument

@Ser
public abstract class AbstractTableDocument
extends EventSource
implements ITableDocument

An adapter class for table documents. This class defines a very simple addressing system: the address of a cell is a "row_index,column_index" string representation of the cell coordinates.

Clients may also override dispose().

Field Summary

Fields inherited from class com.pnfsoftware.jeb.util.events.EventSource

onEventCallCount

Constructor Summary

Constructors

Constructor	Description
AbstractTableDocument()

Method Summary

Modifier and Type	Method	Description
ICellCoordinates	addressToCoordinates(String address)	Convert a cell address to cell coordinates.
String	coordinatesToAddress(ICellCoordinates coordinates)	Convert cell coordinates to the cell address.
void	dispose()	The default implementation does nothing.
IPropertyManager	getPropertyManager()	The default implementation returns null.

Methods inherited from class com.pnfsoftware.jeb.util.events.EventSource

addListener, countListeners, getListeners, getParentSource, insertListener, notifyListeners, notifyListeners, notifyListeners, relay, removeListener, setParentSource

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.pnfsoftware.jeb.util.events.IEventSource

addListener, countListeners, getListeners, getParentSource, insertListener, notifyListeners, removeListener, setParentSource

Methods inherited from interface com.pnfsoftware.jeb.core.output.IGenericDocument

getUnit

Methods inherited from interface com.pnfsoftware.jeb.core.output.table.ITableDocument

getColumnLabels, getRowCount, getTable, getTablePart

Constructor Details

AbstractTableDocument

public AbstractTableDocument()

Method Details

dispose

public void dispose()

The default implementation does nothing.

Specified by:

dispose in interface IGenericDocument

getPropertyManager

public IPropertyManager getPropertyManager()

The default implementation returns null.

Specified by:

getPropertyManager in interface IGenericDocument

Returns:

a PM, null if none

coordinatesToAddress

public String coordinatesToAddress(ICellCoordinates coordinates)

Description copied from interface: ITableDocument

Convert cell coordinates to the cell address.

Note: The addressing scheme is unit specific, and defined by the plugin developer. Addresses should not start with the reserved '@' prefix.

Specified by:

coordinatesToAddress in interface ITableDocument

Parameters:

coordinates - coordinates of a cell

Returns:

the address of the cell, null on error

addressToCoordinates

public ICellCoordinates addressToCoordinates(String address)

Description copied from interface: ITableDocument

Convert a cell address to cell coordinates.

Note: The addressing scheme is unit specific, and defined by the plugin developer. Addresses should not start with the reserved '@' prefix.

Specified by:

addressToCoordinates in interface ITableDocument

Parameters:

address - address of a cell

Returns:

coordinates of the cell, null on error