Class: PHPExcel_Writer_Excel5_Format

Source Location: /PHPExcel/Writer/Excel5/Format.php

Class Overview

Class for generating Excel XF records (formats)

Author(s):

Xavier Noguer <xnoguer@rezebra.com>

Class Details

[line 43]
Class for generating Excel XF records (formats)

Class for generating Excel XF records (formats)

Tags:

author:

Xavier Noguer <xnoguer@rezebra.com>

[ Top ]

Class Variables

$font_index =

[line 55]

Index to the FONT record.

Type:

integer

[ Top ]

$_bg_color =

[line 199]

The cell's background color.

Tags:

access:

private

Type:

integer

[ Top ]

$_bold =

[line 73]

Bold style

Tags:

access:

private

Type:

integer

[ Top ]

$_bottom =

[line 211]

Style of the bottom border of the cell

Tags:

access:

private

Type:

integer

[ Top ]

$_bottom_color =

[line 217]

Color of the bottom border of the cell.

Tags:

access:

private

Type:

integer

[ Top ]

$_color =

[line 85]

Index to the cell's color

Tags:

access:

private

Type:

integer

[ Top ]

$_fg_color =

[line 193]

The cell's foreground color.

Tags:

access:

private

Type:

integer

[ Top ]

$_font_charset =

[line 127]

Byte specifiying the font charset.

Tags:

access:

private

Type:

integer

[ Top ]

$_font_family =

[line 121]

Byte specifiying the font family.

Tags:

access:

private

Type:

integer

[ Top ]

$_font_name =

[line 61]

The font name (ASCII).

Tags:

access:

private

Type:

string

[ Top ]

$_font_outline =

[line 103]

Bit specifiying if the font has outline.

Tags:

access:

private

Type:

integer

[ Top ]

$_font_script =

[line 115]

2 bytes specifiying the script type for the font.

Tags:

access:

private

Type:

integer

[ Top ]

$_font_shadow =

[line 109]

Bit specifiying if the font has shadow.

Tags:

access:

private

Type:

integer

[ Top ]

$_font_strikeout =

[line 97]

Bit specifiying if the font has strikeout.

Tags:

access:

private

Type:

integer

[ Top ]

$_hidden =

[line 139]

Bit specifying if formulas are hidden.

Tags:

access:

private

Type:

integer

[ Top ]

$_indent =

[line 163]

Indent level

Tags:

access:

private

Type:

integer

[ Top ]

$_italic =

[line 79]

Bit specifiying if the font is italic.

Tags:

access:

private

Type:

integer

[ Top ]

$_left =

[line 235]

Style of the left border of the cell

Tags:

access:

private

Type:

integer

[ Top ]

$_left_color =

[line 241]

Color of the left border of the cell.

Tags:

access:

private

Type:

integer

[ Top ]

$_locked =

[line 145]

Bit specifying if the cell is locked.

Tags:

access:

private

Type:

integer

[ Top ]

$_num_format =

[line 133]

An index (2 bytes) to a FORMAT record (number format).

Tags:

access:

private

Type:

integer

[ Top ]

$_pattern =

[line 205]

The cell's background fill pattern.

Tags:

access:

private

Type:

integer

[ Top ]

$_right =

[line 247]

Style of the right border of the cell

Tags:

access:

private

Type:

integer

[ Top ]

$_right_color =

[line 253]

Color of the right border of the cell.

Tags:

access:

private

Type:

integer

[ Top ]

$_rotation =

[line 187]

Integer specifying the text rotation.

Integer specifying the text rotation. (-90 to +90 or -165 indicating stacked text)

Tags:

access:

private

Type:

integer

[ Top ]

$_shrink_to_fit =

[line 169]

Shrink to fit

Tags:

access:

private

Type:

[ Top ]

$_size =

[line 67]

Height of font (1/20 of a point)

Tags:

access:

private

Type:

integer

[ Top ]

$_text_h_align =

[line 151]

The three bits specifying the text horizontal alignment.

Tags:

access:

private

Type:

integer

[ Top ]

$_text_justlast =

[line 181]

1 bit, apparently not used.

Tags:

access:

private

Type:

integer

[ Top ]

$_text_v_align =

[line 175]

The three bits specifying the text vertical alignment.

Tags:

access:

private

Type:

integer

[ Top ]

$_text_wrap =

[line 157]

Bit specifying if the text is wrapped at the right border.

Tags:

access:

private

Type:

integer

[ Top ]

$_top =

[line 223]

Style of the top border of the cell

Tags:

access:

private

Type:

integer

[ Top ]

$_top_color =

[line 229]

Color of the top border of the cell.

Tags:

access:

private

Type:

integer

[ Top ]

