CsvSheet

```
public interface CsvSheet
```
Represents a CSV sheet in SmoothCSV.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`CsvSheet`	`activate()` Activates this sheet.
`CsvSheet`	`autoResizeColumn(int columnPosition)` Sets the width of the given column to fit its contents.
`void`	`close()` Closes this sheet.
`void`	`close(boolean saveChanges, java.lang.String pathname)` Closes this sheet.
`CsvSheet`	`deleteColumn(int columnPosition)` Deletes the column at the given row position.
`CsvSheet`	`deleteColumns(int columnPosition, int howMany)` Deletes a number of columns starting at the given column position.
`CsvSheet`	`deleteRow(int rowPosition)` Deletes the row at the given row position.
`CsvSheet`	`deleteRows(int rowPosition, int howMany)` Deletes a number of rows starting at the given row position.
`Range`	`getActiveCell()` Returns the active cell in this sheet.
`Range`	`getActiveRange()` Returns the active range for the active sheet.
`int`	`getColumnWidth(int columnPosition)` Gets the width in pixels of the given column.
`int`	`getIndex()` Gets the position of the sheet in the application.
`int`	`getNumColumns()`
`int`	`getNumRows()`
`java.lang.String`	`getPathname()` Returns the pathname of the file to be saved.
`CsvProperties`	`getProperties()` Returns the properties that will be used for saving data to a file.
`Range`	`getRange()` Returns the range containing all the cells.
`Range`	`getRange(int row, int column)` Returns the range with the top left cell at the given coordinates.
`Range`	`getRange(int row, int column, int numRows, int numColumns)` Returns the range with the top left cell at the given coordinates with the given number of rows and columns.
`int`	`getRowHeight(int rowPosition)` Gets the height in pixels of the given row.
`CsvSheet`	`insertColumnAfter(int afterPosition)` Inserts a column after the given column position.
`CsvSheet`	`insertColumnBefore(int beforePosition)` Inserts a column before the given column position.
`CsvSheet`	`insertColumnsAfter(int afterPosition, int howMany)` Inserts a number of columns after the given column position.
`CsvSheet`	`insertColumnsBefore(int beforePosition, int howMany)` Inserts a number of columns before the given column position.
`CsvSheet`	`insertRowAfter(int afterPosition)` Inserts a row after the given row position.
`CsvSheet`	`insertRowBefore(int beforePosition)` Inserts a row before the given row position.
`CsvSheet`	`insertRowsAfter(int afterPosition, int howMany)` Inserts a number of rows after the given row position.
`CsvSheet`	`insertRowsBefore(int beforePosition, int howMany)` Inserts a number of rows before the given row position.
`boolean`	`isModified()` Returns true if this editor has been modified.
`boolean`	`redo()` Redo the last change.
`void`	`save()` Saves changes to the specified file.
`void`	`saveAs(java.lang.String pathname)` Saves changes to the different file.
`Range`	`setActiveRange(Range range)` Sets the active range for the active sheet.
`CsvSheet`	`setColumnWidth(int columnPosition, int width)` Sets the width of the given column in pixels.
`void`	`setPathname(java.lang.String pathname)` Sets the pathname of the file to be saved.
`CsvSheet`	`setProperties(CsvProperties properties)` Sets the properties that will be used for saving data to a file.
`CsvSheet`	`sort(java.lang.Object sortSpecObj)` Sorts a sheet, by column and order specified.
`boolean`	`undo()` Undo the last change.

- Method Detail
  - activate
```
CsvSheet activate()
```
    Activates this sheet.
    
    Returns:
    
    the newly active sheet
  - getIndex
```
int getIndex()
```
    Gets the position of the sheet in the application. Starts at 1.
    
    Returns:
    
    the position of the sheet
  - getPathname
```
java.lang.String getPathname()
```
    Returns the pathname of the file to be saved.
    
    Returns:
    
    the pathname of the file
  - setPathname
```
void setPathname(java.lang.String pathname)
```
    Sets the pathname of the file to be saved.
    
    Parameters:
    
    pathname - the pathname of the file
  - getProperties
```
CsvProperties getProperties()
```
    Returns the properties that will be used for saving data to a file.
    
    Returns:
    
    the properties
  - setProperties
