Documentation for class spreadsheet (inherits from generic_acl):


Properties:

name type default params representant foreign foreign_prop position
id CO_INTEGER SEQUENCE READONLY=1;HIDDEN=1 0 0
version CO_INTEGER 0 READONLY=1;HIDDEN=1 0 0
deleted CO_INTEGER 0 READONLY=1;HIDDEN=1 0 0
name CO_STRING '' 1 44
cols CO_INTEGER 0 1 44
rows CO_INTEGER 0 1 44

Methods:


method etest1
description: does nothing, so just gets actions for user session
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER


method etest2
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER


method refresh
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER


method get
description: returns recordset with spreadsheet contents
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER


method edit
description: generates main client page (just frame partition)
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER


method editTop
description: generates top (value, style buttons, controls) frame for spreadsheet client interface
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER


method editBottom
description: generates bottom(with spreadsheet data) frame for client interface
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER


method toHTML
description: generates static spreadsheet, returns string with HTML
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER


method view
description: generates static spreadsheet, as a HTML page
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER


method create
description: overrides generic_acl::create methods, creates new spreadsheet structures
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER

callback
type CO_STRING

create_params
description: this is array of additional parameters that we can pass to target class to create object
type CO_ARRAY_OF_STRINGS

dont_set_acl
description: If this param is set to 1 we do not set ACL for __PERMISSION_CHANGE_ACL for created object
type CO_INTEGER


method setEventHandler
description: as the name says
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER

column_id
type CO_INTEGER

row_id
type CO_INTEGER

event_name
type CO_STRING

event_script
type CO_STRING_SQL_VALUE


method getDefinedEvents
description: used by spreadsheet client interface to obtain all defined events
description: just binary values no event code sent
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER


method onEvent
description: event occured
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER

column_id
type CO_INTEGER

row_id
type CO_INTEGER

event_name
type CO_STRING


method getAllRowIds
description: returns recordset with row ids for a given spreadsheet (row_number order)
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER


method getAllColumnIds
description: returns recordset with column ids for a given spreadsheet (column_number order)
parameters:

par_area
type CO_STRING

par_class
type CO_STRING

par_id
type CO_INTEGER