com.mockturtlesolutions.snifflib.spreadsheets

Interface MyrtleTableAPI

All Known Implementing Classes:

DefaultSpreadsheetTable

public interface MyrtleTableAPI

This interface provides methods implemented by individual spreasheet tables. Any SpreadsheetTable instance within an application script or an extensions will implement these methods and can be used to achieve highly customized functionality. Application developers may find these useful.

Method Summary

Methods

Modifier and Type	Method and Description
void	addRangeGrabListener(RangeGrabListener l)
void	addSheetColumnSelection(int col)
void	addSheetRowSelection(int row)
void	appendTextToEdit(java.lang.String text)
void	copyAllToClipboard()
boolean	copySelectedToClipboard()
void	copySelectedToSelection()
boolean	cutSelectedToClipboard()
void	deleteSelected()
void	editEntry()
void	externalRangeBookmarkUpdate(java.lang.String bookmarkname)
void	externalRangeGrabUpdate(java.lang.String range)
void	fillRange(java.lang.String range, java.lang.String startValue, java.lang.String stopValue) Fills the indicated range in this table.
void	fireRangeGrabUpdated(java.lang.String range)
java.awt.Color	getAlternateRowColor()
javax.swing.table.TableCellEditor	getCellEditor(int row, int column)
javax.swing.table.TableCellRenderer	getCellRenderer(int row, int column)
SharedSpreadsheetClipboard	getClipboardBuffer()
java.lang.String	getLabelForColumn(int col)
java.lang.String	getLabelForRow(int row)
java.util.Vector	getSelectedEntries()
int[]	getSelectionLocation()
java.lang.String	getTitle()
void	goToEntry()
void	goToEntry(java.lang.String inrng)
boolean	isAlternatingRowColors()
boolean	isCellEditable(int row, int column)
void	labelColumnsByRow(int k)
void	pasteClipboard()
void	pasteClipboardAt(int startrow, int startcol)
void	pasteClipboardDown()
void	pasteClipboardDownAt(int r, int c)
void	pasteClipboardLeft()
void	pasteClipboardLeftAt(int r, int c)
void	pasteClipboardRight()
void	pasteClipboardRightAt(int r, int c)
void	pasteClipboardTranspose()
void	pasteClipboardTransposeAt(int startrow, int startcol)
void	pasteClipboardUp()
void	pasteClipboardUpAt(int r, int c)
void	removeRangeGrabListener(RangeGrabListener l)
void	replicateSelectionDown()
void	replicateSelectionLeft()
void	replicateSelectionRight()
void	replicateSelectionUp()
void	resizeTable() Opens a dialog for the user to set the dimensions of the table.
void	resizeTableToContents() Automatically resizes table to the smallest dimensions accomodating the current contents.
void	selectAll()
void	setAlternateRowColor(java.awt.Color s)
void	setAlternatingRowColors(boolean x)
void	setClipboardBuffer(SharedSpreadsheetClipboard buff)
void	shiftSelectedDown()
void	shiftSelectedLeft()
void	shiftSelectedRight()
void	shiftSelectedUp()
void	showMessageDialog(java.lang.String s)
void	startSheetColumnSelection(int col)
void	startSheetRowSelection(int row)

Method Detail

shiftSelectedLeft

void shiftSelectedLeft()

shiftSelectedRight

void shiftSelectedRight()

shiftSelectedUp

void shiftSelectedUp()

shiftSelectedDown

void shiftSelectedDown()

getAlternateRowColor

java.awt.Color getAlternateRowColor()

setAlternateRowColor

void setAlternateRowColor(java.awt.Color s)

setAlternatingRowColors

void setAlternatingRowColors(boolean x)

isAlternatingRowColors

boolean isAlternatingRowColors()

editEntry

void editEntry()

goToEntry

void goToEntry()

goToEntry

void goToEntry(java.lang.String inrng)

deleteSelected

void deleteSelected()

pasteClipboardRight

void pasteClipboardRight()

pasteClipboardLeft

void pasteClipboardLeft()

pasteClipboardUp

void pasteClipboardUp()

pasteClipboardDown

void pasteClipboardDown()

pasteClipboardRightAt

void pasteClipboardRightAt(int r,
                         int c)

pasteClipboardLeftAt

void pasteClipboardLeftAt(int r,
                        int c)

pasteClipboardUpAt

void pasteClipboardUpAt(int r,
                      int c)

pasteClipboardDownAt

void pasteClipboardDownAt(int r,
                        int c)

replicateSelectionRight

void replicateSelectionRight()

replicateSelectionLeft

void replicateSelectionLeft()

replicateSelectionUp

void replicateSelectionUp()

replicateSelectionDown

void replicateSelectionDown()

getSelectionLocation

int[] getSelectionLocation()

pasteClipboardTranspose

void pasteClipboardTranspose()

pasteClipboardTransposeAt

void pasteClipboardTransposeAt(int startrow,
                             int startcol)

pasteClipboard

void pasteClipboard()

pasteClipboardAt

void pasteClipboardAt(int startrow,
                    int startcol)

copyAllToClipboard

void copyAllToClipboard()

cutSelectedToClipboard

boolean cutSelectedToClipboard()

copySelectedToSelection

void copySelectedToSelection()

copySelectedToClipboard

boolean copySelectedToClipboard()

selectAll

void selectAll()

startSheetRowSelection

void startSheetRowSelection(int row)

addSheetRowSelection

void addSheetRowSelection(int row)

startSheetColumnSelection

void startSheetColumnSelection(int col)

addSheetColumnSelection

void addSheetColumnSelection(int col)

fireRangeGrabUpdated

void fireRangeGrabUpdated(java.lang.String range)

addRangeGrabListener

void addRangeGrabListener(RangeGrabListener l)

removeRangeGrabListener

void removeRangeGrabListener(RangeGrabListener l)

externalRangeGrabUpdate

void externalRangeGrabUpdate(java.lang.String range)

externalRangeBookmarkUpdate

void externalRangeBookmarkUpdate(java.lang.String bookmarkname)

getTitle

java.lang.String getTitle()

appendTextToEdit

void appendTextToEdit(java.lang.String text)

getClipboardBuffer

SharedSpreadsheetClipboard getClipboardBuffer()

setClipboardBuffer

void setClipboardBuffer(SharedSpreadsheetClipboard buff)

isCellEditable

boolean isCellEditable(int row,
                     int column)

getCellRenderer

javax.swing.table.TableCellRenderer getCellRenderer(int row,
                                                  int column)

getCellEditor

javax.swing.table.TableCellEditor getCellEditor(int row,
                                              int column)

getLabelForColumn

java.lang.String getLabelForColumn(int col)

getLabelForRow

java.lang.String getLabelForRow(int row)

labelColumnsByRow

void labelColumnsByRow(int k)

getSelectedEntries

java.util.Vector getSelectedEntries()

resizeTableToContents

void resizeTableToContents()

Automatically resizes table to the smallest dimensions accomodating the current contents.

resizeTable

void resizeTable()

Opens a dialog for the user to set the dimensions of the table.

showMessageDialog

void showMessageDialog(java.lang.String s)

fillRange

void fillRange(java.lang.String range,
             java.lang.String startValue,
             java.lang.String stopValue)

Fills the indicated range in this table. Fills the indicated range (e.g. "A1:B10") from a starting value (e.g. "0.231") to a stopping value (e.g. "100.021"). The number of steps incrementing between the start and stop values is equal to the number of elements in the range. Note: If the range has a sheet designation in it (e.g. "Sheet9!A1:B10") then that sheet will be filled instead of this one. Example: fillRange("A1:B10","1","10");