Class PulsarCalc

Object
   |
   +--PulsarCalc

class PulsarCalc

Defined in pulsarcalc.js

Field Detail

background

Object background

Default collection of background colors: normal, selected and f0..f12 for foreign cursors.

button

Object button

Collection of default buttons: - (Spacer), Print, Users, Bold, Italic, Underline. To extend this object look to the 'dummy' value. Don't forget to put the newly created button to the toolbarButtons-array.

dataTable

Object dataTable

DataTable-element.

functions

Object functions

Functions that are supported by the praser ar defined in this object. Extend it to add new functions. Example of insertion of a new function: pulsarcalc.functions["pi"] = function(str, pulsarobject){} ;

toolbarButtons

Object toolbarButtons

Button names that will be created in the toolbar during the initialization.

PulsarCalc

PulsarCalc()

PulsarCalc is the basic constructor for the spreadsheet object.

calculate

Number calculate(str)

This will iterate over all known functions and return the result of the expression.

Returns:
Result of the expression

See:
- functions

create

void create(<String> toolbarId, <String> containerId, <String> sessionName)

This method creates the new PulsarCalc object. It consists of the toolbar and the data table.

Parameters:
toolbarId - The DOM-ID of the DIV-container where the toolbar will be created
containerId - The DOM-ID of the DIV-container where the table will be created
sessionName - The name of the PULSAR-session that will be shared or created

doEdit

void doEdit()

This starts the editiong of the cell where user is currently on.

getCellId

String getCellId(<Number> x, <Number> y)

Convert number representation of a cell into string representation.

Parameters:
x - X-coordinates of a cell
y - Y-coordinates of a cell

Returns:
Cell-ID (e.g. "A4")

getCellObject

Object getCellObject(<String> cellId)

Returns reference to the DOM element of a particular cell

Parameters:
cellId - Cell-ID

Returns:
DOM-Object

getCursorPosition

String getCursorPosition()

Returns the cell name where the own cursor is currently on

Returns:
Cell name (Cell-ID)

getForeignCells

Object getForeignCells()

Positions of foreign users and cells where they currently are.

Returns:
Cell-ID - User-ID - pairs.

getForeignId

Number getForeignId(cellId)

Returns the id of a foreign user in a partucular cell.

Parameters:
cell - -ID

Returns:
User-ID

getFormat

Format getFormat(cellId)

Returns format options for a particular cell.

Parameters:
cell - -ID

Returns:
cell format

getInputObject

Object getInputObject()

Returns the input element (where we change the cell content)

Returns:
DOM-reference to the input element

getInputValue

String getInputValue()

Get the value of the input object

Returns:
Value

getValue

String getValue(<String> cell)

Getting a value of a particular cell

Parameters:
cell - Cell-ID

Returns:
Cell content

See:
- setValue()

isForeignCell

Boolean isForeignCell(cellId)

Check whether if there is somebody but me in a particular cell.

Parameters:
cell - -ID

Returns:
false if there is no other user in the cell, otherwise true

onCellClick

void onCellClick(<Number> x, <Number> y)

This method will be called if the user clicks on a cell of tries to change cursor position with the arrow keys.

Parameters:
x - X-position of the cursor
y - Y-position of the cursor

onConnectionStatusChanges

void onConnectionStatusChanges(<Boolean> status)

This notifier will be called if connectoin status to the PULSAR server changes. Redefine this with your own.

Parameters:
status - Current connection status: true - connected, false - not connected.

onCursorPositionChanges

Boolean onCursorPositionChanges(<String> cell)

This notifier will be called if user is goint to change the current cell. Redefine this with your own and pay attention to the return value.

Parameters:
cell - Cell-ID where the user is going to change to.

Returns:
true - the position will be changed, false - the position will be not changed.

onStartEditing

Boolean onStartEditing(<String> cell)

This notifier will be called if user is going to edit a particular cell. Redefine this with your own and pay attention to the return value.

Parameters:
cell - Cell-ID where the user is going to change to.

Returns:
true - the position will be changed, false - the position will be not changed.

setFormat

void setFormat(<String> cellId, <Format> format)

Setting format of a particular cell.

Parameters:
cellId - Cell-ID
format - New format or new format elements

setInputFocus

void setInputFocus(<Boolean> focus)

Set focus to the input object or blur

Parameters:
focus - true - focus will be set, false - object will be blured.

setInputValue

void setInputValue(<String> value)

Set the value of the input object

Parameters:
value - New value

setSize

void setSize(<Number> rows, <Number> columns)

Defining table size. This function must be called before the create() method.

Parameters:
rows - Rows number
columns - Columns number

setValue

void setValue(<String> cell, <String> value)

Setting a value of a particular cell

Parameters:
cell - Cell name
value - New value

See:
- getValue()
- setFormat()

updateContent

void updateContent()

This method updates content for each cell of the table.

See:
- updateFormat()

updateCursors

void updateCursors(<Boolean> fromMe)

Updates cursor of each cell of the data table.

Parameters:
fromMe - true - if called by me, false - if called by another user

See:
- updateFormat()
- updateContent()

updateFormat

void updateFormat()

Update format of each cell of the data table.

See:
- updateContent()