WebSVN – eFlore/Applications.cel – Diff – /trunk/jrest/lib/Spreadsheet/Excel/Writer/Format.php


<?php
/*
*  Module written/ported by Xavier Noguer <xnoguer@rezebra.com>
*
*  The majority of this is _NOT_ my code.  I simply ported it from the
*  PERL Spreadsheet::WriteExcel module.
*
*  The author of the Spreadsheet::WriteExcel module is John McNamara 
*  <jmcnamara@cpan.org>
*
*  I _DO_ maintain this code, and John McNamara has nothing to do with the
*  porting of this code to PHP.  Any questions directly related to this
*  class library should be directed to me.
*
*  License Information:
*
*    Spreadsheet_Excel_Writer:  A library for generating Excel Spreadsheets
*    Copyright (c) 2002-2003 Xavier Noguer xnoguer@rezebra.com
*
*    This library is free software; you can redistribute it and/or
*    modify it under the terms of the GNU Lesser General Public
*    License as published by the Free Software Foundation; either
*    version 2.1 of the License, or (at your option) any later version.
*
*    This library is distributed in the hope that it will be useful,
*    but WITHOUT ANY WARRANTY; without even the implied warranty of
*    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
*    Lesser General Public License for more details.
*
*    You should have received a copy of the GNU Lesser General Public
*    License along with this library; if not, write to the Free Software
*    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/
 
//require_once('PEAR.php');
 
/**
* Class for generating Excel XF records (formats)
*
* @author   Xavier Noguer <xnoguer@rezebra.com>
* @category FileFormats
* @package  Spreadsheet_Excel_Writer
*/
 
class Spreadsheet_Excel_Writer_Format extends PEAR
{
    /**
    * The index given by the workbook when creating a new format.
    * @var integer
    */
    var $_xf_index;
 
    /**
    * Index to the FONT record.
    * @var integer
    */
    var $font_index;
 
    /**
    * The font name (ASCII).
    * @var string
    */
    var $_font_name;
 
    /**
    * Height of font (1/20 of a point)
    * @var integer
    */
    var $_size;
 
    /**
    * Bold style
    * @var integer
    */
    var $_bold;
 
    /**
    * Bit specifiying if the font is italic.
    * @var integer
    */
    var $_italic;
 
    /**
    * Index to the cell's color
    * @var integer
    */
    var $_color;
 
    /**
    * The text underline property
    * @var integer
    */
    var $_underline;
 
    /**
    * Bit specifiying if the font has strikeout.
    * @var integer
    */
    var $_font_strikeout;
 
    /**
    * Bit specifiying if the font has outline.
    * @var integer
    */
    var $_font_outline;
 
    /**
    * Bit specifiying if the font has shadow.
    * @var integer
    */
    var $_font_shadow;
 
    /**
    * 2 bytes specifiying the script type for the font.
    * @var integer
    */
    var $_font_script;
 
    /**
    * Byte specifiying the font family.
    * @var integer
    */
    var $_font_family;
 
    /**
    * Byte specifiying the font charset.
    * @var integer
    */
    var $_font_charset;
 
    /**
    * An index (2 bytes) to a FORMAT record (number format).
    * @var integer
    */
    var $_num_format;
 
    /**
    * Bit specifying if formulas are hidden.
    * @var integer
    */
    var $_hidden;
 
    /**
    * Bit specifying if the cell is locked.
    * @var integer
    */
    var $_locked;
 
    /**
    * The three bits specifying the text horizontal alignment.
    * @var integer
    */
    var $_text_h_align;
 
    /**
    * Bit specifying if the text is wrapped at the right border.
    * @var integer
    */
    var $_text_wrap;
 
    /**
    * The three bits specifying the text vertical alignment.
    * @var integer
    */
    var $_text_v_align;
 
    /**
    * 1 bit, apparently not used.
    * @var integer
    */
    var $_text_justlast;
 
    /**
    * The two bits specifying the text rotation.
    * @var integer
    */
    var $_rotation;
 
    /**
    * The cell's foreground color.
    * @var integer
    */
    var $_fg_color;
 
    /**
    * The cell's background color.
    * @var integer
    */
    var $_bg_color;
 
    /**
    * The cell's background fill pattern.
    * @var integer
    */
    var $_pattern;
 
    /**
    * Style of the bottom border of the cell
    * @var integer
    */
    var $_bottom;
 
    /**
    * Color of the bottom border of the cell.
    * @var integer
    */
    var $_bottom_color;
 
    /**
    * Style of the top border of the cell
    * @var integer
    */
    var $_top;
 
    /**
    * Color of the top border of the cell.
    * @var integer
    */
    var $_top_color;
 
    /**
    * Style of the left border of the cell
    * @var integer
    */
    var $_left;
 
    /**
    * Color of the left border of the cell.
    * @var integer
    */
    var $_left_color;
 
    /**
    * Style of the right border of the cell
    * @var integer
    */
    var $_right;
 
    /**
    * Color of the right border of the cell.
    * @var integer
    */
    var $_right_color;
 
