phpDocumentor OpenDocumentPHP
util_Spreadsheet
[ class tree: OpenDocumentPHP ] [ index: OpenDocumentPHP ] [ all elements ]

Class: Spreadsheet_OpenDocument_Worksheet

Source Location: /util/Spreadsheet/Worksheet.php

Class Spreadsheet_OpenDocument_Worksheet

Class Overview

Spreadsheet_OpenDocument_Worksheet

Located in /util/Spreadsheet/Worksheet.php [line 67]



		
				Author(s):
		
  • Norman Markgraf (nmarkgraf(at)user.sourceforge.net)
Information Tags:
Version:  Release: @package_version@
Copyright:  Copyright in 2006, 2007 by The OpenDocumentPHP Team
Link:  http://pear.php.net/package/Spreadsheet_Excel_Writer
Link:  http://opendocumentphp.org
Since:  0.6.0 - 22. Jul. 2007
License:  GNU General Public License 2.0.

Properties

Methods

[ Top ]
Property Summary
string   $name  
bool   $protected  
string   $protectionKey  
Workbook   $workbook  

[ Top ]
Method Summary
Spreadsheet_OpenDocument_Worksheet   __construct()  
void   close()  
void   getCells()  
The   getName()   Retrieve the worksheet name.
void   protect()   Set the worksheet protection flag to prevent accidental modification and to hide formulas if the locked and hidden format properties have been set.
void   setColumn()   Set the width of a single column or a range of columns.
void   write()   Map to the appropriate write method acording to the token recieved.
integer   writeUrl()   Write a hyperlink.

[ Top ]
Properties
string   $name [line 114]
API Tags:
Access:  public


[ Top ]
bool   $protected = false [line 120]
API Tags:
Access:  public


[ Top ]
string   $protectionKey = null [line 126]
API Tags:
Access:  public


[ Top ]
Workbook   $workbook [line 132]
API Tags:
Access:  protected


[ Top ]
Methods
Constructor __construct  [line 137]

  Spreadsheet_OpenDocument_Worksheet __construct( string $name, [ $workbook = null]  )

Parameters:
string   $name:  Name of the current worksheet
   $workbook: 


[ Top ]
close  [line 367]

  void close( )


API Tags:
Access:  public

Information Tags:
Since:  0.6.0 - 23. Jul. 2007

[ Top ]
getCells  [line 357]

  void getCells( )



[ Top ]
getName  [line 173]

  The getName( )

Retrieve the worksheet name.

This is usefull when creating worksheets without a name.


API Tags:
Return:  worksheet's name
Access:  public

Information Tags:
Since:  0.6.0 - 23. Jul. 2007

[ Top ]
protect  [line 302]

  void protect( string $password  )

Set the worksheet protection flag to prevent accidental modification and to hide formulas if the locked and hidden format properties have been set.

Parameters:
string   $password:  The password to use for protecting the sheet.

API Tags:
Access:  public

Information Tags:
Since:  0.6.0 - 23. Jul. 2007

[ Top ]
setColumn  [line 321]

  void setColumn( integer $firstcol, integer $lastcol, float $width, [mixed $format = null], [integer $hidden = null]  )

Set the width of a single column or a range of columns.

Parameters:
integer   $firstcol:  - first column on the range
integer   $lastcol:  - last column on the range
float   $width:  - width to set
mixed   $format:  - The optional XF format to apply to the columns
integer   $hidden:  - The optional hidden atribute


[ Top ]
write  [line 205]

  void write( integer $row, integer $col, mixed $token, [mixed $format = null]  )

Map to the appropriate write method acording to the token recieved.

Parameters:
integer   $row:  The row of the cell we are writing to
integer   $col:  The column of the cell we are writing to
mixed   $token:  What we are writing
mixed   $format:  The optional format to apply to the cell

API Tags:
Access:  public

Information Tags:
Since:  0.6.0 - 23. Jul. 2007

[ Top ]
writeUrl  [line 265]

  integer writeUrl( integer $row, integer $col, string $url, [string $string = ''], [mixed $format = null]  )

Write a hyperlink.

This is comprised of two elements: the visible label and the invisible link. The visible label is the same as the link unless an alternative string is specified. The label is written using the writeString() method. Therefore the 255 characters string limit applies. $string and $format are optional.

The hyperlink can be to a http, ftp, mail, internal sheet (not yet), or external directory url.

Parameters:
integer   $row:  Row
integer   $col:  Column
string   $url:  URL string
string   $string:  Alternative label
mixed   $format:  The cell format

API Tags:
Return:  0 : normal termination -2 : row or column out of range -3 : long string truncated to 255 chars
Access:  public


[ Top ]

Documentation generated on Wed, 18 Jun 2008 06:34:38 +0200 by phpDocumentor 1.3.2