com.smoothcsv.core.macro.api

Class App

java.lang.Object

com.smoothcsv.core.macro.apiimpl.APIBase

com.smoothcsv.core.macro.api.App

public class App
extends com.smoothcsv.core.macro.apiimpl.APIBase

This class represents the SmoothCSV application itself.

Method Summary

Modifier and Type	Method and Description
static CellEditor	getActiveCellEditor() Returns the active CellEditor or null if there is no active CellEditor.
static CellEditor	getActiveCellEditor(boolean startEdit) Returns the active CellEditor.
static Range	getActiveRange() Returns the range of cells that is currently considered active.
static CsvSheet	getActiveSheet() Gets the active csvsheet.
static java.lang.String	getName() Returns the name of this application.
static CsvSheet[]	getSheets() Gets all the sheets in this application.
static java.lang.String	getVersion() Returns the version name of this application.
static void	newSheet() Creates a new csvsheet with the default properties.
static void	newSheet(int rows, int columns) Creates a new csvsheet with default properties and the specified number of rows and columns.
static void	newSheet(int rows, int columns, CsvProperties properties) Creates a new csvsheet with the specified number of rows and columns and properties.
static void	open(java.lang.String pathname) Opens the csvsheet that corresponds to the given file path with the default properties.
static void	open(java.lang.String pathname, CsvProperties properties) Opens the csvsheet that corresponds to the given file path with the specified properties.
static void	setActiveSheet(CsvSheet csvSheet) Sets the active csvsheet.

Methods inherited from class com.smoothcsv.core.macro.apiimpl.APIBase

toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getName

public static java.lang.String getName()

Returns the name of this application.

Returns:

the name of this application

getVersion

public static java.lang.String getVersion()

Returns the version name of this application.

Returns:

the version name

newSheet

public static void newSheet()

Creates a new csvsheet with the default properties.

newSheet

public static void newSheet(int rows,
                            int columns)

Creates a new csvsheet with default properties and the specified number of rows and columns.

Parameters:

rows - the number of rows for the csvsheet

columns - the number of columns for the csvsheet

newSheet

public static void newSheet(int rows,
                            int columns,
                            CsvProperties properties)

Creates a new csvsheet with the specified number of rows and columns and properties.

Parameters:

rows - the number of rows for the csvsheet

columns - the number of columns for the csvsheet

properties - the properties

open

public static void open(java.lang.String pathname)

Opens the csvsheet that corresponds to the given file path with the default properties.

Parameters:

pathname - the file path to open

open

public static void open(java.lang.String pathname,
                        CsvProperties properties)

Opens the csvsheet that corresponds to the given file path with the specified properties.

Parameters:

pathname - the file path to open

properties - the properties

getActiveSheet

public static CsvSheet getActiveSheet()

Gets the active csvsheet. Returns null if there is no sheet.

Returns:

the active CsvSheet object

setActiveSheet

public static void setActiveSheet(CsvSheet csvSheet)

Sets the active csvsheet.

Parameters:

csvSheet - the sheet to be activated

getActiveRange

public static Range getActiveRange()

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

getActiveCellEditor

public static CellEditor getActiveCellEditor()

Returns the active CellEditor or null if there is no active CellEditor.

Returns:

the active CellEditor

getActiveCellEditor

public static CellEditor getActiveCellEditor(boolean startEdit)

Returns the active CellEditor.

Parameters:

startEdit - true to start editing if there is no active CellEditor.; false to return null if there is no active CellEditor.

Returns:

the active CellEditor

getSheets

public static CsvSheet[] getSheets()

Gets all the sheets in this application.

Returns:

an array of all the sheets in the application