    /**
    * Constructor
    *
    * @access public
    * @param integer $index the XF index for the format.
    * @param array   $properties array with properties to be set on initialization.
    */
    function Spreadsheet_Excel_Writer_Format($index = 0,$properties =  array())
    {
        $this->_xf_index       = $index;
                               
        $this->font_index      = 0;
        $this->_font_name      = 'Arial';
        $this->_size           = 10;
        $this->_bold           = 0x0190;
        $this->_italic         = 0;
        $this->_color          = 0x7FFF;
        $this->_underline      = 0;
        $this->_font_strikeout = 0;
        $this->_font_outline   = 0;
        $this->_font_shadow    = 0;
        $this->_font_script    = 0;
        $this->_font_family    = 0;
        $this->_font_charset   = 0;
                               
        $this->_num_format     = 0;
                               
        $this->_hidden         = 0;
        $this->_locked         = 1;
 
        $this->_text_h_align   = 0;
        $this->_text_wrap      = 0;
        $this->_text_v_align   = 2;
        $this->_text_justlast  = 0;
        $this->_rotation       = 0;
 
        $this->_fg_color       = 0x40;
        $this->_bg_color       = 0x41;
 
        $this->_pattern        = 0;
                               
        $this->_bottom         = 0;
        $this->_top            = 0;
        $this->_left           = 0;
        $this->_right          = 0;
                               
        $this->_bottom_color   = 0x40;
        $this->_top_color      = 0x40;
        $this->_left_color     = 0x40;
        $this->_right_color    = 0x40;
    
        // Set properties passed to Spreadsheet_Excel_Writer_Workbook::addFormat()
        foreach($properties as $property => $value)
        {
            if(method_exists($this,'set'.ucwords($property)))
            {
                $method_name = 'set'.ucwords($property);
                $this->$method_name($value);
            }
        }
    }
 
 
    /**
    * Generate an Excel BIFF XF record (style or cell).
    *
    * @param string $style The type of the XF record ('style' or 'cell').
    * @return string The XF record
    */
    function getXf($style)
    {
        // Set the type of the XF record and some of the attributes.
        if ($style == "style") {
            $style = 0xFFF5;
        }
        else {
            $style   = $this->_locked;
            $style  |= $this->_hidden << 1;
        }
    
        // Flags to indicate if attributes have been set.
        $atr_num     = ($this->_num_format != 0)?1:0;
        $atr_fnt     = ($this->font_index != 0)?1:0;
        $atr_alc     = ($this->_text_wrap)?1:0;
        $atr_bdr     = ($this->_bottom   ||
                        $this->_top      ||
                        $this->_left     ||
                        $this->_right)?1:0;
        $atr_pat     = (($this->_fg_color != 0x40) ||
                        ($this->_bg_color != 0x41) ||
                        $this->_pattern)?1:0;
        $atr_prot    = 0;
    
        // Zero the default border colour if the border has not been set.
        if ($this->_bottom == 0) {
            $this->_bottom_color = 0;
            }
        if ($this->_top  == 0) {
            $this->_top_color = 0;
            }
        if ($this->_right == 0) {
            $this->_right_color = 0;
            }
        if ($this->_left == 0) {
            $this->_left_color = 0;
            }
    
        $record         = 0x00E0;              // Record identifier
        $length         = 0x0010;              // Number of bytes to follow
                                               
        $ifnt           = $this->font_index;   // Index to FONT record
        $ifmt           = $this->_num_format;  // Index to FORMAT record
    
        $align          = $this->_text_h_align;       // Alignment
        $align         |= $this->_text_wrap     << 3;
        $align         |= $this->_text_v_align  << 4;
        $align         |= $this->_text_justlast << 7;
        $align         |= $this->_rotation      << 8;
        $align         |= $atr_num                << 10;
        $align         |= $atr_fnt                << 11;
        $align         |= $atr_alc                << 12;
        $align         |= $atr_bdr                << 13;
        $align         |= $atr_pat                << 14;
        $align         |= $atr_prot               << 15;
    
        $icv            = $this->_fg_color;           // fg and bg pattern colors
        $icv           |= $this->_bg_color      << 7;
    
        $fill           = $this->_pattern;            // Fill and border line style
        $fill          |= $this->_bottom        << 6;
        $fill          |= $this->_bottom_color  << 9;
    
        $border1        = $this->_top;                // Border line style and color
        $border1       |= $this->_left          << 3;
        $border1       |= $this->_right         << 6;
        $border1       |= $this->_top_color     << 9;
    
        $border2        = $this->_left_color;         // Border color
        $border2       |= $this->_right_color   << 7;
    
        $header      = pack("vv",       $record, $length);
        $data        = pack("vvvvvvvv", $ifnt, $ifmt, $style, $align,
                                        $icv, $fill,
                                        $border1, $border2);
        return($header.$data);
    }
    
    /**
    * Generate an Excel BIFF FONT record.
    *
    * @return string The FONT record
    */
    function getFont()
    {
        $dyHeight   = $this->_size * 20;    // Height of font (1/20 of a point)
        $icv        = $this->_color;        // Index to color palette
        $bls        = $this->_bold;         // Bold style
        $sss        = $this->_font_script;  // Superscript/subscript
        $uls        = $this->_underline;    // Underline
        $bFamily    = $this->_font_family;  // Font family
        $bCharSet   = $this->_font_charset; // Character set
        $rgch       = $this->_font_name;    // Font name
    
        $cch        = strlen($rgch);       // Length of font name
        $record     = 0x31;                // Record identifier
        $length     = 0x0F + $cch;         // Record length
        $reserved   = 0x00;                // Reserved
        $grbit      = 0x00;                // Font attributes
        if ($this->_italic) {
            $grbit     |= 0x02;
        }
        if ($this->_font_strikeout) {
            $grbit     |= 0x08;
        }
        if ($this->_font_outline) {
            $grbit     |= 0x10;
        }
        if ($this->_font_shadow) {
            $grbit     |= 0x20;
        }
    
        $header  = pack("vv",         $record, $length);
        $data    = pack("vvvvvCCCCC", $dyHeight, $grbit, $icv, $bls,
                                      $sss, $uls, $bFamily,
                                      $bCharSet, $reserved, $cch);
        return($header . $data. $this->_font_name);
    }
    
    /**
    * Returns a unique hash key for a font. 
    * Used by Spreadsheet_Excel_Writer_Workbook::_storeAllFonts()
    *
    * The elements that form the key are arranged to increase the probability of
    * generating a unique key. Elements that hold a large range of numbers
    * (eg. _color) are placed between two binary elements such as _italic
    *
    * @return string A key for this font
    */
    function getFontKey()
    {
        $key  = "$this->_font_name$this->_size";
        $key .= "$this->_font_script$this->_underline";
        $key .= "$this->_font_strikeout$this->_bold$this->_font_outline";
        $key .= "$this->_font_family$this->_font_charset";
        $key .= "$this->_font_shadow$this->_color$this->_italic";
        $key  = str_replace(" ","_",$key);
        return ($key);
    }
    
    /**
    * Returns the index used by Spreadsheet_Excel_Writer_Worksheet::_XF()
    *
    * @return integer The index for the XF record
    */
    function getXfIndex()
    {
        return($this->_xf_index);
    }
    
    /**
    * Used in conjunction with the set_xxx_color methods to convert a color
    * string into a number. Color range is 0..63 but we will restrict it
    * to 8..63 to comply with Gnumeric. Colors 0..7 are repeated in 8..15.
    *
    * @access private
    * @param string $name_color name of the color (i.e.: 'blue', 'red', etc..). Optional.
    * @return integer The color index
    */
    function _getColor($name_color = '')
    {
        $colors = array(
                        'aqua'    => 0x0F,
                        'cyan'    => 0x0F,
                        'black'   => 0x08,
                        'blue'    => 0x0C,
                        'brown'   => 0x10,
                        'magenta' => 0x0E,
                        'fuchsia' => 0x0E,
                        'gray'    => 0x17,
                        'grey'    => 0x17,
                        'green'   => 0x11,
                        'lime'    => 0x0B,
                        'navy'    => 0x12,
                        'orange'  => 0x35,
                        'purple'  => 0x14,
                        'red'     => 0x0A,
                        'silver'  => 0x16,
                        'white'   => 0x09,
                        'yellow'  => 0x0D
                       );
    
        // Return the default color, 0x7FFF, if undef,
        if($name_color == '') {
            return(0x7FFF);
        }
    
        // or the color string converted to an integer,
        if(isset($colors[$name_color])) {
            return($colors[$name_color]);
        }
    
        // or the default color if string is unrecognised,
        if(preg_match("/\D/",$name_color)) {
            return(0x7FFF);
        }
    
        // or an index < 8 mapped into the correct range,
        if($name_color < 8) {
            return($name_color + 8);
        }
    
        // or the default color if arg is outside range,
        if($name_color > 63) {
            return(0x7FFF);
        }
    
        // or an integer in the valid range
        return($name_color);
    }
    
