org.riotfamily.forms.element
Class Checkbox

java.lang.Object
  extended by org.riotfamily.forms.AbstractElement
      extended by org.riotfamily.forms.AbstractEditorBase
          extended by org.riotfamily.forms.element.Checkbox
All Implemented Interfaces:
Editor, Element
Direct Known Subclasses:
ImageCheckbox

public class Checkbox
extends AbstractEditorBase
implements Editor

A Checkbox widget.


Field Summary
 
Fields inherited from class org.riotfamily.forms.AbstractElement
log
 
Constructor Summary
Checkbox()
           
 
Method Summary
 String getEventTriggerId()
           
protected  String getSystemStyleClass()
           
 Object getValue()
          Returns the checked or unchecked value depending on the element's state.
 boolean isChecked()
           
 boolean isCheckedByDefault()
           
 void processRequest(FormRequest request)
          Subclasses may override this method to change their internal state according the given request.
 void renderInternal(PrintWriter writer)
           
 void setChecked(boolean checked)
           
 void setCheckedByDefault(boolean checkedByDefault)
           
 void setCheckedValue(Object checkedValue)
          Sets the value representing the element's checked state.
 void setUncheckedValue(Object uncheckedValue)
          Sets the value representing the element's unchecked state.
 void setValue(Object value)
          Sets the (initial) value, typically retrieved from a backing object.
protected  void validate()
           
 
Methods inherited from class org.riotfamily.forms.AbstractEditorBase
addChangeListener, afterBindingSet, fireChangeEvent, getEditorBinding, getFieldName, getHint, getLabel, getParamName, hasListeners, setEditorBinding, setFieldName, setParamName
 
Methods inherited from class org.riotfamily.forms.AbstractElement
afterFormContextSet, afterFormSet, focus, getForm, getFormContext, getFormListener, getId, getParent, getStyleClass, getWrapperStyleClass, isCompositeElement, isEnabled, isRequired, isVisible, render, render, setEnabled, setForm, setFormContext, setHint, setId, setInline, setLabel, setParent, setReadOnly, setRequired, setStyleClass, setVisible, setWrap
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.riotfamily.forms.Editor
addChangeListener, getEditorBinding, getFieldName, getLabel, setEditorBinding, setFieldName
 
Methods inherited from interface org.riotfamily.forms.Element
focus, getForm, getFormContext, getId, getParent, getStyleClass, isCompositeElement, isEnabled, isRequired, isVisible, render, setEnabled, setForm, setFormContext, setId, setParent, setRequired
 

Constructor Detail

Checkbox

public Checkbox()
Method Detail

setCheckedValue

public void setCheckedValue(Object checkedValue)
Sets the value representing the element's checked state. Defaults to Boolean.TRUE


setUncheckedValue

public void setUncheckedValue(Object uncheckedValue)
Sets the value representing the element's unchecked state. Defaults to Boolean.FALSE


setCheckedByDefault

public void setCheckedByDefault(boolean checkedByDefault)

isCheckedByDefault

public boolean isCheckedByDefault()

setChecked

public void setChecked(boolean checked)

isChecked

public boolean isChecked()

getEventTriggerId

public String getEventTriggerId()
Specified by:
getEventTriggerId in interface Element
Overrides:
getEventTriggerId in class AbstractElement

renderInternal

public void renderInternal(PrintWriter writer)
Specified by:
renderInternal in class AbstractElement

getSystemStyleClass

protected String getSystemStyleClass()
Overrides:
getSystemStyleClass in class AbstractElement

setValue

public void setValue(Object value)
Description copied from interface: Editor
Sets the (initial) value, typically retrieved from a backing object.

Specified by:
setValue in interface Editor
See Also:
Editor.setValue(Object)

getValue

public Object getValue()
Returns the checked or unchecked value depending on the element's state.

Specified by:
getValue in interface Editor
See Also:
Editor.getValue(), setCheckedValue(Object), setUncheckedValue(Object), isChecked()

processRequest

public void processRequest(FormRequest request)
Description copied from class: AbstractElement
Subclasses may override this method to change their internal state according the given request.

Specified by:
processRequest in interface Element
Overrides:
processRequest in class AbstractElement

validate

protected void validate()