wf_abstract_object Class Reference

abstract class wich represent e generic simple object All other classes are derived from this More...

Inheritance diagram for wf_abstract_object:

wf_abstract_container_object wf_image wf_message wf_newline wf_abstract_complex_container_object wf_anchor wf_area wf_main wf_abstract_container_array_object wf_abstract_container_matrix_object wf_input wf_form wf_list wf_table List of all members.

Public Member Functions

 do_init ($param, $paramisarray=false)
 common initialization of object
 id ()
 give the object id
 private_set_parameters (&$propertyarray, &$param, $paramisarray)
 set/change parameters for the object
 set ($param, $paramisarray=false)
 set/change the (html) properties for the object
 set_inlinecss ($param, $paramisarray=false)
 set/change the css inline properties for the object
 set_internalcss ($param, $paramisarray=false)
 set/change the page css properties for the object
 private_set_js (&$array, &$param)
 set the javascript (inline or internal) for the object
 set_inlinejs ($param='')
 set the inline javascript for the object
 set_internaljs ($param='')
 set the internal javascript for the object
 do_internalcss ()
 generate page-wide css for object's css properties eventually set the method apply the configuration given with set_internalcss
 do_inlinecss ()
 insert inline into the object the css properties eventually set the method apply the configuration given with set_inlinecss
 do_internaljscode (&$scriptnames)
 insert javascript code eventually defined with set_internaljs in the beginning of the page
 do_internaljscall ()
 insert object javascript calls defined with set_internaljs in the beginning of the page with the Scott Andrew's addEvent (slightly modified) function
 do_inlinejscode ()
 insert into the object the javascript code (functions) eventually set the method apply the configuration given with set_inlinejs and type=code or type=codecall
 do_inlinejscall ($callerid='__WFMAINOBJ')
 insert into the object the javascript calls or raw code eventually set the method apply the configuration given with set_inlinejs and type=call or type=codecall or type=rawcode
 give_subobjects ()
 give a null because this abstract object do not have subobjects; the finction is needed by the internal css/javascript manager
 give_cssproperties ()
 give the css properties admitted for the object
 purge_css ()
 unset the css properties defined for the object
 purge_js ()
 eliminate all javascript code associated with the object

Public Attributes

 $wf_properties
 $wf_inlinecss
 $wf_internalcss
 $wf_inlinejs
 $wf_internaljs
 $wf_cssdefinitions

Detailed Description

abstract class wich represent e generic simple object All other classes are derived from this


Member Function Documentation

wf_abstract_object::do_init ( param,
paramisarray = false 
)

common initialization of object

Parameters:
$param a string of settings of type 'param=value[;;param=value ..]' the function do the generic (common to all objects) initialization and then pass the parameter $param eventually given to the method set
$paramisarray if true tell the function that the params are already in array form and don't need parsing
See also:
set()

wf_abstract_object::private_set_parameters ( &$  propertyarray,
&$  param,
paramisarray 
)

set/change parameters for the object

Parameters:
&$propertyarray array of object properties to set;
$param a string of settings of type 'param=value[;;param=value ..]'
$parmisarray boolean wich indicate if param is in array form;

Reimplemented in wf_abstract_complex_container_object, and wf_form.

wf_abstract_object::set ( param,
paramisarray = false 
)

set/change the (html) properties for the object

Parameters:
$param a string of settings of type 'param=value[;;param=value ..]'
$parmisarray boolean wich indicate if param is in array form;

wf_abstract_object::set_inlinecss ( param,
paramisarray = false 
)

set/change the css inline properties for the object

Parameters:
$param a string of settings of type 'param=value[;;param=value ..]'
$parmisarray boolean wich indicate if param is in array form;

wf_abstract_object::set_internalcss ( param,
paramisarray = false 
)

set/change the page css properties for the object

Parameters:
$param a string of settings of type 'param=value[;;param=value ..]'
$parmisarray boolean wich indicate if param is in array form;

wf_abstract_object::private_set_js ( &$  array,
&$  param 
)

set the javascript (inline or internal) for the object

Parameters:
&$array the internal array wich must be set (inlinejs or internaljs)
$param a string of settings of type 'param=value[;;param=value ..]'; admitted parameters:
  • type: can be 'call','code', 'codecall','rawcode';
  • callerid: id of the element associated to javascript
  • event: the event associated, e.g. onmouseover;
  • scriptname: name of the script function to call (has meaning with type='call' or 'codecall');
  • parameters: parameters to give to the script function to call (has meaning with type='call' or 'codecall');
  • code: code associated to dom event (has meaning with type='code', 'codecall' or 'rawcode' );
  • capture: capture the event or not ;

wf_abstract_object::set_inlinejs ( param = ''  ) 

set the inline javascript for the object

Parameters:
$param a string of settings of type 'param=value[;;param=value ..]'

wf_abstract_object::set_internaljs ( param = ''  ) 

set the internal javascript for the object

Parameters:
param a string of settings of type 'param=value[;;param=value ..]'

wf_abstract_object::do_internalcss (  ) 

generate page-wide css for object's css properties eventually set the method apply the configuration given with set_internalcss

See also:
set_internalcss()

Reimplemented in wf_abstract_complex_container_object.

wf_abstract_object::do_inlinecss (  ) 

insert inline into the object the css properties eventually set the method apply the configuration given with set_inlinecss

See also:
set_inlinecss()

wf_abstract_object::do_internaljscode ( &$  scriptnames  ) 

insert javascript code eventually defined with set_internaljs in the beginning of the page

Parameters:
$scriptnames array of javascript names of functions already inserted, wich prevent objects to insert into the page a function with the same name of an already inserted function.

wf_abstract_object::do_internaljscall (  ) 

insert object javascript calls defined with set_internaljs in the beginning of the page with the Scott Andrew's addEvent (slightly modified) function

Parameters:
 

wf_abstract_object::do_inlinejscode (  ) 

insert into the object the javascript code (functions) eventually set the method apply the configuration given with set_inlinejs and type=code or type=codecall

Parameters:
 

wf_abstract_object::do_inlinejscall ( callerid = '__WFMAINOBJ'  ) 

insert into the object the javascript calls or raw code eventually set the method apply the configuration given with set_inlinejs and type=call or type=codecall or type=rawcode

Parameters:
$calerid,: id of the (sub)object wich is calling the function (needed for objects wich have sub-elements as wf_table)


Member Data Documentation

wf_abstract_object::$wf_properties

array of the object's properties

wf_abstract_object::$wf_inlinecss

array of css properties wich will be applied internal (page-wide)

wf_abstract_object::$wf_internalcss

array of css properties wich will be applied inline

wf_abstract_object::$wf_inlinejs

array of javascript code or function calls to be inserted inline

wf_abstract_object::$wf_internaljs

array of javascript code or function calls to be inserted inline

wf_abstract_object::$wf_cssdefinitions

array of pairs phpwf parameter-css parameter


The documentation for this class was generated from the following file:
Generated on Sun Apr 13 09:12:21 2008 for phpwf(wd) by  doxygen 1.5.2