org.riotfamily.forms.element.select
Class CheckboxGroup

java.lang.Object
  extended by org.riotfamily.forms.AbstractElement
      extended by org.riotfamily.forms.AbstractEditorBase
          extended by org.riotfamily.forms.element.select.AbstractSelectElement
              extended by org.riotfamily.forms.element.select.AbstractMultiSelectElement
                  extended by org.riotfamily.forms.element.select.CheckboxGroup
All Implemented Interfaces:
BackingObjectAware, DHTMLElement, Editor, Element, SelectElement, JavaScriptEventAdapter, ResourceElement
Direct Known Subclasses:
ImageCheckboxGroup

public class CheckboxGroup
extends AbstractMultiSelectElement
implements DHTMLElement, ResourceElement

Multi-select element that uses a group of checkboxes to render the options. Internally a template is used in order to allow the customization of the layout.


Field Summary
protected static FormResource RESOURCE
           
 
Fields inherited from class org.riotfamily.forms.AbstractElement
log
 
Constructor Summary
CheckboxGroup()
           
 
Method Summary
 String getEventTriggerId()
           
 String getInitScript()
          Returns a JavaScript that is evaluated in order to initialize the element, or null if no initialization is needed.
 FormResource getResource()
           
 boolean isCompositeElement()
          Returns whether the element is composed of multiple widgets.
protected  void renderInternal(PrintWriter writer)
           
 void setTemplate(String template)
           
 
Methods inherited from class org.riotfamily.forms.element.select.AbstractMultiSelectElement
afterBindingSet, getCollectionClass, getSelectedValues, getValue, handleJavaScriptEvent, hasSelection, isSelected, processRequest, setCollectionClass, setMaxSelection, setValue, updateSelection, validate
 
Methods inherited from class org.riotfamily.forms.element.select.AbstractSelectElement
createOptionItems, getEventTypes, getOptionIndex, getOptionItems, getOptionLabel, getOptions, getOptionStyleClass, getOptionValue, hasOptionValues, isRequired, isVisible, renderOption, reset, setAppendLabel, setBackingObject, setHideIfEmpty, setLabelMessageKey, setLabelProperty, setOptionRenderer, setOptions, setStyleClassProperty, setValueProperty
 
Methods inherited from class org.riotfamily.forms.AbstractEditorBase
addChangeListener, 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, getSystemStyleClass, getWrapperStyleClass, isEnabled, 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.Element
focus, getForm, getFormContext, getId, getParent, getStyleClass, isEnabled, isRequired, isVisible, processRequest, render, setEnabled, setForm, setFormContext, setId, setParent, setRequired
 
Methods inherited from interface org.riotfamily.forms.element.select.SelectElement
getParamName
 
Methods inherited from interface org.riotfamily.forms.event.JavaScriptEventAdapter
getId
 

Field Detail

RESOURCE

protected static final FormResource RESOURCE
Constructor Detail

CheckboxGroup

public CheckboxGroup()
Method Detail

getEventTriggerId

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

getResource

public FormResource getResource()
Specified by:
getResource in interface ResourceElement

setTemplate

public void setTemplate(String template)

renderInternal

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

getInitScript

public String getInitScript()
Description copied from interface: DHTMLElement
Returns a JavaScript that is evaluated in order to initialize the element, or null if no initialization is needed.

Specified by:
getInitScript in interface DHTMLElement

isCompositeElement

public boolean isCompositeElement()
Description copied from interface: Element
Returns whether the element is composed of multiple widgets. The information may be used by templates to render composite elements in the same style as element groups or nested forms.

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