it.amattioli.guidate.properties
Class PropertyComposer

Show UML class diagram

java.lang.Object
  org.zkoss.zk.ui.event.GenericEventListener
      org.zkoss.zk.ui.util.GenericComposer
          it.amattioli.guidate.properties.PropertyComposer

All Implemented Interfaces:

Serializable, org.zkoss.zk.scripting.NamespaceActivationListener, org.zkoss.zk.ui.event.EventListener, org.zkoss.zk.ui.util.Composer, org.zkoss.zk.ui.util.ComposerExt

Direct Known Subclasses:

AvailableComposer, CheckboxComposer, ImagePropertyComposer, InputPropertyComposer, LabelCellComposer, LabelPropertyComposer, WritableComposer

public abstract class PropertyComposer
extends org.zkoss.zk.ui.util.GenericComposer

A composer that is able to bind a component attribute to the property of the back-bean so that every time the property of the back-bean changes the component attribute is updated. To obtain this effect the back-bean must send a PropertyChangeEvent every time the property value changes.

The name of the property of the back-bean can be provided in two ways:

• Using the setPropertyName(String) method
• Using custom-attributes as specified by PropertyNameRetriever
  Subclasses must define the getComponentValueAttribute(Component) method to provide the name of the attribute of the component that is bound.

  Author:

  andrea

  See Also:

  Serialized Form

  Constructor Summary

  PropertyComposer()
  

  Method Summary

  void	doAfterCompose(org.zkoss.zk.ui.Component comp)
  Object	getBackBean(org.zkoss.zk.ui.Component comp)
  protected String	getCompletePropertyName(org.zkoss.zk.ui.Component comp)
  protected abstract String	getComponentValueAttribute(org.zkoss.zk.ui.Component comp)
  protected org.zkoss.zkplus.databind.TypeConverter	getConverter(org.zkoss.zk.ui.Component comp)
  protected Class<?>	getPropertyClass()
  String	getPropertyName()
  protected Object	getPropertyValue(org.zkoss.zk.ui.Component comp)
  void	onBindingUpdate(org.zkoss.zk.ui.event.Event evt)
  void	onCreate(org.zkoss.zk.ui.event.Event evt)
  protected void	registerPropertyChangeListener(org.zkoss.zk.ui.Component comp)
  protected void	setComponentValue(org.zkoss.zk.ui.Component comp, Object val)
  protected void	setConverter(org.zkoss.zkplus.databind.TypeConverter converter)
  protected void	setPropertyClass(Class<?> propertyClass)
  void	setPropertyName(String propertyName)

  Methods inherited from class org.zkoss.zk.ui.util.GenericComposer

  didActivate, doBeforeCompose, doBeforeComposeChildren, doCatch, doFinally, willPassivate

  Methods inherited from class org.zkoss.zk.ui.event.GenericEventListener

  bindComponent, getController, onEvent

  Methods inherited from class java.lang.Object

  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  Constructor Detail

  PropertyComposer

  public PropertyComposer()

  Method Detail

  getComponentValueAttribute

  protected abstract String getComponentValueAttribute(org.zkoss.zk.ui.Component comp)

  doAfterCompose

  public void doAfterCompose(org.zkoss.zk.ui.Component comp)
                      throws Exception

  Specified by:

  doAfterCompose in interface org.zkoss.zk.ui.util.Composer

  Overrides:

  doAfterCompose in class org.zkoss.zk.ui.util.GenericComposer

  Throws:

  Exception

  registerPropertyChangeListener

  protected void registerPropertyChangeListener(org.zkoss.zk.ui.Component comp)

  getPropertyClass

  protected Class<?> getPropertyClass()

  setPropertyClass

  protected void setPropertyClass(Class<?> propertyClass)

  getPropertyName

  public String getPropertyName()

  setPropertyName

  public void setPropertyName(String propertyName)

  getBackBean

  public Object getBackBean(org.zkoss.zk.ui.Component comp)

  getConverter

  protected org.zkoss.zkplus.databind.TypeConverter getConverter(org.zkoss.zk.ui.Component comp)

  setConverter

  protected void setConverter(org.zkoss.zkplus.databind.TypeConverter converter)

  getCompletePropertyName

  protected String getCompletePropertyName(org.zkoss.zk.ui.Component comp)

  onBindingUpdate

  public void onBindingUpdate(org.zkoss.zk.ui.event.Event evt)
                       throws Exception

  Throws:

  Exception

  setComponentValue

  protected void setComponentValue(org.zkoss.zk.ui.Component comp,
                                   Object val)
                            throws Exception

  Throws:

  Exception

  getPropertyValue

  protected Object getPropertyValue(org.zkoss.zk.ui.Component comp)
                             throws Exception

  Throws:

  Exception

  onCreate

  public void onCreate(org.zkoss.zk.ui.event.Event evt)
                throws Exception

  Throws:

  Exception