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

org.zenmagick.mvc.widgets.form\ZMBooleanFormWidget

mvc\widgets\form\ZMBooleanFormWidget.php at line 38

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

Method Summary
void	__construct() Create new instance.
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.
string	render(ZMRequest request) {@inheritDoc}
protected The	renderCheckbox(ZMRequest request) Render as checkbox.
protected The	renderRadio(ZMRequest request) Render as radiobox group.
protected The	renderSelect(ZMRequest request) Render as select box.

Methods inherited from org.zenmagick.mvc.widgets.form\ZMFormWidget
__construct, compare, getAttributeNames, getAttributeString, getName, getStringValue, getValue, isEncode, isMultiValue, setAttributeNames, setEncode, setName, setValue

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

Methods inherited from org.zenmagick.core\ZMObject
__construct, attachMethod, get, getAttachedMethods, getProperties, getPropertyNames, set, singleton

Method Detail

mvc\widgets\form\ZMBooleanFormWidget.php at line 43

__construct

public void __construct()

Create new instance.

mvc\widgets\form\ZMBooleanFormWidget.php at line 178

compare

public boolean compare(string value)

Compare the given value with the widget value.

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

mvc\widgets\form\ZMBooleanFormWidget.php at line 75

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.

mvc\widgets\form\ZMBooleanFormWidget.php at line 65

getValue

public boolean getValue()

Overload to evaluate as boolean.

Returns:: The value.

mvc\widgets\form\ZMBooleanFormWidget.php at line 162

render

public string render(ZMRequest request)

Parameters:: request - The current request.
Returns:: The HTML.

mvc\widgets\form\ZMBooleanFormWidget.php at line 89

renderCheckbox

protected The renderCheckbox(ZMRequest request)

Render as checkbox.

Parameters:: request - The current request.
Returns:: rendered HTML.

mvc\widgets\form\ZMBooleanFormWidget.php at line 119

renderRadio

protected The renderRadio(ZMRequest request)

Render as radiobox group.

Parameters:: request - The current request.
Returns:: rendered HTML.

mvc\widgets\form\ZMBooleanFormWidget.php at line 144

renderSelect

protected The renderSelect(ZMRequest request)

Render as select box.

Parameters:: request - The current request.
Returns:: rendered HTML.

Frames No frames