```
CsvSheet setProperties(CsvProperties properties)
```
    Sets the properties that will be used for saving data to a file.
    
    Parameters:
    
    properties - the properties to set
    
    Returns:
    
    the sheet, useful for method chaining
  - isModified
```
boolean isModified()
```
    Returns true if this editor has been modified.
    
    Returns:
    
    whether this editor has been modified or not
  - save
```
void save()
```
    Saves changes to the specified file. The first time you save a CSV, use setPathname(String) before calling this method to specify a name for the file, or use saveAs(String) instead. Otherwise the user is asked to supply a pathname.
  - saveAs
```
void saveAs(java.lang.String pathname)
```
    Saves changes to the different file.
    
    Parameters:
    
    pathname - the pathname of the file to be saved.
  - close
```
void close()
```
    Closes this sheet.
  - close
```
void close(boolean saveChanges,
           java.lang.String pathname)
```
    Closes this sheet.
    
    Parameters:
    
    saveChanges - If there are no changes to the sheet, this argument is ignored. If there are changes to the sheet, this argument specifies whether changes should be saved. If set to true, changes are saved to the file. If there is not yet a file pathname associated with the sheet, then pathname is used. If pathname is omitted, the user is asked to supply a pathname.
    
    pathname - If saveChanges is true, the pathname with which to save the file. The default is to prompt for the pathname.
  - undo
```
boolean undo()
```
    Undo the last change.
    
    Returns:
    
    true if the undoing has succeeded, false if the undoing couldn't complete
  - redo
```
boolean redo()
```
    Redo the last change.
    
    Returns:
    
    true if the redoing has succeeded, false if the redoing couldn't complete
  - autoResizeColumn
```
CsvSheet autoResizeColumn(int columnPosition)
```
    Sets the width of the given column to fit its contents.
    
    Parameters:
    
    columnPosition - the position of the given column to resize
    
    Returns:
    
    the sheet, useful for method chaining
  - getRowHeight
```
int getRowHeight(int rowPosition)
```
    Gets the height in pixels of the given row.
    
    Parameters:
    
    rowPosition - the position of the row to examine
    
    Returns:
    
    row height in pixels
  - getColumnWidth
```
int getColumnWidth(int columnPosition)
```
    Gets the width in pixels of the given column.
    
    Parameters:
    
    columnPosition - the position of the column to examine
    
    Returns:
    
    column width in pixels
  - setColumnWidth
```
CsvSheet setColumnWidth(int columnPosition,
                        int width)
```
    Sets the width of the given column in pixels.
    
    Parameters:
    
    columnPosition - the position of the given column to set
    
    width - the width in pixels to set it to
    
    Returns:
    
    the sheet, useful for method chaining
  - insertRowAfter
```
CsvSheet insertRowAfter(int afterPosition)
```
    Inserts a row after the given row position.
    
    Parameters:
    
    afterPosition - the row after which the new row should be added
    
    Returns:
    
    the sheet, useful for method chaining
  - insertRowsAfter
```
CsvSheet insertRowsAfter(int afterPosition,
                         int howMany)
```
    Inserts a number of rows after the given row position.
    
    Parameters:
    
    afterPosition - the row after which the new row should be added
    
    howMany - the number of rows to insert
    
    Returns:
    
    the sheet, useful for method chaining
  - insertRowBefore
```
CsvSheet insertRowBefore(int beforePosition)
```
    Inserts a row before the given row position.
    
    Parameters:
    
    beforePosition - the row before which the new row should be added
    
    Returns:
    
    the sheet, useful for method chaining
  - insertRowsBefore
```
CsvSheet insertRowsBefore(int beforePosition,
                          int howMany)
```
    Inserts a number of rows before the given row position.
    
    Parameters:
    
    beforePosition - the row before which the new row should be added
    
    howMany - the number of rows to insert
    
    Returns:
    
    the sheet, useful for method chaining
  - deleteRow
```
CsvSheet deleteRow(int rowPosition)
```
    Deletes the row at the given row position.
    
    Parameters:
    
    rowPosition - the position of the row, starting at 1 for the first row
    
    Returns:
    
    the sheet, useful for method chaining
  - deleteRows
```
CsvSheet deleteRows(int rowPosition,
                    int howMany)
```
    Deletes a number of rows starting at the given row position.
    
    Parameters:
    
    rowPosition - the position of the first row to delete
    
    howMany - the number of rows to delete
    
    Returns:
    
    the sheet, useful for method chaining
  - insertColumnAfter
