Class: CColumn

Source Location: /sptpl_clsColumn.php

Class CColumn

Class Overview

Located in /sptpl_clsColumn.php [line 34]

Author(s):

Andrioli Darvin <(inside) andrioli (dot) com darvin (inside) andrioli (dot) com>

Information Tags:

Version:	$Header: d:\cvs/classistd/sptpl/sptpl_clsColumn.php,v 2.15 2005/03/17 12:46:48 Darvin Exp $
Copyright:	sptpl_clsColumn.php is part of Sptpl project http://www.andrioli.com/en/sptpl.html and it is LGPL

Properties

Methods

[ Top ]

Property Summary

mixed	$clsCurrentFont	Real font to use to print the columns text
mixed	$clsDefaultFont	Default font to use to print the columns text.
string	$DefAlign	Alignment value used if not specified as parameter into function writeout
integer	$DefColPos	Colpos value used if not specified as parameter into function writeout
integer	$Height	Height for the current text stored into innerText
array	$innerText	Array of texts row defined inside this unit
integer	$LeftPosition	Left position of this column inside the parent column
array	$LeftText	For each row from innerText, set the distance from
array	$Margins	Margins setting.
integer	$RowPtr	The text inside this unit is retrieved on row basis.
integer	$Width	Column width

[ Top ]

Method Summary

CColumn	CColumn()	Class initializer
bool	AlreadyHaveText()	This column hold some text or not
void	ClearText()	Remove the text for this column, and prepare to receive a new one
void	EndParseXml()	Function executed at the end of the xml parsing. I run the final configuration
string	GetFontId()	Returns the id of the current font
void	GetHeight()
integer	GetLeftPos()	Return where is the left margin of the column
integer	GetLeftTextPos()	Return where is the left margin of the text
string	GetText()	retrieve the text from the column per row basis
bool	HasAnotherText()	Has this column another row of text to retrieve?
void	Parse()	Parse the configuration node
object CFont	SetDefaultFont()	Set the default font for the column
void	SetLeftPos()
void	SetWidth()
void	WriteOut()	Pass the text to the appropriate column. It returns a CUnit object holding
void	_AddRow()	Append a new text row into this unit
void	_CalcEndOffset()
void	_MyStrlen()

[ Top ]

Properties

mixed $clsCurrentFont [line 78]

Real font to use to print the columns text

NULL if not set var object CFont

[ Top ]

mixed $clsDefaultFont [line 72]

Default font to use to print the columns text.

The class use this font if no one is supplied NULL if not set var object CFont

[ Top ]

string $DefAlign [line 65]

Alignment value used if not specified as parameter into function writeout

API Tags:

See:

CColumn::WriteOut()

[ Top ]

integer $DefColPos [line 58]

Colpos value used if not specified as parameter into function writeout

API Tags:

See:

CColumn::WriteOut()

[ Top ]

integer $Height [line 105]

Height for the current text stored into innerText

API Tags:

See:	AddRow()
See:	CColumn::$innerText

[ Top ]

array $innerText [line 84]

Array of texts row defined inside this unit

[ Top ]

integer $LeftPosition [line 44]

Left position of this column inside the parent column

[ Top ]

array $LeftText [line 91]

For each row from innerText, set the distance from

the left border of the column

API Tags:

See:

CColumn::$innerText

[ Top ]

array $Margins [line 51]

Margins setting.

Allowed index: top, bottom, left, right

[ Top ]

integer $RowPtr [line 98]

The text inside this unit is retrieved on row basis.

This variable track which row return on each call to gettext

API Tags:

See:

getText()

[ Top ]

integer $Width [line 39]

Column width

[ Top ]

Methods

Constructor CColumn [line 111]

CColumn CColumn(
[object CXml2Array
$Cfg = NULL] 
)

Class initializer

Parameters:

object CXml2Array

$Cfg:

API Tags:

Access:

public

[ Top ]

AlreadyHaveText [line 463]

bool AlreadyHaveText(
)

This column hold some text or not

API Tags:

Access:

public

[ Top ]

ClearText [line 450]

void ClearText(
)

Remove the text for this column, and prepare to receive a new one

API Tags:

Access:

public

[ Top ]

EndParseXml [line 218]

void EndParseXml(
)

Function executed at the end of the xml parsing. I run the final configuration

checks and complete the configration data

API Tags:

Access:

public

[ Top ]

GetFontId [line 286]

string GetFontId(
)

Returns the id of the current font

API Tags:

Access:

public

[ Top ]

GetHeight [line 304]

void GetHeight(
)

[ Top ]

GetLeftPos [line 253]

integer GetLeftPos(
)

Return where is the left margin of the column

API Tags:

Access:

public

[ Top ]

GetLeftTextPos [line 263]

integer GetLeftTextPos(
)

Return where is the left margin of the text

API Tags:

Access:

public

[ Top ]

GetText [line 295]

string GetText(
)

retrieve the text from the column per row basis

API Tags:

Access:

public

[ Top ]

HasAnotherText [line 473]

bool HasAnotherText(
)

Has this column another row of text to retrieve?

API Tags:

Access:

public

[ Top ]

Parse [line 131]

void Parse(
object CXml2Array
$Cfg 
)

Parse the configuration node

Parameters:

object CXml2Array

$Cfg:

API Tags:

Access:

public

[ Top ]

SetDefaultFont [line 274]

object CFont SetDefaultFont(
object CFont
$NFont 
)

Set the default font for the column

Parameters:

object CFont

$NFont:

API Tags:

Access:

public

[ Top ]

SetLeftPos [line 244]

void SetLeftPos(
integer
$pos 
)

Parameters:

integer

$pos:

API Tags:

Access:

public

[ Top ]

SetWidth [line 236]

void SetWidth(
integer
$width 
)

Parameters:

integer

$width:

API Tags:

Access:

public

[ Top ]

WriteOut [line 320]

void WriteOut(
string
$txt, [string
$align = ''], [integer
$colPos = 0], [mixed
$pFont = NULL], integer
$Column, object CFont
4 
)

Pass the text to the appropriate column. It returns a CUnit object holding

the text with format (alignment, font) according to the given parameters

Parameters:

string	$txt:	Text to write
string	$align:	Text alignment, left, center, right
integer	$colPos:
integer	$Column:	column where place the text
object CFont	4:	Font used to print the text, if NULL, it uses the default font for the current column

API Tags:

Access:

public

[ Top ]

_AddRow [line 439]

void _AddRow(
string
$Text, integer
$StartCol, object CFont
2 
)

Append a new text row into this unit

Parameters:

object CFont	2:	font to use to print the text, NULL if not set (only clsPageManager)
string	$Text:
integer	$StartCol:	Position from the left border of the column where to start the text

API Tags:

Access:

public

[ Top ]

_CalcEndOffset [line 373]

void _CalcEndOffset(
mixed
$text 
)

[ Top ]

_MyStrlen [line 367]

void _MyStrlen(
mixed
$text 
)

[ Top ]

Documentation generated on Mon, 28 Mar 2005 15:13:12 +0200 by phpDocumentor 1.3.0RC3

	SpoolTemplate

[ Back ] [ class tree: SpoolTemplate ] [ index: SpoolTemplate ] [ all elements ]