$_underline =

[line 91]

The text underline property

Tags:

access:

private

Type:

integer

[ Top ]

$_xf_index =

[line 49]

The index given by the workbook when creating a new format.

Tags:

access:

private

Type:

integer

[ Top ]

Class Methods

constructor PHPExcel_Writer_Excel5_Format [line 262]

PHPExcel_Writer_Excel5_Format PHPExcel_Writer_Excel5_Format(

$BIFF_version, [integer
$index = 0], [array
$properties = array()])

Constructor

Tags:

access:

private

Parameters:

integer	$index	the XF index for the format.
array	$properties	array with properties to be set on initialization.
	$BIFF_version

[ Top ]

method getFont [line 471]

string getFont(
)

Generate an Excel BIFF FONT record.

Tags:

return:

The FONT record

[ Top ]

method getFontKey [line 527]

string getFontKey(
)

Returns a unique hash key for a font.

Returns a unique hash key for a font. Used by PHPExcel_Writer_Excel5_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

Tags:

return:

A key for this font

[ Top ]

method getXf [line 327]

string getXf(
string
$style)

Generate an Excel BIFF XF record (style or cell).

Tags:

return:

The XF record

Parameters:

string

$style

The type of the XF record ('style' or 'cell').

[ Top ]

method getXfIndex [line 543]

integer getXfIndex(
)

Returns the index used by PHPExcel_Writer_Excel5_Worksheet::_XF()

Tags:

return:

The index for the XF record

[ Top ]

method setAlign [line 615]

void setAlign(
string
$location)

Set cell alignment.

Tags:

access:

public

Parameters:

string

$location

alignment for the cell ('left', 'right', etc...).

[ Top ]

method setBgColor [line 932]

void setBgColor(
mixed
$color)

Sets the cell's background color

Tags:

access:

public

Parameters:

mixed

$color

either a string (like 'blue'), or an integer (range is [8...63]).

[ Top ]

method setBold [line 761]

void setBold(
[integer
$weight = 1])

Sets the boldness of the text.

Sets the boldness of the text. Bold has a range 100..1000.

(400) is normal. 1 (700) is bold.

Tags:

access:

public

Parameters:

integer

$weight

Weight for the text, 0 maps to 400 (normal text),

[ Top ]

method setBorder [line 834]

void setBorder(
integer
$style)

Set cells borders to the same style

Tags:

access:

public

Parameters:

integer

$style

style to apply for all cell borders. 1 => thin, 2 => thick.

[ Top ]

method setBorderColor [line 854]

void setBorderColor(
mixed
$color)

Sets all the cell's borders to the same color

Tags:

access:

public

Parameters:

mixed

$color

The color we are setting. Either a string (like 'blue'), or an integer (range is [8...63]).

[ Top ]

method setBottom [line 789]

void setBottom(
integer
$style)

Sets the width for the bottom border of the cell

Tags:

access:

public

Parameters:

integer

$style

style of the cell border. 1 => thin, 2 => thick.

[ Top ]

method setBottomColor [line 868]

void setBottomColor(
mixed
$color)

Sets the cell's bottom border color

Tags:

access:

public

Parameters:

mixed

$color

either a string (like 'blue'), or an integer (range is [8...63]).

[ Top ]

method setColor [line 947]

void setColor(
mixed
$color)

Sets the cell's color

Tags:

access:

public

Parameters:

mixed

$color

either a string (like 'blue'), or an integer (range is [8...63]).

[ Top ]

method setFgColor [line 917]

void setFgColor(
mixed
$color)

Sets the cell's foreground color

Tags:

access:

public

Parameters:

mixed

$color

either a string (like 'blue'), or an integer (range is [8...63]).

[ Top ]

method setFontFamily [line 1162]

void setFontFamily(

$font_family, string
$fontfamily)

Sets the font family name.

Tags:

access:

public

Parameters:

string	$fontfamily	The font family name. Possible values are: 'Times New Roman', 'Arial', 'Courier'.
	$font_family

[ Top ]

method setHAlign [line 673]

void setHAlign(
string
$location)

Set cell horizontal alignment.

Tags:

access:

public

Parameters:

string

$location

alignment for the cell ('left', 'right', etc...).

[ Top ]

method setHidden [line 1140]

void setHidden(
)

Hide a cell.

Tags:

access:

public

[ Top ]

method setIndent [line 1014]

void setIndent(
integer
$indent)

Sets indent level

Tags:

access:

public

Parameters:

integer

$indent

[ Top ]

method setItalic [line 982]

void setItalic(
)

Sets the font style as italic

Tags:

access:

public

[ Top ]

method setLeft [line 811]

void setLeft(
integer
$style)