    /**
    * Set cell alignment.
    *
    * @access public
    * @param string $location alignment for the cell ('left', 'right', etc...).
    */
    function setAlign($location)
    {
        if (preg_match("/\d/",$location)) {
            return;                      // Ignore numbers
        }
    
        $location = strtolower($location);
    
        if ($location == 'left') {
            $this->_text_h_align = 1;
            }
        if ($location == 'centre') {
            $this->_text_h_align = 2;
            }
        if ($location == 'center') {
            $this->_text_h_align = 2;
            }
        if ($location == 'right') {
            $this->_text_h_align = 3;
            }
        if ($location == 'fill') {
            $this->_text_h_align = 4;
            }
        if ($location == 'justify') {
            $this->_text_h_align = 5;
            }
        if ($location == 'merge') {
            $this->_text_h_align = 6;
            }
        if ($location == 'equal_space') { // For T.K.
            $this->_text_h_align = 7;
            }
        if ($location == 'top') {
            $this->_text_v_align = 0;
            }
        if ($location == 'vcentre') {
            $this->_text_v_align = 1;
            }
        if ($location == 'vcenter') {
            $this->_text_v_align = 1;
            }
        if ($location == 'bottom') {
            $this->_text_v_align = 2;
            }
        if ($location == 'vjustify') {
            $this->_text_v_align = 3;
            }
        if ($location == 'vequal_space') { // For T.K.
            $this->_text_v_align = 4;
            }
    }
    
    /**
    * This is an alias for the unintuitive setAlign('merge')
    *
    * @access public
    */
    function setMerge()
    {
        $this->setAlign('merge');
    }
    
    /**
    * Sets the boldness of the text.
    * Bold has a range 100..1000.
    * 0 (400) is normal. 1 (700) is bold.
    *
    * @access public
    * @param integer $weight Weight for the text, 0 maps to 400 (normal text),
                             1 maps to 700 (bold text). Valid range is: 100-1000.
                             It's Optional, default is 1 (bold).
    */
    function setBold($weight = 1)
    {
        if($weight == 1) {
            $weight = 0x2BC;  // Bold text
        }
        if($weight == 0) {
            $weight = 0x190;  // Normal text
        }
        if($weight <  0x064) {
            $weight = 0x190;  // Lower bound
        }
        if($weight >  0x3E8) {
            $weight = 0x190;  // Upper bound
        }
        $this->_bold = $weight;
    }
    
    
    /************************************
    * FUNCTIONS FOR SETTING CELLS BORDERS
    */
    
    /**
    * Sets the width for the bottom border of the cell
    *
    * @access public
    * @param integer $style style of the cell border. 1 => thin, 2 => thick.
    */
    function setBottom($style)
    {
        $this->_bottom = $style;
    }
    
    /**
    * Sets the width for the top border of the cell
    *
    * @access public
    * @param integer $style style of the cell top border. 1 => thin, 2 => thick.
    */
    function setTop($style)
    {
        $this->_top = $style;
    }
    
    /**
    * Sets the width for the left border of the cell
    *
    * @access public
    * @param integer $style style of the cell left border. 1 => thin, 2 => thick.
    */
    function setLeft($style)
    {
        $this->_left = $style;
    }
    
    /**
    * Sets the width for the right border of the cell
    *
    * @access public
    * @param integer $style style of the cell right border. 1 => thin, 2 => thick.
    */
    function setRight($style)
    {
        $this->_right = $style;
    }
    
    
    /**
    * Set cells borders to the same style
    *
    * @access public
    * @param integer $style style to apply for all cell borders. 1 => thin, 2 => thick.
    */
    function setBorder($style)
    {
        $this->setBottom($style);
        $this->setTop($style);
        $this->setLeft($style);
        $this->setRight($style);
    }
    
    
    /*******************************************
    * FUNCTIONS FOR SETTING CELLS BORDERS COLORS
    */
    
    /**
    * Sets all the cell's borders to the same color
    *
    * @access public
    * @param mixed $color The color we are setting. Either a string (like 'blue'), 
    *                     or an integer (range is [8...63]).
    */
    function setBorderColor($color)
    {
        $this->setBottomColor($color);
        $this->setTopColor($color);
        $this->setLeftColor($color);
        $this->setRightColor($color);
    }
    
    /**
    * Sets the cell's bottom border color
    *
    * @access public
    * @param mixed $color either a string (like 'blue'), or an integer (range is [8...63]).
    */
    function setBottomColor($color)
    {
        $value = $this->_getColor($color);
        $this->_bottom_color = $value;
    }
    
    /**
    * Sets the cell's top border color
    *
    * @access public
    * @param mixed $color either a string (like 'blue'), or an integer (range is [8...63]).
    */
    function setTopColor($color)
    {
        $value = $this->_getColor($color);
        $this->_top_color = $value;
    }
    
    /**
    * Sets the cell's left border color
    *
    * @access public
    * @param mixed $color either a string (like 'blue'), or an integer (range is [8...63]).
    */
    function setLeftColor($color)
    {
        $value = $this->_getColor($color);
        $this->_left_color = $value;
    }
    
    /**
    * Sets the cell's right border color
    *
    * @access public
    * @param mixed $color either a string (like 'blue'), or an integer (range is [8...63]).
    */
    function setRightColor($color)
    {
        $value = $this->_getColor($color);
        $this->_right_color = $value;
    }
    
    
    /**
    * Sets the cell's foreground color
    *
    * @access public
    * @param mixed $color either a string (like 'blue'), or an integer (range is [8...63]).
    */
    function setFgColor($color)
    {
        $value = $this->_getColor($color);
        $this->_fg_color = $value;
    }
      
    /**
    * Sets the cell's background color
    *
    * @access public
    * @param mixed $color either a string (like 'blue'), or an integer (range is [8...63]).
    */
    function setBgColor($color)
    {
        $value = $this->_getColor($color);
        $this->_bg_color = $value;
    }
    
    /**
    * Sets the cell's color
    *
    * @access public
    * @param mixed $color either a string (like 'blue'), or an integer (range is [8...63]).
    */
    function setColor($color)
    {
        $value = $this->_getColor($color);
        $this->_color = $value;
    }
    
    /**
    * Sets the fill pattern attribute of a cell
    *
    * @access public
    * @param integer $arg Optional. Defaults to 1. Meaningful values are: 0-18,
    *                     0 meaning no background.
    */
    function setPattern($arg = 1)
    {
        $this->_pattern = $arg;
    }
    
    /**
    * Sets the underline of the text
    *
    * @access public
    * @param integer $underline The value for underline. Possible values are:
    *                          1 => underline, 2 => double underline.
    */
    function setUnderline($underline)
    {
        $this->_underline = $underline;
    }
 
    /**
    * Sets the font style as italic
    *
    * @access public
    */
    function setItalic()
    {
        $this->_italic = 1;
    }
 
    /**
    * Sets the font size 
    *
    * @access public
    * @param integer $size The font size (in pixels I think).
    */
    function setSize($size)
    {
        $this->_size = $size;
    }
    
