Summary: Field | Method | Constr Detail: Field | Method | Constr

org.zenmagick.widgets.form.widget.ZMBooleanFormWidget

Class ZMBooleanFormWidget

ZMObject
  |
  +--ZMWidget
       |
       +--ZMFormWidget
            |
            +--ZMBooleanFormWidget

public class ZMBooleanFormWidget
extends ZMFormWidget

A widget to make a boolean selection (true/false).

Style can be: radio, select or checkbox. Default is radio.

If style is checkbox, the custom property label might be set to override the use of the title as label text.

Radiobox and select label for true and false may be set via label_true and label_false, respectively.

Author:: DerManoMann
Version:: $Id: ZMBooleanFormWidget.php 2109 2009-03-24 04:05:11Z dermanomann $

Constructor Summary
ZMBooleanFormWidget() Create new instance.

Constructor Summary

ZMBooleanFormWidget()

Create new instance.

Method Summary
boolean	compare(string value) {@inheritDoc} /
protected string	getCheckboxHiddenValueName(string name) Build the hidden value element name used for checkbox rendering.
boolean	getValue() Overload to evaluate as boolean.
The	handleFormData(array data) {@inheritDoc} /
string	render() {@inheritDoc} /
protected The	renderCheckbox() Render as checkbox.
protected The	renderRadio() Render as radiobox group.
protected The	renderSelect() Render as select box.

Methods inherited from org.zenmagick.widgets.form.ZMFormWidget
compare, getName, getValue, handleFormData, setName, setValue

Methods inherited from org.zenmagick.widgets.ZMWidget
getDescription, getTitle, isEnabled, render, setDescription, setEnabled, setTitle

Methods inherited from org.zenmagick.ZMObject
attachMethod, get, getAttachedMethods, getPropertyNames, set, singleton

Constructor Detail

ZMBooleanFormWidget

public ZMBooleanFormWidget()

Create new instance. /

Method Detail

compare

public boolean compare(string value)

Parameters:: value - A string value.
Returns:: true if the given value evaluates to the * same value as the widget value.

getCheckboxHiddenValueName

protected string getCheckboxHiddenValueName(string name)

Build the hidden value element name used for checkbox rendering.

Parameters:: name - The name.
Returns:: The generated name for the hidden element.

getValue

public boolean getValue()

Overload to evaluate as boolean.

Returns:: The value.

handleFormData

public The handleFormData(array data)

Parameters:: data - The form data.
Returns:: processed form data.

render

public string render()

Returns:: The HTML.

renderCheckbox

protected The renderCheckbox()

Render as checkbox.

Returns:: rendered HTML.

renderRadio

protected The renderRadio()

Render as radiobox group.

Returns:: rendered HTML.

renderSelect

protected The renderSelect()

Render as select box.

Returns:: rendered HTML.

Frames No frames