Clientbase
/
Spreadsheet_Excel_Writer
mirror of https://github.com/basemaster/Spreadsheet_Excel_Writer.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

adding setOutline() method (Herman Kuiper). 

git-svn-id: https://svn.php.net/repository/pear/packages/Spreadsheet_Excel_Writer/trunk@141435 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Xavier Noguer Gallego 2003-10-01 13:17:04 +00:00
parent c7dc7b9da0
commit 3a5771f93f
1 changed files with 188 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

185
Writer/Worksheet.php
View File

@ -283,6 +283,54 @@ class Spreadsheet_Excel_Writer_Worksheet extends Spreadsheet_Excel_Writer_BIFFwr
*/ */
var $print_colmax; var $print_colmax;
/**
* Whether to use outline.
* @var bool
*/
var $_outline_on;
/**
* Auto outline styles.
* @var bool
*/
var $_outline_style;
/**
* Whether to have outline summary below.
* @var bool
*/
var $_outline_below;
/**
* Whether to have outline summary at the right.
* @var bool
*/
var $_outline_right;
/**
* Outline row level.
* @var integer
*/
var $_outline_row_level;
/**
* Whether to fit to page when printing or not.
* @var bool
*/
var $_fit_page;
/**
* Number of pages to fit wide
* @var integer
*/
var $_fit_width;
/**
* Number of pages to fit high
* @var integer
*/
var $_fit_height;
/** /**
* Constructor * Constructor
* *
@ -369,6 +417,12 @@ class Spreadsheet_Excel_Writer_Worksheet extends Spreadsheet_Excel_Writer_BIFFwr
$this->_zoom = 100; $this->_zoom = 100;
$this->_print_scale = 100; $this->_print_scale = 100;
$this->_outline_row_level = 0;
$this->_outline_style = 0;
$this->_outline_below = 1;
$this->_outline_right = 1;
$this->_outline_on = 1;
$this->_initialize(); $this->_initialize();
} }
@ -458,6 +512,9 @@ class Spreadsheet_Excel_Writer_Worksheet extends Spreadsheet_Excel_Writer_BIFFwr
// Prepend GRIDSET // Prepend GRIDSET
$this->_storeGridset(); $this->_storeGridset();
// Prepend GUTS
$this->_storeGuts();
// Prepend PRINTGRIDLINES // Prepend PRINTGRIDLINES
$this->_storePrintGridlines(); $this->_storePrintGridlines();
@ -604,10 +661,11 @@ class Spreadsheet_Excel_Writer_Worksheet extends Spreadsheet_Excel_Writer_BIFFwr
* @param integer $width width to set * @param integer $width width to set
* @param mixed $format The optional XF format to apply to the columns * @param mixed $format The optional XF format to apply to the columns
* @param integer $hidden The optional hidden atribute * @param integer $hidden The optional hidden atribute
* @param integer $level The optional outline level
*/ */
function setColumn($firstcol, $lastcol, $width, $format = 0, $hidden = 0) function setColumn($firstcol, $lastcol, $width, $format = 0, $hidden = 0, $level = 0)
{ {
$this->_colinfo[] = array($firstcol, $lastcol, $width, &$format, $hidden); $this->_colinfo[] = array($firstcol, $lastcol, $width, &$format, $hidden, $level);
// Set width to zero if column is hidden // Set width to zero if column is hidden
$width = ($hidden) ? 0 : $width; $width = ($hidden) ? 0 : $width;
@ -1245,6 +1303,27 @@ class Spreadsheet_Excel_Writer_Worksheet extends Spreadsheet_Excel_Writer_BIFFwr
return($password); return($password);
} }
/**
* This method sets the properties for outlining and grouping. The defaults
* correspond to Excel's defaults.
*
* @param bool $visible
* @param bool $symbols_below
* @param bool $symbols_right
* @param bool $auto_style
*/
function setOutline($visible = true, $symbols_below = true, $symbols_right = true, $auto_style = false)
{
$this->_outline_on = $visible;
$this->_outline_below = $symbols_below;
$this->_outline_right = $symbols_right;
$this->_outline_style = $auto_style;
// Ensure this is a boolean vale for Window2
if ($this->_outline_on) {
$this->_outline_on = true;
}
}
/****************************************************************************** /******************************************************************************
******************************************************************************* *******************************************************************************
@ -1915,8 +1994,10 @@ class Spreadsheet_Excel_Writer_Worksheet extends Spreadsheet_Excel_Writer_BIFFwr
* @param integer $height Height we are giving to the row. * @param integer $height Height we are giving to the row.
* Use NULL to set XF without setting height * Use NULL to set XF without setting height
* @param mixed $format XF format we are giving to the row * @param mixed $format XF format we are giving to the row
* @param bool $hidden The optional hidden attribute
* @param integer $level The optional outline level for row, in range [0,7]
*/ */
function setRow($row, $height, $format = 0) function setRow($row, $height, $format = 0, $hidden = false, $level = 0)
{ {
$record = 0x0208; // Record identifier $record = 0x0208; // Record identifier
$length = 0x0010; // Number of bytes to follow $length = 0x0010; // Number of bytes to follow
@ -1925,7 +2006,7 @@ class Spreadsheet_Excel_Writer_Worksheet extends Spreadsheet_Excel_Writer_BIFFwr
$colMac = 0x0000; // Last defined column $colMac = 0x0000; // Last defined column
$irwMac = 0x0000; // Used by Excel to optimise loading $irwMac = 0x0000; // Used by Excel to optimise loading
$reserved = 0x0000; // Reserved $reserved = 0x0000; // Reserved
$grbit = 0x01C0; // Option flags. (monkey) see $1 do $grbit = 0x0000; // Option flags
$ixfe = $this->_XF($format); // XF index $ixfe = $this->_XF($format); // XF index
// Use setRow($row, NULL, $XF) to set XF format without setting height // Use setRow($row, NULL, $XF) to set XF format without setting height
@ -1936,6 +2017,22 @@ class Spreadsheet_Excel_Writer_Worksheet extends Spreadsheet_Excel_Writer_BIFFwr
$miyRw = 0xff; // default row height is 256 $miyRw = 0xff; // default row height is 256
} }
$level = max(0, min($level, 7)); // level should be between 0 and 7
$this->_outline_row_level = max($level, $this->_outline_row_level);
// Set the options flags. fUnsynced is used to show that the font and row
// heights are not compatible. This is usually the case for WriteExcel.
// The collapsed flag 0x10 doesn't seem to be used to indicate that a row
// is collapsed. Instead it is used to indicate that the previous row is
// collapsed. The zero height flag, 0x20, is used to collapse a row.
$grbit |= $level;
if($hidden) $grbit |= 0x0020;
$grbit |= 0x0040; # fUnsynced
if($format) $grbit |= 0x0080;
$grbit |= 0x0100;
$header = pack("vv", $record, $length); $header = pack("vv", $record, $length);
$data = pack("vvvvvvvv", $row, $colMic, $colMac, $miyRw, $data = pack("vvvvvvvv", $row, $colMic, $colMac, $miyRw,
$irwMac,$reserved, $grbit, $ixfe); $irwMac,$reserved, $grbit, $ixfe);
@ -1986,7 +2083,7 @@ class Spreadsheet_Excel_Writer_Worksheet extends Spreadsheet_Excel_Writer_BIFFwr
$fDspZeros = 1; // 4 $fDspZeros = 1; // 4
$fDefaultHdr = 1; // 5 $fDefaultHdr = 1; // 5
$fArabic = 0; // 6 $fArabic = 0; // 6
$fDspGuts = 1; // 7 $fDspGuts = $this->_outline_on; // 7
$fFrozenNoSplit = 0; // 0 - bit $fFrozenNoSplit = 0; // 0 - bit
$fSelected = $this->selected; // 1 $fSelected = $this->selected; // 1
$fPaged = 1; // 2 $fPaged = 1; // 2
@ -2037,6 +2134,7 @@ class Spreadsheet_Excel_Writer_Worksheet extends Spreadsheet_Excel_Writer_BIFFwr
* 2 => Col width (8.43 is Excel default), * 2 => Col width (8.43 is Excel default),
* 3 => The optional XF format of the column, * 3 => The optional XF format of the column,
* 4 => Option flags. * 4 => Option flags.
* 5 => Optional outline level
*/ */
function _storeColinfo($col_array) function _storeColinfo($col_array)
{ {
@ -2064,6 +2162,12 @@ class Spreadsheet_Excel_Writer_Worksheet extends Spreadsheet_Excel_Writer_BIFFwr
else { else {
$grbit = 0; $grbit = 0;
} }
if (isset($col_array[5])) {
$level = $col_array[5];
}
else {
$level = 0;
}
$record = 0x007D; // Record identifier $record = 0x007D; // Record identifier
$length = 0x000B; // Number of bytes to follow $length = 0x000B; // Number of bytes to follow
@ -2073,6 +2177,9 @@ class Spreadsheet_Excel_Writer_Worksheet extends Spreadsheet_Excel_Writer_BIFFwr
$ixfe = $this->_XF($format); $ixfe = $this->_XF($format);
$reserved = 0x00; // Reserved $reserved = 0x00; // Reserved
$level = max(0, min($level, 7));
$grbit |= $level << 8;
$header = pack("vv", $record, $length); $header = pack("vv", $record, $length);
$data = pack("vvvvvC", $colFirst, $colLast, $coldx, $data = pack("vvvvvC", $colFirst, $colLast, $coldx,
$ixfe, $grbit, $reserved); $ixfe, $grbit, $reserved);
@ -2572,6 +2679,53 @@ class Spreadsheet_Excel_Writer_Worksheet extends Spreadsheet_Excel_Writer_BIFFwr
$this->_prepend($header.$data); $this->_prepend($header.$data);
} }
/**
* Write the GUTS BIFF record. This is used to configure the gutter margins
* where Excel outline symbols are displayed. The visibility of the gutters is
* controlled by a flag in WSBOOL.
*
* @see _storeWsbool()
* @access private
*/
function _storeGuts()
{
$record = 0x0080; // Record identifier
$length = 0x0008; // Bytes to follow
$dxRwGut = 0x0000; // Size of row gutter
$dxColGut = 0x0000; // Size of col gutter
$row_level = $this->_outline_row_level;
$col_level = 0;
// Calculate the maximum column outline level. The equivalent calculation
// for the row outline level is carried out in setRow().
for ($i=0; $i < count($this->_colinfo); $i++)
{
// Skip cols without outline level info.
if (count($col_level) >= 6) {
$col_level = max($this->_colinfo[$i][5], $col_level);
}
}
// Set the limits for the outline levels (0 <= x <= 7).
$col_level = max(0, min($col_level, 7));
// The displayed level is one greater than the max outline levels
if ($row_level) {
$row_level++;
}
if ($col_level) {
$col_level++;
}
$header = pack("vv", $record, $length);
$data = pack("vvvv", $dxRwGut, $dxColGut, $row_level, $col_level);
$this->_prepend($header.$data);
}
/** /**
* Write the WSBOOL BIFF record, mainly for fit-to-page. Used in conjunction * Write the WSBOOL BIFF record, mainly for fit-to-page. Used in conjunction
* with the SETUP record. * with the SETUP record.
@ -2582,15 +2736,33 @@ class Spreadsheet_Excel_Writer_Worksheet extends Spreadsheet_Excel_Writer_BIFFwr
{ {
$record = 0x0081; // Record identifier $record = 0x0081; // Record identifier
$length = 0x0002; // Bytes to follow $length = 0x0002; // Bytes to follow
$grbit = 0x0000;
// The only option that is of interest is the flag for fit to page. So we // The only option that is of interest is the flag for fit to page. So we
// set all the options in one go. // set all the options in one go.
// //
if ($this->_fit_page) { /*if ($this->_fit_page) {
$grbit = 0x05c1; $grbit = 0x05c1;
} }
else { else {
$grbit = 0x04c1; $grbit = 0x04c1;
}*/
// Set the option flags
$grbit |= 0x0001; // Auto page breaks visible
if ($this->_outline_style) {
$grbit |= 0x0020; // Auto outline styles
}
if ($this->_outline_below) {
$grbit |= 0x0040; // Outline summary below
}
if ($this->_outline_right) {
$grbit |= 0x0080; // Outline summary right
}
if ($this->_fit_page) {
$grbit |= 0x0100; // Page setup fit to page
}
if ($this->_outline_on) {
$grbit |= 0x0400; // Outline symbols displayed
} }
$header = pack("vv", $record, $length); $header = pack("vv", $record, $length);
@ -2598,7 +2770,6 @@ class Spreadsheet_Excel_Writer_Worksheet extends Spreadsheet_Excel_Writer_BIFFwr
$this->_prepend($header.$data); $this->_prepend($header.$data);
} }
/** /**
* Write the HORIZONTALPAGEBREAKS BIFF record. * Write the HORIZONTALPAGEBREAKS BIFF record.
* *