org.apache.wicket.model
Class PropertyModel<T>

java.lang.Object
  org.apache.wicket.model.AbstractPropertyModel<T>
      org.apache.wicket.model.PropertyModel<T>

Type Parameters:

T - The Model object type

All Implemented Interfaces:

Serializable, IClusterable, IChainingModel<T>, IDetachable, IModel<T>, IObjectClassAwareModel<T>, IPropertyReflectionAwareModel

public class PropertyModel<T>
extends AbstractPropertyModel<T>

A PropertyModel is used to dynamically access a model using a "property expression". See PropertyResolver javadoc for allowed property expressions.

For example, take the following bean:

 public class Person
 {
        private String name;
 
        public String getName()
        {
                return name;
        }
 
        public void setName(String name)
        {
                this.name = name;
        }
 }
 

We could construct a label that dynamically fetches the name property of the given person object like this:

     Person person = getSomePerson();
     ...
     add(new Label("myLabel", new PropertyModel(person, "name"));
 

Where 'myLabel' is the name of the component, and 'name' is the property expression to get the name property.

In the same fashion, we can create form components that work dynamically on the given model object. For instance, we could create a text field that updates the name property of a person like this:

     add(new TextField("myTextField", new PropertyModel(person, "name"));
 

Note that the property resolver by default provides access to private members and methods. If guaranteeing encapsulation of the target objects is a big concern, you should consider using an alternative implementation.

Author:

Chris Turner, Eelco Hillenius, Jonathan Locke

See Also:

PropertyResolver, IModel, Model, LoadableDetachableModel, Serialized Form

Constructor Summary

PropertyModel(Object modelObject, String expression)
Construct with a wrapped (IModel) or unwrapped (non-IModel) object and a property expression that works on the given model.

Method Summary

static <Z> PropertyModel<Z>	of(Object parent, String property) Type-infering factory method
protected String	propertyExpression()
String	toString()

Methods inherited from class org.apache.wicket.model.AbstractPropertyModel

detach, getChainedModel, getObject, getObjectClass, getPropertyExpression, getPropertyField, getPropertyGetter, getPropertySetter, getTarget, onGetObject, onSetObject, setChainedModel, setObject

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyModel

public PropertyModel(Object modelObject,
                     String expression)

Construct with a wrapped (IModel) or unwrapped (non-IModel) object and a property expression that works on the given model.

Parameters:

modelObject - The model object, which may or may not implement IModel

expression - Property expression for property access

Method Detail

toString

public String toString()

Overrides:

toString in class AbstractPropertyModel<T>

See Also:

Object.toString()

propertyExpression

protected String propertyExpression()

Specified by:

propertyExpression in class AbstractPropertyModel<T>

Returns:

The property expression for the component

See Also:

AbstractPropertyModel.propertyExpression()

of

public static <Z> PropertyModel<Z> of(Object parent,
                                      String property)

Type-infering factory method

Type Parameters:

Z -

Parameters:

parent - object that contains the property

property - property path

Returns:

PropertyModel instance