Docs For Class Structures_Form_Renderer_Gtk2

$buttonBox =

[line 71]

The widget holding the buttons.

Var: GtkHButtonBox
Access: public

Type:

object A

[ Top ]

$elements = array()

[line 47]

The form elements to display.

Access: public

Type:

array

[ Top ]

$errorBox =

[line 63]

The widget holding the current errors.

Var: GtkVBox
Access: public

Type:

object A

[ Top ]

$errors = array()

[line 55]

The form errors to display.

Access: public

Type:

array

[ Top ]

$form =

[line 20]

The Structures_Form.

Access: public

Type:

object

[ Top ]

$requiredNote = ' denotes required field'

[line 29]

A note identifying the required field marker.

The renderer should prepend the required symbol to the note.

Access: protected

Type:

string

[ Top ]

$requiredSymbol = '*'

[line 39]

A symbol identifying the required fields.

The renderer should provide some sort of formatting to make the symbol standout.

Access: protected

Type:

string

[ Top ]

__construct (Constructor) [line 79]

void __construct(
)

Constructor. Calls parent constructor and creates an error box.

Access: public

[ Top ]

attachButtons [line 297]

void attachButtons(
array
$buttons, integer
$row)

Packs the buttons into the button box.

Access: protected

Parameters:

array	`$buttons`	—	An array of GtkButtons
integer	`$row`	—	The row to attach the button box to.

[ Top ]

attachElement [line 252]

void attachElement(
object
$element, integer
$row)

Attaches the given element in the given row.

Each element is attached with the label in the left column and the widget in the right hand column.

Access: protected

Parameters:

object	`$element`	—	The element to attach.
integer	`$row`	—	The row to attach the element in.

[ Top ]

attachElements [line 214]

void attachElements(
)

Attaches the form elements to the table. Also attaches a required note.

Buttons are always added at the bottom in a button box unless the button has a label. If the button has a label, it is treated like a normal element.

Access: protected

[ Top ]

attachErrors [line 199]

void attachErrors(
)

Attachs the error box to the table.

Access: protected

[ Top ]

attachRequiredNote [line 321]

void attachRequiredNote(
integer
$row)

Attachs the required note to the given row.

Access: protected

Parameters:

integer $row — The row to attach the note to.

[ Top ]

createRequiredMarker [line 354]

string. createRequiredMarker(
)

Returns a required symbol string.

Wraps the symbol in Pango markup to make it red.

Access: public

[ Top ]

getRequiredNote [line 405]

string getRequiredNote(
)

Returns the current required note.

Access: public

[ Top ]

getRequiredSymbol [line 416]

string getRequiredSymbol(
)

Returns the current required symbol.

Access: public

[ Top ]

render [line 173]

object A render(
)

Returns the rendered form.

This method should return something inline with the intent of the renderer even if there are no elements in the form. For example, if the renderer is a GtkTable renderer, this method should return a GtkTable no matter what. Of course, it may throw an exception if needed but should not return anything other than a GtkTable. Not even null or void.

Return: GtkTable containing the form.
Access: public

[ Top ]

setElements [line 112]

void setElements(
array
$elements)

Sets the elements that make up the form.

The array passed in will be of the form: array(<name> => <element>)

Access: public

Parameters:

array $elements — The elements that make up the form.

[ Top ]

setErrors [line 124]

void setErrors(
array
$errors)

Sets the errors to be displayed.

Access: public

Parameters:

array $errors — An array of error strings.

[ Top ]

setForm [line 98]

void setForm(
Structures_Form
$form)

Sets the form.

Access: public

Parameters:

object $form — The form.

[ Top ]

setRequiredNote [line 374]

void setRequiredNote(
string
$note)

Sets the string to be used as the note indicating what the required symbol means.

The required note does not include the required symbol. It is up to the renderer to append or prepend the required symbol in a way that makes sense for the rendered output.

The required note is controlled by the form to maintain consistency when a single form is rendered in different ways.

Access: public

Parameters:

string $note — The required note.

[ Top ]

setRequiredSymbol [line 394]

void setRequiredSymbol(
string
$symbol)

Sets the string to be used as the note indicating what the required symbol means.

The required note does not include the required symbol. It is up to the renderer to append or prepend the required symbol in a way that makes sense for the rendered output.

The required symbol is controlled by the form to maintain consistency when a single form is rendered in different ways.

Access: public

Parameters:

string $symbol — The required symbol.

[ Top ]

updateErrors [line 139]

void updateErrors(
)

Updates the errors in the errorBox.

Access: protected

[ Top ]

Class: Structures_Form_Renderer_Gtk2_Table

Class Overview

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$buttonBox =

$elements = array()

$errorBox =

$errors = array()

$form =

$requiredNote = ' denotes required field'

$requiredSymbol = '*'

Method Detail

__construct (Constructor) [line 79]

attachButtons [line 297]

Parameters:

attachElement [line 252]

Parameters:

attachElements [line 214]

attachErrors [line 199]

attachRequiredNote [line 321]

Parameters:

createRequiredMarker [line 354]

getRequiredNote [line 405]

getRequiredSymbol [line 416]

render [line 173]

setElements [line 112]

Parameters:

setErrors [line 124]

Parameters:

setForm [line 98]

Parameters:

setRequiredNote [line 374]

Parameters:

setRequiredSymbol [line 394]

Parameters:

updateErrors [line 139]