    /**
    * Sets text wrapping
    *
    * @access public
    */
    function setTextWrap()
    {
        $this->_text_wrap = 1;
    }
 
    /**
    * Sets the orientation of the text
    *
    * @access public
    * @param integer $angle The rotation angle for the text (clockwise). Possible
                            values are: 0, 90, 270 and -1 for stacking top-to-bottom.
    */
    function setTextRotation($angle)
    {
        switch ($angle)
        {
            case 0:
                $this->_rotation = 0;
                break;
            case 90:
                $this->_rotation = 3;
                break;
            case 270:
                $this->_rotation = 2;
                break;
            case -1:
                $this->_rotation = 1;
                break;
            default :
                $this->raiseError("Invalid value for angle.".
                                  " Possible values are: 0, 90, 270 and -1 ".
                                  "for stacking top-to-bottom.");
                $this->_rotation = 0;
                break;
        }
    }
 
    /**
    * Sets the numeric format.
    * It can be date, time, currency, etc...
    *
    * @access public
    * @param integer $num_format The numeric format.
    */
    function setNumFormat($num_format)
    {
        $this->_num_format = $num_format;
    }
 
    /**
    * Sets font as strikeout.
    *
    * @access public
    */
    function setStrikeOut()
    {
        $this->_font_strikeout = 1;
    }
 
    /**
    * Sets outlining for a font.
    *
    * @access public
    */
    function setOutLine()
    {
        $this->_font_outline = 1;
    }
 
    /**
    * Sets font as shadow.
    *
    * @access public
    */
    function setShadow()
    {
        $this->_font_shadow = 1;
    }
 
    /**
    * Sets the script type of the text
    *
    * @access public
    * @param integer $script The value for script type. Possible values are:
    *                        1 => superscript, 2 => subscript.
    */
    function setScript($script)
    {
        $this->_font_script = $script;
    }
 
    /**
    * Unlocks a cell. Useful for unprotecting particular cells of a protected sheet.
    *
    * @access public
    */
    function setUnLocked()
    {
        $this->_locked = 0;
    }
}
?>

