STransObject Class Reference
[Translators]

the Default translator class that takes data objects as input and outputs HTML. More...

Inheritance diagram for STransObject:

Inheritance graph
[legend]

List of all members.

Public Member Functions

 doc ()
 returns a brief description of this class.
 getInFormat ()
 returns the desired input type
 getOutFormat ()
 returns the output type
 translate ($si)
 Outputs errors. Always. This translator should be extended, not used directly.


Detailed Description

the Default translator class that takes data objects as input and outputs HTML.

Extend this class if you want to write any page-specific object translators (such as translators that take SModel objects and turn them into html).

Author:
Jonathan Stuart-Moore <jwsm@shodor.org> (6/13/07)

Member Function Documentation

STransObject::doc (  ) 

returns a brief description of this class.

Returns:
[string]: A brief description of this class.

Reimplemented from STrans.

STransObject::getInFormat (  ) 

returns the desired input type

Returns:
[string]: Always returns the string 'object', the only input this handles.

Reimplemented from STrans.

STransObject::getOutFormat (  ) 

returns the output type

Returns:
[string]: Always returns the string 'html', the only output this gives.

Reimplemented from STrans.

STransObject::translate ( si  ) 

Outputs errors. Always. This translator should be extended, not used directly.

Returns:
[boolean]: always returns true.

Reimplemented from STrans.


The documentation for this class was generated from the following file:

Generated on Wed Nov 24 02:03:51 2010 for Common by  doxygen 1.5.6