public interface MyrtleSheetAPI extends SpreadsheetPanel, RangeGrabListener, javax.swing.event.TableModelListener, MyrtleStorage
Modifier and Type | Method and Description |
---|---|
void |
addBookmark(java.lang.String gory,
java.lang.String bmname,
java.lang.String range)
Adds a bookmark for the given range under the named bookmark category folder.
|
void |
addProc(SpreadsheetProcedure newScript)
Adds the given procedure and docks it into the scripting frame.
|
void |
addRangeGrabListener(RangeGrabListener l)
Adds a listener for changes in the selected (highlighted)
ranges within a spreadsheet.
|
void |
addSelectionBookmark()
Allows a user to interactively add a new bookmark.
|
DefaultSpreadsheetTable |
addSheetAfter()
Adds a new sheet positioned subsequent to the current one.
|
void |
addSheetAfterCopyAll()
Adds a new sheet after the current one and copies the current sheet's
contents to that one.
|
DefaultSpreadsheetTable |
addSheetBefore()
Adds and returns a new sheet positioned before the currently selected sheet.
|
void |
addSheetBeforeCopyAll()
Adds a new sheet before the current one and copies the current sheet's
contents to that one.
|
void |
addSpreadsheetPanelListener(SpreadsheetPanelListener l)
Adds the given SpreadsheetPanelListener.
|
void |
copyAllToClipboard()
Selects and then copies all of the contents of the current sheet to the clipboard.
|
void |
copySelectedToClipboard()
Copies the contents of the current sheet's selected range to the clipboard.
|
SpreadsheetTable |
createNewSheet()
Creates a new sheet as a SpreadsheetTable.
|
void |
csvExportOneFilePerSheet()
Exports each sheet as a separate CSV file.
|
void |
csvExportSheet()
Exports the current sheet as a CSV file.
|
void |
deleteCurrentSheet()
Deletes the currently selected sheet.
|
void |
deleteSelectedProcs()
Deletes the currently selected procedures from the scripting frame.
|
void |
editSelectedLinkLabels()
Edits/Browses the selected registered links.
|
void |
editSelectedScripts()
Edits/Browses the selected procedures.
|
void |
evaluateSelectedProcedures()
Evaluates the currently selected procedures in the scripting frame.
|
void |
exitAll()
Exits the entire project.
|
void |
fillRange(DefaultSpreadsheetTable tabl,
java.lang.String range,
java.lang.String startValue,
java.lang.String stopValue)
Fills the indicated range in the indicated table.
|
void |
fillRange(java.lang.String range,
java.lang.String startValue,
java.lang.String stopValue)
Fills the indicated range in the currently selected table.
|
void |
fireSpreadsheetPanelChange(SpreadsheetPanelEvent ev)
Inform all SpreadsheetPanelListeners that a change has occured.
|
java.lang.String |
getBookmarkForRange(java.lang.String range)
Returns a bookmark name if one exists for the given range.
|
java.lang.String |
getCurrentSheetTitle()
Gets the currently selected sheet's title.
|
DblMatrix |
getDblMatrixFor(java.lang.String str)
Extracts a range of sheet cells' values interpreted as double's.
|
DblMatrix |
getDblMatrixForBookmark(java.lang.String range)
Extracts a range of sheet cells' values interpreted as double's.
|
DblMatrix |
getDblMatrixForRange(java.lang.String range)
Extracts a range of sheet cells' values interpreted as double's.
|
java.util.HashMap |
getGetFunctionLibrary()
Returns the current reserved function library as a HashMap.
|
GroovyScriptReservedFunction |
getGroovyScriptReservedFunctionFor(java.lang.String cobj,
DefaultSpreadsheetPanel parentPanel,
DefaultSpreadsheetTable parentTable,
DefaultSpreadsheetEntry entry)
Returns a reserved function having the indicated name and associates it with the indicated
panel, table, and spreadsheet cell.
|
java.lang.String |
getPrintExportFormat()
Gets the user's preferred print/export format.
|
java.lang.String |
getRangeForBookmark(java.lang.String mark)
Returns the spreadsheet cell range having the given bookmark.
|
SpreadsheetTable |
getSheet(java.lang.String title)
Returns the named sheet as a SpreadsheetTable.
|
SpreadsheetTable |
getSheetAt(int j)
Returns the sheet at the given index as a SpreadsheetTable.
|
java.lang.String |
getSheetComment(int sheet)
Returns the description for the named spreadsheet.
|
int |
getSheetCount()
Returns the total number of sheets.
|
java.lang.String |
getTitleOfTable(DefaultSpreadsheetTable t)
Returns the title of the current sheet.
|
void |
goToNextSheet()
Makes the subsequent sheet the current one.
|
void |
goToPreviousSheet()
Makes the previous sheet the current one.
|
void |
goToSheet()
Allows user to interactively select a sheet and make it current.
|
void |
goToSheet(java.lang.String title)
Makes the names sheet current.
|
void |
htmlExportOneFilePerSheet()
Exports each sheet as a separate HTML web page.
|
void |
htmlExportOneFilePerSheetMerged()
Exports each sheet as a single merged HTML web page.
|
void |
htmlExportSheet()
Exports the current sheet as a HTML web page.
|
void |
importCSVFile(java.io.File csvfile)
Imports the named CSV file.
|
void |
importProc()
Imports and docks a new script interactively into the scripting frame.
|
void |
importProc(java.net.URL url)
Imports and docks a new script at the given URL into the scripting frame.
|
void |
importSheets()
Allows user to interactively import spreadsheets (e.g.
|
void |
latexExportOneFilePerSheet()
Exports each sheet as a single merged LaTeX document.
|
void |
latexExportOneFilePerSheetMerged()
Exports each sheet as a separate LaTeX document.
|
Script |
loadArchivedProcedure(java.lang.String nn)
Loads an existing script storage by nickname.
|
void |
manageSelectionBookmarks()
Allows a user to interactively manage their bookmarks.
|
void |
pasteClipboardAt(int r,
int c)
Pastes the contents of the clipboard beginning at the indicated row and column
of the current sheet.
|
void |
printOneFilePerSheet()
Prints separately for each sheet.
|
void |
printSheet()
Prints the currently selected sheet.
|
void |
rangeGrabAction(RangeGrabEvent e)
Executes and updates for the given RangeGrabEvent.
|
void |
refreshLink(java.lang.String x)
Updates the images or files for the named registered links.
|
void |
refreshLink(java.net.URL x)
Updates the images or files for links whose URL is given.
|
void |
refreshSelectedLinks()
Updates the images or files for all selected registered links.
|
void |
registerLink(java.lang.String link)
Registers the named link into the results frame.
|
void |
registerLinks(java.lang.String linksList)
Registers a list of links (one link per line) into the results frame.
|
void |
removeRangeGrabListener(RangeGrabListener l)
Removes a listener for changes in the selected (highlighted)
ranges within a spreadsheet.
|
void |
removeSpreadsheetPanelListener(SpreadsheetPanelListener l)
Removes the given SpreadsheetPanelListener.
|
void |
saveOneFilePerProc()
Saves/exports each procedure to a file.
|
void |
saveProcAs()
Allows user to saves the selected procedures interactively.
|
void |
saveProcAs(SpreadsheetProcedure selected,
java.io.File fid)
Saves the indicated procedure to the given file.
|
void |
selectAll()
Selects all of the contents of the current sheet.
|
void |
selectAllProcs()
Selects all of the procedurs that are currently docked into the scripting frame.
|
void |
setSheetComment(int sheet,
java.lang.String com)
Sets the description for the named spreadsheet.
|
void |
showMessageDialog(java.lang.String msg)
Shows a message to the user.
|
void |
showProcedureStackTrace(java.lang.String script,
java.lang.Throwable e)
Allows user to view and debug failed scripts by showing the stack trace which lead up to
the script failing.
|
void |
showStackTrace(java.lang.Throwable e)
Allows user to view and debug by showing the stack trace.
|
void |
tableChanged(javax.swing.event.TableModelEvent ev)
Executes and updates for the given TableModelEvent.
|
boolean |
unRegisterLink(java.lang.String x)
Unregisters the named registered links (image or file) from the results frame.
|
boolean |
unRegisterLink(java.net.URL x)
Unregisters the registered links (image or file) whose URL is given.
|
void |
unRegisterSelectedLinks()
Unregisters all selected registered links (image or file) from the results frame.
|
addBookmarkFolder, addRegisteredLink, addScriptAt, addSheet, getAllBookmarks, getAllEntries, getAllRegisteredLinks, getColumnCountForSheet, getEntryFunctionAt, getEntryValueAt, getPersistentSheetCounter, getRowCountForSheet, getScriptContents, getScriptCount, getScriptLabel, getSheetDescription, getSheetLabel, removeAllBookmarks, removeAllRegisteredLinks, removeAllScripts, removeAllSheets, removeScriptAt, removeSheet, setColumnCountForSheet, setEntryFunctionAt, setEntryValueAt, setPersistentSheetCounter, setRowCountForSheet, setScriptContents, setScriptLabel, setSheetDescription
addRepositoryListener, getComment, getCreatedBy, getCreatedOn, getDefaultGraphicalEditorClass, getEnabled, getNickname, removeRepositoryListener, setComment, setCreatedBy, setCreatedOn, setEnabled, setNickname
afterCopyStorage, afterTransferStorage, beforeCopyStorage, beforeTransferStorage, copyStorage, copyStorageCommands, transferStorage, transferStorageCommands
getDOMStorageClass
DblMatrix getDblMatrixFor(java.lang.String str)
DblMatrix getDblMatrixForRange(java.lang.String range)
DblMatrix getDblMatrixForBookmark(java.lang.String range)
void addSelectionBookmark()
void manageSelectionBookmarks()
java.util.HashMap getGetFunctionLibrary()
void addRangeGrabListener(RangeGrabListener l)
void removeRangeGrabListener(RangeGrabListener l)
void deleteSelectedProcs()
void refreshLink(java.lang.String x)
void refreshSelectedLinks()
void refreshLink(java.net.URL x)
java.lang.String getBookmarkForRange(java.lang.String range)
void showMessageDialog(java.lang.String msg)
void addBookmark(java.lang.String gory, java.lang.String bmname, java.lang.String range)
addBookmark
in interface MyrtleStorage
java.lang.String getRangeForBookmark(java.lang.String mark)
boolean unRegisterLink(java.lang.String x)
void unRegisterSelectedLinks()
boolean unRegisterLink(java.net.URL x)
void registerLink(java.lang.String link)
void registerLinks(java.lang.String linksList)
void setSheetComment(int sheet, java.lang.String com)
java.lang.String getSheetComment(int sheet)
void importSheets()
void importCSVFile(java.io.File csvfile)
void htmlExportSheet()
void csvExportSheet()
void htmlExportOneFilePerSheet()
void latexExportOneFilePerSheetMerged()
void htmlExportOneFilePerSheetMerged()
void latexExportOneFilePerSheet()
java.lang.String getCurrentSheetTitle()
void csvExportOneFilePerSheet()
java.lang.String getPrintExportFormat()
DefaultSpreadsheetTable addSheetBefore()
void exitAll()
void addSheetAfterCopyAll()
void addSheetBeforeCopyAll()
void deleteCurrentSheet()
void copyAllToClipboard()
void copySelectedToClipboard()
void selectAll()
void pasteClipboardAt(int r, int c)
java.lang.String getTitleOfTable(DefaultSpreadsheetTable t)
DefaultSpreadsheetTable addSheetAfter()
void fireSpreadsheetPanelChange(SpreadsheetPanelEvent ev)
void addSpreadsheetPanelListener(SpreadsheetPanelListener l)
void removeSpreadsheetPanelListener(SpreadsheetPanelListener l)
void goToSheet()
void goToSheet(java.lang.String title)
void goToNextSheet()
void goToPreviousSheet()
SpreadsheetTable getSheet(java.lang.String title)
int getSheetCount()
getSheetCount
in interface MyrtleStorage
SpreadsheetTable getSheetAt(int j)
void rangeGrabAction(RangeGrabEvent e)
rangeGrabAction
in interface RangeGrabListener
void tableChanged(javax.swing.event.TableModelEvent ev)
tableChanged
in interface javax.swing.event.TableModelListener
SpreadsheetTable createNewSheet()
void printOneFilePerSheet()
void printSheet()
GroovyScriptReservedFunction getGroovyScriptReservedFunctionFor(java.lang.String cobj, DefaultSpreadsheetPanel parentPanel, DefaultSpreadsheetTable parentTable, DefaultSpreadsheetEntry entry)
void selectAllProcs()
void importProc(java.net.URL url)
void importProc()
void saveOneFilePerProc()
void saveProcAs(SpreadsheetProcedure selected, java.io.File fid)
void editSelectedLinkLabels()
void editSelectedScripts()
void saveProcAs()
void evaluateSelectedProcedures()
void addProc(SpreadsheetProcedure newScript)
void showProcedureStackTrace(java.lang.String script, java.lang.Throwable e)
void showStackTrace(java.lang.Throwable e)
Script loadArchivedProcedure(java.lang.String nn)
void fillRange(java.lang.String range, java.lang.String startValue, java.lang.String stopValue)
void fillRange(DefaultSpreadsheetTable tabl, java.lang.String range, java.lang.String startValue, java.lang.String stopValue)
Copyright © 2011, 2013. Daniel P. Dougherty