Class: SizedField

Field::__construct(): Constructor for Field.
Field::formatAddition(): Formats any additional data that should be appended to the field. Any '%id' entities in the formatted string are replaced with the field's id. Any '%name' entities in the formatted string are replaced with the field's name.
Field::getAsHtml(): Returns the (X)HTML representation of the field. This function should be concidered as an abstract function, any subclasses should override this.
Field::getAttributes(): Gets the (X)HTML information containing all base information.
Field::getError()
Field::getId(): Gets the field's id.
Field::getName(): Gets the name of the field.
Field::getValue(): Gets the value of the field.
Field::hasUserValue(): Checks if the field has a non empty value that has been supplied by a user.
Field::hasValue(): Checks if the field has a non empty value.
Field::isValid()
Field::setAttribute(): Sets one of the firleds attributes. If the attribute does not exist then it is created. The attributes 'id', 'name' and 'value' can not be modified throught this function.
Field::setId(): Sets the field's id.
Field::setValue(): Sets the value of the field.

Class Details

[line 410]
Describes a field that can be sized.

Tags:

abstract:
author:	Andreas Launila

[ Top ]

Class Variables

$height =

[line 415]

The height of the field, 0 means that no height has been set.

Tags:

access:

private

Type:

integer

[ Top ]

$width =

[line 420]

The width of the field, 0 means that no width has been set.

Tags:

access:

private

Type:

integer

[ Top ]

Class Methods

constructor __construct [line 428]

SizedField __construct(
string
$name, [boolean
$required = false])

Constructor for SizedField.

Parameters:

string	$name	The name of the SizedField.
boolean	$required	True if the field has to contain something to be valid, false otherwise. False by default.

[ Top ]

method getAttributes [line 467]

void getAttributes(
)

Tags:

access:	protected
see:	field.getAttributes()

Overrides Field::getAttributes() (Gets the (X)HTML information containing all base information.)

[ Top ]

method getHeight [line 452]

integer getHeight(
)

Gets the height of the field.

Tags:

return:	A field height.
access:	public

[ Top ]

method getWidth [line 460]

integer getWidth(
)

Gets the width of the field.

Tags:

return:	A field width.
access:	public

[ Top ]

method setHeight [line 436]

void setHeight(
integer
$new_height)

Sets the height of the field.

Tags:

access:

public

Parameters:

integer

$new_height

The new height.

[ Top ]

method setWidth [line 444]

void setWidth(
integer
$new_width)

Sets the width of the field.

Tags:

access:

public

Parameters:

integer

$new_width

The new width.

[ Top ]

Documentation generated on Tue, 10 Jan 2006 17:06:32 +0100 by phpDocumentor 1.3.0RC4