Sets the width for the left border of the cell

Tags:

access:

public

Parameters:

integer

$style

style of the cell left border. 1 => thin, 2 => thick.

[ Top ]

method setLeftColor [line 892]

void setLeftColor(
mixed
$color)

Sets the cell's left border color

Tags:

access:

public

Parameters:

mixed

$color

either a string (like 'blue'), or an integer (range is [8...63]).

[ Top ]

method setLocked [line 1120]

void setLocked(
)

Locks a cell.

Tags:

access:

public

[ Top ]

method setMerge [line 746]

void setMerge(
)

This is an alias for the unintuitive setAlign('merge')

Tags:

access:

public

[ Top ]

method setNumFormat [line 1068]

void setNumFormat(
integer
$num_format)

Sets the numeric format.

Sets the numeric format. It can be date, time, currency, etc...

Tags:

access:

public

Parameters:

integer

$num_format

The numeric format.

[ Top ]

method setOutLine [line 1088]

void setOutLine(
)

Sets outlining for a font.

Tags:

access:

public

[ Top ]

method setPattern [line 960]

void setPattern(
[integer
$arg = 1])

Sets the fill pattern attribute of a cell

Tags:

access:

public

Parameters:

integer

$arg

Optional. Defaults to 1. Meaningful values are: 0-18,

meaning no background.

[ Top ]

method setRight [line 822]

void setRight(
integer
$style)

Sets the width for the right border of the cell

Tags:

access:

public

Parameters:

integer

$style

style of the cell right border. 1 => thin, 2 => thick.

[ Top ]

method setRightColor [line 904]

void setRightColor(
mixed
$color)

Sets the cell's right border color

Tags:

access:

public

Parameters:

mixed

$color

either a string (like 'blue'), or an integer (range is [8...63]).

[ Top ]

method setScript [line 1110]

void setScript(
integer
$script)

Sets the script type of the text

Tags:

access:

public

Parameters:

integer

$script

The value for script type. Possible values are:

=> superscript, 2 => subscript.

[ Top ]

method setShadow [line 1098]

void setShadow(
)

Sets font as shadow.

Tags:

access:

public

[ Top ]

method setShrinkToFit [line 1024]

void setShrinkToFit(
)

Sets Shrink To Fit

Tags:

access:

public

[ Top ]

method setSize [line 993]

void setSize(
integer
$size)

Sets the font size

Tags:

access:

public

Parameters:

integer

$size

The font size (in pixels I think).

[ Top ]

method setStrikeOut [line 1078]

void setStrikeOut(
)

Sets font as strikeout.

Tags:

access:

public

[ Top ]

method setTextRotation [line 1035]

void setTextRotation(
integer
$rotation)

Sets the orientation of the text

Tags:

access:

public

Parameters:

integer

$rotation

The rotation angle for the text (-90 to 90, -165 stacked text)

[ Top ]

method setTextWrap [line 1003]

void setTextWrap(
)

Sets text wrapping

Tags:

access:

public

[ Top ]

method setTop [line 800]

void setTop(
integer
$style)

Sets the width for the top border of the cell

Tags:

access:

public

Parameters:

integer

$style

style of the cell top border. 1 => thin, 2 => thick.

[ Top ]

method setTopColor [line 880]

void setTopColor(
mixed
$color)

Sets the cell's top border color

Tags:

access:

public

Parameters:

mixed

$color

either a string (like 'blue'), or an integer (range is [8...63]).

[ Top ]

method setUnderline [line 972]

void setUnderline(
integer
$underline)

Sets the underline of the text

Tags:

access:

public

Parameters:

integer

$underline

The value for underline. Possible values are:

=> underline, 2 => double underline.

[ Top ]

method setUnhidden [line 1150]

void setUnhidden(
)

Unhide a cell.

Tags:

access:

public

[ Top ]

method setUnLocked [line 1130]

void setUnLocked(
)

Unlocks a cell.

Unlocks a cell. Useful for unprotecting particular cells of a protected sheet.

Tags:

access:

public

[ Top ]

method setVAlign [line 713]

void setVAlign(
string
$location)

Set cell vertical alignment.

Tags:

access:

public

Parameters:

string

$location

alignment for the cell ('top', 'vleft', 'vright', etc...).

[ Top ]

method _getColor [line 557]

integer _getColor(
[string
$name_color = ''])

Used in conjunction with the set_xxx_color methods to convert a color string into a number. to 8.

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.

Tags:

return:	The color index
access:	private

Parameters:

string

$name_color

name of the color (i.e.: 'blue', 'red', etc..). Optional.

[ Top ]

Documentation generated on Mon, 05 Jan 2009 20:37:15 +0100 by phpDocumentor 1.4.1