SpreadsheetBinder (Abacus Formula Compiler API (Version 1.4.0))

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.formulacompiler.spreadsheet
Interface SpreadsheetBinder

public interface SpreadsheetBinder

Defines the bindings of spreadsheet cells and sections to Java elements.

This interface is an API only. Do not implement it yourself.

Author:: peo
See Also:: EngineBuilder.getRootBinder(), SpreadsheetCompiler.newSpreadsheetBinder(Spreadsheet, Class, Class)

Nested Class Summary
`static class`	`SpreadsheetBinder.Config` Configuration data for new instances of `SpreadsheetBinder`.
`static interface`	`SpreadsheetBinder.Factory` Factory interface for `ImplementationLocator.getInstance(Class)`.
`static interface`	`SpreadsheetBinder.Section` Represents both the container for the definitions of global spreadsheet cells and instances of horizontal or vertical sections within a spreadsheet.

Method Summary
`SpreadsheetBinding`	`getBinding()` Finalizes and returns the binding built by this class.
`SpreadsheetBinder.Section`	`getRoot()` Returns the root section, which represents the entire worksheet.
`Spreadsheet`	`getSpreadsheet()` Returns the spreadsheet model of which elements are bound.
`boolean`	`isInputCell(Spreadsheet.Cell _cell)` Checks if a given cell already is bound to an input method.
`boolean`	`isOutputCell(Spreadsheet.Cell _cell)` Checks if a given cell already is bound to an output method.

Method Detail

getSpreadsheet

Spreadsheet getSpreadsheet()

Returns the spreadsheet model of which elements are bound.

Returns:: The spreadsheet model.

getBinding

SpreadsheetBinding getBinding()
                              throws CompilerException

Finalizes and returns the binding built by this class.

Returns:: The finalized binding.
Throws:: CompilerException

getRoot

SpreadsheetBinder.Section getRoot()

Returns the root section, which represents the entire worksheet.

Returns:: The root section. Is never null.

isInputCell

boolean isInputCell(Spreadsheet.Cell _cell)

Checks if a given cell already is bound to an input method. Cells may not be bound to multiple inputs.

Parameters:: _cell - is the cell to check.
Returns:: true if the cell is already bound to an input method, false otherwise.
See Also:: isOutputCell(Spreadsheet.Cell)

isOutputCell

boolean isOutputCell(Spreadsheet.Cell _cell)

Checks if a given cell already is bound to an output method.

Parameters:: _cell - is the cell to check.
Returns:: true if the cell is already bound to an output method, false otherwise.
See Also:: isInputCell(Spreadsheet.Cell)