```
CsvSheet insertColumnAfter(int afterPosition)
```
    Inserts a column after the given column position.
    
    Parameters:
    
    afterPosition - the column after which the new column should be added
    
    Returns:
    
    the sheet, useful for method chaining
  - insertColumnsAfter
```
CsvSheet insertColumnsAfter(int afterPosition,
                            int howMany)
```
    Inserts a number of columns after the given column position.
    
    Parameters:
    
    afterPosition - the column after which the new column should be added
    
    howMany - the number of columns to insert
    
    Returns:
    
    the sheet, useful for method chaining
  - insertColumnBefore
```
CsvSheet insertColumnBefore(int beforePosition)
```
    Inserts a column before the given column position.
    
    Parameters:
    
    beforePosition - the column before which the new column should be added
    
    Returns:
    
    the sheet, useful for method chaining
  - insertColumnsBefore
```
CsvSheet insertColumnsBefore(int beforePosition,
                             int howMany)
```
    Inserts a number of columns before the given column position.
    
    Parameters:
    
    beforePosition - the column before which the new column should be added
    
    howMany - the number of columns to insert
    
    Returns:
    
    the sheet, useful for method chaining
  - deleteColumn
```
CsvSheet deleteColumn(int columnPosition)
```
    Deletes the column at the given row position.
    
    Parameters:
    
    columnPosition - the position of the column, starting at 1 for the first column
    
    Returns:
    
    the sheet, useful for method chaining
  - deleteColumns
```
CsvSheet deleteColumns(int columnPosition,
                       int howMany)
```
    Deletes a number of columns starting at the given column position.
    
    Parameters:
    
    columnPosition - the position of the first column to delete
    
    howMany - the number of columns to delete
    
    Returns:
    
    the sheet, useful for method chaining
  - getNumRows
```
int getNumRows()
```
  - getNumColumns
```
int getNumColumns()
```
  - getRange
```
Range getRange(int row,
               int column)
```
    Returns the range with the top left cell at the given coordinates.
    
    Parameters:
    
    row - the row of the cell to return
    
    column - the column of the cell to return
    
    Returns:
    
    a Range containing only this cell
  - getRange
```
Range getRange(int row,
               int column,
               int numRows,
               int numColumns)
```
    Returns the range with the top left cell at the given coordinates with the given number of rows and columns.
    
    Parameters:
    
    row - the starting row of the range
    
    column - the starting column of the range
    
    numRows - the number of rows to return
    
    numColumns - the number of columns to return
    
    Returns:
    
    a Range corresponding to the area specified
  - getActiveRange
```
Range getActiveRange()
```
    Returns the active range for the active sheet. Returns the range of cells that is currently considered active. This generally means the range that a user has selected in the active sheet.
    
    Returns:
    
    the active range
  - setActiveRange
```
Range setActiveRange(Range range)
```
    Sets the active range for the active sheet.
    
    Parameters:
    
    range - the range to set as the active range
    
    Returns:
    
    the newly active range
  - getActiveCell
```
Range getActiveCell()
```
    Returns the active cell in this sheet.
    
    Returns:
    
    the current active cell
  - getRange
```
Range getRange()
```
    Returns the range containing all the cells.
    
    Returns:
    
    a Range containing all the cells
  - sort
```
CsvSheet sort(java.lang.Object sortSpecObj)
```
    Sorts a sheet, by column and order specified.
    
    Parameters:
    
    sortSpecObj - TODO
    
    Returns:
    
    the sheet, useful for method chaining

Interface CsvSheet

Method Summary

Method Detail

activate

getIndex

getPathname

setPathname

getProperties

setProperties

isModified

save

saveAs

close

close

undo

redo

autoResizeColumn

getRowHeight

getColumnWidth

setColumnWidth

insertRowAfter

insertRowsAfter

insertRowBefore

insertRowsBefore

deleteRow

deleteRows

insertColumnAfter

insertColumnsAfter

insertColumnBefore

insertColumnsBefore

deleteColumn

deleteColumns

getNumRows

getNumColumns

getRange

getRange

getActiveRange

setActiveRange

getActiveCell

getRange

sort