Rev 418	Rev 970
1	`<?php`	1	`<?php`
2	`/*`	2	`/*`
3	`* Module written/ported by Xavier Noguer <xnoguer@rezebra.com>`	3	`* Module written/ported by Xavier Noguer <xnoguer@rezebra.com>`
4	`*`	4	`*`
5	`* The majority of this is _NOT_ my code. I simply ported it from the`	5	`* The majority of this is _NOT_ my code. I simply ported it from the`
6	`* PERL Spreadsheet::WriteExcel module.`	6	`* PERL Spreadsheet::WriteExcel module.`
7	`*`	7	`*`
8	`* The author of the Spreadsheet::WriteExcel module is John McNamara`	8	`* The author of the Spreadsheet::WriteExcel module is John McNamara`
9	`* <jmcnamara@cpan.org>`	9	`* <jmcnamara@cpan.org>`
10	`*`	10	`*`
11	`* I _DO_ maintain this code, and John McNamara has nothing to do with the`	11	`* I _DO_ maintain this code, and John McNamara has nothing to do with the`
12	`* porting of this code to PHP. Any questions directly related to this`	12	`* porting of this code to PHP. Any questions directly related to this`
13	`* class library should be directed to me.`	13	`* class library should be directed to me.`
14	`*`	14	`*`
15	`* License Information:`	15	`* License Information:`
16	`*`	16	`*`
17	`* Spreadsheet_Excel_Writer: A library for generating Excel Spreadsheets`	17	`* Spreadsheet_Excel_Writer: A library for generating Excel Spreadsheets`
18	`* Copyright (c) 2002-2003 Xavier Noguer xnoguer@rezebra.com`	18	`* Copyright (c) 2002-2003 Xavier Noguer xnoguer@rezebra.com`
19	`*`	19	`*`
20	`* This library is free software; you can redistribute it and/or`	20	`* This library is free software; you can redistribute it and/or`
21	`* modify it under the terms of the GNU Lesser General Public`	21	`* modify it under the terms of the GNU Lesser General Public`
22	`* License as published by the Free Software Foundation; either`	22	`* License as published by the Free Software Foundation; either`
23	`* version 2.1 of the License, or (at your option) any later version.`	23	`* version 2.1 of the License, or (at your option) any later version.`
24	`*`	24	`*`
25	`* This library is distributed in the hope that it will be useful,`	25	`* This library is distributed in the hope that it will be useful,`
26	`* but WITHOUT ANY WARRANTY; without even the implied warranty of`	26	`* but WITHOUT ANY WARRANTY; without even the implied warranty of`
27	`* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU`	27	`* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU`
28	`* Lesser General Public License for more details.`	28	`* Lesser General Public License for more details.`
29	`*`	29	`*`
30	`* You should have received a copy of the GNU Lesser General Public`	30	`* You should have received a copy of the GNU Lesser General Public`
31	`* License along with this library; if not, write to the Free Software`	31	`* License along with this library; if not, write to the Free Software`
32	`* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA`	32	`* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA`
33	`*/`	33	`*/`
34		34
35	`require_once('PEAR.php');`	35	`//require_once('PEAR.php');`
36		36
37	`/**`	37	`/**`
38	`* Class for generating Excel XF records (formats)`	38	`* Class for generating Excel XF records (formats)`
39	`*`	39	`*`
40	`* @author Xavier Noguer <xnoguer@rezebra.com>`	40	`* @author Xavier Noguer <xnoguer@rezebra.com>`
41	`* @category FileFormats`	41	`* @category FileFormats`
42	`* @package Spreadsheet_Excel_Writer`	42	`* @package Spreadsheet_Excel_Writer`
43	`*/`	43	`*/`
44		44
45	`class Spreadsheet_Excel_Writer_Format extends PEAR`	45	`class Spreadsheet_Excel_Writer_Format extends PEAR`
46	`{`	46	`{`
47	`/**`	47	`/**`
48	`* The index given by the workbook when creating a new format.`	48	`* The index given by the workbook when creating a new format.`
49	`* @var integer`	49	`* @var integer`
50	`*/`	50	`*/`
51	`var $_xf_index;`	51	`var $_xf_index;`
52		52
53	`/**`	53	`/**`
54	`* Index to the FONT record.`	54	`* Index to the FONT record.`
55	`* @var integer`	55	`* @var integer`
56	`*/`	56	`*/`
57	`var $font_index;`	57	`var $font_index;`
58		58
59	`/**`	59	`/**`
60	`* The font name (ASCII).`	60	`* The font name (ASCII).`
61	`* @var string`	61	`* @var string`
62	`*/`	62	`*/`
63	`var $_font_name;`	63	`var $_font_name;`
64		64
65	`/**`	65	`/**`
66	`* Height of font (1/20 of a point)`	66	`* Height of font (1/20 of a point)`
67	`* @var integer`	67	`* @var integer`
68	`*/`	68	`*/`
69	`var $_size;`	69	`var $_size;`
70		70
71	`/**`	71	`/**`
72	`* Bold style`	72	`* Bold style`
73	`* @var integer`	73	`* @var integer`
74	`*/`	74	`*/`
75	`var $_bold;`	75	`var $_bold;`
76		76
77	`/**`	77	`/**`
78	`* Bit specifiying if the font is italic.`	78	`* Bit specifiying if the font is italic.`
79	`* @var integer`	79	`* @var integer`
80	`*/`	80	`*/`
81	`var $_italic;`	81	`var $_italic;`
82		82
83	`/**`	83	`/**`
84	`* Index to the cell's color`	84	`* Index to the cell's color`
85	`* @var integer`	85	`* @var integer`
86	`*/`	86	`*/`
87	`var $_color;`	87	`var $_color;`
88		88
89	`/**`	89	`/**`
90	`* The text underline property`	90	`* The text underline property`
91	`* @var integer`	91	`* @var integer`
92	`*/`	92	`*/`
93	`var $_underline;`	93	`var $_underline;`
94		94
95	`/**`	95	`/**`
96	`* Bit specifiying if the font has strikeout.`	96	`* Bit specifiying if the font has strikeout.`
97	`* @var integer`	97	`* @var integer`
98	`*/`	98	`*/`
99	`var $_font_strikeout;`	99	`var $_font_strikeout;`
100		100
101	`/**`	101	`/**`
102	`* Bit specifiying if the font has outline.`	102	`* Bit specifiying if the font has outline.`
103	`* @var integer`	103	`* @var integer`
104	`*/`	104	`*/`
105	`var $_font_outline;`	105	`var $_font_outline;`
106		106
107	`/**`	107	`/**`
108	`* Bit specifiying if the font has shadow.`	108	`* Bit specifiying if the font has shadow.`
109	`* @var integer`	109	`* @var integer`
110	`*/`	110	`*/`
111	`var $_font_shadow;`	111	`var $_font_shadow;`
112		112
113	`/**`	113	`/**`
114	`* 2 bytes specifiying the script type for the font.`	114	`* 2 bytes specifiying the script type for the font.`
115	`* @var integer`	115	`* @var integer`
116	`*/`	116	`*/`
117	`var $_font_script;`	117	`var $_font_script;`
118		118
119	`/**`	119	`/**`
120	`* Byte specifiying the font family.`	120	`* Byte specifiying the font family.`
121	`* @var integer`	121	`* @var integer`
122	`*/`	122	`*/`
123	`var $_font_family;`	123	`var $_font_family;`
124		124
125	`/**`	125	`/**`
126	`* Byte specifiying the font charset.`	126	`* Byte specifiying the font charset.`
127	`* @var integer`	127	`* @var integer`
128	`*/`	128	`*/`
129	`var $_font_charset;`	129	`var $_font_charset;`
130		130
131	`/**`	131	`/**`
132	`* An index (2 bytes) to a FORMAT record (number format).`	132	`* An index (2 bytes) to a FORMAT record (number format).`
133	`* @var integer`	133	`* @var integer`
134	`*/`	134	`*/`
135	`var $_num_format;`	135	`var $_num_format;`
136		136
137	`/**`	137	`/**`
138	`* Bit specifying if formulas are hidden.`	138	`* Bit specifying if formulas are hidden.`
139	`* @var integer`	139	`* @var integer`
140	`*/`	140	`*/`
141	`var $_hidden;`	141	`var $_hidden;`
142		142
143	`/**`	143	`/**`
144	`* Bit specifying if the cell is locked.`	144	`* Bit specifying if the cell is locked.`
145	`* @var integer`	145	`* @var integer`
146	`*/`	146	`*/`
147	`var $_locked;`	147	`var $_locked;`
148		148
149	`/**`	149	`/**`
150	`* The three bits specifying the text horizontal alignment.`	150	`* The three bits specifying the text horizontal alignment.`
151	`* @var integer`	151	`* @var integer`
152	`*/`	152	`*/`
153	`var $_text_h_align;`	153	`var $_text_h_align;`
154		154
155	`/**`	155	`/**`
156	`* Bit specifying if the text is wrapped at the right border.`	156	`* Bit specifying if the text is wrapped at the right border.`
157	`* @var integer`	157	`* @var integer`
158	`*/`	158	`*/`
159	`var $_text_wrap;`	159	`var $_text_wrap;`
160		160
161	`/**`	161	`/**`
162	`* The three bits specifying the text vertical alignment.`	162	`* The three bits specifying the text vertical alignment.`
163	`* @var integer`	163	`* @var integer`
164	`*/`	164	`*/`
165	`var $_text_v_align;`	165	`var $_text_v_align;`
166		166
167	`/**`	167	`/**`
168	`* 1 bit, apparently not used.`	168	`* 1 bit, apparently not used.`
169	`* @var integer`	169	`* @var integer`
170	`*/`	170	`*/`
171	`var $_text_justlast;`	171	`var $_text_justlast;`
172		172
173	`/**`	173	`/**`
174	`* The two bits specifying the text rotation.`	174	`* The two bits specifying the text rotation.`
175	`* @var integer`	175	`* @var integer`
176	`*/`	176	`*/`
177	`var $_rotation;`	177	`var $_rotation;`
178		178
179	`/**`	179	`/**`
180	`* The cell's foreground color.`	180	`* The cell's foreground color.`
181	`* @var integer`	181	`* @var integer`
182	`*/`	182	`*/`
183	`var $_fg_color;`	183	`var $_fg_color;`
184		184
185	`/**`	185	`/**`
186	`* The cell's background color.`	186	`* The cell's background color.`
187	`* @var integer`	187	`* @var integer`
188	`*/`	188	`*/`
189	`var $_bg_color;`	189	`var $_bg_color;`
190		190
191	`/**`	191	`/**`
192	`* The cell's background fill pattern.`	192	`* The cell's background fill pattern.`
193	`* @var integer`	193	`* @var integer`
194	`*/`	194	`*/`
195	`var $_pattern;`	195	`var $_pattern;`
196		196
197	`/**`	197	`/**`
198	`* Style of the bottom border of the cell`	198	`* Style of the bottom border of the cell`
199	`* @var integer`	199	`* @var integer`
200	`*/`	200	`*/`
201	`var $_bottom;`	201	`var $_bottom;`
202		202
203	`/**`	203	`/**`
204	`* Color of the bottom border of the cell.`	204	`* Color of the bottom border of the cell.`
205	`* @var integer`	205	`* @var integer`
206	`*/`	206	`*/`
207	`var $_bottom_color;`	207	`var $_bottom_color;`
208		208
209	`/**`	209	`/**`
210	`* Style of the top border of the cell`	210	`* Style of the top border of the cell`
211	`* @var integer`	211	`* @var integer`
212	`*/`	212	`*/`
213	`var $_top;`	213	`var $_top;`
214		214
215	`/**`	215	`/**`
216	`* Color of the top border of the cell.`	216	`* Color of the top border of the cell.`
217	`* @var integer`	217	`* @var integer`
218	`*/`	218	`*/`
219	`var $_top_color;`	219	`var $_top_color;`
220		220
221	`/**`	221	`/**`
222	`* Style of the left border of the cell`	222	`* Style of the left border of the cell`
223	`* @var integer`	223	`* @var integer`
224	`*/`	224	`*/`
225	`var $_left;`	225	`var $_left;`
226		226
227	`/**`	227	`/**`
228	`* Color of the left border of the cell.`	228	`* Color of the left border of the cell.`
229	`* @var integer`	229	`* @var integer`
230	`*/`	230	`*/`
231	`var $_left_color;`	231	`var $_left_color;`
232		232
233	`/**`	233	`/**`
234	`* Style of the right border of the cell`	234	`* Style of the right border of the cell`
235	`* @var integer`	235	`* @var integer`
236	`*/`	236	`*/`
237	`var $_right;`	237	`var $_right;`
238		238
239	`/**`	239	`/**`
240	`* Color of the right border of the cell.`	240	`* Color of the right border of the cell.`
241	`* @var integer`	241	`* @var integer`
242	`*/`	242	`*/`
243	`var $_right_color;`	243	`var $_right_color;`
244		244
245	`/**`	245	`/**`
246	`* Constructor`	246	`* Constructor`
247	`*`	247	`*`
248	`* @access public`	248	`* @access public`
249	`* @param integer $index the XF index for the format.`	249	`* @param integer $index the XF index for the format.`
250	`* @param array $properties array with properties to be set on initialization.`	250	`* @param array $properties array with properties to be set on initialization.`
251	`*/`	251	`*/`
252	`function Spreadsheet_Excel_Writer_Format($index = 0,$properties = array())`	252	`function Spreadsheet_Excel_Writer_Format($index = 0,$properties = array())`
253	`{`	253	`{`
254	`$this->_xf_index = $index;`	254	`$this->_xf_index = $index;`
255		255
256	`$this->font_index = 0;`	256	`$this->font_index = 0;`
257	`$this->_font_name = 'Arial';`	257	`$this->_font_name = 'Arial';`
258	`$this->_size = 10;`	258	`$this->_size = 10;`
259	`$this->_bold = 0x0190;`	259	`$this->_bold = 0x0190;`
260	`$this->_italic = 0;`	260	`$this->_italic = 0;`
261	`$this->_color = 0x7FFF;`	261	`$this->_color = 0x7FFF;`
262	`$this->_underline = 0;`	262	`$this->_underline = 0;`
263	`$this->_font_strikeout = 0;`	263	`$this->_font_strikeout = 0;`
264	`$this->_font_outline = 0;`	264	`$this->_font_outline = 0;`
265	`$this->_font_shadow = 0;`	265	`$this->_font_shadow = 0;`
266	`$this->_font_script = 0;`	266	`$this->_font_script = 0;`
267	`$this->_font_family = 0;`	267	`$this->_font_family = 0;`
268	`$this->_font_charset = 0;`	268	`$this->_font_charset = 0;`
269		269
270	`$this->_num_format = 0;`	270	`$this->_num_format = 0;`
271		271
272	`$this->_hidden = 0;`	272	`$this->_hidden = 0;`
273	`$this->_locked = 1;`	273	`$this->_locked = 1;`
274		274
275	`$this->_text_h_align = 0;`	275	`$this->_text_h_align = 0;`
276	`$this->_text_wrap = 0;`	276	`$this->_text_wrap = 0;`
277	`$this->_text_v_align = 2;`	277	`$this->_text_v_align = 2;`
278	`$this->_text_justlast = 0;`	278	`$this->_text_justlast = 0;`
279	`$this->_rotation = 0;`	279	`$this->_rotation = 0;`
280		280
281	`$this->_fg_color = 0x40;`	281	`$this->_fg_color = 0x40;`
282	`$this->_bg_color = 0x41;`	282	`$this->_bg_color = 0x41;`
283		283
284	`$this->_pattern = 0;`	284	`$this->_pattern = 0;`
285		285
286	`$this->_bottom = 0;`	286	`$this->_bottom = 0;`
287	`$this->_top = 0;`	287	`$this->_top = 0;`
288	`$this->_left = 0;`	288	`$this->_left = 0;`
289	`$this->_right = 0;`	289	`$this->_right = 0;`
290		290
291	`$this->_bottom_color = 0x40;`	291	`$this->_bottom_color = 0x40;`
292	`$this->_top_color = 0x40;`	292	`$this->_top_color = 0x40;`
293	`$this->_left_color = 0x40;`	293	`$this->_left_color = 0x40;`
294	`$this->_right_color = 0x40;`	294	`$this->_right_color = 0x40;`
295		295
296	`// Set properties passed to Spreadsheet_Excel_Writer_Workbook::addFormat()`	296	`// Set properties passed to Spreadsheet_Excel_Writer_Workbook::addFormat()`
297	`foreach($properties as $property => $value)`	297	`foreach($properties as $property => $value)`
298	`{`	298	`{`
299	`if(method_exists($this,'set'.ucwords($property)))`	299	`if(method_exists($this,'set'.ucwords($property)))`
300	`{`	300	`{`
301	`$method_name = 'set'.ucwords($property);`	301	`$method_name = 'set'.ucwords($property);`
302	`$this->$method_name($value);`	302	`$this->$method_name($value);`
303	`}`	303	`}`
304	`}`	304	`}`
305	`}`	305	`}`
306		306
307		307
308	`/**`	308	`/**`
309	`* Generate an Excel BIFF XF record (style or cell).`	309	`* Generate an Excel BIFF XF record (style or cell).`
310	`*`	310	`*`
311	`* @param string $style The type of the XF record ('style' or 'cell').`	311	`* @param string $style The type of the XF record ('style' or 'cell').`
312	`* @return string The XF record`	312	`* @return string The XF record`
313	`*/`	313	`*/`
314	`function getXf($style)`	314	`function getXf($style)`
315	`{`	315	`{`
316	`// Set the type of the XF record and some of the attributes.`	316	`// Set the type of the XF record and some of the attributes.`
317	`if ($style == "style") {`	317	`if ($style == "style") {`
318	`$style = 0xFFF5;`	318	`$style = 0xFFF5;`
319	`}`	319	`}`
320	`else {`	320	`else {`
321	`$style = $this->_locked;`	321	`$style = $this->_locked;`
322	`$style \|= $this->_hidden << 1;`	322	`$style \|= $this->_hidden << 1;`
323	`}`	323	`}`
324		324
325	`// Flags to indicate if attributes have been set.`	325	`// Flags to indicate if attributes have been set.`
326	`$atr_num = ($this->_num_format != 0)?1:0;`	326	`$atr_num = ($this->_num_format != 0)?1:0;`
327	`$atr_fnt = ($this->font_index != 0)?1:0;`	327	`$atr_fnt = ($this->font_index != 0)?1:0;`
328	`$atr_alc = ($this->_text_wrap)?1:0;`	328	`$atr_alc = ($this->_text_wrap)?1:0;`
329	`$atr_bdr = ($this->_bottom \|\|`	329	`$atr_bdr = ($this->_bottom \|\|`
330	`$this->_top \|\|`	330	`$this->_top \|\|`
331	`$this->_left \|\|`	331	`$this->_left \|\|`
332	`$this->_right)?1:0;`	332	`$this->_right)?1:0;`
333	`$atr_pat = (($this->_fg_color != 0x40) \|\|`	333	`$atr_pat = (($this->_fg_color != 0x40) \|\|`
334	`($this->_bg_color != 0x41) \|\|`	334	`($this->_bg_color != 0x41) \|\|`
335	`$this->_pattern)?1:0;`	335	`$this->_pattern)?1:0;`
336	`$atr_prot = 0;`	336	`$atr_prot = 0;`
337		337
338	`// Zero the default border colour if the border has not been set.`	338	`// Zero the default border colour if the border has not been set.`
339	`if ($this->_bottom == 0) {`	339	`if ($this->_bottom == 0) {`
340	`$this->_bottom_color = 0;`	340	`$this->_bottom_color = 0;`
341	`}`	341	`}`
342	`if ($this->_top == 0) {`	342	`if ($this->_top == 0) {`
343	`$this->_top_color = 0;`	343	`$this->_top_color = 0;`
344	`}`	344	`}`
345	`if ($this->_right == 0) {`	345	`if ($this->_right == 0) {`
346	`$this->_right_color = 0;`	346	`$this->_right_color = 0;`
347	`}`	347	`}`
348	`if ($this->_left == 0) {`	348	`if ($this->_left == 0) {`
349	`$this->_left_color = 0;`	349	`$this->_left_color = 0;`
350	`}`	350	`}`
351		351
352	`$record = 0x00E0; // Record identifier`	352	`$record = 0x00E0; // Record identifier`
353	`$length = 0x0010; // Number of bytes to follow`	353	`$length = 0x0010; // Number of bytes to follow`
354		354
355	`$ifnt = $this->font_index; // Index to FONT record`	355	`$ifnt = $this->font_index; // Index to FONT record`
356	`$ifmt = $this->_num_format; // Index to FORMAT record`	356	`$ifmt = $this->_num_format; // Index to FORMAT record`
357		357
358	`$align = $this->_text_h_align; // Alignment`	358	`$align = $this->_text_h_align; // Alignment`
359	`$align \|= $this->_text_wrap << 3;`	359	`$align \|= $this->_text_wrap << 3;`
360	`$align \|= $this->_text_v_align << 4;`	360	`$align \|= $this->_text_v_align << 4;`
361	`$align \|= $this->_text_justlast << 7;`	361	`$align \|= $this->_text_justlast << 7;`
362	`$align \|= $this->_rotation << 8;`	362	`$align \|= $this->_rotation << 8;`
363	`$align \|= $atr_num << 10;`	363	`$align \|= $atr_num << 10;`
364	`$align \|= $atr_fnt << 11;`	364	`$align \|= $atr_fnt << 11;`
365	`$align \|= $atr_alc << 12;`	365	`$align \|= $atr_alc << 12;`
366	`$align \|= $atr_bdr << 13;`	366	`$align \|= $atr_bdr << 13;`
367	`$align \|= $atr_pat << 14;`	367	`$align \|= $atr_pat << 14;`
368	`$align \|= $atr_prot << 15;`	368	`$align \|= $atr_prot << 15;`
369		369
370	`$icv = $this->_fg_color; // fg and bg pattern colors`	370	`$icv = $this->_fg_color; // fg and bg pattern colors`
371	`$icv \|= $this->_bg_color << 7;`	371	`$icv \|= $this->_bg_color << 7;`
372		372
373	`$fill = $this->_pattern; // Fill and border line style`	373	`$fill = $this->_pattern; // Fill and border line style`
374	`$fill \|= $this->_bottom << 6;`	374	`$fill \|= $this->_bottom << 6;`
375	`$fill \|= $this->_bottom_color << 9;`	375	`$fill \|= $this->_bottom_color << 9;`
376		376
377	`$border1 = $this->_top; // Border line style and color`	377	`$border1 = $this->_top; // Border line style and color`
378	`$border1 \|= $this->_left << 3;`	378	`$border1 \|= $this->_left << 3;`
379	`$border1 \|= $this->_right << 6;`	379	`$border1 \|= $this->_right << 6;`
380	`$border1 \|= $this->_top_color << 9;`	380	`$border1 \|= $this->_top_color << 9;`
381		381
382	`$border2 = $this->_left_color; // Border color`	382	`$border2 = $this->_left_color; // Border color`
383	`$border2 \|= $this->_right_color << 7;`	383	`$border2 \|= $this->_right_color << 7;`
384		384
385	`$header = pack("vv", $record, $length);`	385	`$header = pack("vv", $record, $length);`
386	`$data = pack("vvvvvvvv", $ifnt, $ifmt, $style, $align,`	386	`$data = pack("vvvvvvvv", $ifnt, $ifmt, $style, $align,`
387	`$icv, $fill,`	387	`$icv, $fill,`
388	`$border1, $border2);`	388	`$border1, $border2);`
389	`return($header.$data);`	389	`return($header.$data);`
390	`}`	390	`}`
391		391
392	`/**`	392	`/**`
393	`* Generate an Excel BIFF FONT record.`	393	`* Generate an Excel BIFF FONT record.`
394	`*`	394	`*`
395	`* @return string The FONT record`	395	`* @return string The FONT record`
396	`*/`	396	`*/`
397	`function getFont()`	397	`function getFont()`
398	`{`	398	`{`
399	`$dyHeight = $this->_size * 20; // Height of font (1/20 of a point)`	399	`$dyHeight = $this->_size * 20; // Height of font (1/20 of a point)`
400	`$icv = $this->_color; // Index to color palette`	400	`$icv = $this->_color; // Index to color palette`
401	`$bls = $this->_bold; // Bold style`	401	`$bls = $this->_bold; // Bold style`
402	`$sss = $this->_font_script; // Superscript/subscript`	402	`$sss = $this->_font_script; // Superscript/subscript`
403	`$uls = $this->_underline; // Underline`	403	`$uls = $this->_underline; // Underline`
404	`$bFamily = $this->_font_family; // Font family`	404	`$bFamily = $this->_font_family; // Font family`
405	`$bCharSet = $this->_font_charset; // Character set`	405	`$bCharSet = $this->_font_charset; // Character set`
406	`$rgch = $this->_font_name; // Font name`	406	`$rgch = $this->_font_name; // Font name`
407		407
408	`$cch = strlen($rgch); // Length of font name`	408	`$cch = strlen($rgch); // Length of font name`
409	`$record = 0x31; // Record identifier`	409	`$record = 0x31; // Record identifier`
410	`$length = 0x0F + $cch; // Record length`	410	`$length = 0x0F + $cch; // Record length`
411	`$reserved = 0x00; // Reserved`	411	`$reserved = 0x00; // Reserved`
412	`$grbit = 0x00; // Font attributes`	412	`$grbit = 0x00; // Font attributes`
413	`if ($this->_italic) {`	413	`if ($this->_italic) {`
414	`$grbit \|= 0x02;`	414	`$grbit \|= 0x02;`
415	`}`	415	`}`
416	`if ($this->_font_strikeout) {`	416	`if ($this->_font_strikeout) {`
417	`$grbit \|= 0x08;`	417	`$grbit \|= 0x08;`
418	`}`	418	`}`
419	`if ($this->_font_outline) {`	419	`if ($this->_font_outline) {`
420	`$grbit \|= 0x10;`	420	`$grbit \|= 0x10;`
421	`}`	421	`}`
422	`if ($this->_font_shadow) {`	422	`if ($this->_font_shadow) {`
423	`$grbit \|= 0x20;`	423	`$grbit \|= 0x20;`
424	`}`	424	`}`
425		425
426	`$header = pack("vv", $record, $length);`	426	`$header = pack("vv", $record, $length);`
427	`$data = pack("vvvvvCCCCC", $dyHeight, $grbit, $icv, $bls,`	427	`$data = pack("vvvvvCCCCC", $dyHeight, $grbit, $icv, $bls,`
428	`$sss, $uls, $bFamily,`	428	`$sss, $uls, $bFamily,`
429	`$bCharSet, $reserved, $cch);`	429	`$bCharSet, $reserved, $cch);`
430	`return($header . $data. $this->_font_name);`	430	`return($header . $data. $this->_font_name);`
431	`}`	431	`}`
432		432
433	`/**`	433	`/**`
434	`* Returns a unique hash key for a font.`	434	`* Returns a unique hash key for a font.`
435	`* Used by Spreadsheet_Excel_Writer_Workbook::_storeAllFonts()`	435	`* Used by Spreadsheet_Excel_Writer_Workbook::_storeAllFonts()`
436	`*`	436	`*`
437	`* The elements that form the key are arranged to increase the probability of`	437	`* The elements that form the key are arranged to increase the probability of`
438	`* generating a unique key. Elements that hold a large range of numbers`	438	`* generating a unique key. Elements that hold a large range of numbers`
439	`* (eg. _color) are placed between two binary elements such as _italic`	439	`* (eg. _color) are placed between two binary elements such as _italic`
440	`*`	440	`*`
441	`* @return string A key for this font`	441	`* @return string A key for this font`
442	`*/`	442	`*/`
443	`function getFontKey()`	443	`function getFontKey()`
444	`{`	444	`{`
445	`$key = "$this->_font_name$this->_size";`	445	`$key = "$this->_font_name$this->_size";`
446	`$key .= "$this->_font_script$this->_underline";`	446	`$key .= "$this->_font_script$this->_underline";`
447	`$key .= "$this->_font_strikeout$this->_bold$this->_font_outline";`	447	`$key .= "$this->_font_strikeout$this->_bold$this->_font_outline";`
448	`$key .= "$this->_font_family$this->_font_charset";`	448	`$key .= "$this->_font_family$this->_font_charset";`
449	`$key .= "$this->_font_shadow$this->_color$this->_italic";`	449	`$key .= "$this->_font_shadow$this->_color$this->_italic";`
450	`$key = str_replace(" ","_",$key);`	450	`$key = str_replace(" ","_",$key);`
451	`return ($key);`	451	`return ($key);`
452	`}`	452	`}`
453		453
454	`/**`	454	`/**`
455	`* Returns the index used by Spreadsheet_Excel_Writer_Worksheet::_XF()`	455	`* Returns the index used by Spreadsheet_Excel_Writer_Worksheet::_XF()`
456	`*`	456	`*`
457	`* @return integer The index for the XF record`	457	`* @return integer The index for the XF record`
458	`*/`	458	`*/`
459	`function getXfIndex()`	459	`function getXfIndex()`
460	`{`	460	`{`
461	`return($this->_xf_index);`	461	`return($this->_xf_index);`
462	`}`	462	`}`
463		463
464	`/**`	464	`/**`
465	`* Used in conjunction with the set_xxx_color methods to convert a color`	465	`* Used in conjunction with the set_xxx_color methods to convert a color`
466	`* string into a number. Color range is 0..63 but we will restrict it`	466	`* string into a number. Color range is 0..63 but we will restrict it`
467	`* to 8..63 to comply with Gnumeric. Colors 0..7 are repeated in 8..15.`	467	`* to 8..63 to comply with Gnumeric. Colors 0..7 are repeated in 8..15.`
468	`*`	468	`*`
469	`* @access private`	469	`* @access private`
470	`* @param string $name_color name of the color (i.e.: 'blue', 'red', etc..). Optional.`	470	`* @param string $name_color name of the color (i.e.: 'blue', 'red', etc..). Optional.`
471	`* @return integer The color index`	471	`* @return integer The color index`
472	`*/`	472	`*/`
473	`function _getColor($name_color = '')`	473	`function _getColor($name_color = '')`
474	`{`	474	`{`
475	`$colors = array(`	475	`$colors = array(`
476	`'aqua' => 0x0F,`	476	`'aqua' => 0x0F,`
477	`'cyan' => 0x0F,`	477	`'cyan' => 0x0F,`
478	`'black' => 0x08,`	478	`'black' => 0x08,`
479	`'blue' => 0x0C,`	479	`'blue' => 0x0C,`
480	`'brown' => 0x10,`	480	`'brown' => 0x10,`
481	`'magenta' => 0x0E,`	481	`'magenta' => 0x0E,`
482	`'fuchsia' => 0x0E,`	482	`'fuchsia' => 0x0E,`
483	`'gray' => 0x17,`	483	`'gray' => 0x17,`
484	`'grey' => 0x17,`	484	`'grey' => 0x17,`
485	`'green' => 0x11,`	485	`'green' => 0x11,`
486	`'lime' => 0x0B,`	486	`'lime' => 0x0B,`
487	`'navy' => 0x12,`	487	`'navy' => 0x12,`
488	`'orange' => 0x35,`	488	`'orange' => 0x35,`
489	`'purple' => 0x14,`	489	`'purple' => 0x14,`
490	`'red' => 0x0A,`	490	`'red' => 0x0A,`
491	`'silver' => 0x16,`	491	`'silver' => 0x16,`
492	`'white' => 0x09,`	492	`'white' => 0x09,`
493	`'yellow' => 0x0D`	493	`'yellow' => 0x0D`
494	`);`	494	`);`
495		495
496	`// Return the default color, 0x7FFF, if undef,`	496	`// Return the default color, 0x7FFF, if undef,`
497	`if($name_color == '') {`	497	`if($name_color == '') {`
498	`return(0x7FFF);`	498	`return(0x7FFF);`
499	`}`	499	`}`
500		500

Subversion Repositories eFlore/Applications.cel

(root)/trunk/jrest/lib/Spreadsheet/Excel/Writer/Format.php @ 1655 – Rev 418 → 970